Skip to content

APIExportEndpointSlice

APIExportEndpointSlice CRD schema reference (group apis.kcp.io)

APIExportEndpointSlice is a sink for the endpoints of an APIExport. These endpoints can be filtered by a Partition. They get consumed by the managers to start controllers and informers for the respective APIExport services.
Full name:
apiexportendpointslices.apis.kcp.io
Group:
apis.kcp.io
Singular name:
apiexportendpointslice
Plural name:
apiexportendpointslices
Scope:
Cluster
Versions:
v1alpha1

Version v1alpha1

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

spec holds the desired state: - the targetted APIExport - an optional partition for filtering

.spec.export

object Required

export points to the API export.

.spec.export.name

string Required

name is the name of the APIExport that describes the API.

.spec.export.path

string

path is a logical cluster path where the APIExport is defined. If the path is unset, the logical cluster of the APIBinding is used.

.spec.partition

string

partition (optional) points to a partition that is used for filtering the endpoints of the APIExport part of the slice.

.status

object

status communicates the observed state: the filtered list of endpoints for the APIExport service.

.status.conditions

array

conditions is a list of conditions that apply to the APIExportEndpointSlice.

.status.conditions[*]

object

Condition defines an observation of a object operational state.

.status.conditions[*].lastTransitionTime

string Required

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.endpoints

array

endpoints contains all the URLs of the APIExport service.

.status.endpoints[*]

object

APIExportEndpoint contains the endpoint information of an APIExport service for a specific shard.

.status.endpoints[*].url

string Required

url is an APIExport virtual workspace URL.