Cluster is the Schema for the clusters API.
5 top-level fields · last changed in Cluster API v1.10.0
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 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
spec is the desired state of Cluster.
clusterNetwork is the cluster network configuration.
apiServerPort specifies the port the API Server should bind to. Defaults to 6443.
pods is the network ranges from which Pod networks are allocated.
cidrBlocks is a list of CIDR blocks.
serviceDomain is the domain name for services.
services is the network ranges from which service VIPs are allocated.
cidrBlocks is a list of CIDR blocks.
controlPlaneEndpoint represents the endpoint used to communicate with the control plane.
host is the hostname on which the API server is serving.
port is the port on which the API server is serving.
controlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster.
API version of the referent.
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.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
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
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
infrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider.
API version of the referent.
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.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
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
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
paused can be used to prevent controllers from processing the Cluster and all its associated objects.
status is the observed state of Cluster.
conditions defines current service state of the cluster.
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.
message is a human readable message indicating details about the transition. This field may be empty.
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.
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 of the condition, one of True, False, Unknown.
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.
controlPlaneInitialized defines if the control plane has been initialized.
controlPlaneReady defines if the control plane is ready.
failureDomains is a slice of failure domain objects synced from the infrastructure provider.
attributes is a free form map of attributes an infrastructure provider might use or require.
controlPlane determines if this failure domain is suitable for use by control plane machines.
failureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message.
failureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation.
infrastructureReady is the state of the infrastructure provider.
observedGeneration is the latest generation observed by the controller.
phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
Source: cluster.x-k8s.io_clusters.yaml
Changes to Cluster (cluster.x-k8s.io/v1alpha3) in each Cluster API version, compared to the version before it.
13 properties have changed the description
Released · View Cluster in v1.10.0
21 properties have changed the description
Released · View Cluster in v1.9.0
25 properties have changed the description
Released · View Cluster in v1.7.0
The description of Cluster has changed
2 properties have changed the description
Released · View Cluster in v0.4.0
2 properties have been added
Released · View Cluster in v0.3.7
Cluster was first seen on this version of Cluster API
Released · View Cluster in v0.3.0
No examples of Cluster yet. Contribute one on GitHub.
kubespec.dev