VSphereMachineConfigPool [infrastructure.cluster.x-k8s.io/v1beta1]
- Description
- VSphereMachineConfigPool is the Schema for the vspheremachineconfigpools API.
- Type
object
Specification
.spec
- Description
- VSphereMachineConfigPoolSpec defines the desired state of VSphereMachineConfigPool.
- Type
object- Required
clusterRefconfigs
.spec.clusterRef
- Description
- ClusterRef references the CAPI Cluster (in the same namespace) whose VSphereCluster provides vCenter server, thumbprint, and credential chain (IdentityRef) for this pool's vCenter operations (e.g. disk reclaim). Required. Can only be changed when consumerRef is nil. The pool will not reconcile until the referenced Cluster and its VSphereCluster infrastructure are available.
- Type
object
.spec.configs
- Description
- Configs is the list of pre-defined machine configuration slots.
- Type
array
.spec.configs[]
- Description
- MachineConfigSlot defines a single machine configuration slot in the pool.
- Type
object- Required
hostname
.spec.configs[].network
- Description
- Network describes the primary and additional network configurations for this slot.
- Type
object- Required
primary
.spec.configs[].network.additional
- Description
- Additional are the remaining network configurations attached after the primary device.
- Type
array
.spec.configs[].network.additional[]
- Description
- NetworkConfig defines the network configuration for a slot device.
- Type
object- Required
networkName
.spec.configs[].network.additional[].dns
- Description
- DNS nameservers
- Type
array
.spec.configs[].network.additional[].dns[]
- Type
string
.spec.configs[].network.primary
- Description
- Primary is the network configuration used for kubelet node IP registration.
- Type
object- Required
networkName
.spec.configs[].network.primary.dns
- Description
- DNS nameservers
- Type
array
.spec.configs[].network.primary.dns[]
- Type
string
.spec.configs[].persistentDisks
- Description
- PersistentDisks that survive VM deletion.
- Type
array
.spec.configs[].persistentDisks[]
- Description
- PersistentDisk defines a disk that survives VM deletion.
- Type
object- Required
namesizeGiB
.spec.configs[].persistentDisks[].mountOptions
- Description
- MountOptions for the filesystem mount.
- Type
array
.spec.configs[].persistentDisks[].mountOptions[]
- Type
string
.status
- Description
- VSphereMachineConfigPoolStatus defines the observed state of VSphereMachineConfigPool.
- Type
object
.status.conditions
- Description
- Conditions defines current state of the machine config pool.
- Type
array
.status.conditions[]
- Description
- Condition defines an observation of a Cluster API resource operational state.
- Type
object- Required
lastTransitionTimestatustype
.status.configStatuses
- Description
- ConfigStatuses tracks the state of each slot.
- Type
array
.status.configStatuses[]
- Description
- MachineConfigSlotStatus tracks the state of a single slot.
- Type
object- Required
hostnamestate
.status.configStatuses[].machineRef
- Description
- MachineRef is the reference to the Machine currently using this slot.
- Type
object
.status.configStatuses[].reclaimStatus
- Description
- ReclaimStatus tracks asynchronous reclaim progress for this slot.
- Type
object
.status.consumerRef
- Description
- ConsumerRef is the workload controller (KubeadmControlPlane or MachineDeployment) currently bound to this pool. Set automatically by the controller when a machine allocates a slot. Cleared when the pool becomes fully reusable.
- Type
object
API Endpoints
The following API endpoints are available:
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/vspheremachineconfigpoolsDELETE: delete collection of VSphereMachineConfigPoolGET: list objects of kind VSphereMachineConfigPoolPOST: create a new VSphereMachineConfigPool
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/vspheremachineconfigpools/{name}DELETE: delete the specified VSphereMachineConfigPoolGET: read the specified VSphereMachineConfigPoolPATCH: partially update the specified VSphereMachineConfigPoolPUT: replace the specified VSphereMachineConfigPool
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/vspheremachineconfigpools/{name}/statusGET: read status of the specified VSphereMachineConfigPoolPATCH: partially update status of the specified VSphereMachineConfigPoolPUT: replace status of the specified VSphereMachineConfigPool
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/vspheremachineconfigpools
- HTTP method
DELETE- Description
- delete collection of VSphereMachineConfigPool
- HTTP responses
- HTTP method
GET- Description
- list objects of kind VSphereMachineConfigPool
- HTTP responses
- HTTP method
POST- Description
- create a new VSphereMachineConfigPool
- Query parameters
- Body parameters
- HTTP responses
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/vspheremachineconfigpools/{name}
- HTTP method
DELETE- Description
- delete the specified VSphereMachineConfigPool
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified VSphereMachineConfigPool
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified VSphereMachineConfigPool
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified VSphereMachineConfigPool
- Query parameters
- Body parameters
- HTTP responses
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/vspheremachineconfigpools/{name}/status
- HTTP method
GET- Description
- read status of the specified VSphereMachineConfigPool
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified VSphereMachineConfigPool
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified VSphereMachineConfigPool
- Query parameters
- Body parameters
- HTTP responses