Cluster

string

.apiVersion

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
string

.kind

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
object

.metadata
object

.spec

spec is the desired state of Cluster.
object

.spec .clusterNetwork

clusterNetwork is the cluster network configuration.
integer

.spec .clusterNetwork .apiServerPort

apiServerPort specifies the port the API Server should bind to. Defaults to 6443.
object

.spec .clusterNetwork .pods

pods is the network ranges from which Pod networks are allocated.
array required

.spec .clusterNetwork .pods .cidrBlocks

cidrBlocks is a list of CIDR blocks.
string

.spec .clusterNetwork .serviceDomain

serviceDomain is the domain name for services.
object

.spec .clusterNetwork .services

services is the network ranges from which service VIPs are allocated.
array required

.spec .clusterNetwork .services .cidrBlocks

cidrBlocks is a list of CIDR blocks.
object

.spec .controlPlaneEndpoint

controlPlaneEndpoint represents the endpoint used to communicate with the control plane.
string required

.spec .controlPlaneEndpoint .host

host is the hostname on which the API server is serving.
integer required

.spec .controlPlaneEndpoint .port

port is the port on which the API server is serving.
object

.spec .controlPlaneRef

controlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster.
string

.spec .controlPlaneRef .apiVersion

API version of the referent.
string

.spec .controlPlaneRef .fieldPath

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
string

.spec .controlPlaneRef .kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
string

.spec .controlPlaneRef .name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
string

.spec .controlPlaneRef .namespace

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
string

.spec .controlPlaneRef .resourceVersion

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
string

.spec .controlPlaneRef .uid

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
object

.spec .infrastructureRef

infrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider.
string

.spec .infrastructureRef .apiVersion

API version of the referent.
string

.spec .infrastructureRef .fieldPath

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
string

.spec .infrastructureRef .kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
string

.spec .infrastructureRef .name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
string

.spec .infrastructureRef .namespace

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
string

.spec .infrastructureRef .resourceVersion

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
string

.spec .infrastructureRef .uid

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
boolean

.spec .paused

paused can be used to prevent controllers from processing the Cluster and all its associated objects.
object

.spec .topology

topology encapsulates the topology for the cluster. NOTE: It is required to enable the ClusterTopology feature gate flag to activate managed topologies support; this feature is highly experimental, and parts of it might still be not implemented.
string required

.spec .topology .class

class is the name of the ClusterClass object to create the topology.
object

.spec .topology .controlPlane

controlPlane describes the cluster control plane.
object

.spec .topology .controlPlane .metadata

metadata is the metadata applied to the machines of the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.

This field is supported if and only if the control plane provider template referenced in the ClusterClass is Machine based.
object

.spec .topology .controlPlane .metadata .annotations

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
object

.spec .topology .controlPlane .metadata .labels

labels is a 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
integer

.spec .topology .controlPlane .replicas

replicas is the number of control plane nodes. If the value is nil, the ControlPlane object is created without the number of Replicas and it’s assumed that the control plane controller does not implement support for this field. When specified against a control plane provider that lacks support for this field, this value will be ignored.
string

.spec .topology .rolloutAfter

rolloutAfter performs a rollout of the entire cluster one component at a time, control plane first and then machine deployments.
string required

.spec .topology .version

version is the Kubernetes version of the cluster.
object

.spec .topology .workers

workers encapsulates the different constructs that form the worker nodes for the cluster.
array

.spec .topology .workers .machineDeployments

machineDeployments is a list of machine deployments in the cluster.
string required

.spec .topology .workers .machineDeployments[] .class

class is the name of the MachineDeploymentClass used to create the set of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the Cluster.Spec.Class field.
object

.spec .topology .workers .machineDeployments[] .metadata

metadata is the metadata applied to the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.
object

.spec .topology .workers .machineDeployments[] .metadata .annotations

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
object

.spec .topology .workers .machineDeployments[] .metadata .labels

labels is a 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
string required

.spec .topology .workers .machineDeployments[] .name

name is the unique identifier for this MachineDeploymentTopology. The value is used with other unique identifiers to create a MachineDeployment’s Name (e.g. cluster’s name, etc). In case the name is greater than the allowed maximum length, the values are hashed together.
integer

.spec .topology .workers .machineDeployments[] .replicas

replicas is the number of worker nodes belonging to this set. If the value is nil, the MachineDeployment is created without the number of Replicas (defaulting to zero) and it’s assumed that an external entity (like cluster autoscaler) is responsible for the management of this value.
object

.status

status is the observed state of Cluster.
array

.status .conditions

conditions defines current service state of the cluster.
string

.status .conditions[] .lastTransitionTime

lastTransitionTime is the 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.
string

.status .conditions[] .message

message is a human readable message indicating details about the transition. This field may be empty.
string

.status .conditions[] .reason

reason is 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.
string

.status .conditions[] .severity

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.
string required

.status .conditions[] .status

status of the condition, one of True, False, Unknown.
string required

.status .conditions[] .type

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.
boolean

.status .controlPlaneReady

controlPlaneReady defines if the control plane is ready.
object

.status .failureDomains

failureDomains is a slice of failure domain objects synced from the infrastructure provider.
string

.status .failureMessage

failureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message.
string

.status .failureReason

failureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation.
boolean

.status .infrastructureReady

infrastructureReady is the state of the infrastructure provider.
integer

.status .observedGeneration

observedGeneration is the latest generation observed by the controller.
string

.status .phase

phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.