API Reference

host string

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

MaxLength: 512

port integer

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

configRef ObjectReference

configRef is a reference to a bootstrap provider-specific resource
that holds configuration details. The reference is optional to
allow users/operators to specify Bootstrap.DataSecretName without
the need of a controller.

dataSecretName string

dataSecretName is the name of the secret that stores the bootstrap data script.
If nil, the Machine should remain in the Pending state.

MaxLength: 253
MinLength: 0

apiVersion string

cluster.x-k8s.io/v1beta1

kind string

Cluster

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ClusterSpec

spec is the desired state of Cluster.

status ClusterStatus

status is the observed state of Cluster.

conditionType string

conditionType refers to a condition with matching type in the Cluster’s condition list.
If the conditions doesn’t exist, it will be treated as unknown.
Note: Both Cluster API conditions or conditions added by 3rd party controllers can be used as availability gates.

MaxLength: 316
MinLength: 1
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

polarity ConditionPolarity

polarity of the conditionType specified in this availabilityGate.
Valid values are Positive, Negative and omitted.
When omitted, the default behaviour will be Positive.
A positive polarity means that the condition should report a true status under normal conditions.
A negative polarity means that the condition should report a false status under normal conditions.

Enum: [Positive Negative]

apiVersion string

cluster.x-k8s.io/v1beta1

kind string

ClusterClass

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ClusterClassSpec

spec is the desired state of ClusterClass.

status ClusterClassStatus

status is the observed state of ClusterClass.

name string

name of the patch.

MaxLength: 256
MinLength: 1

description string

description is a human-readable description of this patch.

MaxLength: 1024
MinLength: 1

enabledIf string

enabledIf is a Go template to be used to calculate if a patch should be enabled.
It can reference variables defined in .spec.variables and builtin variables.
The patch will be enabled if the template evaluates to true, otherwise it will
be disabled.
If EnabledIf is not set, the patch will be enabled per default.

MaxLength: 256
MinLength: 1

definitions PatchDefinition array

definitions define inline patches.
Note: Patches will be applied in the order of the array.
Note: Exactly one of Definitions or External must be set.

MaxItems: 100

external ExternalPatchDefinition

external defines an external patch.
Note: Exactly one of Definitions or External must be set.

availabilityGates ClusterAvailabilityGate array

availabilityGates specifies additional conditions to include when evaluating Cluster Available condition.

MaxItems: 32

infrastructure LocalObjectTemplate

infrastructure is a reference to a provider-specific template that holds
the details for provisioning infrastructure specific cluster
for the underlying provider.
The underlying provider is responsible for the implementation
of the template to an infrastructure cluster.

infrastructureNamingStrategy InfrastructureNamingStrategy

infrastructureNamingStrategy allows changing the naming pattern used when creating the infrastructure object.

controlPlane ControlPlaneClass

controlPlane is a reference to a local struct that holds the details
for provisioning the Control Plane for the Cluster.

workers WorkersClass

workers describes the worker nodes for the cluster.
It is a collection of node types which can be used to create
the worker nodes of the cluster.

variables ClusterClassVariable array

variables defines the variables which can be configured
in the Cluster topology and are then used in patches.

MaxItems: 1000

patches ClusterClassPatch array

patches defines the patches which are applied to customize
referenced templates of a ClusterClass.
Note: Patches will be applied in the order of the array.

MaxItems: 1000

variables ClusterClassStatusVariable array

variables is a list of ClusterClassStatusVariable that are defined for the ClusterClass.

MaxItems: 1000

conditions Conditions

conditions defines current observed state of the ClusterClass.

observedGeneration integer

observedGeneration is the latest generation observed by the controller.

v1beta2 ClusterClassV1Beta2Status

v1beta2 groups all the fields that will be added or modified in ClusterClass’s status with the V1Beta2 version.

name string

name is the name of the variable.

MaxLength: 256
MinLength: 1

definitionsConflict boolean

definitionsConflict specifies whether or not there are conflicting definitions for a single variable name.

definitions ClusterClassStatusVariableDefinition array

definitions is a list of definitions for a variable.

MaxItems: 100

from string

from specifies the origin of the variable definition.
This will be inline for variables defined in the ClusterClass or the name of a patch defined in the ClusterClass
for variables discovered from a DiscoverVariables runtime extensions.

MaxLength: 256
MinLength: 1

required boolean

required specifies if the variable is required.
Note: this applies to the variable as a whole and thus the
top-level object defined in the schema. If nested fields are
required, this will be specified inside the schema.

metadata ClusterClassVariableMetadata

Refer to Kubernetes API documentation for fields of metadata.

schema VariableSchema

schema defines the schema of the variable.

conditions Condition array

conditions represents the observations of a ClusterClass’s current state.
Known condition types are VariablesReady, RefVersionsUpToDate, Paused.

MaxItems: 32

name string

name of the variable.

MaxLength: 256
MinLength: 1

required boolean

required specifies if the variable is required.
Note: this applies to the variable as a whole and thus the
top-level object defined in the schema. If nested fields are
required, this will be specified inside the schema.

metadata ClusterClassVariableMetadata

Refer to Kubernetes API documentation for fields of metadata.

schema VariableSchema

schema defines the schema of the variable.

labels object (keys:string, values:string)

labels is a map of string keys and values that can be used to organize and categorize
(scope and select) variables.

annotations object (keys:string, values:string)

annotations is an unstructured key value map that can be used to store and
retrieve arbitrary metadata.
They are not queryable.

desiredReplicas integer

desiredReplicas is the total number of desired control plane machines in this cluster.

replicas integer

replicas is the total number of control plane machines in this cluster.
NOTE: replicas also includes machines still being provisioned or being deleted.

upToDateReplicas integer

upToDateReplicas is the number of up-to-date control plane machines in this cluster. A machine is considered up-to-date when Machine’s UpToDate condition is true.

readyReplicas integer

readyReplicas is the total number of ready control plane machines in this cluster. A machine is considered ready when Machine’s Ready condition is true.

availableReplicas integer

availableReplicas is the total number of available control plane machines in this cluster. A machine is considered available when Machine’s Available condition is true.

apiServerPort integer

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

services NetworkRanges

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

pods NetworkRanges

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

serviceDomain string

serviceDomain is the domain name for services.

MaxLength: 253
MinLength: 1

paused boolean

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

clusterNetwork ClusterNetwork

clusterNetwork represents the cluster network configuration.

controlPlaneEndpoint APIEndpoint

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

controlPlaneRef ObjectReference

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

infrastructureRef ObjectReference

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

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

availabilityGates ClusterAvailabilityGate array

availabilityGates specifies additional conditions to include when evaluating Cluster Available condition.

If this field is not defined and the Cluster implements a managed topology, availabilityGates
from the corresponding ClusterClass will be used, if any.

MaxItems: 32

failureDomains FailureDomains

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

failureReason ClusterStatusError

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

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.

failureMessage string

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

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.

MaxLength: 10240
MinLength: 1

phase string

phase represents the current phase of cluster actuation.

Enum: [Pending Provisioning Provisioned Deleting Failed Unknown]

infrastructureReady boolean

infrastructureReady is the state of the infrastructure provider.

controlPlaneReady boolean

controlPlaneReady denotes if the control plane became ready during initial provisioning
to receive requests.
NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning.
The value of this field is never updated after provisioning is completed. Please use conditions
to check the operational state of the control plane.

conditions Conditions

conditions defines current service state of the cluster.

observedGeneration integer

observedGeneration is the latest generation observed by the controller.

v1beta2 ClusterV1Beta2Status

v1beta2 groups all the fields that will be added or modified in Cluster’s status with the V1Beta2 version.

conditions Condition array

conditions represents the observations of a Cluster’s current state.
Known condition types are Available, InfrastructureReady, ControlPlaneInitialized, ControlPlaneAvailable, WorkersAvailable, MachinesReady
MachinesUpToDate, RemoteConnectionProbe, ScalingUp, ScalingDown, Remediating, Deleting, Paused.
Additionally, a TopologyReconciled condition will be added in case the Cluster is referencing a ClusterClass / defining a managed Topology.

MaxItems: 32

controlPlane ClusterControlPlaneStatus

controlPlane groups all the observations about Cluster’s ControlPlane current state.

workers WorkersStatus

workers groups all the observations about Cluster’s Workers current state.

name string

name of the variable.

MaxLength: 256
MinLength: 1

definitionFrom string

definitionFrom specifies where the definition of this Variable is from.

Deprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion.

MaxLength: 256

value JSON

value of the variable.
Note: the value will be validated against the schema of the corresponding ClusterClassVariable
from the ClusterClass.
Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a
hard-coded schema for apiextensionsv1.JSON which cannot be produced by another type via controller-tools,
i.e. it is not possible to have no type field.
Ref: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111

type ConditionType

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.

MaxLength: 256
MinLength: 1

status ConditionStatus

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

severity ConditionSeverity

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.

MaxLength: 32

lastTransitionTime Time

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.

reason string

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 be empty.

MaxLength: 256
MinLength: 1

message string

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

MaxLength: 10240
MinLength: 1

type ConditionType

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.

MaxLength: 256
MinLength: 1

status ConditionStatus

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

severity ConditionSeverity

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.

MaxLength: 32

lastTransitionTime Time

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.

reason string

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 be empty.

MaxLength: 256
MinLength: 1

message string

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

MaxLength: 10240
MinLength: 1

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ref ObjectReference

ref is a required reference to a custom resource
offered by a provider.

machineInfrastructure LocalObjectTemplate

machineInfrastructure defines the metadata and infrastructure information
for control plane machines.

This field is supported if and only if the control plane provider template
referenced above is Machine based and supports setting replicas.

machineHealthCheck MachineHealthCheckClass

machineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass.
This field is supported if and only if the ControlPlane provider template
referenced above is Machine based and supports setting replicas.

namingStrategy ControlPlaneClassNamingStrategy

namingStrategy allows changing the naming pattern used when creating the control plane provider object.

nodeDrainTimeout Duration

nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.
The default value is 0, meaning that the node can be drained without any time limitations.
NOTE: NodeDrainTimeout is different from kubectl drain --timeout
NOTE: This value can be overridden while defining a Cluster.Topology.

nodeVolumeDetachTimeout Duration

nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes
to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.
NOTE: This value can be overridden while defining a Cluster.Topology.

nodeDeletionTimeout Duration

nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine
hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.
Defaults to 10 seconds.
NOTE: This value can be overridden while defining a Cluster.Topology.

readinessGates MachineReadinessGate array

readinessGates specifies additional conditions to include when evaluating Machine Ready condition.

This field can be used e.g. to instruct the machine controller to include in the computation for Machine’s ready
computation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.

MaxItems: 32

template string

template defines the template to use for generating the name of the ControlPlane object.
If not defined, it will fallback to {{ .cluster.name }}-{{ .random }}.
If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will
get concatenated with a random suffix of length 5.
The templating mechanism provides the following arguments:
* .cluster.name: The name of the cluster object.
* .random: A random alphanumeric string, without vowels, of length 5.

MaxLength: 1024
MinLength: 1

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

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.

machineHealthCheck MachineHealthCheckTopology

machineHealthCheck allows to enable, disable and override
the MachineHealthCheck configuration in the ClusterClass for this control plane.

nodeDrainTimeout Duration

nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.
The default value is 0, meaning that the node can be drained without any time limitations.
NOTE: NodeDrainTimeout is different from kubectl drain --timeout

nodeVolumeDetachTimeout Duration

nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes
to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.

nodeDeletionTimeout Duration

nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine
hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.
Defaults to 10 seconds.

readinessGates MachineReadinessGate array

readinessGates specifies additional conditions to include when evaluating Machine Ready condition.

This field can be used e.g. to instruct the machine controller to include in the computation for Machine’s ready
computation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.

If this field is not defined, readinessGates from the corresponding ControlPlaneClass will be used, if any.

MaxItems: 32

variables ControlPlaneVariables

variables can be used to customize the ControlPlane through patches.

overrides ClusterVariable array

overrides can be used to override Cluster level variables.

MaxItems: 1000

generateExtension string

generateExtension references an extension which is called to generate patches.

MaxLength: 512
MinLength: 1

validateExtension string

validateExtension references an extension which is called to validate the topology.

MaxLength: 512
MinLength: 1

discoverVariablesExtension string

discoverVariablesExtension references an extension which is called to discover variables.

MaxLength: 512
MinLength: 1

settings object (keys:string, values:string)

settings defines key value pairs to be passed to the extensions.
Values defined here take precedence over the values defined in the
corresponding ExtensionConfig.

controlPlane boolean

controlPlane determines if this failure domain is suitable for use by control plane machines.

attributes object (keys:string, values:string)

attributes is a free form map of attributes an infrastructure provider might use or require.

template string

template defines the template to use for generating the name of the Infrastructure object.
If not defined, it will fallback to {{ .cluster.name }}-{{ .random }}.
If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will
get concatenated with a random suffix of length 5.
The templating mechanism provides the following arguments:
* .cluster.name: The name of the cluster object.
* .random: A random alphanumeric string, without vowels, of length 5.

MaxLength: 1024
MinLength: 1

op string

op defines the operation of the patch.
Note: Only add, replace and remove are supported.

Enum: [add replace remove]

path string

path defines the path of the patch.
Note: Only the spec of a template can be patched, thus the path has to start with /spec/.
Note: For now the only allowed array modifications are append and prepend, i.e.:
* for op: add: only index 0 (prepend) and - (append) are allowed
* for op: replace or remove: no indexes are allowed

MaxLength: 512
MinLength: 1

value JSON

value defines the value of the patch.
Note: Either Value or ValueFrom is required for add and replace
operations. Only one of them is allowed to be set at the same time.
Note: We have to use apiextensionsv1.JSON instead of our JSON type,
because controller-tools has a hard-coded schema for apiextensionsv1.JSON
which cannot be produced by another type (unset type field).
Ref: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111

valueFrom JSONPatchValue

valueFrom defines the value of the patch.
Note: Either Value or ValueFrom is required for add and replace
operations. Only one of them is allowed to be set at the same time.

variable string

variable is the variable to be used as value.
Variable can be one of the variables defined in .spec.variables or a builtin variable.

MaxLength: 256
MinLength: 1

template string

template is the Go template to be used to calculate the value.
A template can reference variables defined in .spec.variables and builtin variables.
Note: The template must evaluate to a valid YAML or JSON value.

MaxLength: 10240
MinLength: 1

description string

description is a human-readable description of this variable.

MaxLength: 4096
MinLength: 1

example JSON

example is an example for this variable.

type string

type is the type of the variable.
Valid values are: object, array, string, integer, number or boolean.

Enum: [object array string integer number boolean]

properties object (keys:string, values:JSONSchemaProps)

properties specifies fields of an object.
NOTE: Can only be set if type is object.
NOTE: Properties is mutually exclusive with AdditionalProperties.
NOTE: This field uses PreserveUnknownFields and Schemaless,
because recursive validation is not possible.

Schemaless: \{}

additionalProperties JSONSchemaProps

additionalProperties specifies the schema of values in a map (keys are always strings).
NOTE: Can only be set if type is object.
NOTE: AdditionalProperties is mutually exclusive with Properties.
NOTE: This field uses PreserveUnknownFields and Schemaless,
because recursive validation is not possible.

Schemaless: \{}

maxProperties integer

maxProperties is the maximum amount of entries in a map or properties in an object.
NOTE: Can only be set if type is object.

minProperties integer

minProperties is the minimum amount of entries in a map or properties in an object.
NOTE: Can only be set if type is object.

required string array

required specifies which fields of an object are required.
NOTE: Can only be set if type is object.

MaxItems: 1000
items:MaxLength: 256
items:MinLength: 1

items JSONSchemaProps

items specifies fields of an array.
NOTE: Can only be set if type is array.
NOTE: This field uses PreserveUnknownFields and Schemaless,
because recursive validation is not possible.

Schemaless: \{}

maxItems integer

maxItems is the max length of an array variable.
NOTE: Can only be set if type is array.

minItems integer

minItems is the min length of an array variable.
NOTE: Can only be set if type is array.

uniqueItems boolean

uniqueItems specifies if items in an array must be unique.
NOTE: Can only be set if type is array.

format string

format is an OpenAPI v3 format string. Unknown formats are ignored.
For a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we’re currently using)
https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go
NOTE: Can only be set if type is string.

MaxLength: 32
MinLength: 1

maxLength integer

maxLength is the max length of a string variable.
NOTE: Can only be set if type is string.

minLength integer

minLength is the min length of a string variable.
NOTE: Can only be set if type is string.

pattern string

pattern is the regex which a string variable must match.
NOTE: Can only be set if type is string.

MaxLength: 512
MinLength: 1

maximum integer

maximum is the maximum of an integer or number variable.
If ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum.
If ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum.
NOTE: Can only be set if type is integer or number.

exclusiveMaximum boolean

exclusiveMaximum specifies if the Maximum is exclusive.
NOTE: Can only be set if type is integer or number.

minimum integer

minimum is the minimum of an integer or number variable.
If ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum.
If ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum.
NOTE: Can only be set if type is integer or number.

exclusiveMinimum boolean

exclusiveMinimum specifies if the Minimum is exclusive.
NOTE: Can only be set if type is integer or number.

x-kubernetes-preserve-unknown-fields boolean

x-kubernetes-preserve-unknown-fields allows setting fields in a variable object
which are not defined in the variable schema. This affects fields recursively,
except if nested properties or additionalProperties are specified in the schema.

enum JSON array

enum is the list of valid values of the variable.
NOTE: Can be set for all types.

MaxItems: 100

default JSON

default is the default value of the variable.
NOTE: Can be set for all types.

x-kubernetes-validations ValidationRule array

x-kubernetes-validations describes a list of validation rules written in the CEL expression language.

MaxItems: 100

x-metadata VariableSchemaMetadata

x-metadata is the metadata of a variable or a nested field within a variable.
It can be used to add additional data for higher level tools.

x-kubernetes-int-or-string boolean

x-kubernetes-int-or-string specifies that this value is
either an integer or a string. If this is true, an empty
type is allowed and type as child of anyOf is permitted
if following one of the following patterns:

1) anyOf:
- type: integer
- type: string
2) allOf:
- anyOf:
- type: integer
- type: string
- …​ zero or more

allOf JSONSchemaProps array

allOf specifies that the variable must validate against all of the subschemas in the array.
NOTE: This field uses PreserveUnknownFields and Schemaless,
because recursive validation is not possible.

Schemaless: \{}

oneOf JSONSchemaProps array

oneOf specifies that the variable must validate against exactly one of the subschemas in the array.
NOTE: This field uses PreserveUnknownFields and Schemaless,
because recursive validation is not possible.

Schemaless: \{}

anyOf JSONSchemaProps array

anyOf specifies that the variable must validate against one or more of the subschemas in the array.
NOTE: This field uses PreserveUnknownFields and Schemaless,
because recursive validation is not possible.

Schemaless: \{}

not JSONSchemaProps

not specifies that the variable must not validate against the subschema.
NOTE: This field uses PreserveUnknownFields and Schemaless,
because recursive validation is not possible.

Schemaless: \{}

ref ObjectReference

ref is a required reference to a custom resource
offered by a provider.

apiVersion string

cluster.x-k8s.io/v1beta1

kind string

Machine

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec MachineSpec

spec is the desired state of Machine.

status MachineStatus

status is the observed state of Machine.

type MachineAddressType

type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.

Enum: [Hostname ExternalIP InternalIP ExternalDNS InternalDNS]

address string

address is the machine address.

MaxLength: 256
MinLength: 1

type MachineAddressType

type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.

Enum: [Hostname ExternalIP InternalIP ExternalDNS InternalDNS]

address string

address is the machine address.

MaxLength: 256
MinLength: 1

nodeDrainStartTime Time

nodeDrainStartTime is the time when the drain of the node started and is used to determine
if the NodeDrainTimeout is exceeded.
Only present when the Machine has a deletionTimestamp and draining the node had been started.

waitForNodeVolumeDetachStartTime Time

waitForNodeVolumeDetachStartTime is the time when waiting for volume detachment started
and is used to determine if the NodeVolumeDetachTimeout is exceeded.
Detaching volumes from nodes is usually done by CSI implementations and the current state
is observed from the node’s .Status.VolumesAttached field.
Only present when the Machine has a deletionTimestamp and waiting for volume detachments had been started.

apiVersion string

cluster.x-k8s.io/v1beta1

kind string

MachineDeployment

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec MachineDeploymentSpec

spec is the desired state of MachineDeployment.

status MachineDeploymentStatus

status is the observed state of MachineDeployment.

class string

class denotes a type of worker node present in the cluster,
this name MUST be unique within a ClusterClass and can be referenced
in the Cluster to create a managed MachineDeployment.

MaxLength: 256
MinLength: 1

template MachineDeploymentClassTemplate

template is a local struct containing a collection of templates for creation of
MachineDeployment objects representing a set of worker nodes.

machineHealthCheck MachineHealthCheckClass

machineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass.

failureDomain string

failureDomain is the failure domain the machines will be created in.
Must match a key in the FailureDomains map stored on the cluster object.
NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.

MaxLength: 256
MinLength: 1

namingStrategy MachineDeploymentClassNamingStrategy

namingStrategy allows changing the naming pattern used when creating the MachineDeployment.

nodeDrainTimeout Duration

nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.
The default value is 0, meaning that the node can be drained without any time limitations.
NOTE: NodeDrainTimeout is different from kubectl drain --timeout
NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.

nodeVolumeDetachTimeout Duration

nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes
to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.
NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.

nodeDeletionTimeout Duration

nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine
hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.
Defaults to 10 seconds.
NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.

minReadySeconds integer

minReadySeconds is the minimum number of seconds for which a newly created machine should
be ready.
Defaults to 0 (machine will be considered available as soon as it
is ready)
NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.

readinessGates MachineReadinessGate array

readinessGates specifies additional conditions to include when evaluating Machine Ready condition.

This field can be used e.g. to instruct the machine controller to include in the computation for Machine’s ready
computation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.

MaxItems: 32

strategy MachineDeploymentStrategy

strategy is the deployment strategy to use to replace existing machines with
new ones.
NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.

template string

template defines the template to use for generating the name of the MachineDeployment object.
If not defined, it will fallback to {{ .cluster.name }}-{{ .machineDeployment.topologyName }}-{{ .random }}.
If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will
get concatenated with a random suffix of length 5.
The templating mechanism provides the following arguments:
* .cluster.name: The name of the cluster object.
* .random: A random alphanumeric string, without vowels, of length 5.
* .machineDeployment.topologyName: The name of the MachineDeployment topology (Cluster.spec.topology.workers.machineDeployments[].name).

MaxLength: 1024
MinLength: 1

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

bootstrap LocalObjectTemplate

bootstrap contains the bootstrap template reference to be used
for the creation of worker Machines.

infrastructure LocalObjectTemplate

infrastructure contains the infrastructure template reference to be used
for the creation of worker Machines.

clusterName string

clusterName is the name of the Cluster this object belongs to.

MaxLength: 63
MinLength: 1

replicas integer

replicas is the number of desired machines.
This is a pointer to distinguish between explicit zero and not specified.

Defaults to:
* if the Kubernetes autoscaler min size and max size annotations are set:
- if it’s a new MachineDeployment, use min size
- if the replicas field of the old MachineDeployment is < min size, use min size
- if the replicas field of the old MachineDeployment is > max size, use max size
- if the replicas field of the old MachineDeployment is in the (min size, max size) range, keep the value from the oldMD
* otherwise use 1
Note: Defaulting will be run whenever the replicas field is not set:
* A new MachineDeployment is created with replicas not set.
* On an existing MachineDeployment the replicas field was first set and is now unset.
Those cases are especially relevant for the following Kubernetes autoscaler use cases:
* A new MachineDeployment is created and replicas should be managed by the autoscaler
* An existing MachineDeployment which initially wasn’t controlled by the autoscaler
should be later controlled by the autoscaler

rolloutAfter Time

rolloutAfter is a field to indicate a rollout should be performed
after the specified time even if no changes have been made to the
MachineDeployment.
Example: In the YAML the time can be specified in the RFC3339 format.
To specify the rolloutAfter target as March 9, 2023, at 9 am UTC
use "2023-03-09T09:00:00Z".

selector LabelSelector

selector is the label selector for machines. Existing MachineSets whose machines are
selected by this will be the ones affected by this deployment.
It must match the machine template’s labels.

template MachineTemplateSpec

template describes the machines that will be created.

strategy MachineDeploymentStrategy

strategy is the deployment strategy to use to replace existing machines with
new ones.

machineNamingStrategy MachineNamingStrategy

machineNamingStrategy allows changing the naming pattern used when creating Machines.
Note: InfraMachines & BootstrapConfigs will use the same name as the corresponding Machines.

minReadySeconds integer

minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available.
Defaults to 0 (machine will be considered available as soon as the Node is ready)

revisionHistoryLimit integer

revisionHistoryLimit is the number of old MachineSets to retain to allow rollback.
This is a pointer to distinguish between explicit zero and not specified.
Defaults to 1.

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/10479 for more details.

paused boolean

paused indicates that the deployment is paused.

progressDeadlineSeconds integer

progressDeadlineSeconds is the maximum time in seconds for a deployment to make progress before it
is considered to be failed. The deployment controller will continue to
process failed deployments and a condition with a ProgressDeadlineExceeded
reason will be surfaced in the deployment status. Note that progress will
not be estimated during the time a deployment is paused. Defaults to 600s.

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/11470 for more details.

observedGeneration integer

observedGeneration is the generation observed by the deployment controller.

selector string

selector is the same as the label selector but in the string format to avoid introspection
by clients. The string will be in the same format as the query-param syntax.
More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors

MaxLength: 4096
MinLength: 1

replicas integer

replicas is the total number of non-terminated machines targeted by this deployment
(their labels match the selector).

updatedReplicas integer

updatedReplicas is the total number of non-terminated machines targeted by this deployment
that have the desired template spec.

readyReplicas integer

readyReplicas is the total number of ready machines targeted by this deployment.

availableReplicas integer

availableReplicas is the total number of available machines (ready for at least minReadySeconds)
targeted by this deployment.

unavailableReplicas integer

unavailableReplicas is the total number of unavailable machines targeted by this deployment.
This is the total number of machines that are still required for
the deployment to have 100% available capacity. They may either
be machines that are running but not yet available or machines
that still have not been created.

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.

phase string

phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown).

Enum: [ScalingUp ScalingDown Running Failed Unknown]

conditions Conditions

conditions defines current service state of the MachineDeployment.

v1beta2 MachineDeploymentV1Beta2Status

v1beta2 groups all the fields that will be added or modified in MachineDeployment’s status with the V1Beta2 version.

type MachineDeploymentStrategyType

type of deployment. Allowed values are RollingUpdate and OnDelete.
The default is RollingUpdate.

Enum: [RollingUpdate OnDelete]

rollingUpdate MachineRollingUpdateDeployment

rollingUpdate is the rolling update config params. Present only if
MachineDeploymentStrategyType = RollingUpdate.

remediation RemediationStrategy

remediation controls the strategy of remediating unhealthy machines
and how remediating operations should occur during the lifecycle of the dependant MachineSets.

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

class string

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.

MaxLength: 256
MinLength: 1

name string

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.

MaxLength: 63
MinLength: 1

failureDomain string

failureDomain is the failure domain the machines will be created in.
Must match a key in the FailureDomains map stored on the cluster object.

MaxLength: 256
MinLength: 1

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 1)
and it’s assumed that an external entity (like cluster autoscaler) is responsible for the management
of this value.

machineHealthCheck MachineHealthCheckTopology

machineHealthCheck allows to enable, disable and override
the MachineHealthCheck configuration in the ClusterClass for this MachineDeployment.

nodeDrainTimeout Duration

nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.
The default value is 0, meaning that the node can be drained without any time limitations.
NOTE: NodeDrainTimeout is different from kubectl drain --timeout

nodeVolumeDetachTimeout Duration

nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes
to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.

nodeDeletionTimeout Duration

nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine
hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.
Defaults to 10 seconds.

minReadySeconds integer

minReadySeconds is the minimum number of seconds for which a newly created machine should
be ready.
Defaults to 0 (machine will be considered available as soon as it
is ready)

readinessGates MachineReadinessGate array

readinessGates specifies additional conditions to include when evaluating Machine Ready condition.

This field can be used e.g. to instruct the machine controller to include in the computation for Machine’s ready
computation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.

If this field is not defined, readinessGates from the corresponding MachineDeploymentClass will be used, if any.

MaxItems: 32

strategy MachineDeploymentStrategy

strategy is the deployment strategy to use to replace existing machines with
new ones.

variables MachineDeploymentVariables

variables can be used to customize the MachineDeployment through patches.

conditions Condition array

conditions represents the observations of a MachineDeployment’s current state.
Known condition types are Available, MachinesReady, MachinesUpToDate, ScalingUp, ScalingDown, Remediating, Deleting, Paused.

MaxItems: 32

readyReplicas integer

readyReplicas is the number of ready replicas for this MachineDeployment. A machine is considered ready when Machine’s Ready condition is true.

availableReplicas integer

availableReplicas is the number of available replicas for this MachineDeployment. A machine is considered available when Machine’s Available condition is true.

upToDateReplicas integer

upToDateReplicas is the number of up-to-date replicas targeted by this deployment. A machine is considered up-to-date when Machine’s UpToDate condition is true.

overrides ClusterVariable array

overrides can be used to override Cluster level variables.

MaxItems: 1000

apiVersion string

cluster.x-k8s.io/v1beta1

kind string

MachineDrainRule

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec MachineDrainRuleSpec

spec defines the spec of a MachineDrainRule.

behavior MachineDrainRuleDrainBehavior

behavior defines the drain behavior.
Can be either "Drain", "Skip", or "WaitCompleted".
"Drain" means that the Pods to which this MachineDrainRule applies will be drained.
If behavior is set to "Drain" the order in which Pods are drained can be configured
with the order field. When draining Pods of a Node the Pods will be grouped by order
and one group after another will be drained (by increasing order). Cluster API will
wait until all Pods of a group are terminated / removed from the Node before starting
with the next group.
"Skip" means that the Pods to which this MachineDrainRule applies will be skipped during drain.
"WaitCompleted" means that the pods to which this MachineDrainRule applies will never be evicted
and we wait for them to be completed, it is enforced that pods marked with this behavior always have Order=0.

Enum: [Drain Skip WaitCompleted]

order integer

order defines the order in which Pods are drained.
Pods with higher order are drained after Pods with lower order.
order can only be set if behavior is set to "Drain".
If order is not set, 0 will be used.
Valid values for order are from -2147483648 to 2147483647 (inclusive).

selector LabelSelector

selector is a label selector which selects Machines by their labels.
This field follows standard label selector semantics; if not present or
empty, it selects all Machines.

If clusterSelector is also set, then the selector as a whole selects
Machines matching selector belonging to Clusters selected by clusterSelector.
If clusterSelector is not set, it selects all Machines matching selector in
all Clusters.

clusterSelector LabelSelector

clusterSelector is a label selector which selects Machines by the labels of
their Clusters.
This field follows standard label selector semantics; if not present or
empty, it selects Machines of all Clusters.

If selector is also set, then the selector as a whole selects
Machines matching selector belonging to Clusters selected by clusterSelector.
If selector is not set, it selects all Machines belonging to Clusters
selected by clusterSelector.

selector LabelSelector

selector is a label selector which selects Pods by their labels.
This field follows standard label selector semantics; if not present or
empty, it selects all Pods.

If namespaceSelector is also set, then the selector as a whole selects
Pods matching selector in Namespaces selected by namespaceSelector.
If namespaceSelector is not set, it selects all Pods matching selector in
all Namespaces.

namespaceSelector LabelSelector

namespaceSelector is a label selector which selects Pods by the labels of
their Namespaces.
This field follows standard label selector semantics; if not present or
empty, it selects Pods of all Namespaces.

If selector is also set, then the selector as a whole selects
Pods matching selector in Namespaces selected by namespaceSelector.
If selector is not set, it selects all Pods in Namespaces selected by
namespaceSelector.

drain MachineDrainRuleDrainConfig

drain configures if and how Pods are drained.

machines MachineDrainRuleMachineSelector array

machines defines to which Machines this MachineDrainRule should be applied.

If machines is not set, the MachineDrainRule applies to all Machines in the Namespace.
If machines contains multiple selectors, the results are ORed.
Within a single Machine selector the results of selector and clusterSelector are ANDed.
Machines will be selected from all Clusters in the Namespace unless otherwise
restricted with the clusterSelector.

Example: Selects control plane Machines in all Clusters or
Machines with label "os" == "linux" in Clusters with label
"stage" == "production".

MaxItems: 32
MinItems: 1
MinProperties: 1

pods MachineDrainRulePodSelector array

pods defines to which Pods this MachineDrainRule should be applied.

If pods is not set, the MachineDrainRule applies to all Pods in all Namespaces.
If pods contains multiple selectors, the results are ORed.
Within a single Pod selector the results of selector and namespaceSelector are ANDed.
Pods will be selected from all Namespaces unless otherwise
restricted with the namespaceSelector.

Example: Selects Pods with label "app" == "logging" in all Namespaces or
Pods with label "app" == "prometheus" in the "monitoring"
Namespace.

MaxItems: 32
MinItems: 1
MinProperties: 1

apiVersion string

cluster.x-k8s.io/v1beta1

kind string

MachineHealthCheck

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec MachineHealthCheckSpec

spec is the specification of machine health check policy

status MachineHealthCheckStatus

status is the most recently observed status of MachineHealthCheck resource

unhealthyConditions UnhealthyCondition array

unhealthyConditions contains a list of the conditions that determine
whether a node is considered unhealthy. The conditions are combined in a
logical OR, i.e. if any of the conditions is met, the node is unhealthy.

MaxItems: 100

maxUnhealthy IntOrString

maxUnhealthy specifies the maximum number of unhealthy machines allowed.
Any further remediation is only allowed if at most "maxUnhealthy" machines selected by
"selector" are not healthy.

unhealthyRange string

unhealthyRange specifies the range of unhealthy machines allowed.
Any further remediation is only allowed if the number of machines selected by "selector" as not healthy
is within the range of "unhealthyRange". Takes precedence over maxUnhealthy.
Eg. "[3-5]" - This means that remediation will be allowed only when:
(a) there are at least 3 unhealthy machines (and)
(b) there are at most 5 unhealthy machines

MaxLength: 32
MinLength: 1
Pattern: ^\[[0-9]+-[0-9]+\]$

nodeStartupTimeout Duration

nodeStartupTimeout allows to set the maximum time for MachineHealthCheck
to consider a Machine unhealthy if a corresponding Node isn’t associated
through a Spec.ProviderID field.

The duration set in this field is compared to the greatest of:
- Cluster’s infrastructure ready condition timestamp (if and when available)
- Control Plane’s initialized condition timestamp (if and when available)
- Machine’s infrastructure ready condition timestamp (if and when available)
- Machine’s metadata creation timestamp

Defaults to 10 minutes.
If you wish to disable this feature, set the value explicitly to 0.

remediationTemplate ObjectReference

remediationTemplate is a reference to a remediation template
provided by an infrastructure provider.

This field is completely optional, when filled, the MachineHealthCheck controller
creates a new object from the template referenced and hands off remediation of the machine to
a controller that lives outside of Cluster API.

clusterName string

clusterName is the name of the Cluster this object belongs to.

MaxLength: 63
MinLength: 1

selector LabelSelector

selector is a label selector to match machines whose health will be exercised

unhealthyConditions UnhealthyCondition array

unhealthyConditions contains a list of the conditions that determine
whether a node is considered unhealthy. The conditions are combined in a
logical OR, i.e. if any of the conditions is met, the node is unhealthy.

MaxItems: 100

maxUnhealthy IntOrString

maxUnhealthy specifies the maximum number of unhealthy machines allowed.
Any further remediation is only allowed if at most "maxUnhealthy" machines selected by
"selector" are not healthy.

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/10722 for more details.

unhealthyRange string

unhealthyRange specifies the range of unhealthy machines allowed.
Any further remediation is only allowed if the number of machines selected by "selector" as not healthy
is within the range of "unhealthyRange". Takes precedence over maxUnhealthy.
Eg. "[3-5]" - This means that remediation will be allowed only when:
(a) there are at least 3 unhealthy machines (and)
(b) there are at most 5 unhealthy machines

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/10722 for more details.

MaxLength: 32
MinLength: 1
Pattern: ^\[[0-9]+-[0-9]+\]$

nodeStartupTimeout Duration

nodeStartupTimeout allows to set the maximum time for MachineHealthCheck
to consider a Machine unhealthy if a corresponding Node isn’t associated
through a Spec.ProviderID field.

The duration set in this field is compared to the greatest of:
- Cluster’s infrastructure ready condition timestamp (if and when available)
- Control Plane’s initialized condition timestamp (if and when available)
- Machine’s infrastructure ready condition timestamp (if and when available)
- Machine’s metadata creation timestamp

Defaults to 10 minutes.
If you wish to disable this feature, set the value explicitly to 0.

remediationTemplate ObjectReference

remediationTemplate is a reference to a remediation template
provided by an infrastructure provider.

This field is completely optional, when filled, the MachineHealthCheck controller
creates a new object from the template referenced and hands off remediation of the machine to
a controller that lives outside of Cluster API.

expectedMachines integer

expectedMachines is the total number of machines counted by this machine health check

Minimum: 0

currentHealthy integer

currentHealthy is the total number of healthy machines counted by this machine health check

Minimum: 0

remediationsAllowed integer

remediationsAllowed is the number of further remediations allowed by this machine health check before
maxUnhealthy short circuiting will be applied

Minimum: 0

observedGeneration integer

observedGeneration is the latest generation observed by the controller.

targets string array

targets shows the current list of machines the machine health check is watching

MaxItems: 10000
items:MaxLength: 253
items:MinLength: 1

conditions Conditions

conditions defines current service state of the MachineHealthCheck.

v1beta2 MachineHealthCheckV1Beta2Status

v1beta2 groups all the fields that will be added or modified in MachineHealthCheck’s status with the V1Beta2 version.

enable boolean

enable controls if a MachineHealthCheck should be created for the target machines.

If false: No MachineHealthCheck will be created.

If not set(default): A MachineHealthCheck will be created if it is defined here or
in the associated ClusterClass. If no MachineHealthCheck is defined then none will be created.

If true: A MachineHealthCheck is guaranteed to be created. Cluster validation will
block if enable is true and no MachineHealthCheck definition is available.

unhealthyConditions UnhealthyCondition array

unhealthyConditions contains a list of the conditions that determine
whether a node is considered unhealthy. The conditions are combined in a
logical OR, i.e. if any of the conditions is met, the node is unhealthy.

MaxItems: 100

maxUnhealthy IntOrString

maxUnhealthy specifies the maximum number of unhealthy machines allowed.
Any further remediation is only allowed if at most "maxUnhealthy" machines selected by
"selector" are not healthy.

unhealthyRange string

unhealthyRange specifies the range of unhealthy machines allowed.
Any further remediation is only allowed if the number of machines selected by "selector" as not healthy
is within the range of "unhealthyRange". Takes precedence over maxUnhealthy.
Eg. "[3-5]" - This means that remediation will be allowed only when:
(a) there are at least 3 unhealthy machines (and)
(b) there are at most 5 unhealthy machines

MaxLength: 32
MinLength: 1
Pattern: ^\[[0-9]+-[0-9]+\]$

nodeStartupTimeout Duration

nodeStartupTimeout allows to set the maximum time for MachineHealthCheck
to consider a Machine unhealthy if a corresponding Node isn’t associated
through a Spec.ProviderID field.

The duration set in this field is compared to the greatest of:
- Cluster’s infrastructure ready condition timestamp (if and when available)
- Control Plane’s initialized condition timestamp (if and when available)
- Machine’s infrastructure ready condition timestamp (if and when available)
- Machine’s metadata creation timestamp

Defaults to 10 minutes.
If you wish to disable this feature, set the value explicitly to 0.

remediationTemplate ObjectReference

remediationTemplate is a reference to a remediation template
provided by an infrastructure provider.

This field is completely optional, when filled, the MachineHealthCheck controller
creates a new object from the template referenced and hands off remediation of the machine to
a controller that lives outside of Cluster API.

conditions Condition array

conditions represents the observations of a MachineHealthCheck’s current state.
Known condition types are RemediationAllowed, Paused.

MaxItems: 32

template string

template defines the template to use for generating the names of the
Machine objects.
If not defined, it will fallback to {{ .machineSet.name }}-{{ .random }}.
If the generated name string exceeds 63 characters, it will be trimmed to
58 characters and will
get concatenated with a random suffix of length 5.
Length of the template string must not exceed 256 characters.
The template allows the following variables .cluster.name,
.machineSet.name and .random.
The variable .cluster.name retrieves the name of the cluster object
that owns the Machines being created.
The variable .machineSet.name retrieves the name of the MachineSet
object that owns the Machines being created.
The variable .random is substituted with random alphanumeric string,
without vowels, of length 5. This variable is required part of the
template. If not provided, validation will fail.

MaxLength: 256
MinLength: 1

conditionType string

conditionType refers to a condition with matching type in the Machine’s condition list.
If the conditions doesn’t exist, it will be treated as unknown.
Note: Both Cluster API conditions or conditions added by 3rd party controllers can be used as readiness gates.

MaxLength: 316
MinLength: 1
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

polarity ConditionPolarity

polarity of the conditionType specified in this readinessGate.
Valid values are Positive, Negative and omitted.
When omitted, the default behaviour will be Positive.
A positive polarity means that the condition should report a true status under normal conditions.
A negative polarity means that the condition should report a false status under normal conditions.

Enum: [Positive Negative]

apiVersion string

cluster.x-k8s.io/v1beta1

kind string

MachineSet

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec MachineSetSpec

spec is the desired state of MachineSet.

status MachineSetStatus

status is the observed state of MachineSet.

clusterName string

clusterName is the name of the Cluster this object belongs to.

MaxLength: 63
MinLength: 1

replicas integer

replicas is the number of desired replicas.
This is a pointer to distinguish between explicit zero and unspecified.

Defaults to:
* if the Kubernetes autoscaler min size and max size annotations are set:
- if it’s a new MachineSet, use min size
- if the replicas field of the old MachineSet is < min size, use min size
- if the replicas field of the old MachineSet is > max size, use max size
- if the replicas field of the old MachineSet is in the (min size, max size) range, keep the value from the oldMS
* otherwise use 1
Note: Defaulting will be run whenever the replicas field is not set:
* A new MachineSet is created with replicas not set.
* On an existing MachineSet the replicas field was first set and is now unset.
Those cases are especially relevant for the following Kubernetes autoscaler use cases:
* A new MachineSet is created and replicas should be managed by the autoscaler
* An existing MachineSet which initially wasn’t controlled by the autoscaler
should be later controlled by the autoscaler

minReadySeconds integer

minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available.
Defaults to 0 (machine will be considered available as soon as the Node is ready)

deletePolicy string

deletePolicy defines the policy used to identify nodes to delete when downscaling.
Defaults to "Random". Valid values are "Random, "Newest", "Oldest"

Enum: [Random Newest Oldest]

selector LabelSelector

selector is a label query over machines that should match the replica count.
Label keys and values that must match in order to be controlled by this MachineSet.
It must match the machine template’s labels.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

template MachineTemplateSpec

template is the object that describes the machine that will be created if
insufficient replicas are detected.
Object references to custom resources are treated as templates.

machineNamingStrategy MachineNamingStrategy

machineNamingStrategy allows changing the naming pattern used when creating Machines.
Note: InfraMachines & BootstrapConfigs will use the same name as the corresponding Machines.

selector string

selector is the same as the label selector but in the string format to avoid introspection
by clients. The string will be in the same format as the query-param syntax.
More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors

MaxLength: 4096
MinLength: 1

replicas integer