API Reference

# Clusterregistry

# Cluster v1alpha1

Group | Version | Kind
--- | --- | ---
`clusterregistry` | `v1alpha1` | `Cluster`

Cluster contains information about a cluster in a cluster registry.

Field | Description
--- | ---
`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/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/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`spec` ClusterSpec | Spec is the specification of the cluster. This may or may not be reconciled by an active controller.
`status` ClusterStatus | Status is the status of the cluster.

### ClusterSpec v1alpha1

Appears In:

- Cluster v1alpha1

Field | Description
--- | ---
`authInfo` AuthInfo | AuthInfo contains public information that can be used to authenticate to and authorize with this cluster. It is not meant to store private information (e.g., tokens or client certificates) and cluster registry implementations are not expected to provide hardened storage for secrets.
`kubernetesApiEndpoints` KubernetesAPIEndpoints | KubernetesAPIEndpoints represents the endpoints of the API server for this cluster.

### ClusterStatus v1alpha1

Appears In:

- Cluster v1alpha1

Field | Description
--- | ---
`conditions` ClusterCondition array | Conditions contains the different condition statuses for this cluster.

# Old API Versions

# Field Definitions

## AuthInfo v1alpha1

Group | Version | Kind
--- | --- | ---
`clusterregistry` | `v1alpha1` | `AuthInfo`

AuthInfo holds information that describes how a client can get credentials to access the cluster. For example, OAuth2 client registration endpoints and supported flows, or Kerberos server locations.

Appears In:

- ClusterSpec v1alpha1

Field | Description
--- | ---
`controller` ObjectReference | Controller references an object that contains implementation-specific details about how a controller should authenticate. A simple use case for this would be to reference a secret in another namespace that stores a bearer token that can be used to authenticate against this cluster's API server.
`user` ObjectReference | User references an object that contains implementation-specific details about how a user should authenticate against this cluster.

## ClusterCondition v1alpha1

Group | Version | Kind
--- | --- | ---
`clusterregistry` | `v1alpha1` | `ClusterCondition`

ClusterCondition contains condition information for a cluster.

Appears In:

- ClusterStatus v1alpha1

Field | Description
--- | ---
`lastHeartbeatTime` Time | LastHeartbeatTime is the last time this condition was updated.
`lastTransitionTime` Time | LastTransitionTime is the last time the condition changed from one status to another.
`message` string | Message is a human-readable message indicating details about the last status change.
`reason` string | Reason is a (brief) reason for the condition's last status change.
`status` string | Status is the status of the condition. One of True, False, Unknown.
`type` string | Type is the type of the cluster condition.

## Initializer v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Initializer`

Initializer is information about an initializer that has not yet completed.

Appears In:

- Initializers v1

Field | Description
--- | ---
`name` string | name of the process that is responsible for initializing this object.

## Initializers v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Initializers`

Initializers tracks the progress of initialization.

Appears In:

- ObjectMeta v1

Field | Description
--- | ---
`pending` Initializer array patch type: merge patch merge key: name | Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
`result` Status | If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

## KubernetesAPIEndpoints v1alpha1

Group | Version | Kind
--- | --- | ---
`clusterregistry` | `v1alpha1` | `KubernetesAPIEndpoints`

KubernetesAPIEndpoints represents the endpoints for one and only one Kubernetes API server.

Appears In:

- ClusterSpec v1alpha1

Field | Description
--- | ---
`caBundle` string | CABundle contains the certificate authority information.
`serverEndpoints` ServerAddressByClientCIDR array | ServerEndpoints specifies the address(es) of the Kubernetes API server’s network identity or identities.

## ListMeta v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `ListMeta`

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Appears In:

- Status v1

Field | Description
--- | ---
`continue` string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
`resourceVersion` string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
`selfLink` string | selfLink is a URL representing this object. Populated by the system. Read-only.

## ObjectMeta v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `ObjectMeta`

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Appears In:

- Cluster v1alpha1

Field | Description
--- | ---
`annotations` object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
`clusterName` string | The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
`creationTimestamp` Time | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`deletionGracePeriodSeconds` integer | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
`deletionTimestamp` Time | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`finalizers` string array patch type: merge | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
`generateName` string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
`generation` integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
`initializers` Initializers | An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
`labels` object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
`name` string | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
`namespace` string | Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
`ownerReferences` OwnerReference array patch type: merge patch merge key: uid | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
`resourceVersion` string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
`selfLink` string | SelfLink is a URL representing this object. Populated by the system. Read-only.
`uid` string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## ObjectReference v1alpha1

Group | Version | Kind
--- | --- | ---
`clusterregistry` | `v1alpha1` | `ObjectReference`

ObjectReference contains enough information to let you inspect or modify the referred object.

Appears In:

- AuthInfo v1alpha1

Field | Description
--- | ---
`kind` string | Kind contains the kind of the referent, e.g., Secret or ConfigMap More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`name` string | Name contains the name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace` string | Namespace contains the namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

## OwnerReference v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `OwnerReference`

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Appears In:

- ObjectMeta v1

Field | Description
--- | ---
`apiVersion` string | API version of the referent.
`blockOwnerDeletion` boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
`controller` boolean | If true, this reference points to the managing controller.
`kind` string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`name` string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
`uid` string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## ServerAddressByClientCIDR v1alpha1

Group | Version | Kind
--- | --- | ---
`clusterregistry` | `v1alpha1` | `ServerAddressByClientCIDR`

ServerAddressByClientCIDR helps clients determine the server address that they should use, depending on the ClientCIDR that they match.

Appears In:

- KubernetesAPIEndpoints v1alpha1

Field | Description
--- | ---
`clientCIDR` string | The CIDR with which clients can match their IP to figure out if they should use the corresponding server address.
`serverAddress` string | Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

## Status v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Status`

Status is a return value for calls that don't return other objects.

Appears In:

- Initializers v1

Field | Description
--- | ---
`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/api-conventions.md#resources
`code` integer | Suggested HTTP return code for this status, 0 if not set.
`details` StatusDetails | Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
`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/api-conventions.md#types-kinds
`message` string | A human-readable description of the status of this operation.
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`reason` string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
`status` string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

## StatusCause v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `StatusCause`

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Appears In:

- StatusDetails v1

Field | Description
--- | ---
`field` string | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
`message` string | A human-readable description of the cause of the error. This field may be presented as-is to a reader.
`reason` string | A machine-readable description of the cause of the error. If this value is empty there is no information available.

## StatusDetails v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `StatusDetails`

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Appears In:

- Status v1

Field | Description
--- | ---
`causes` StatusCause array | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
`group` string | The group attribute of the resource associated with the status StatusReason.
`kind` string | The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`name` string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
`retryAfterSeconds` integer | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
`uid` string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## Time v1

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Time`

Appears In:

- ClusterCondition v1alpha1
- ObjectMeta v1

Field | Description
--- | ---