Chapter 4. Configuring for the Bare Metal Service After Deployment

Configure the shell to access Identity as the administrative user:

$ source ~/overcloudrc

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

$ openstack network create \
  --provider-network-type flat \
  --provider-physical-network baremetal \
  --share NETWORK_NAME

Replace NETWORK_NAME with a name for this network. The name of the physical network over which the virtual network is implemented (in this case baremetal) was set earlier in the ~/templates/network-environment.yaml file, with the parameter NeutronBridgeMappings.

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 the following values:

Create a router for the network and subnet to ensure that the OpenStack Networking Service serves metadata requests:

$ openstack router create ROUTER_NAME

Replace ROUTER_NAME with a name for the router.

Attach the subnet to the new router:

$ openstack router add subnet ROUTER_NAME BAREMETAL_SUBNET

Replace ROUTER_NAME with the name of your router and BAREMETAL_SUBNET with the ID or name of the subnet that you created previously. This allows the metadata requests from cloud-init to be served and the node configured.

Create a vlan network with a VlanID that matches the OcProvisioning network that you create during deployment. Name the new network provisioning to match the default name of the cleaning network.

(overcloud) [stack@host01 ~]$ openstack network create \
  --share \
  --provider-network-type vlan \
  --provider-physical-network datacentre \
  --provider-segment 205 provisioning

If the name of the overcloud network is not provisioning, log in to the controller and run the following commands to rename and restart the network:

heat-admin@overcloud-controller-0 ~]$ sudo vi /var/lib/config-data/puppet-generated/ironic/etc/ironic/ironic.conf

heat-admin@overcloud-controller-0 ~]$ sudo podman restart ironic_conductor

Define DIB_LOCAL_IMAGE as the downloaded image:

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

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>

Create the user images using the diskimage-builder tool:

$ disk-image-create rhel8 baremetal -o rhel-image

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

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

Nova compute invokes driver.spawn from the Nova compute virt layer to create a spawn task that contains all of the necessary information. During the spawn process, the virt driver completes the following steps.

Create or modify a custom environment file /home/stack/templates/direct_deploy.yaml and specify the IronicEnabledDeployInterfaces and the IronicDefaultDeployInterface parameters.

parameter_defaults:
  IronicEnabledDeployInterfaces: direct
  IronicDefaultDeployInterface: direct

If you register your nodes with iscsi, retain the iscsi value in the IronicEnabledDeployInterfaces parameter:

parameter_defaults:
  IronicEnabledDeployInterfaces: direct,iscsi
  IronicDefaultDeployInterface: direct

By default, the Bare Metal Service (ironic) agent on each node obtains the image stored in the Object Storage Service (swift) through a HTTP link. Alternatively, Ironic can stream this image directly to the node through the ironic-conductor HTTP server. To change the service providing the image, set the IronicImageDownloadSource to http in the /home/stack/templates/direct_deploy.yaml file:

parameter_defaults:
  IronicEnabledDeployInterfaces: direct
  IronicDefaultDeployInterface: direct
  IronicImageDownloadSource: http

Include the custom environment with your overcloud deployment:

$ openstack overcloud deploy \
  --templates \
  ...
  -e /usr/share/openstack-tripleo-heat-templates/environments/services/ironic.yaml \
  -e /home/stack/templates/direct_deploy.yaml \
  ...

Wait until deployment completes.

Create a file overcloud-nodes.yaml, including 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>
      properties:
        cpus: <CPU_COUNT>
        cpu_arch: <CPU_ARCHITECTURE>
        memory_mb: <MEMORY>
        local_gb: <ROOT_DISK>
        root_device:
            serial: <SERIAL>
      ports:
        - address: <PXE_NIC_MAC>

Replace the following values:

Configure the shell to use Identity as the administrative user:

$ source ~/overcloudrc

Import the inventory file into ironic:

$ openstack baremetal create overcloud-nodes.yaml

Specify the deploy kernel and deploy ramdisk on each node:

$ openstack baremetal node set NODE_UUID \
  --driver-info deploy_kernel=KERNEL_UUID \
  --driver-info deploy_ramdisk=INITRAMFS_UUID

Replace the following values:

Set the node’s provisioning state to available:

$ openstack baremetal node manage _NODE_UUID_
$ openstack baremetal node provide _NODE_UUID_

The bare metal service cleans the node if you enabled node cleaning,

Check that the nodes were successfully enrolled:

$ openstack baremetal node list

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

Configure the shell to use Identity as the administrative user:

$ source ~/overcloudrc

Add a new node:

$ openstack baremetal node create --driver ipmi --name NAME

To create a node, you must specify the driver name. This example uses ipmi. To use a different driver, you must enable the driver by setting the IronicEnabledDrivers parameter. For more information on supported drivers, see Appendix A, Bare Metal Drivers.

Update the node driver information to allow the Bare Metal service to manage the node:

$ openstack baremetal node set NODE_UUID \
  --driver_info PROPERTY=VALUE \
  --driver_info PROPERTY=VALUE

Replace the following values:

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

$ openstack baremetal node set NODE_UUID \
  --driver-info deploy_kernel=KERNEL_UUID \
  --driver-info deploy_ramdisk=INITRAMFS_UUID

Replace the following values:

Update the node’s properties to match the hardware specifications on the node:

$ openstack baremetal node set NODE_UUID \
  --property cpus=CPU \
  --property memory_mb=RAM_MB \
  --property local_gb=DISK_GB \
  --property cpu_arch=ARCH

Replace the following values:

OPTIONAL: Configure the node to reboot after initial deployment from a local boot loader installed on the node’s disk, instead of using PXE from ironic-conductor. You must also set the local boot capability on the flavor used to provision the node. To enable local boot, the image used to deploy the node must contain grub2. Configure local boot:

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

Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.

Inform the Bare Metal service of the node’s 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_UUID with the unique identifier for the node. Replace MAC_ADDRESS with the MAC address of the NIC used to PXE boot.

If you have multiple disks, set the root device hints. This informs the deploy ramdisk which disk it should use for deployment.

$ openstack baremetal node set NODE_UUID \
  --property root_device={"PROPERTY": "VALUE"}

Replace with the following values:

Validate the configuration of the node:

$ openstack baremetal node validate NODE_UUID
+------------+--------+---------------------------------------------+
| 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   |                                             |
+------------+--------+---------------------------------------------+

Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name. The output of the openstack baremetal node validate command should report either True or None for each interface. Interfaces marked None are those that you have not configured, or those that are not supported for your driver.