集群 [cluster.x-k8s.io/v1beta1]
- 描述
- Cluster is the Schema for the clusters API.
- 类型
object
规格
.spec
- 描述
- spec is the desired state of Cluster.
- 类型
object
.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
.spec.clusterNetwork
- 描述
- clusterNetwork represents the cluster network configuration.
- 类型
object
.spec.clusterNetwork.pods
- 描述
- pods is the network ranges from which Pod networks are allocated.
- 类型
object- 必填
cidrBlocks
.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
.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
.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
.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
.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
.spec.topology.controlPlane
- 描述
- controlPlane describes the cluster control plane.
- 类型
object
.spec.topology.controlPlane.machineHealthCheck
- 描述
- machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this control plane.
- 类型
object
.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
.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
.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
.spec.topology.controlPlane.variables
- 描述
- variables can be used to customize the ControlPlane through patches.
- 类型
object
.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
.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
.spec.topology.workers
- 描述
- workers encapsulates the different constructs that form the worker nodes for the cluster.
- 类型
object
.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
.spec.topology.workers.machineDeployments[].machineHealthCheck
- 描述
- machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this MachineDeployment.
- 类型
object
.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
.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
.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
.spec.topology.workers.machineDeployments[].strategy
- 描述
- strategy is the deployment strategy to use to replace existing machines with new ones.
- 类型
object
.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
.spec.topology.workers.machineDeployments[].strategy.rollingUpdate
- 描述
- rollingUpdate is the rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.
- 类型
object
.spec.topology.workers.machineDeployments[].variables
- 描述
- variables can be used to customize the MachineDeployment through patches.
- 类型
object
.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
.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
.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
.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
.status
- 描述
- status is the observed state of Cluster.
- 类型
object
.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
.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
.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
.status.v1beta2.controlPlane
- 描述
- controlPlane groups all the observations about Cluster's ControlPlane current state.
- 类型
object
.status.v1beta2.workers
- 描述
- workers groups all the observations about Cluster's Workers current state.
- 类型
object
API 端点
可用的 API 端点如下:
/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clustersDELETE: delete collection of ClusterGET: list objects of kind ClusterPOST: create a new Cluster
/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}DELETE: delete the specified ClusterGET: read the specified ClusterPATCH: partially update the specified ClusterPUT: replace the specified Cluster
/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}/statusGET: read status of the specified ClusterPATCH: partially update status of the specified ClusterPUT: replace status of the specified Cluster
/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters
- HTTP 方法
DELETE- 描述
- delete collection of Cluster
- HTTP 响应
- HTTP 方法
GET- 描述
- list objects of kind Cluster
- HTTP 响应
- HTTP 方法
POST- 描述
- create a new Cluster
- 查询参数
- 请求体参数
- HTTP 响应
/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}
- HTTP 方法
DELETE- 描述
- delete the specified Cluster
- 查询参数
- HTTP 响应
- HTTP 方法
GET- 描述
- read the specified Cluster
- HTTP 响应
- HTTP 方法
PATCH- 描述
- partially update the specified Cluster
- 查询参数
- HTTP 响应
- HTTP 方法
PUT- 描述
- replace the specified Cluster
- 查询参数
- 请求体参数
- HTTP 响应
/apis/cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusters/{name}/status
- HTTP 方法
GET- 描述
- read status of the specified Cluster
- HTTP 响应
- HTTP 方法
PATCH- 描述
- partially update status of the specified Cluster
- 查询参数
- HTTP 响应
- HTTP 方法
PUT- 描述
- replace status of the specified Cluster
- 查询参数
- 请求体参数
- HTTP 响应