Last generated March 23, 2022

Cluster

Cluster is the Schema for the clusters API.

Full name:
clusters.cluster.x-k8s.io
Group:
cluster.x-k8s.io
Singular name:
cluster
Plural name:
clusters
Scope:
Namespaced
Versions:
v1alpha3v1alpha4v1beta1

Version v1alpha3

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

ClusterSpec defines the desired state of Cluster.

.spec.clusterNetwork

object

Cluster network configuration.

.spec.clusterNetwork.apiServerPort

integer

APIServerPort specifies the port the API Server should bind to. Defaults to 6443.

.spec.clusterNetwork.pods

object

The network ranges from which Pod networks are allocated.

.spec.clusterNetwork.pods.cidrBlocks

array Required

.spec.clusterNetwork.pods.cidrBlocks[*]

string

.spec.clusterNetwork.serviceDomain

string

Domain name for services.

.spec.clusterNetwork.services

object

The network ranges from which service VIPs are allocated.

.spec.clusterNetwork.services.cidrBlocks

array Required

.spec.clusterNetwork.services.cidrBlocks[*]

string

.spec.controlPlaneEndpoint

object

ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

.spec.controlPlaneEndpoint.host

string Required

The hostname on which the API server is serving.

.spec.controlPlaneEndpoint.port

integer Required

The port on which the API server is serving.

.spec.controlPlaneRef

object

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

.spec.controlPlaneRef.apiVersion

string

API version of the referent.

.spec.controlPlaneRef.fieldPath

string

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. TODO: this design is not final and this field is subject to change in the future.

.spec.controlPlaneRef.kind

.spec.controlPlaneRef.name

.spec.controlPlaneRef.namespace

.spec.controlPlaneRef.resourceVersion

string

.spec.controlPlaneRef.uid

.spec.infrastructureRef

object

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

.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.infrastructureRef.fieldPath

string

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. TODO: this design is not final and this field is subject to change in the future.

.spec.infrastructureRef.kind

.spec.infrastructureRef.name

.spec.infrastructureRef.namespace

.spec.infrastructureRef.resourceVersion

string

.spec.infrastructureRef.uid

.spec.paused

boolean

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

.status

object

ClusterStatus defines the observed state of Cluster.

.status.conditions

array

Conditions defines current service state of the cluster.

.status.conditions[*]

object

Condition defines an observation of a Cluster API resource operational state.

.status.conditions[*].lastTransitionTime

string

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

boolean

ControlPlaneInitialized defines if the control plane has been initialized.

.status.controlPlaneReady

boolean

ControlPlaneReady defines if the control plane is ready.

.status.failureDomains

object

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

.status.failureMessage

string

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

.status.failureReason

string

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

.status.infrastructureReady

boolean

InfrastructureReady is the state of the infrastructure provider.

.status.observedGeneration

integer

ObservedGeneration is the latest generation observed by the controller.

.status.phase

string

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

Annotations

alpha.giantswarm.io/update-schedule-target-release

This annotation is used to define the desired target release for a scheduled upgrade of the cluster. The upgrade to the specified version will be applied if the “update-schedule-target-time” annotation has been set and the time defined there has been reached. The value has to be only the desired release version, e.g “15.2.1”.

alpha.giantswarm.io/update-schedule-target-time

This annotation is used to define the desired target time for a scheduled upgrade of the cluster. The upgrade will be applied at the specified time if the “update-schedule-target-release” annotation has been set to the target release version. The value has to be in RFC822 Format and UTC time zone. e.g. “30 Jan 21 15:04 UTC”

Version v1alpha4

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

ClusterSpec defines the desired state of Cluster.

.spec.clusterNetwork

object

Cluster network configuration.

.spec.clusterNetwork.apiServerPort

integer

APIServerPort specifies the port the API Server should bind to. Defaults to 6443.

.spec.clusterNetwork.pods

object

The network ranges from which Pod networks are allocated.

.spec.clusterNetwork.pods.cidrBlocks

array Required

.spec.clusterNetwork.pods.cidrBlocks[*]

string

.spec.clusterNetwork.serviceDomain

string

Domain name for services.

.spec.clusterNetwork.services

object

The network ranges from which service VIPs are allocated.

.spec.clusterNetwork.services.cidrBlocks

array Required

.spec.clusterNetwork.services.cidrBlocks[*]

string

.spec.controlPlaneEndpoint

object

ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

.spec.controlPlaneEndpoint.host

string Required

The hostname on which the API server is serving.

.spec.controlPlaneEndpoint.port

integer Required

The port on which the API server is serving.

.spec.controlPlaneRef

object

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

.spec.controlPlaneRef.apiVersion

string

API version of the referent.

.spec.controlPlaneRef.fieldPath

string

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. TODO: this design is not final and this field is subject to change in the future.

.spec.controlPlaneRef.kind

.spec.controlPlaneRef.name

.spec.controlPlaneRef.namespace

.spec.controlPlaneRef.resourceVersion

string

.spec.controlPlaneRef.uid

.spec.infrastructureRef

object

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

.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.infrastructureRef.fieldPath

string

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. TODO: this design is not final and this field is subject to change in the future.

.spec.infrastructureRef.kind

.spec.infrastructureRef.name

.spec.infrastructureRef.namespace

.spec.infrastructureRef.resourceVersion

string

.spec.infrastructureRef.uid

.spec.paused

boolean

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

.spec.topology

object

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

.spec.topology.class

string Required

The name of the ClusterClass object to create the topology.

.spec.topology.controlPlane

object

ControlPlane describes the cluster control plane.

.spec.topology.controlPlane.metadata

object

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.

.spec.topology.controlPlane.metadata.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

.spec.topology.controlPlane.metadata.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

.spec.topology.controlPlane.replicas

integer

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.

.spec.topology.rolloutAfter

string

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

.spec.topology.version

string Required

The Kubernetes version of the cluster.

.spec.topology.workers

object

Workers encapsulates the different constructs that form the worker nodes for the cluster.

.spec.topology.workers.machineDeployments

array

MachineDeployments is a list of machine deployments in the cluster.

.spec.topology.workers.machineDeployments[*]

object

MachineDeploymentTopology specifies the different parameters for a set of worker nodes in the topology. This set of nodes is managed by a MachineDeployment object whose lifecycle is managed by the Cluster controller.

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

string Required

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.

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

object

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

.spec.topology.workers.machineDeployments[*].metadata.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

.spec.topology.workers.machineDeployments[*].metadata.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

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

string Required

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.

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

integer

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.

.status

object

ClusterStatus defines the observed state of Cluster.

.status.conditions

array

Conditions defines current service state of the cluster.

.status.conditions[*]

object

Condition defines an observation of a Cluster API resource operational state.

.status.conditions[*].lastTransitionTime

string

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

boolean

ControlPlaneReady defines if the control plane is ready.

.status.failureDomains

object

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

.status.failureMessage

string

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

.status.failureReason

string

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

.status.infrastructureReady

boolean

InfrastructureReady is the state of the infrastructure provider.

.status.observedGeneration

integer

ObservedGeneration is the latest generation observed by the controller.

.status.phase

string

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

Version v1beta1

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

ClusterSpec defines the desired state of Cluster.

.spec.clusterNetwork

object

Cluster network configuration.

.spec.clusterNetwork.apiServerPort

integer

APIServerPort specifies the port the API Server should bind to. Defaults to 6443.

.spec.clusterNetwork.pods

object

The network ranges from which Pod networks are allocated.

.spec.clusterNetwork.pods.cidrBlocks

array Required

.spec.clusterNetwork.pods.cidrBlocks[*]

string

.spec.clusterNetwork.serviceDomain

string

Domain name for services.

.spec.clusterNetwork.services

object

The network ranges from which service VIPs are allocated.

.spec.clusterNetwork.services.cidrBlocks

array Required

.spec.clusterNetwork.services.cidrBlocks[*]

string

.spec.controlPlaneEndpoint

object

ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

.spec.controlPlaneEndpoint.host

string Required

The hostname on which the API server is serving.

.spec.controlPlaneEndpoint.port

integer Required

The port on which the API server is serving.

.spec.controlPlaneRef

object

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

.spec.controlPlaneRef.apiVersion

string

API version of the referent.

.spec.controlPlaneRef.fieldPath

string

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. TODO: this design is not final and this field is subject to change in the future.

.spec.controlPlaneRef.kind

.spec.controlPlaneRef.name

.spec.controlPlaneRef.namespace

.spec.controlPlaneRef.resourceVersion

string

.spec.controlPlaneRef.uid

.spec.infrastructureRef

object

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

.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.infrastructureRef.fieldPath

string

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. TODO: this design is not final and this field is subject to change in the future.

.spec.infrastructureRef.kind

.spec.infrastructureRef.name

.spec.infrastructureRef.namespace

.spec.infrastructureRef.resourceVersion

string

.spec.infrastructureRef.uid

.spec.paused

boolean

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

.spec.topology

object

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

.spec.topology.class

string Required

The name of the ClusterClass object to create the topology.

.spec.topology.controlPlane

object

ControlPlane describes the cluster control plane.

.spec.topology.controlPlane.metadata

object

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.

.spec.topology.controlPlane.metadata.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

.spec.topology.controlPlane.metadata.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

.spec.topology.controlPlane.replicas

integer

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.

.spec.topology.rolloutAfter

string

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

.spec.topology.version

string Required

The Kubernetes version of the cluster.

.spec.topology.workers

object

Workers encapsulates the different constructs that form the worker nodes for the cluster.

.spec.topology.workers.machineDeployments

array

MachineDeployments is a list of machine deployments in the cluster.

.spec.topology.workers.machineDeployments[*]

object

MachineDeploymentTopology specifies the different parameters for a set of worker nodes in the topology. This set of nodes is managed by a MachineDeployment object whose lifecycle is managed by the Cluster controller.

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

string Required

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.

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

object

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

.spec.topology.workers.machineDeployments[*].metadata.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

.spec.topology.workers.machineDeployments[*].metadata.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

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

string Required

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.

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

integer

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.

.status

object

ClusterStatus defines the observed state of Cluster.

.status.conditions

array

Conditions defines current service state of the cluster.

.status.conditions[*]

object

Condition defines an observation of a Cluster API resource 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.controlPlaneReady

boolean

ControlPlaneReady defines if the control plane is ready.

.status.failureDomains

object

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

.status.failureMessage

string

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

.status.failureReason

string

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

.status.infrastructureReady

boolean

InfrastructureReady is the state of the infrastructure provider.

.status.observedGeneration

integer

ObservedGeneration is the latest generation observed by the controller.

.status.phase

string

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


This documentation page shows information based on apiextensions v5.0.0.