This is a cache of https://docs.okd.io/4.19/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-bare-metal.html. It is a snapshot of the page at 2025-07-01T20:47:42.977+0000.
Cluster <strong>api</strong> configuration options for bare metal - Managing machines with the Cluster <strong>api</strong> | Machine management | OKD 4.19
  1. Documentation
×

Cluster api configuration options for bare metal

You can change the configuration of your bare metal Cluster api machines by updating values in the Cluster api custom resource manifests.

Managing machines with the Cluster api is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

Sample YAML for configuring bare metal clusters

The following example YAML files show configurations for a bare metal cluster.

Sample YAML for a Cluster api machine template resource on bare metal

The machine template resource is provider-specific and defines the basic properties of the machines that a compute machine set creates. The compute machine set references this template when creating machines.

apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: Metal3MachineTemplate (1)
metadata:
  name: <template_name>  (2)
  namespace: openshift-cluster-api
spec:
  template:
    spec: (3)
      customDeploy: install_coreos
      userData:
        name: worker-user-data-managed (4)
1 Specify the machine template kind. This value must match the value for your platform.
2 Specify a name for the machine template.
3 Specify the details for your environment. The values here are examples.
4 The userData parameter refers to the Ignition configuration, which the Machine api Operator generates during installation. You must apply the openshift-cluster-api namespace to ensure the cluster can access the secret by running the following command: 
$ oc get secret worker-user-data-managed \
  -n openshift-machine-api -o yaml | \
  sed 's/namespace: .*/namespace: openshift-cluster-api/' | oc apply -f -

Sample YAML for a Cluster api compute machine set resource on bare metal

The compute machine set resource defines additional properties of the machines that it creates. The compute machine set also references the cluster resource and machine template when creating machines.

apiVersion: cluster.x-k8s.io/v1beta1
kind: MachineSet
metadata:
  name: <machine_set_name> (1)
  namespace: openshift-cluster-api
  labels:
    cluster.x-k8s.io/cluster-name: <cluster_name> (2)
spec:
  clusterName: <cluster_name>
  replicas: 1
  selector:
    matchLabels:
      test: example
      cluster.x-k8s.io/cluster-name: <cluster_name>
      cluster.x-k8s.io/set-name: <machine_set_name>
  template:
    metadata:
      labels:
        test: example
        cluster.x-k8s.io/cluster-name: <cluster_name>
        cluster.x-k8s.io/set-name: <machine_set_name>
        node-role.kubernetes.io/worker: ""
    spec:
      bootstrap:
         dataSecretName: worker-user-data-managed
      clusterName: <cluster_name>
      infrastructureRef:
        apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
        kind: Metal3MachineTemplate (3)
        name: <template_name> (4)
1 Specify a name for the compute machine set. The cluster ID, machine role, and region form a typical pattern for this value in the following format: <cluster_name>-<role>-<region>.
2 Specify the cluster ID as the name of the cluster.
3 Specify the machine template kind. This value must match the value for your platform.
4 Specify the machine template name.