Chapter 4. Configuring the Bare Metal Provisioning service after deployment

Procedure

1. Log in to the node that hosts the Networking service (neutron) as the root user.

2. Source your overcloud credentials file:

   # source ~/<credentials_file>

   • Replace <credentials_file> with the name of your credentials file, for example, overcloudrc.

3. Create the flat network over which to provision bare-metal instances:

   # openstack network create \
     --provider-network-type flat \
     --provider-physical-network <provider_physical_network> \
     --share <network_name>

   • Replace <provider_physical_network> with the name of the physical network over which you implement the virtual network, which is configured with the parameter NeutronBridgeMappings in your network-environment.yaml file.
   • Replace <network_name> with a name for this network.

4. Create the subnet on the flat network:

   # openstack subnet create \
     --network <network_name> \
     --subnet-range <network_cidr> \
     --ip-version 4 \
     --gateway <gateway_ip> \
     --allocation-pool start=<start_ip>,end=<end_ip> \
     --dhcp <subnet_name>

   • Replace <network_name> with the name of the provisioning network that you created in the previous step.
   • Replace <network_cidr> with the Classless Inter-Domain Routing (CIDR) representation of the block of IP addresses that the subnet represents. The block of IP addresses that you specify in the range starting with <start_ip> and ending with <end_ip> must be within the block of IP addresses specified by <network_cidr>.
   • Replace <gateway_ip> with the IP address or host name of the router interface that acts as the gateway for the new subnet. This address must be within the block of IP addresses specified by <network_cidr>, but outside of the block of IP addresses specified by the range that starts with <start_ip> and ends with <end_ip>.
   • Replace <start_ip> with the IP address that denotes the start of the range of IP addresses within the new subnet from which floating IP addresses are allocated.
   • Replace <end_ip> with the IP address that denotes the end of the range of IP addresses within the new subnet from which floating IP addresses are allocated.
   • Replace <subnet_name> with a name for the subnet.

5. Create a router for the network and subnet to ensure that the Networking service serves metadata requests:

   # openstack router create <router_name>

   • Replace <router_name> with a name for the router.

6. Attach the subnet to the new router to enable the metadata requests from cloud-init to be served and the node to be configured: :

   # openstack router add subnet <router_name> <subnet>

   • Replace <router_name> with the name of your router.
   • Replace <subnet> with the ID or name of the bare-metal subnet that you created in the step 4.

Procedure

1. Log in to the undercloud host.

2. Source your overcloud credentials file:

   $ source ~/<credentials_file>

   • Replace <credentials_file> with the name of your credentials file, for example, overcloudrc.

3. Retrieve the UUID for the provider network that hosts the Bare Metal Provisioning service:

   (overcloud)$ openstack network show <network_name> -f value -c id

   • Replace <network_name> with the name of the provider network that you want to use for the bare-metal instance provisioning network.
4. Open your local environment file that configures the Bare Metal Provisioning service for your deployment, for example, ironic-overrides.yaml.

5. Configure the network to use as the bare-metal instance provisioning network:

   parameter_defaults:
     IronicProvisioningNetwork: <network_uuid>

   • Replace <network_uuid> with the UUID of the provider network retrieved in step 3.

6. Source the stackrc undercloud credentials file:

   $ source ~/stackrc

7. To apply the bare-metal instance provisioning network configuration, add your Bare Metal Provisioning environment files to the stack with your other environment files and deploy the overcloud:

   (undercloud)$ openstack overcloud deploy --templates \
     -e [your environment files] \
     -e /home/stack/templates/node-info.yaml
     -r /home/stack/templates/roles_data.yaml \
     -e /usr/share/openstack-tripleo-heat-templates/network-environment.yaml \
     -e /usr/share/openstack-tripleo-heat-templates/environments/services/<default_ironic_template> \
     -e /usr/share/openstack-tripleo-heat-templates/environments/services/ironic-inspector.yaml \
     -e /home/stack/templates/network_environment_overrides.yaml
     -n /home/stack/templates/network_data.yaml
     -e /home/stack/templates/ironic-overrides.yaml \

   • Replace <default_ironic_template> with either ironic.yaml or ironic-overcloud.yaml, depending on the Networking service mechanism driver for your deployment.

Procedure

1. Log in to the undercloud host.

2. Source your overcloud credentials file:

   $ source ~/<credentials_file>

   • Replace <credentials_file> with the name of your credentials file, for example, overcloudrc.

3. Retrieve the UUID for the provider network that hosts the Bare Metal Provisioning service:

   (overcloud)$ openstack network show <network_name> -f value -c id

   • Replace <network_name> with the name of the network that you want to use for the bare-metal node cleaning network.
4. Open your local environment file that configures the Bare Metal Provisioning service for your deployment, for example, ironic-overrides.yaml.

5. Configure the network to use as the node cleaning network:

   parameter_defaults:
     IronicCleaningNetwork: <network_uuid>

   • Replace <network_uuid> with the UUID of the provider network that you retrieved in step 3.

6. Source the stackrc undercloud credentials file:

   $ source ~/stackrc

7. To apply the node cleaning network configuration, add your Bare Metal Provisioning environment files to the stack with your other environment files and deploy the overcloud:

   (undercloud)$ openstack overcloud deploy --templates \
     -e [your environment files] \
     -e /home/stack/templates/node-info.yaml
     -r /home/stack/templates/roles_data.yaml \
     -e /usr/share/openstack-tripleo-heat-templates/network-environment.yaml \
     -e /usr/share/openstack-tripleo-heat-templates/environments/services/<default_ironic_template> \
     -e /usr/share/openstack-tripleo-heat-templates/environments/services/ironic-inspector.yaml \
     -e /home/stack/templates/network_environment_overrides.yaml
     -n /home/stack/templates/network_data.yaml
     -e /home/stack/templates/ironic-overrides.yaml \

   • Replace <default_ironic_template> with either ironic.yaml or ironic-overcloud.yaml, depending on the Networking service mechanism driver for your deployment.

Procedure

1. Source your overcloud credentials file:

   $ source ~/<credentials_file>

   • Replace <credentials_file> with the name of your credentials file, for example, overcloudrc.

2. Check the current state of the node:

   $ openstack baremetal node show \
    -f value -c provision_state <node>

   • Replace <node> with the name or UUID of the node to clean.

3. If the node is not in the manageable state, then set it to manageable:

   $ openstack baremetal node manage <node>

4. Clean the node:

   $ openstack baremetal node clean <node> \
     --clean-steps '[{"interface": "deploy", "step": "<clean_mode>"}]'

   • Replace <node> with the name or UUID of the node to clean.

   • Replace <clean_mode> with the type of cleaning to perform on the node:

     • erase_devices: Performs a full clean.
     • erase_devices_metadata: Performs a metadata only clean.

5. Wait for the clean to complete, then check the status of the node:

   • manageable: The clean was successful, and the node is ready to provision.
   • clean failed: The clean was unsuccessful. Inspect the last_error field for the cause of failure.

Procedure

1. Download the Red Hat Enterprise Linux KVM guest image from the Customer Portal.

2. Define DIB_LOCAL_IMAGE as the downloaded image:

   $ export DIB_LOCAL_IMAGE=rhel-8.0-x86_64-kvm.qcow2

3. Set your registration information. If you use Red Hat Customer Portal, you must configure the following information:

   $ export REG_USER='USER_NAME'
   $ export REG_PASSWORD='PASSWORD'
   $ export REG_AUTO_ATTACH=true
   $ export REG_METHOD=portal
   $ export https_proxy='IP_address:port' (if applicable)
   $ export http_proxy='IP_address:port' (if applicable)

   If you use Red Hat Satellite, you must configure the following information:

   $ export REG_USER='USER_NAME'
   $ export REG_PASSWORD='PASSWORD'
   $ export REG_SAT_URL='<SATELLITE URL>'
   $ export REG_ORG='<SATELLITE ORG>'
   $ export REG_ENV='<SATELLITE ENV>'
   $ export REG_METHOD=<METHOD>

   If you have any offline repositories, you can define DIB_YUM_REPO_CONF as local repository configuration:

   $ export DIB_YUM_REPO_CONF=<path-to-local-repository-config-file>

4. Create the user images with the diskimage-builder tool:

   $ export DIB_RELEASE=8
   $ disk-image-create rhel baremetal -o rhel-image

   This command extracts the kernel as rhel-image.vmlinuz and initial ramdisk as rhel-image.initrd.

5. Upload the images to the Image service:

   $ KERNEL_ID=$(openstack image create \
     --file rhel-image.vmlinuz --public \
     --container-format aki --disk-format aki \
     -f value -c id rhel-image.vmlinuz)
   $ RAMDISK_ID=$(openstack image create \
     --file rhel-image.initrd --public \
     --container-format ari --disk-format ari \
     -f value -c id rhel-image.initrd)
   $ openstack image create \
     --file rhel-image.qcow2   --public \
     --container-format bare \
     --disk-format qcow2 \
     --property kernel_id=$KERNEL_ID \
     --property ramdisk_id=$RAMDISK_ID \
     rhel-image

Procedure

1. Create an inventory file, overcloud-nodes.yaml, that includes the node details. You can enroll multiple nodes with one file.

   nodes:
       - name: node0
         driver: ipmi
         driver_info:
           ipmi_address: <ipmi_ip>
           ipmi_username: <user>
           ipmi_password: <password>
           [<property>: <value>]
         properties:
           cpus: <cpu_count>
           cpu_arch: <cpu_arch>
           memory_mb: <memory>
           local_gb: <root_disk>
           root_device:
               serial: <serial>
         ports:
           - address: <mac_address>

   • Replace <ipmi_ip> with the address of the Bare Metal controller.
   • Replace <user> with your username.
   • Replace <password> with your password.
   • Optional: Replace <property>: <value> with an IPMI property that you want to configure, and the property value. For information on the available properties, see Intelligent Platform Management Interface (IPMI) power management driver.
   • Replace <cpu_count> with the number of CPUs.
   • Replace <cpu_arch> with the type of architecture of the CPUs.
   • Replace <memory> with the amount of memory in MiB.
   • Replace <root_disk> with the size of the root disk in GiB. Only required when the machine has multiple disks.
   • Replace <serial> with the serial number of the disk that you want to use for deployment.
   • Replace <mac_address> with the MAC address of the NIC used to PXE boot.
   • --driver-info <property>=<value>

2. Source the overcloudrc file:

   $ source ~/overcloudrc

3. Import the inventory file into the Bare Metal Provisioning service:

   $ openstack baremetal create overcloud-nodes.yaml

   The nodes are now in the enroll state.

4. Specify the deploy kernel and deploy ramdisk on each node:

   $ openstack baremetal node set <node> \
     --driver-info deploy_kernel=<kernel_file> \
     --driver-info deploy_ramdisk=<initramfs_file>

   • Replace <node> with the name or ID of the node.
   • Replace <kernel_file> with the path to the .kernel image, for example, file:///var/lib/ironic/httpboot/agent.kernel.
   • Replace <initramfs_file> with the path to the .initramfs image, for example, file:///var/lib/ironic/httpboot/agent.ramdisk.

5. Optional: Specify the IPMI cipher suite for each node:

   $ openstack baremetal node set <node> \
    --driver-info ipmi_cipher_suite=<version>

   • Replace <node> with the name or ID of the node.

   • Replace <version> with the cipher suite version to use on the node. Set to one of the following valid values:

     • 3 - The node uses the AES-128 with SHA1 cipher suite.
     • 17 - The node uses the AES-128 with SHA256 cipher suite.

6. Set the provisioning state of the node to available:

   $ openstack baremetal node manage <node>
   $ openstack baremetal node provide <node>

   The Bare Metal Provisioning service cleans the node if you enabled node cleaning.

7. Set the local boot option on the node:

   $ openstack baremetal node set <node> --property capabilities="boot_option:local"

8. Check that the nodes are enrolled:

   $ openstack baremetal node list

   There might be a delay between enrolling a node and its state being shown.

Procedure

1. Log in to the undercloud host as the stack user.

2. Source the overcloud credentials file:

   (undercloud)$ source ~/overcloudrc

3. Add a new node:

   $ openstack baremetal node create --driver <driver_name> --name <node_name>

   • Replace <driver_name> with the name of the driver, for example, ipmi.
   • Replace <node_name> with the name of your new bare-metal node.
4. Note the UUID assigned to the node when it is created.

5. Set the boot option to local for each registered node:

   $ openstack baremetal node set \
     --property capabilities="boot_option:local" <node>

   Replace <node> with the UUID of the bare metal node.

6. Specify the deploy kernel and deploy ramdisk for the node driver:

   $ openstack baremetal node set <node> \
     --driver-info deploy_kernel=<kernel_file> \
     --driver-info deploy_ramdisk=<initramfs_file>

   • Replace <node> with the ID of the bare metal node.
   • Replace <kernel_file> with the path to the .kernel image, for example, file:///var/lib/ironic/httpboot/agent.kernel.
   • Replace <initramfs_file> with the path to the .initramfs image, for example, file:///var/lib/ironic/httpboot/agent.ramdisk.

7. Update the node properties to match the hardware specifications on the node:

   $ openstack baremetal node set <node> \
     --property cpus=<cpu> \
     --property memory_mb=<ram> \
     --property local_gb=<disk> \
     --property cpu_arch=<arch>

   • Replace <node> with the ID of the bare metal node.
   • Replace <cpu> with the number of CPUs.
   • Replace <ram> with the RAM in MB.
   • Replace <disk> with the disk size in GB.
   • Replace <arch> with the architecture type.

8. Optional: Specify the IPMI cipher suite for each node:

   $ openstack baremetal node set <node> \
    --driver-info ipmi_cipher_suite=<version>

   • Replace <node> with the ID of the bare metal node.

   • Replace <version> with the cipher suite version to use on the node. Set to one of the following valid values:

     • 3 - The node uses the AES-128 with SHA1 cipher suite.
     • 17 - The node uses the AES-128 with SHA256 cipher suite.

9. Optional: Specify the IPMI details for each node:

   $ openstack baremetal node set <node> \
    --driver-info <property>=<value>

   • Replace <node> with the ID of the bare metal node.
   • Replace <property> with the IPMI property that you want to configure. For information on the available properties, see Intelligent Platform Management Interface (IPMI) power management driver.
   • Replace <value> with the property value.

10. Optional: If you have multiple disks, set the root device hints to inform the deploy ramdisk which disk to use for deployment:

    $ openstack baremetal node set <node> \
      --property root_device='{"<property>": "<value>"}'

    • Replace <node> with the ID of the bare metal node.

    • Replace <property> and <value> with details about the disk that you want to use for deployment, for example root_device='{"size": "128"}'

      RHOSP supports the following properties:

      • model (String): Device identifier.
      • vendor (String): Device vendor.
      • serial (String): Disk serial number.
      • hctl (String): Host:Channel:Target:Lun for SCSI.
      • size (Integer): Size of the device in GB.
      • wwn (String): Unique storage identifier.
      • wwn_with_extension (String): Unique storage identifier with the vendor extension appended.
      • wwn_vendor_extension (String): Unique vendor storage identifier.
      • rotational (Boolean): True for a rotational device (HDD), otherwise false (SSD).

      • name (String): The name of the device, for example: /dev/sdb1 Use this property only for devices with persistent names.

        Note

        If you specify more than one property, the device must match all of those properties.

11. Inform the Bare Metal Provisioning service of the node network card by creating a port with the MAC address of the NIC on the provisioning network:

    $ openstack baremetal port create --node <node_uuid> <mac_address>

    • Replace <node> with the unique ID of the bare metal node.
    • Replace <mac_address> with the MAC address of the NIC used to PXE boot.

12. Validate the configuration of the node:

    $ openstack baremetal node validate <node>
    +------------+--------+---------------------------------------------+
    | Interface  | Result | Reason                                      |
    +------------+--------+---------------------------------------------+
    | boot       | False  | Cannot validate image information for node  |
    |            |        | a02178db-1550-4244-a2b7-d7035c743a9b        |
    |            |        | because one or more parameters are missing  |
    |            |        | from its instance_info. Missing are:        |
    |            |        | ['ramdisk', 'kernel', 'image_source']       |
    | console    | None   | not supported                               |
    | deploy     | False  | Cannot validate image information for node  |
    |            |        | a02178db-1550-4244-a2b7-d7035c743a9b        |
    |            |        | because one or more parameters are missing  |
    |            |        | from its instance_info. Missing are:        |
    |            |        | ['ramdisk', 'kernel', 'image_source']       |
    | inspect    | None   | not supported                               |
    | management | True   |                                             |
    | network    | True   |                                             |
    | power      | True   |                                             |
    | raid       | True   |                                             |
    | storage    | True   |                                             |
    +------------+--------+---------------------------------------------+

    The validation output Result indicates the following:

    • False: The interface has failed validation. If the reason provided includes missing the instance_info parameters [\'ramdisk', \'kernel', and \'image_source'], this might be because the Compute service populates those missing parameters at the beginning of the deployment process, therefore they have not been set at this point. If you are using a whole disk image, then you might need to only set image_source to pass the validation.
    • True: The interface has passed validation.
    • None: The interface is not supported for your driver.

Procedure

1. Set the Bare Metal service (ironic) boot interface to redfish-virtual-media:

   $ openstack baremetal node set --boot-interface redfish-virtual-media $NODE_NAME

   Replace $NODE_NAME with the name of the node.

2. For UEFI nodes, set the boot mode to uefi:

   $ openstack baremetal node set --property capabilities="boot_mode:uefi" $NODE_NAME

   Replace $NODE_NAME with the name of the node.

   Note

   For BIOS nodes, do not complete this step.

3. For UEFI nodes, define the EFI System Partition (ESP) image:

   $ openstack baremetal node set --driver-info bootloader=$ESP $NODE_NAME

   Replace $ESP with the glance image UUID or URL for the ESP image, and replace $NODE_NAME with the name of the node.

   Note

   For BIOS nodes, do not complete this step.

4. Create a port on the bare metal node and associate the port with the MAC address of the NIC on the bare metal node:

   $ openstack baremetal port create --pxe-enabled True --node $UUID $MAC_ADDRESS

   Replace $UUID with the UUID of the bare metal node, and replace $MAC_ADDRESS with the MAC address of the NIC on the bare metal node.

5. Create the new bare metal server:

   $ openstack server create \
       --flavor baremetal \
       --image $IMAGE \
       --network $NETWORK \
       test_instance

   Replace $IMAGE and $NETWORK with the names of the image and network that you want to use.