#VSphereMachineConfigPool [infrastructure.cluster.x-k8s.io/v1beta1]

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

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

VSphereMachineConfigPoolSpec defines the desired state of VSphereMachineConfigPool.

VSphereMachineConfigPoolStatus defines the observed state of VSphereMachineConfigPool.

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.

Configs is the list of pre-defined machine configuration slots.

Datacenter is the default vSphere datacenter for slots in this pool. It is used when a slot does not define its own Datacenter.

ReleaseDelayHours is the time to wait before marking a released slot as "Available" for any machine. During this period, the slot can only be reused if specifically requested or via priority reuse. Default is 24.

API version of the referent.

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

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

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

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

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

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

Datacenter is the vSphere datacenter for this slot. If set, it takes precedence over VSphereMachineConfigPool.spec.datacenter. If unset, the pool-level Datacenter acts as the default.

EphemeralDisks are non-persistent data disks. Unlike PersistentDisks they are created fresh (as empty disks) whenever the slot's VM is (re)created and deleted together with the VM: they do not participate in detach preservation, reclaim, or slot-release gating. Their SCSI unit number is assigned by the controller at clone time and observed in status.ephemeralDiskStatuses; it is not user-declared.

Hostname is the unique identifier for this slot and will be assigned to the VM. It must also be a valid Kubernetes node name because CAPV uses it for kubeadm nodeRegistration.name and the kubelet serving certificate DNS SAN.

Network describes the primary and additional network configurations for this slot.

PersistentDisks that survive VM deletion.

Datastore is the vSphere datastore name.

FSFormat is the filesystem format (default "ext4").

MountOptions for the filesystem mount.

MountPath is the mount path inside the VM guest OS (e.g., "/var/lib/containerd").

Name is the disk name. It shares a namespace with the slot's persistent disks: a name must be unique across both lists within the slot.

SizeGiB is the disk size.

StoragePolicy is the vSphere storage policy name.

Additional are the remaining network configurations attached after the primary device.

Primary is the network configuration used for kubelet node IP registration.

DeviceName explicitly assigns a guest OS interface name to the network device.

DNS nameservers

IPv4 configuration

IPv6 configuration

NetworkName is the name of the vSphere network (PortGroup or DVPortGroup).

DeviceName explicitly assigns a guest OS interface name to the network device.

DNS nameservers

IPv4 configuration

IPv6 configuration

NetworkName is the name of the vSphere network (PortGroup or DVPortGroup).

Datastore is the vSphere datastore name.

DiskUUID is backfilled by the controller.

FSFormat is the filesystem format (default "ext4").

MountOptions for the filesystem mount.

MountPath is the mount path inside the VM guest OS (e.g., "/var/lib/etcd").

Name is the disk name.

SizeGiB is the disk size.

StoragePolicy is the vSphere storage policy name.

UnitNumber is the SCSI unit number for the disk (0-15, excluding 7). This ensures consistent disk ordering across VM recreations.

VolumePath is backfilled by the controller after the disk is created. For vSphere, this is usually the datastore path to the .vmdk file.

WipeFilesystem controls whether to wipe the filesystem content when the slot is reused by a new VM. When true, the disk content is cleared on the first boot of a new VM (reboots and manual service restarts are not affected). Defaults to false (data is preserved across VM recreations).

Allocated is the number of slots currently bound to a VSphereMachine (slots in the InUse state).

Available is the number of slots currently free for allocation (slots in the Available state).

Conditions defines current state of the machine config pool.

ConfigStatuses tracks the state of each slot.

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.

EphemeralDiskStatuses records the controller-observed SCSI unit number of each non-persistent disk, keyed by (hostname, disk name). The unit is assigned at clone time and reused (hydrated back onto the in-memory slot) on the next reconcile so the guest disk table can address the disk. Unlike PersistentDiskStatuses this carries no VolumePath/DiskUUID/Phase: ephemeral disks are recreated with the VM and never reclaimed.

PersistentDiskStatuses tracks the observed state of each persistent disk, keyed by (hostname, disk name). The controller backfills the vmdk path, disk UUID, and actually-assigned SCSI unit here instead of writing them back onto spec, and drives reclaim through the per-disk Phase.

Total is the total number of configuration slots defined in the pool.

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

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

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

reason is the reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may be empty.

severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

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

type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

Hostname matches the Hostname in the Spec.

LastReleasedTime is the timestamp when the slot transitioned to Released.

MachineRef is the reference to the Machine currently using this slot.

ReclaimStatus tracks asynchronous reclaim progress for this slot.

State is the allocation state of the slot.

API version of the referent.

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

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

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

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

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

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

LastError stores the latest reclaim task failure.

RetryAfter prevents tight retry loops after reclaim task failures.

State tracks the lifecycle of the reclaim task.

TaskRef tracks the in-flight vCenter reclaim task for this slot.

VolumePath tracks the persistent disk currently being reclaimed.

API version of the referent.

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

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

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

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

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

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

Hostname is the slot this disk belongs to (matches MachineConfigSlot.Hostname).

Name is the disk name (matches EphemeralDisk.Name within the slot).

UnitNumber is the SCSI unit number the disk was attached at, assigned by the controller at clone time and reused on the next VM recreation to keep guest disk addressing stable.

DiskUUID is the disk UUID, backfilled after the disk is created. The guest uses it to identify and mount the disk.

Hostname is the slot this disk belongs to (matches MachineConfigSlot.Hostname).

LastError stores the latest reclaim failure, surfaced when Phase is Error.

LastTransitionTime is the time Phase last changed.

Name is the disk name (matches PersistentDisk.Name within the slot).

OwnerMachineName is the name of the Machine currently owning the disk.

OwnerMachineUID is the UID of the Machine currently owning the disk. It is preserved across VM delete/recreate so a rolling upgrade re-attaches the disk to the rebuilt machine.

Phase is the observed lifecycle of the disk: Creating -> Attached while in use, Attached -> Available when the VM is released, and Available -> Reclaiming -> Reclaimed as the backing is deleted (Error on a failed reclaim, retried after RetryAfter). Reclaimed is a terminal tombstone: the backing is gone but the record is kept so the release-1 migration does not re-seed the disk from spec's frozen VolumePath.

RetryAfter prevents tight retry loops after a failed reclaim task.

TaskRef tracks the in-flight vCenter reclaim task for this disk. CAPV reclaims disks asynchronously, so the task moniker is polled across reconciles (DCS/HCS call their SDKs synchronously and have no equivalent).

UnitNumber is the SCSI unit number the disk was actually attached at. When spec does not pin a UnitNumber, this observed value is reused on the next VM recreation to keep disk ordering stable.

VolumePath is the datastore path to the backing .vmdk, backfilled after the disk is created.

conditions represents the observations of a VSphereMachineConfigPool's current state. Known condition types are Ready, MembersValid, MembersUnique, SlotAvailable, PersistentDisksReady, ClusterRefReady and VCenterAvailable.

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

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

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.

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.

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

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