Chapter 6. Installer-provisioned postinstallation configuration

Procedure

1. Configure the HAProxy Ingress Controller, so that you can enable access to the cluster from your load balancer on ports 6443, 22623, 443, and 80. Depending on your needs, you can specify the IP address of a single subnet or IP addresses from multiple subnets in your HAProxy configuration.

   Example HAProxy configuration with one listed subnet

   # ...
   listen my-cluster-api-6443
       bind 192.168.1.100:6443
       mode tcp
       balance roundrobin
     option httpchk
     http-check connect
     http-check send meth GET uri /readyz
     http-check expect status 200
       server my-cluster-master-2 192.168.1.101:6443 check inter 10s rise 2 fall 2
       server my-cluster-master-0 192.168.1.102:6443 check inter 10s rise 2 fall 2
       server my-cluster-master-1 192.168.1.103:6443 check inter 10s rise 2 fall 2
   
   listen my-cluster-machine-config-api-22623
       bind 192.168.1.100:22623
       mode tcp
       balance roundrobin
     option httpchk
     http-check connect
     http-check send meth GET uri /healthz
     http-check expect status 200
       server my-cluster-master-2 192.168.1.101:22623 check inter 10s rise 2 fall 2
       server my-cluster-master-0 192.168.1.102:22623 check inter 10s rise 2 fall 2
       server my-cluster-master-1 192.168.1.103:22623 check inter 10s rise 2 fall 2
   
   listen my-cluster-apps-443
       bind 192.168.1.100:443
       mode tcp
       balance roundrobin
     option httpchk
     http-check connect
     http-check send meth GET uri /healthz/ready
     http-check expect status 200
       server my-cluster-worker-0 192.168.1.111:443 check port 1936 inter 10s rise 2 fall 2
       server my-cluster-worker-1 192.168.1.112:443 check port 1936 inter 10s rise 2 fall 2
       server my-cluster-worker-2 192.168.1.113:443 check port 1936 inter 10s rise 2 fall 2
   
   listen my-cluster-apps-80
      bind 192.168.1.100:80
      mode tcp
      balance roundrobin
     option httpchk
     http-check connect
     http-check send meth GET uri /healthz/ready
     http-check expect status 200
       server my-cluster-worker-0 192.168.1.111:80 check port 1936 inter 10s rise 2 fall 2
       server my-cluster-worker-1 192.168.1.112:80 check port 1936 inter 10s rise 2 fall 2
       server my-cluster-worker-2 192.168.1.113:80 check port 1936 inter 10s rise 2 fall 2
   # ...

   Copy to Clipboard Toggle word wrap

   Example HAProxy configuration with multiple listed subnets

   # ...
   listen api-server-6443
       bind *:6443
       mode tcp
         server master-00 192.168.83.89:6443 check inter 1s
         server master-01 192.168.84.90:6443 check inter 1s
         server master-02 192.168.85.99:6443 check inter 1s
         server bootstrap 192.168.80.89:6443 check inter 1s
   
   listen machine-config-server-22623
       bind *:22623
       mode tcp
         server master-00 192.168.83.89:22623 check inter 1s
         server master-01 192.168.84.90:22623 check inter 1s
         server master-02 192.168.85.99:22623 check inter 1s
         server bootstrap 192.168.80.89:22623 check inter 1s
   
   listen ingress-router-80
       bind *:80
       mode tcp
       balance source
         server worker-00 192.168.83.100:80 check inter 1s
         server worker-01 192.168.83.101:80 check inter 1s
   
   listen ingress-router-443
       bind *:443
       mode tcp
       balance source
         server worker-00 192.168.83.100:443 check inter 1s
         server worker-01 192.168.83.101:443 check inter 1s
   
   listen ironic-api-6385
       bind *:6385
       mode tcp
       balance source
         server master-00 192.168.83.89:6385 check inter 1s
         server master-01 192.168.84.90:6385 check inter 1s
         server master-02 192.168.85.99:6385 check inter 1s
         server bootstrap 192.168.80.89:6385 check inter 1s
   
   listen inspector-api-5050
       bind *:5050
       mode tcp
       balance source
         server master-00 192.168.83.89:5050 check inter 1s
         server master-01 192.168.84.90:5050 check inter 1s
         server master-02 192.168.85.99:5050 check inter 1s
         server bootstrap 192.168.80.89:5050 check inter 1s
   # ...

   Copy to Clipboard Toggle word wrap

2. Use the curl CLI command to verify that the user-managed load balancer and its resources are operational:

   1. Verify that the cluster machine configuration API is accessible to the Kubernetes API server resource, by running the following command and observing the response:

      $ curl https://<loadbalancer_ip_address>:6443/version --insecure

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, you receive a JSON object in response:

      {
        "major": "1",
        "minor": "11+",
        "gitVersion": "v1.11.0+ad103ed",
        "gitCommit": "ad103ed",
        "gitTreeState": "clean",
        "buildDate": "2019-01-09T06:44:10Z",
        "goVersion": "go1.10.3",
        "compiler": "gc",
        "platform": "linux/amd64"
      }

      Copy to Clipboard Toggle word wrap

   2. Verify that the cluster machine configuration API is accessible to the Machine config server resource, by running the following command and observing the output:

      $ curl -v https://<loadbalancer_ip_address>:22623/healthz --insecure

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, the output from the command shows the following response:

      HTTP/1.1 200 OK
      Content-Length: 0

      Copy to Clipboard Toggle word wrap

   3. Verify that the controller is accessible to the Ingress Controller resource on port 80, by running the following command and observing the output:

      $ curl -I -L -H "Host: console-openshift-console.apps.<cluster_name>.<base_domain>" http://<load_balancer_front_end_IP_address>

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, the output from the command shows the following response:

      HTTP/1.1 302 Found
      content-length: 0
      location: https://console-openshift-console.apps.ocp4.private.opequon.net/
      cache-control: no-cache

      Copy to Clipboard Toggle word wrap

   4. Verify that the controller is accessible to the Ingress Controller resource on port 443, by running the following command and observing the output:

      $ curl -I -L --insecure --resolve console-openshift-console.apps.<cluster_name>.<base_domain>:443:<Load Balancer Front End IP Address> https://console-openshift-console.apps.<cluster_name>.<base_domain>

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, the output from the command shows the following response:

      HTTP/1.1 200 OK
      referrer-policy: strict-origin-when-cross-origin
      set-cookie: csrf-token=UlYWOyQ62LWjw2h003xtYSKlh1a0Py2hhctw0WmV2YEdhJjFyQwWcGBsja261dGLgaYO0nxzVErhiXt6QepA7g==; Path=/; Secure; SameSite=Lax
      x-content-type-options: nosniff
      x-dns-prefetch-control: off
      x-frame-options: DENY
      x-xss-protection: 1; mode=block
      date: Wed, 04 Oct 2023 16:29:38 GMT
      content-type: text/html; charset=utf-8
      set-cookie: 1e2670d92730b515ce3a1bb65da45062=1bf5e9573c9a2760c964ed1659cc1673; path=/; HttpOnly; Secure; SameSite=None
      cache-control: private

      Copy to Clipboard Toggle word wrap

3. Configure the DNS records for your cluster to target the front-end IP addresses of the user-managed load balancer. You must update records to your DNS server for the cluster API and applications over the load balancer.

   Examples of modified DNS records

   <load_balancer_ip_address>  A  api.<cluster_name>.<base_domain>
   A record pointing to Load Balancer Front End

   Copy to Clipboard Toggle word wrap

   <load_balancer_ip_address>   A apps.<cluster_name>.<base_domain>
   A record pointing to Load Balancer Front End

   Copy to Clipboard Toggle word wrap
   Important

   DNS propagation might take some time for each DNS record to become available. Ensure that each DNS record propagates before validating each record.

4. For your OpenShift Container Platform cluster to use the user-managed load balancer, you must specify the following configuration in your cluster’s install-config.yaml file:

   # ...
   platform:
       loadBalancer:
         type: UserManaged 

   1

   
       apiVIPs:
       - <api_ip> 

   2

   
       ingressVIPs:
       - <ingress_ip> 

   3

   
   # ...

   Copy to Clipboard Toggle word wrap

   1

   Set UserManaged for the type parameter to specify a user-managed load balancer for your cluster. The parameter defaults to OpenShiftManagedDefault, which denotes the default internal load balancer. For services defined in an openshift-kni-infra namespace, a user-managed load balancer can deploy the coredns service to pods in your cluster but ignores keepalived and haproxy services.

   2

   Required parameter when you specify a user-managed load balancer. Specify the user-managed load balancer’s public IP address, so that the Kubernetes API can communicate with the user-managed load balancer.

   3

   Required parameter when you specify a user-managed load balancer. Specify the user-managed load balancer’s public IP address, so that the user-managed load balancer can manage ingress traffic for your cluster.

Verification

1. Use the curl CLI command to verify that the user-managed load balancer and DNS record configuration are operational:

   1. Verify that you can access the cluster API, by running the following command and observing the output:

      $ curl https://api.<cluster_name>.<base_domain>:6443/version --insecure

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, you receive a JSON object in response:

      {
        "major": "1",
        "minor": "11+",
        "gitVersion": "v1.11.0+ad103ed",
        "gitCommit": "ad103ed",
        "gitTreeState": "clean",
        "buildDate": "2019-01-09T06:44:10Z",
        "goVersion": "go1.10.3",
        "compiler": "gc",
        "platform": "linux/amd64"
        }

      Copy to Clipboard Toggle word wrap

   2. Verify that you can access the cluster machine configuration, by running the following command and observing the output:

      $ curl -v https://api.<cluster_name>.<base_domain>:22623/healthz --insecure

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, the output from the command shows the following response:

      HTTP/1.1 200 OK
      Content-Length: 0

      Copy to Clipboard Toggle word wrap

   3. Verify that you can access each cluster application on port, by running the following command and observing the output:

      $ curl http://console-openshift-console.apps.<cluster_name>.<base_domain> -I -L --insecure

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, the output from the command shows the following response:

      HTTP/1.1 302 Found
      content-length: 0
      location: https://console-openshift-console.apps.<cluster-name>.<base domain>/
      cache-control: no-cacheHTTP/1.1 200 OK
      referrer-policy: strict-origin-when-cross-origin
      set-cookie: csrf-token=39HoZgztDnzjJkq/JuLJMeoKNXlfiVv2YgZc09c3TBOBU4NI6kDXaJH1LdicNhN1UsQWzon4Dor9GWGfopaTEQ==; Path=/; Secure
      x-content-type-options: nosniff
      x-dns-prefetch-control: off
      x-frame-options: DENY
      x-xss-protection: 1; mode=block
      date: Tue, 17 Nov 2020 08:42:10 GMT
      content-type: text/html; charset=utf-8
      set-cookie: 1e2670d92730b515ce3a1bb65da45062=9b714eb87e93cf34853e87a92d6894be; path=/; HttpOnly; Secure; SameSite=None
      cache-control: private

      Copy to Clipboard Toggle word wrap

   4. Verify that you can access each cluster application on port 443, by running the following command and observing the output:

      $ curl https://console-openshift-console.apps.<cluster_name>.<base_domain> -I -L --insecure

      Copy to Clipboard Toggle word wrap

      If the configuration is correct, the output from the command shows the following response:

      HTTP/1.1 200 OK
      referrer-policy: strict-origin-when-cross-origin
      set-cookie: csrf-token=UlYWOyQ62LWjw2h003xtYSKlh1a0Py2hhctw0WmV2YEdhJjFyQwWcGBsja261dGLgaYO0nxzVErhiXt6QepA7g==; Path=/; Secure; SameSite=Lax
      x-content-type-options: nosniff
      x-dns-prefetch-control: off
      x-frame-options: DENY
      x-xss-protection: 1; mode=block
      date: Wed, 04 Oct 2023 16:29:38 GMT
      content-type: text/html; charset=utf-8
      set-cookie: 1e2670d92730b515ce3a1bb65da45062=1bf5e9573c9a2760c964ed1659cc1673; path=/; HttpOnly; Secure; SameSite=None
      cache-control: private

      Copy to Clipboard Toggle word wrap

1. The BareMetalHost spec
2. The BareMetalHost status

Procedure

1. Get the list of BareMetalHost resources:

   $ oc get bmh -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap
   Note

   You can use baremetalhost as the long form of bmh with oc get command.

2. Get the list of hosts:

   $ oc get bmh -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

3. Get the BareMetalHost resource for a specific host:

   $ oc get bmh <host_name> -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap

   Where <host_name> is the name of the host.

   Example output

   apiVersion: metal3.io/v1alpha1
   kind: BareMetalHost
   metadata:
     creationTimestamp: "2022-06-16T10:48:33Z"
     finalizers:
     - baremetalhost.metal3.io
     generation: 2
     name: openshift-worker-0
     namespace: openshift-machine-api
     resourceVersion: "30099"
     uid: 1513ae9b-e092-409d-be1b-ad08edeb1271
   spec:
     automatedCleaningMode: metadata
     bmc:
       address: redfish://10.46.61.19:443/redfish/v1/Systems/1
       credentialsName: openshift-worker-0-bmc-secret
       disableCertificateVerification: true
     bootMACAddress: 48:df:37:c7:f7:b0
     bootMode: UEFI
     consumerRef:
       apiVersion: machine.openshift.io/v1beta1
       kind: Machine
       name: ocp-edge-958fk-worker-0-nrfcg
       namespace: openshift-machine-api
     customDeploy:
       method: install_coreos
     online: true
     rootDeviceHints:
       deviceName: /dev/disk/by-id/scsi-<serial_number>
     userData:
       name: worker-user-data-managed
       namespace: openshift-machine-api
   status:
     errorCount: 0
     errorMessage: ""
     goodCredentials:
       credentials:
         name: openshift-worker-0-bmc-secret
         namespace: openshift-machine-api
       credentialsVersion: "16120"
     hardware:
       cpu:
         arch: x86_64
         clockMegahertz: 2300
         count: 64
         flags:
         - 3dnowprefetch
         - abm
         - acpi
         - adx
         - aes
         model: Intel(R) Xeon(R) Gold 5218 CPU @ 2.30GHz
       firmware:
         bios:
           date: 10/26/2020
           vendor: HPE
           version: U30
       hostname: openshift-worker-0
       nics:
       - mac: 48:df:37:c7:f7:b3
         model: 0x8086 0x1572
         name: ens1f3
       ramMebibytes: 262144
       storage:
       - hctl: "0:0:0:0"
         model: VK000960GWTTB
         name: /dev/disk/by-id/scsi-<serial_number>
         sizeBytes: 960197124096
         type: SSD
         vendor: ATA
       systemVendor:
         manufacturer: HPE
         productName: ProLiant DL380 Gen10 (868703-B21)
         serialNumber: CZ200606M3
     lastUpdated: "2022-06-16T11:41:42Z"
     operationalStatus: OK
     poweredOn: true
     provisioning:
       ID: 217baa14-cfcf-4196-b764-744e184a3413
       bootMode: UEFI
       customDeploy:
         method: install_coreos
       image:
         url: ""
       raid:
         hardwareRAIDVolumes: null
         softwareRAIDVolumes: []
       rootDeviceHints:
         deviceName: /dev/disk/by-id/scsi-<serial_number>
       state: provisioned
     triedCredentials:
       credentials:
         name: openshift-worker-0-bmc-secret
         namespace: openshift-machine-api
       credentialsVersion: "16120"

   Copy to Clipboard Toggle word wrap

Procedure

1. Get the list of nodes:

   $ oc get bmh -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

2. Before editing the node’s BareMetalHost resource, detach the node from Ironic by running the following command:

   $ oc annotate baremetalhost <node_name> -n openshift-machine-api 'baremetalhost.metal3.io/detached=true' 

   1

   Copy to Clipboard Toggle word wrap

   1

   Replace <node_name> with the name of the node.

3. Edit the BareMetalHost resource by running the following command:

   $ oc edit bmh <node_name> -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

4. Reattach the node to Ironic by running the following command:

   $ oc annotate baremetalhost <node_name> -n openshift-machine-api 'baremetalhost.metal3.io/detached'-

   Copy to Clipboard Toggle word wrap

Procedure

1. If the cleaning process fails and restarts, wait for it to finish. This might take about 5 minutes.
2. If the provisioning status remains in the deleting state, disable the cleaning process by modifying the BareMetalHost resource and setting the automatedCleaningMode field to disabled.

Procedure

1. Create a DataImage resource:

   apiVersion: metal3.io/v1alpha1
   kind: DataImage
   metadata:
     name: <node_name> 

   1

   
   spec:
     url: "http://dataimage.example.com/non-bootable.iso" 

   2

   Copy to Clipboard Toggle word wrap

   1

   Specify the name of the node as defined in its BareMetalHost resource.

   2

   Specify the URL and path to the ISO image.

2. Save the DataImage resource to a file by running the following command:

   $ vim <node_name>-dataimage.yaml

   Copy to Clipboard Toggle word wrap

3. Apply the DataImage resource by running the following command:

   $ oc apply -f <node_name>-dataimage.yaml -n <node_namespace> 

   1

   Copy to Clipboard Toggle word wrap

   1

   Replace <node_namespace> so that the namespace matches the namespace for the BareMetalHost resource. For example, openshift-machine-api.

4. Reboot the node.

   Note

   To reboot the node, attach the reboot.metal3.io annotation, or reset set the online status in the BareMetalHost resource. A forced reboot of the bare-metal node will change the state of the node to NotReady for awhile. For example, 5 minutes or more.

5. View the DataImage resource by running the following command:

   $ oc get dataimage <node_name> -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap

   Example output

   apiVersion: v1
   items:
   - apiVersion: metal3.io/v1alpha1
     kind: DataImage
     metadata:
       annotations:
         kubectl.kubernetes.io/last-applied-configuration: |
           {"apiVersion":"metal3.io/v1alpha1","kind":"DataImage","metadata":{"annotations":{},"name":"bmh-node-1","namespace":"openshift-machine-api"},"spec":{"url":"http://dataimage.example.com/non-bootable.iso"}}
       creationTimestamp: "2024-06-10T12:00:00Z"
       finalizers:
       - dataimage.metal3.io
       generation: 1
       name: bmh-node-1
       namespace: openshift-machine-api
       ownerReferences:
       - apiVersion: metal3.io/v1alpha1
         blockOwnerDeletion: true
         controller: true
         kind: BareMetalHost
         name: bmh-node-1
         uid: 046cdf8e-0e97-485a-8866-e62d20e0f0b3
       resourceVersion: "21695581"
       uid: c5718f50-44b6-4a22-a6b7-71197e4b7b69
     spec:
       url: http://dataimage.example.com/non-bootable.iso
     status:
       attachedImage:
         url: http://dataimage.example.com/non-bootable.iso
       error:
         count: 0
         message: ""
       lastReconciled: "2024-06-10T12:05:00Z"

   Copy to Clipboard Toggle word wrap

1. The HostFirmwareSettings spec.
2. The HostFirmwareSettings status.

Procedure

1. Get the detailed list of HostFirmwareSettings resources:

   $ oc get hfs -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap
   Note

   You can use hostfirmwaresettings as the long form of hfs with the oc get command.

2. Get the list of HostFirmwareSettings resources:

   $ oc get hfs -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

3. Get the HostFirmwareSettings resource for a particular host

   $ oc get hfs <host_name> -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap

   Where <host_name> is the name of the host.

Procedure

1. Get the list of HostFirmwareSettings resources:

   $ oc get hfs -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

2. Edit a host’s HostFirmwareSettings resource:

   $ oc edit hfs <host_name> -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

   Where <host_name> is the name of a provisioned host. The HostFirmwareSettings resource will open in the default editor for your terminal.

3. Add name/value pairs to the spec.settings section:

   Example

   spec:
     settings:
       name: value 

   1

   Copy to Clipboard Toggle word wrap

   1

   Use the FirmwareSchema resource to identify the available settings for the host. You cannot set values that are read-only.

4. Save the changes and exit the editor.

5. Get the host’s machine name:

    $ oc get bmh <host_name> -n openshift-machine name

   Copy to Clipboard Toggle word wrap

   Where <host_name> is the name of the host. The machine name appears under the CONSUMER field.

6. Annotate the machine to delete it from the machineset:

   $ oc annotate machine <machine_name> machine.openshift.io/delete-machine=true -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

   Where <machine_name> is the name of the machine to delete.

7. Get a list of nodes and count the number of worker nodes:

   $ oc get nodes

   Copy to Clipboard Toggle word wrap

8. Get the machineset:

   $ oc get machinesets -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

9. Scale the machineset:

   $ oc scale machineset <machineset_name> -n openshift-machine-api --replicas=<n-1>

   Copy to Clipboard Toggle word wrap

   Where <machineset_name> is the name of the machineset and <n-1> is the decremented number of worker nodes.

10. When the host enters the Available state, scale up the machineset to make the HostFirmwareSettings resource changes take effect:

    $ oc scale machineset <machineset_name> -n openshift-machine-api --replicas=<n>

    Copy to Clipboard Toggle word wrap

    Where <machineset_name> is the name of the machineset and <n> is the number of worker nodes.

Procedure

1. Get a list of HostFirmwareSetting resources:

   $ oc get hfs -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

2. Verify that the HostFirmwareSettings resource for a particular host is valid:

   $ oc describe hfs <host_name> -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

   Where <host_name> is the name of the host.

   Example output

   Events:
     Type    Reason            Age    From                                    Message
     ----    ------            ----   ----                                    -------
     Normal  ValidationFailed  2m49s  metal3-hostfirmwaresettings-controller  Invalid BIOS setting: Setting ProcTurboMode is invalid, unknown enumeration value - Foo

   Copy to Clipboard Toggle word wrap

   Important

   If the response returns ValidationFailed, there is an error in the resource configuration and you must update the values to conform to the FirmwareSchema resource.

Procedure

1. To get a list of FirmwareSchema resource instances, execute the following:

   $ oc get firmwareschema -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

2. To get a particular FirmwareSchema instance, execute:

   $ oc get firmwareschema <instance_name> -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap

   Where <instance_name> is the name of the schema instance stated in the HostFirmwareSettings resource (see Table 3).

1. The HostFirmwareComponents spec
2. The HostFirmwareComponents status

Procedure

1. Get the detailed list of HostFirmwareComponents resources:

   $ oc get hostfirmwarecomponents -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap

2. Get the list of HostFirmwareComponents resources:

   $ oc get hostfirmwarecomponents -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

3. Get the HostFirmwareComponents resource for a particular host:

   $ oc get hostfirmwarecomponents <host_name> -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap

   Where <host_name> is the name of the host.

   Example output

   ---
   apiVersion: metal3.io/v1alpha1
   kind: HostFirmwareComponents
   metadata:
     creationTimestamp: 2024-04-25T20:32:06Z"
     generation: 1
     name: ostest-master-2
     namespace: openshift-machine-api
     ownerReferences:
     - apiVersion: metal3.io/v1alpha1
       blockOwnerDeletion: true
       controller: true
       kind: BareMetalHost
       name: ostest-master-2
       uid: 16022566-7850-4dc8-9e7d-f216211d4195
     resourceVersion: "2437"
     uid: 2038d63f-afc0-4413-8ffe-2f8e098d1f6c
   spec:
     updates: []
   status:
     components:
     - component: bios
       currentVersion: 1.0.0
       initialVersion: 1.0.0
     - component: bmc
       currentVersion: "1.00"
       initialVersion: "1.00"
     conditions:
     - lastTransitionTime: "2024-04-25T20:32:06Z"
       message: ""
       observedGeneration: 1
       reason: OK
       status: "True"
       type: Valid
     - lastTransitionTime: "2024-04-25T20:32:06Z"
       message: ""
       observedGeneration: 1
       reason: OK
       status: "False"
       type: ChangeDetected
     lastUpdated: "2024-04-25T20:32:06Z"
     updates: []

   Copy to Clipboard Toggle word wrap

Procedure

1. Get the detailed list of HostFirmwareComponents resources:

   $ oc get hostfirmwarecomponents -n openshift-machine-api -o yaml

   Copy to Clipboard Toggle word wrap

2. Edit a host’s HostFirmwareComponents resource:

   $ oc edit <host_name> hostfirmwarecomponents -n openshift-machine-api 

   1

   Copy to Clipboard Toggle word wrap

   1

   Where <host_name> is the name of the host. The HostFirmwareComponents resource will open in the default editor for your terminal.

   Example output

   ---
   apiVersion: metal3.io/v1alpha1
   kind: HostFirmwareComponents
   metadata:
     creationTimestamp: 2024-04-25T20:32:06Z"
     generation: 1
     name: ostest-master-2
     namespace: openshift-machine-api
     ownerReferences:
     - apiVersion: metal3.io/v1alpha1
       blockOwnerDeletion: true
       controller: true
       kind: BareMetalHost
       name: ostest-master-2
       uid: 16022566-7850-4dc8-9e7d-f216211d4195
     resourceVersion: "2437"
     uid: 2038d63f-afc0-4413-8ffe-2f8e098d1f6c
   spec:
     updates:
       - name: bios 

   1

   
         url: https://myurl.with.firmware.for.bios 

   2

   
       - name: bmc 

   3

   
         url: https://myurl.with.firmware.for.bmc 

   4

   
   status:
     components:
     - component: bios
       currentVersion: 1.0.0
       initialVersion: 1.0.0
     - component: bmc
       currentVersion: "1.00"
       initialVersion: "1.00"
     conditions:
     - lastTransitionTime: "2024-04-25T20:32:06Z"
       message: ""
       observedGeneration: 1
       reason: OK
       status: "True"
       type: Valid
     - lastTransitionTime: "2024-04-25T20:32:06Z"
       message: ""
       observedGeneration: 1
       reason: OK
       status: "False"
       type: ChangeDetected
     lastUpdated: "2024-04-25T20:32:06Z"

   Copy to Clipboard Toggle word wrap

   1

   To set a BIOS version, set the name attribute to bios.

   2

   To set a BIOS version, set the url attribute to the URL for the firmware version of the BIOS.

   3

   To set a BMC version, set the name attribute to bmc.

   4

   To set a BMC version, set the url attribute to the URL for the firmware verison of the BMC.

3. Save the changes and exit the editor.

4. Get the host’s machine name:

   $ oc get bmh <host_name> -n openshift-machine name 

   1

   Copy to Clipboard Toggle word wrap

   1

   Where <host_name> is the name of the host. The machine name appears under the CONSUMER field.

5. Annotate the machine to delete it from the machine set:

   $ oc annotate machine <machine_name> machine.openshift.io/delete-machine=true -n openshift-machine-api 

   1

   Copy to Clipboard Toggle word wrap

   1

   Where <machine_name> is the name of the machine to delete.

6. Get a list of nodes and count the number of worker nodes:

   $ oc get nodes

   Copy to Clipboard Toggle word wrap

7. Get the machine set:

   $ oc get machinesets -n openshift-machine-api

   Copy to Clipboard Toggle word wrap

8. Scale the machine set:

   $ oc scale machineset <machineset_name> -n openshift-machine-api --replicas=<n-1> 

   1

   Copy to Clipboard Toggle word wrap

   1

   Where <machineset_name> is the name of the machine set and <n-1> is the decremented number of worker nodes.

9. When the host enters the Available state, scale up the machine set to make the HostFirmwareComponents resource changes take effect:

   $ oc scale machineset <machineset_name> -n openshift-machine-api --replicas=<n> 

   1

   Copy to Clipboard Toggle word wrap

   1

   Where <machineset_name> is the name of the machine set and <n> is the number of worker nodes.