VsphereAgentPool

Mon, 01 Jan 0001 00:00:00 +0000

The API specification can be viewed here.

VsphereAgentPool is a namespace-scoped bridge between one HyperShift Agent NodePool and vSphere VM inventory.

HyperShift and CAPI remain authoritative. The operator reacts to AgentMachine objects that report Ready=False with Reason=NoSuitableAgents by ensuring enough matching Assisted Installer Agent objects can exist.

Example

apiVersion: agent-forge.containeroo.ch/v1alpha1
kind: VsphereAgentPool
metadata:
  name: demo-worker
  namespace: demo
spec:
  hostedClusterRef:
    name: demo
  nodePoolRef:
    name: demo-worker
  infraEnvRef:
    name: demo
  controlPlaneNamespace: demo-demo
  cleanupPolicy: Delete
  vsphere:
    credentialsSecretRef:
      name: vsphere-credentials
    datacenter: dc1
    datastoreCluster: workload-datastore-cluster
    isoDatastore: iso-datastore
    resourcePool: cluster/Resources
    folder: demo
    network: VM Network
  template:
    namePrefix: demo-worker
    numCPUs: 4
    memoryMiB: 16384
    diskGiB: 100
  agent:
    role: worker
    approve: true
    labels:
      hypershift.openshift.io/nodepool-role: worker
      customer: example
  iso:
    checkInterval: 10m
    retainVersions: 2
    pathPrefix: agent-forge/demo/demo-worker

Required spec fields

Field	Description
`spec.hostedClusterRef.name`	HostedCluster name in the same namespace as this resource.
`spec.nodePoolRef.name`	HyperShift NodePool name in the same namespace as this resource.
`spec.infraEnvRef.name`	Assisted Installer InfraEnv name in the same namespace.
`spec.controlPlaneNamespace`	Hosted control plane namespace containing CAPI `AgentMachine` and `Machine` objects.
`spec.vsphere.credentialsSecretRef.name`	Secret containing vSphere `server`, `username`, and `password`.
`spec.vsphere.datastoreCluster`	Datastore cluster for VM disks.
`spec.vsphere.isoDatastore`	Datastore for cached discovery ISOs.
`spec.vsphere.resourcePool`	Resource pool path, for example `cluster/Resources`.
`spec.vsphere.network`	vSphere network attached to the VM NIC.
`spec.agent.labels`	Labels required on discovered Agents. These should match the NodePool Agent selector.

Important optional spec fields

Field	Description
`spec.vsphere.credentialsSecretRef.namespace`	Secret namespace. Defaults to the resource namespace.
`spec.vsphere.datacenter`	vSphere datacenter name. Defaults to `dc1`.
`spec.vsphere.folder`	VM folder path. Defaults logically to the hosted cluster name when empty.
`spec.vsphere.vmTags`	Optional vSphere tag IDs to attach to created VMs.
`spec.vsphere.guestID`	Guest OS identifier. Defaults to `rhel9_64Guest`.
`spec.vsphere.scsiType`	SCSI controller type. Defaults to `pvscsi`.
`spec.vsphere.firmware`	VM firmware, `efi` or `bios`. Defaults to `efi`.
`spec.vsphere.networkAdapterType`	NIC adapter type. Defaults to `vmxnet3`.
`spec.template.namePrefix`	Prefix for operator-created VM names.
`spec.template.numCPUs`	VM vCPU count. Defaults to `4`.
`spec.template.memoryMiB`	VM memory in MiB. Defaults to `16384`.
`spec.template.diskGiB`	Primary disk size in GiB. Defaults to `100`.
`spec.agent.role`	Value for `hypershift.openshift.io/nodepool-role`. Defaults to `worker`.
`spec.agent.approve`	When true, patch matching Agents with `spec.approved=true`. Defaults to `true`.
`spec.iso.checkInterval`	How often to download and hash the InfraEnv ISO. Defaults to `10m`.
`spec.iso.retainVersions`	Number of content-addressed ISO objects to keep. Defaults to `2`.
`spec.iso.pathPrefix`	Datastore directory for cached ISO objects.
`spec.cleanupPolicy`	`Delete` removes stale owned VMs and unbound Agents. `Retain` leaves them in place. Defaults to `Delete`.

Status

VsphereAgentPool.status reports observed AgentMachine demand, matching Agent capacity, owned VM identities, active ISO cache state, planned actions, and conditions.

VsphereAgent

Mon, 01 Jan 0001 00:00:00 +0000

The API specification can be viewed here.

VsphereAgent represents one vSphere VM requested to satisfy AgentMachine demand.

Most users do not create VsphereAgent resources manually. The AgentMachine controller creates one VsphereAgent for each waiting AgentMachine when the selected VsphereAgentPool needs additional capacity.

Example

apiVersion: agent-forge.containeroo.ch/v1alpha1
kind: VsphereAgent
metadata:
  name: demo-worker-abc12
  namespace: demo
spec:
  poolRef:
    name: demo-worker

Spec

Field	Description
`spec.poolRef.name`	Name of the `VsphereAgentPool` whose configuration is used to create and manage the VM.

Status

Field	Description
`status.observedGeneration`	Latest resource generation reconciled by the controller.
`status.vm.name`	vSphere VM name.
`status.vm.biosUUID`	VM BIOS UUID when known.
`status.vm.macAddress`	Primary NIC MAC address when known.
`status.vm.agentRef`	Discovered Assisted Installer Agent matched to this VM.
`status.vm.machineRef`	CAPI Machine paired with this VM when bound.
`status.vm.phase`	VM lifecycle phase such as `Provisioning`, `Available`, `Bound`, `Released`, or `Orphaned`.
`status.conditions`	Readiness and provider errors.

When a VsphereAgent is deleted, its finalizer deletes the paired vSphere VM unless the owning VsphereAgentPool uses spec.cleanupPolicy: Retain.

Resources on contineroo.ch

VsphereAgentPool

Example

Required spec fields

Important optional spec fields

Status

VsphereAgent

Example

Spec

Status