集群 [cluster.x-k8s.io/v1beta1]

描述
Cluster is the Schema for the clusters API.
类型
object

规格

属性类型描述
apiVersionstring

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

kindstring

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

metadataObjectMeta

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

specobject

spec is the desired state of Cluster.

statusobject

status is the observed state of Cluster.

.spec

描述
spec is the desired state of Cluster.
类型
object
属性类型描述
availabilityGatesarray

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.

NOTE: this field is considered only for computing v1beta2 conditions.

clusterNetworkobject

clusterNetwork represents the cluster network configuration.

controlPlaneEndpointobject

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

controlPlaneRefobject

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

infrastructureRefobject

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

pausedboolean

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

topologyobject

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.

.spec.availabilityGates

描述
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. NOTE: this field is considered only for computing v1beta2 conditions.
类型
array

.spec.availabilityGates[]

描述
ClusterAvailabilityGate contains the type of a Cluster condition to be used as availability gate.
类型
object
必填
conditionType
属性类型描述
conditionTypestring

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.

polaritystring

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.

.spec.clusterNetwork

描述
clusterNetwork represents the cluster network configuration.
类型
object
属性类型描述
apiServerPortinteger

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

podsobject

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

serviceDomainstring

serviceDomain is the domain name for services.

servicesobject

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

.spec.clusterNetwork.pods

描述
pods is the network ranges from which Pod networks are allocated.
类型
object
必填
cidrBlocks
属性类型描述
cidrBlocksarray

cidrBlocks is a list of CIDR blocks.

.spec.clusterNetwork.pods.cidrBlocks

描述
cidrBlocks is a list of CIDR blocks.
类型
array

.spec.clusterNetwork.pods.cidrBlocks[]

类型
string

.spec.clusterNetwork.services

描述
services is the network ranges from which service VIPs are allocated.
类型
object
必填
cidrBlocks
属性类型描述
cidrBlocksarray

cidrBlocks is a list of CIDR blocks.

.spec.clusterNetwork.services.cidrBlocks

描述
cidrBlocks is a list of CIDR blocks.
类型
array

.spec.clusterNetwork.services.cidrBlocks[]

类型
string

.spec.controlPlaneEndpoint

描述
controlPlaneEndpoint represents the endpoint used to communicate with the control plane.
类型
object
必填
hostport
属性类型描述
hoststring

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

portinteger

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

.spec.controlPlaneRef

描述
controlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster.
类型
object
属性类型描述
apiVersionstring

API version of the referent.

fieldPathstring

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.

kindstring

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

namestring

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

namespacestring

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

resourceVersionstring

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

uidstring

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

.spec.infrastructureRef

描述
infrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider.
类型
object
属性类型描述
apiVersionstring

API version of the referent.

fieldPathstring

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.

kindstring

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

namestring

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

namespacestring

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

resourceVersionstring

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

uidstring

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

.spec.topology

描述
topology encapsulates the topology for the cluster. NOTE: It is required to enable the ClusterTopology feature gate flag to activate managed topologies support; this feature is highly experimental, and parts of it might still be not implemented.
类型
object
必填
classversion
属性类型描述
classstring

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

classNamespacestring

classNamespace is the namespace of the ClusterClass that should be used for the topology. If classNamespace is empty or not set, it is defaulted to the namespace of the Cluster object. classNamespace must be a valid namespace name and because of that be at most 63 characters in length and it must consist only of lower case alphanumeric characters or hyphens (-), and must start and end with an alphanumeric character.

controlPlaneobject

controlPlane describes the cluster control plane.

rolloutAfterstring

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

Deprecated: This field has no function and is going to be removed in the next apiVersion.

variablesarray

variables can be used to customize the Cluster through patches. They must comply to the corresponding VariableClasses defined in the ClusterClass.

versionstring

version is the Kubernetes version of the cluster.

workersobject

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

.spec.topology.controlPlane

描述
controlPlane describes the cluster control plane.
类型
object
属性类型描述
machineHealthCheckobject

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

metadataObjectMeta

metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced by the ClusterClass is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.

nodeDeletionTimeoutstring

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.

nodeDrainTimeoutstring

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

nodeVolumeDetachTimeoutstring

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.

readinessGatesarray

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.

NOTE: This field is considered only for computing v1beta2 conditions. NOTE: Specific control plane provider implementations might automatically extend the list of readinessGates; e.g. the kubeadm control provider adds ReadinessGates for the APIServerPodHealthy, SchedulerPodHealthy conditions, etc.

replicasinteger

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.

variablesobject

variables can be used to customize the ControlPlane through patches.

.spec.topology.controlPlane.machineHealthCheck

描述
machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this control plane.
类型
object
属性类型描述
enableboolean

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.

maxUnhealthyinteger|string

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.

nodeStartupTimeoutstring

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.

remediationTemplateobject

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.

unhealthyConditionsarray

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.

unhealthyRangestring

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

.spec.topology.controlPlane.machineHealthCheck.remediationTemplate

描述
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.
类型
object
属性类型描述
apiVersionstring

API version of the referent.

fieldPathstring

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.

kindstring

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

namestring

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

namespacestring

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

resourceVersionstring

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

uidstring

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

.spec.topology.controlPlane.machineHealthCheck.unhealthyConditions

描述
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.
类型
array

.spec.topology.controlPlane.machineHealthCheck.unhealthyConditions[]

描述
UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.
类型
object
必填
statustimeouttype
属性类型描述
statusstring

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

timeoutstring

timeout is the duration that a node must be in a given status for, after which the node is considered unhealthy. For example, with a value of "1h", the node must match the status for at least 1 hour before being considered unhealthy.

typestring

type of Node condition

.spec.topology.controlPlane.readinessGates

描述
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. NOTE: This field is considered only for computing v1beta2 conditions. NOTE: Specific control plane provider implementations might automatically extend the list of readinessGates; e.g. the kubeadm control provider adds ReadinessGates for the APIServerPodHealthy, SchedulerPodHealthy conditions, etc.
类型
array

.spec.topology.controlPlane.readinessGates[]

描述
MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.
类型
object
必填
conditionType
属性类型描述
conditionTypestring

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.

polaritystring

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.

.spec.topology.controlPlane.variables

描述
variables can be used to customize the ControlPlane through patches.
类型
object
属性类型描述
overridesarray

overrides can be used to override Cluster level variables.

.spec.topology.controlPlane.variables.overrides

描述
overrides can be used to override Cluster level variables.
类型
array

.spec.topology.controlPlane.variables.overrides[]

描述
ClusterVariable can be used to customize the Cluster through patches. Each ClusterVariable is associated with a Variable definition in the ClusterClass `status` variables.
类型
object
必填
namevalue
属性类型描述
definitionFromstring

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.

namestring

name of the variable.

value

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

.spec.topology.variables

描述
variables can be used to customize the Cluster through patches. They must comply to the corresponding VariableClasses defined in the ClusterClass.
类型
array

.spec.topology.variables[]

描述
ClusterVariable can be used to customize the Cluster through patches. Each ClusterVariable is associated with a Variable definition in the ClusterClass `status` variables.
类型
object
必填
namevalue
属性类型描述
definitionFromstring

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.

namestring

name of the variable.

value

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

.spec.topology.workers

描述
workers encapsulates the different constructs that form the worker nodes for the cluster.
类型
object
属性类型描述
machineDeploymentsarray

machineDeployments is a list of machine deployments in the cluster.

machinePoolsarray

machinePools is a list of machine pools in the cluster.

.spec.topology.workers.machineDeployments

描述
machineDeployments is a list of machine deployments in the cluster.
类型
array

.spec.topology.workers.machineDeployments[]

描述
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.
类型
object
必填
classname
属性类型描述
classstring

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.

failureDomainstring

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

machineHealthCheckobject

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

metadataObjectMeta

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

minReadySecondsinteger

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)

namestring

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.

nodeDeletionTimeoutstring

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.

nodeDrainTimeoutstring

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

nodeVolumeDetachTimeoutstring

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.

readinessGatesarray

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.

NOTE: This field is considered only for computing v1beta2 conditions.

replicasinteger

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.

strategyobject

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

variablesobject

variables can be used to customize the MachineDeployment through patches.

.spec.topology.workers.machineDeployments[].machineHealthCheck

描述
machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this MachineDeployment.
类型
object
属性类型描述
enableboolean

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.

maxUnhealthyinteger|string

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.

nodeStartupTimeoutstring

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.

remediationTemplateobject

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.

unhealthyConditionsarray

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.

unhealthyRangestring

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

.spec.topology.workers.machineDeployments[].machineHealthCheck.remediationTemplate

描述
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.
类型
object
属性类型描述
apiVersionstring

API version of the referent.

fieldPathstring

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.

kindstring

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

namestring

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

namespacestring

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

resourceVersionstring

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

uidstring

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

.spec.topology.workers.machineDeployments[].machineHealthCheck.unhealthyConditions

描述
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.
类型
array

.spec.topology.workers.machineDeployments[].machineHealthCheck.unhealthyConditions[]

描述
UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.
类型
object
必填
statustimeouttype
属性类型描述
statusstring

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

timeoutstring

timeout is the duration that a node must be in a given status for, after which the node is considered unhealthy. For example, with a value of "1h", the node must match the status for at least 1 hour before being considered unhealthy.

typestring

type of Node condition

.spec.topology.workers.machineDeployments[].readinessGates

描述
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. NOTE: This field is considered only for computing v1beta2 conditions.
类型
array

.spec.topology.workers.machineDeployments[].readinessGates[]

描述
MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.
类型
object
必填
conditionType
属性类型描述
conditionTypestring

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.

polaritystring

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.

.spec.topology.workers.machineDeployments[].strategy

描述
strategy is the deployment strategy to use to replace existing machines with new ones.
类型
object
属性类型描述
remediationobject

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

rollingUpdateobject

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

typestring

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

.spec.topology.workers.machineDeployments[].strategy.remediation

描述
remediation controls the strategy of remediating unhealthy machines and how remediating operations should occur during the lifecycle of the dependant MachineSets.
类型
object
属性类型描述
maxInFlightinteger|string

maxInFlight determines how many in flight remediations should happen at the same time.

Remediation only happens on the MachineSet with the most current revision, while older MachineSets (usually present during rollout operations) aren't allowed to remediate.

Note: In general (independent of remediations), unhealthy machines are always prioritized during scale down operations over healthy ones.

MaxInFlight can be set to a fixed number or a percentage. Example: when this is set to 20%, the MachineSet controller deletes at most 20% of the desired replicas.

If not set, remediation is limited to all machines (bounded by replicas) under the active MachineSet's management.

.spec.topology.workers.machineDeployments[].strategy.rollingUpdate

描述
rollingUpdate is the rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.
类型
object
属性类型描述
deletePolicystring

deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are "Random", "Newest", "Oldest" When no value is supplied, the default DeletePolicy of MachineSet is used

maxSurgeinteger|string

maxSurge is the maximum number of machines that can be scheduled above the desired number of machines. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 1. Example: when this is set to 30%, the new MachineSet can be scaled up immediately when the rolling update starts, such that the total number of old and new machines do not exceed 130% of desired machines. Once old machines have been killed, new MachineSet can be scaled up further, ensuring that total number of machines running at any time during the update is at most 130% of desired machines.

maxUnavailableinteger|string

maxUnavailable is the maximum number of machines that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 0. Example: when this is set to 30%, the old MachineSet can be scaled down to 70% of desired machines immediately when the rolling update starts. Once new machines are ready, old MachineSet can be scaled down further, followed by scaling up the new MachineSet, ensuring that the total number of machines available at all times during the update is at least 70% of desired machines.

.spec.topology.workers.machineDeployments[].variables

描述
variables can be used to customize the MachineDeployment through patches.
类型
object
属性类型描述
overridesarray

overrides can be used to override Cluster level variables.

.spec.topology.workers.machineDeployments[].variables.overrides

描述
overrides can be used to override Cluster level variables.
类型
array

.spec.topology.workers.machineDeployments[].variables.overrides[]

描述
ClusterVariable can be used to customize the Cluster through patches. Each ClusterVariable is associated with a Variable definition in the ClusterClass `status` variables.
类型
object
必填
namevalue
属性类型描述
definitionFromstring

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.

namestring

name of the variable.

value

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

.spec.topology.workers.machinePools

描述
machinePools is a list of machine pools in the cluster.
类型
array

.spec.topology.workers.machinePools[]

描述
MachinePoolTopology specifies the different parameters for a pool of worker nodes in the topology. This pool of nodes is managed by a MachinePool object whose lifecycle is managed by the Cluster controller.
类型
object
必填
classname
属性类型描述
classstring

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

failureDomainsarray

failureDomains is the list of failure domains the machine pool will be created in. Must match a key in the FailureDomains map stored on the cluster object.

metadataObjectMeta

metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.

minReadySecondsinteger

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

namestring

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

nodeDeletionTimeoutstring

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

nodeDrainTimeoutstring

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

nodeVolumeDetachTimeoutstring

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.

replicasinteger

replicas is the number of nodes belonging to this pool. If the value is nil, the MachinePool 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.

variablesobject

variables can be used to customize the MachinePool through patches.

.spec.topology.workers.machinePools[].failureDomains

描述
failureDomains is the list of failure domains the machine pool will be created in. Must match a key in the FailureDomains map stored on the cluster object.
类型
array

.spec.topology.workers.machinePools[].failureDomains[]

类型
string

.spec.topology.workers.machinePools[].variables

描述
variables can be used to customize the MachinePool through patches.
类型
object
属性类型描述
overridesarray

overrides can be used to override Cluster level variables.

.spec.topology.workers.machinePools[].variables.overrides

描述
overrides can be used to override Cluster level variables.
类型
array

.spec.topology.workers.machinePools[].variables.overrides[]

描述
ClusterVariable can be used to customize the Cluster through patches. Each ClusterVariable is associated with a Variable definition in the ClusterClass `status` variables.
类型
object
必填
namevalue
属性类型描述
definitionFromstring

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.

namestring

name of the variable.

value

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

.status

描述
status is the observed state of Cluster.
类型
object
属性类型描述
conditionsarray

conditions defines current service state of the cluster.

controlPlaneReadyboolean

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.

failureDomainsobject

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

failureMessagestring

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.

failureReasonstring

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.

infrastructureReadyboolean

infrastructureReady is the state of the infrastructure provider.

observedGenerationinteger

observedGeneration is the latest generation observed by the controller.

phasestring

phase represents the current phase of cluster actuation.

v1beta2object

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

.status.conditions

描述
conditions defines current service state of the cluster.
类型
array

.status.conditions[]

描述
Condition defines an observation of a Cluster API resource operational state.
类型
object
必填
lastTransitionTimestatustype
属性类型描述
lastTransitionTimestring

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.

messagestring

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

reasonstring

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.

severitystring

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.

statusstring

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

typestring

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

描述
failureDomains is a slice of failure domain objects synced from the infrastructure provider.
类型
object

.status.v1beta2

描述
v1beta2 groups all the fields that will be added or modified in Cluster's status with the V1Beta2 version.
类型
object
属性类型描述
conditionsarray

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.

controlPlaneobject

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

workersobject

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

.status.v1beta2.conditions

描述
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.
类型
array

.status.v1beta2.conditions[]

描述
Condition contains details for one aspect of the current state of this API Resource.
类型
object
必填
lastTransitionTimemessagereasonstatustype
属性类型描述
lastTransitionTimestring

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.

messagestring

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

observedGenerationinteger

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reasonstring

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

statusstring

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

typestring

type of condition in CamelCase or in foo.example.com/CamelCase.

.status.v1beta2.controlPlane

描述
controlPlane groups all the observations about Cluster's ControlPlane current state.
类型
object
属性类型描述
availableReplicasinteger

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.

desiredReplicasinteger

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

readyReplicasinteger

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.

replicasinteger

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

upToDateReplicasinteger

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.

.status.v1beta2.workers

描述
workers groups all the observations about Cluster's Workers current state.
类型
object
属性类型描述
availableReplicasinteger

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

desiredReplicasinteger

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

readyReplicasinteger

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

replicasinteger

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

upToDateReplicasinteger

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

API 端点

可用的 API 端点如下:

  • /apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters
    • DELETE: delete collection of Cluster
    • GET: list objects of kind Cluster
    • POST: create a new Cluster
  • /apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}
    • DELETE: delete the specified Cluster
    • GET: read the specified Cluster
    • PATCH: partially update the specified Cluster
    • PUT: replace the specified Cluster
  • /apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}/status
    • GET: read status of the specified Cluster
    • PATCH: partially update status of the specified Cluster
    • PUT: replace status of the specified Cluster

/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters

HTTP 方法
DELETE
描述
delete collection of Cluster
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind Cluster
HTTP 响应
HTTP 状态码响应体
200 - OKClusterList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new Cluster
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyCluster schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCluster schema
201 - CreatedCluster schema
202 - AcceptedCluster schema
401 - UnauthorizedEmpty

/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}

HTTP 方法
DELETE
描述
delete the specified Cluster
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified Cluster
HTTP 响应
HTTP 状态码响应体
200 - OKCluster schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified Cluster
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP 响应
HTTP 状态码响应体
200 - OKCluster schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified Cluster
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyCluster schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCluster schema
201 - CreatedCluster schema
401 - UnauthorizedEmpty

/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}/status

HTTP 方法
GET
描述
read status of the specified Cluster
HTTP 响应
HTTP 状态码响应体
200 - OKCluster schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified Cluster
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP 响应
HTTP 状态码响应体
200 - OKCluster schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified Cluster
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyCluster schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCluster schema
201 - CreatedCluster schema
401 - UnauthorizedEmpty