Add a bare metal host

Before creating a bare metal managed cluster, add the required number of bare metal hosts using CLI and YAML files for configuration. This section describes how to add bare metal hosts using the Container Cloud CLI during a managed cluster creation.

To add a bare metal host:

  1. Verify that you configured each bare metal host as follows:

    • Enable the boot NIC support for UEFI load. Usually, at least the built-in network interfaces support it.

    • Enable the UEFI-LAN-OPROM support in BIOS -> Advanced -> PCIPCIe.

    • Enable the IPv4-PXE stack.

    • Set the following boot order:

      1. UEFI-DISK

      2. UEFI-PXE

    • If your PXE network is not configured to use the first network interface, fix the UEFI-PXE boot order to speed up node discovering by selecting only one required network interface.

    • Power off all bare metal hosts.

    Warning

    Only one Ethernet port on a host must be connected to the Common/PXE network at any given time. The physical address (MAC) of this interface must be noted and used to configure the BareMetalHost object describing the host.

  2. Log in to the host where your management cluster kubeconfig is located and where kubectl is installed.

  3. Describe the unique credentials of the new bare metal host:

    Create a YAML file that describes the unique credentials of the new bare metal host as a BareMetalHostCredential object.

    apiVersion: kaas.mirantis.com/v1alpha1
kind: BareMetalHostCredential
metadata:
  labels:
    kaas.mirantis.com/provider: baremetal
    kaas.mirantis.com/region: region-one
  name: <bare-metal-host-credential-unique-name>
  namespace: <managed-cluster-project-name>
spec:
  username: <ipmi-user-name>
  password:
    value: <ipmi-user-password>

    • In the metadata section, add a unique credentials name and the name of the non-default project (namespace) dedicated for the managed cluster being created.

    • In the spec section, add the IPMI user name and password in plain text to access the Baseboard Management Controller (BMC). The password will not be stored in the BareMetalHostCredential object but will be erased and saved in an underlying Secret object.

    Caution

    Each bare metal host must have a unique BareMetalHostCredential. For details about the BareMetalHostCredential object, refer to Mirantis Container Cloud API Reference: BareMetalHostCredential.

    Note

    The kaas.mirantis.com/region label is removed from all Container Cloud and MOSK objects in 24.1.

    Therefore, do not add the label starting with these releases. On existing clusters updated to these releases, or if added manually, Container Cloud ignores this label.

    Create a secret YAML file that describes the unique credentials of the new bare metal host. Example of the bare metal host secret:

    apiVersion: v1
data:
  password: <credentials-password>
  username: <credentials-user-name>
kind: Secret
metadata:
  labels:
    kaas.mirantis.com/credentials: "true"
    kaas.mirantis.com/provider: baremetal
    kaas.mirantis.com/region: region-one
  name: <credentials-name>
  namespace: <managed-cluster-project-name>
type: Opaque

    • In the data section, add the IPMI user name and password in the base64 encoding to access the BMC. To obtain the base64-encoded credentials, you can use the following command in your Linux console:

      echo -n <username|password> | base64

      Caution

      Each bare metal host must have a unique Secret.

    • In the metadata section, add the unique name of credentials and the name of the non-default project (namespace) dedicated for the managed cluster being created. To create a project, refer to Mirantis Container Cloud Operations Guide: Create a project for managed clusters.

  4. Apply this secret YAML file to your deployment:

    kubectl apply -f ${<bmh-cred-file-name>}.yaml

  5. Create a YAML file that contains a description of the new bare metal host:

    apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  annotations:
    kaas.mirantis.com/baremetalhost-credentials-name: <bare-metal-host-credential-unique-name>
  labels:
    kaas.mirantis.com/baremetalhost-id: <unique-bare-metal-host-hardware-node-id>
    hostlabel.bm.kaas.mirantis.com/worker: "true"
    kaas.mirantis.com/provider: baremetal
    kaas.mirantis.com/region: region-one
  name: <bare-metal-host-unique-name>
  namespace: <managed-cluster-project-name>
spec:
  bmc:
    address: <ip-address-for-bmc-access>
    credentialsName: <credentials-name>
  bootMACAddress: <bare-metal-host-boot-mac-address>
  online: true

    Note

    The kaas.mirantis.com/region label is removed from all Container Cloud and MOSK objects in 24.1.

    Therefore, do not add the label starting with these releases. On existing clusters updated to these releases, or if added manually, Container Cloud ignores this label.

    apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  labels:
    kaas.mirantis.com/baremetalhost-id: <unique-bare-metal-host-hardware-node-id>
    hostlabel.bm.kaas.mirantis.com/worker: "true"
    kaas.mirantis.com/provider: baremetal
    kaas.mirantis.com/region: region-one
  name: <bare-metal-host-unique-name>
  namespace: <managed-cluster-project-name>
spec:
  bmc:
    address: <ip-address-for-bmc-access>
    credentialsName: <credentials-name>
  bootMACAddress: <bare-metal-host-boot-mac-address>
  online: true

    For a detailed fields description, see Mirantis Container Cloud API Reference: BareMetalHost.

  6. Apply this configuration YAML file to your deployment:

    kubectl create -f ${<bare-metal-host-config-file-name>}.yaml

  7. Verify the new BareMetalHost object status:

    kubectl get -n <managed-cluster-project-name> bmh -o wide <bare-metal-host-unique-name>

    Example of system response:

    NAMESPACE    NAME   STATUS   STATE      CONSUMER  BMC                        BOOTMODE  ONLINE  ERROR  REGION
my-project   bmh1   OK       preparing            ip-address-for-bmc-access  legacy    true           region-one

    During provisioning, the status changes as follows:

    1. registering

    2. inspecting

    3. preparing

  8. After BareMetalHost switches to the preparing stage, the inspecting phase finishes and you can verify that hardware information is available in the object status and matches the MOSK cluster hardware requirements.

    For example:

    • Verify the status of hardware NICs:

      kubectl -n <managed-cluster-project-name> get bmh -o yaml <bare-metal-host-unique-name> -o json |  jq -r '[.status.hardware.nics]'

      Example of system response:

      [
  [
    {
      "ip": "172.18.171.32",
      "mac": "ac:1f:6b:02:81:1a",
      "model": "0x8086 0x1521",
      "name": "eno1",
      "pxe": true
    },
    {
      "ip": "fe80::225:90ff:fe33:d5ac%ens1f0",
      "mac": "00:25:90:33:d5:ac",
      "model": "0x8086 0x10fb",
      "name": "ens1f0"
    },
 ...

    • Verify the status of RAM:

      kubectl -n <managed-cluster-project-name> get bmh -o yaml <bare-metal-host-unique-name> -o json |  jq -r '[.status.hardware.ramMebibytes]'

      Example of system response:

      [
  98304
]

Now, proceed with Create a custom bare metal host profile.