Chapter 2. Configure Bare Metal Deployment

Configuring OpenStack Networking to Communicate with Bare Metal Provisioning

1. Set up the shell to access Identity as the administrative user:

   # source ~stack/overcloudrc

   Copy to Clipboard Toggle word wrap

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

   # neutron net-create --tenant-id TENANT_ID sharednet1 --shared \
   --provider:network_type flat --provider:physical_network PHYSNET

   Copy to Clipboard Toggle word wrap

   Replace TENANT_ID with the unique identifier of the tenant on which to create the network. Replace PHYSNET with the name of the physical network.

3. Create the subnet on the flat network:

   # neutron subnet-create sharednet1 NETWORK_CIDR --name SUBNET_NAME \
   --ip-version 4 --gateway GATEWAY_IP --allocation-pool \
   start=START_IP,end=END_IP --enable-dhcp

   Copy to Clipboard Toggle word wrap

   Replace the following values:

   • Replace NETWORK_CIDR with the Classless Inter-Domain Routing (CIDR) representation of the block of IP addresses the subnet represents. The block of IP addresses specified by the range started by START_IP and ended by END_IP must fall within the block of IP addresses specified by NETWORK_CIDR.
   • Replace SUBNET_NAME with a name for the subnet.
   • Replace GATEWAY_IP with the IP address or host name of the system that will act 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 started by START_IP and ended by 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 will be 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 will be allocated.

4. Attach the network and subnet to the router to ensure the metadata requests are served by the OpenStack Networking service.

   # neutron router-create ROUTER_NAME

   Copy to Clipboard Toggle word wrap

   Replace ROUTER_NAME with a name for the router.

5. Add the Bare Metal subnet as an interface on this router:

   # neutron router-interface-add ROUTER_NAME BAREMETAL_SUBNET

   Copy to Clipboard Toggle word wrap

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

6. Update the /etc/ironic/ironic.conf file on the Compute node running the Bare Metal Provisioning service to utilize the same network for the cleaning service. Login to the Compute node where the Bare Metal Provisioning service is running and execute the following as a root user:

   # openstack-config --set /etc/ironic/ironic.conf neutron cleaning_network_uuid NETWORK_UUID

   Copy to Clipboard Toggle word wrap

   Replace the NETWORK_UUID with the ID of the Bare Metal Provisioning Network created in the previous steps.

7. Restart the Bare Metal Provisioning service:

   # systemctl restart openstack-ironic-conductor.service

   Copy to Clipboard Toggle word wrap

1. Set up the shell to access Identity as the administrative user:

   # source ~stack/overcloudrc

   Copy to Clipboard Toggle word wrap

2. List existing flavors:

   # openstack flavor list

   Copy to Clipboard Toggle word wrap

3. Create a new flavor for the Bare Metal Provisioning service:

   # openstack flavor create --id auto --ram RAM --vcpus VCPU --disk DISK --public baremetal

   Copy to Clipboard Toggle word wrap

   Replace RAM with the RAM memory, VCPU with the number of vCPUs and DISK with the disk storage value.

4. Verify that the new flavor is created with the respective values:

   # openstack flavor list

   Copy to Clipboard Toggle word wrap

1. Source the overcloudrc file and import the .json file:

   # source ~stack/overcloudrc
   # openstack baremetal import --json ./baremetal.json

   Copy to Clipboard Toggle word wrap

2. Update the bare metal node in the Bare Metal Provisioning service to use the deployed images as the initial boot image by specifying the deploy_kernel and deploy_ramdisk in the driver_info section of the node:

   # ironic node-update NODE_UUID add driver_info/deploy_kernel=DEPLOY_KERNEL_ID driver_info/deploy_ramdisk=DEPLOY_RAMDISK_ID

   Copy to Clipboard Toggle word wrap

Configure Image Proxy

1. Set up the shell to access Identity as the administrative user:

   # source ~stack/overcloudrc

   Copy to Clipboard Toggle word wrap

2. Configure the bare metal node driver to use HTTP or HTTPS:

   # openstack baremetal node set NODE_UUID \
      --driver_info image_https_proxy=HTTPS://PROXYIP:PORT

   Copy to Clipboard Toggle word wrap

   This example uses the HTTPS protocol. Set the driverinfo/image_http_proxy parameter if you want to use HTTP instead of HTTPS.

3. Set Bare Metal Provisioning to reuse cached Object Storage temporary URLs when an image is requested.

   # openstack-config --set /etc/ironic/ironic.conf glance swift_temp_url_cache_enabled=true

   Copy to Clipboard Toggle word wrap

   The proxy server will not create new cache entries for the same image based on the query part of the URL when it contains some query parameters that change each time the request is regenerated.

4. Set the duration (in seconds) that the generated temporary URL remains valid:

   # openstack-config --set /etc/ironic/ironic.conf glance swift_temp_url_duration=DURATION

   Copy to Clipboard Toggle word wrap

   Only non-expired links to images will be returned from the Object Storage service temporary URLs cache. If swift_temp_url_duration=1200, then after 20 minutes a new image will be cached by the proxy server. The value of this option must be greater than or equal to swift_temp_url_expected_download_start_delay.

5. Set the download start delay (in seconds) for your hardware:

   # openstack-config --set /etc/ironic/ironic.conf glance swift_temp_url_expected_download_start_delay=DELAY

   Copy to Clipboard Toggle word wrap

   Set DELAY to cover the delay between when the deploy request is made (the temporary URL is generated) to when the URL is used to download an image to the bare metal node. This delay allows time for the ramdisk to boot and begin the image download. This value determines if a cached entry will still be valid when the image download starts.

Adding a Node with Hardware Inspection

1. Set up the shell to use Identity as the administrative user:

   # source ~/keystonerc_admin

   Copy to Clipboard Toggle word wrap

2. Add a new node:

   # ironic node-create -d DRIVER_NAME

   Copy to Clipboard Toggle word wrap

   Replace DRIVER_NAME with the name of the driver that Bare Metal Provisioning will use to provision this node. You must have enabled this driver in the /etc/ironic/ironic.conf file. To create a node, you must, at a minimum, specify the driver name.

   Important

   Note the unique identifier for the node.

3. You can refer to a node by a logical name or by its UUID. Optionally assign a logical name to the node:

   # ironic node-update NODE_UUID add name=NAME

   Copy to Clipboard Toggle word wrap

   Replace NODE_UUID with the unique identifier for the node. Replace NAME with a logical name for the node.

4. Determine the node information that is required by the driver, then update the node driver information to allow Bare Metal Provisioning to manage the node:

   # ironic driver-properties DRIVER_NAME
   # ironic node-update NODE_UUID add \
      driver_info/PROPERTY=VALUE \
      driver_info/PROPERTY=VALUE

   Copy to Clipboard Toggle word wrap

   Replace the following values:

   • Replace DRIVER_NAME with the name of the driver for which to show properties. The information is not returned unless the driver has been enabled in the /etc/ironic/ironic.conf file.
   • Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
   • Replace PROPERTY with a required property returned by the ironic driver-properties command.
   • Replace VALUE with a valid value for that property.

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

   # ironic node-update NODE_UUID add \
     driver_info/deploy_kernel=KERNEL_UUID \
     driver_info/deploy_ramdisk=INITRAMFS_UUID

   Copy to Clipboard Toggle word wrap

   Replace the following values:

   • Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
   • Replace KERNEL_UUID with the unique identifier for the .kernel image that was uploaded to the Image service.
   • Replace INITRAMFS_UUID with the unique identifier for the .initramfs image that was uploaded to the Image service.

6. Configure the node to reboot after initial deployment from a local boot loader installed on the node’s disk, instead of via PXE or virtual media. The local boot capability must also be set 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:

   # ironic node-update NODE_UUID add \
      properties/capabilities="boot_option:local"

   Copy to Clipboard Toggle word wrap

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

7. Move the bare metal node to manageable state:

   # ironic node-set-provision-state NODE_UUID manage

   Copy to Clipboard Toggle word wrap

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

8. Start inspection:

   # openstack baremetal introspection start NODE_UUID --discoverd-url http://overcloud IP:5050

   Copy to Clipboard Toggle word wrap
   • Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name. The node discovery and inspection process must run to completion before the node can be provisioned. To check the status of node inspection, run ironic node-list and look for Provision State. Nodes will be in available state after successful inspection.
   • Replace overcloud IP with the service_url value that was previously set in ironic.conf.

9. Validate the node’s setup:

   # ironic node-validate NODE_UUID
   +------------+--------+----------------------------+
   | Interface  | Result | Reason                     |
   +------------+--------+----------------------------+
   | console    | None   | not supported              |
   | deploy     | True   |                            |
   | inspect    | True   |                            |
   | management | True   |                            |
   | power      | True   |                            |
   +------------+--------+----------------------------+

   Copy to Clipboard Toggle word wrap

   Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name. The output of the command above 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.

Adding a Node without Hardware Inspection

1. Set up the shell to use Identity as the administrative user:

   # source ~/keystonerc_admin

   Copy to Clipboard Toggle word wrap

2. Add a new node:

   # ironic node-create -d DRIVER_NAME

   Copy to Clipboard Toggle word wrap

   Replace DRIVER_NAME with the name of the driver that Bare Metal Provisioning will use to provision this node. You must have enabled this driver in the /etc/ironic/ironic.conf file. To create a node, you must, at a minimum, specify the driver name.

   Important

   Note the unique identifier for the node.

3. You can refer to a node by a logical name or by its UUID. Optionally assign a logical name to the node:

   # ironic node-update NODE_UUID add name=NAME

   Copy to Clipboard Toggle word wrap

   Replace NODE_UUID with the unique identifier for the node. Replace NAME with a logical name for the node.

4. Determine the node information that is required by the driver, then update the node driver information to allow Bare Metal Provisioning to manage the node:

   # ironic driver-properties DRIVER_NAME
   # ironic node-update NODE_UUID add \
      driver_info/PROPERTY=VALUE \
      driver_info/PROPERTY=VALUE

   Copy to Clipboard Toggle word wrap

   Replace the following values:

   • Replace DRIVER_NAME with the name of the driver for which to show properties. The information is not returned unless the driver has been enabled in the /etc/ironic/ironic.conf file.
   • Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
   • Replace PROPERTY with a required property returned by the ironic driver-properties command.
   • Replace VALUE with a valid value for that property.

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

   # ironic node-update NODE_UUID add \
     driver_info/deploy_kernel=KERNEL_UUID \
     driver_info/deploy_ramdisk=INITRAMFS_UUID

   Copy to Clipboard Toggle word wrap

   Replace the following values:

   • Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
   • Replace KERNEL_UUID with the unique identifier for the .kernel image that was uploaded to the Image service.
   • Replace INITRAMFS_UUID with the unique identifier for the .initramfs image that was uploaded to the Image service.

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

   # ironic node-update NODE_UUID add \
      properties/cpus=CPU \
      properties/memory_mb=RAM_MB \
      properties/local_gb=DISK_GB \
      properties/cpu_arch=ARCH

   Copy to Clipboard Toggle word wrap

   Replace the following values:

   • Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
   • Replace CPU with the number of CPUs to use.
   • Replace RAM_MB with the RAM (in MB) to use.
   • Replace DISK_GB with the disk size (in GB) to use.
   • Replace ARCH with the architecture type to use.

7. Configure the node to reboot after initial deployment from a local boot loader installed on the node’s disk, instead of via PXE or virtual media. The local boot capability must also be set 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:

   # ironic node-update NODE_UUID add \
      properties/capabilities="boot_option:local"

   Copy to Clipboard Toggle word wrap

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

8. Inform Bare Metal Provisioning of the network interface cards on the node. Create a port with each NIC’s MAC address:

   # ironic port-create -n NODE_UUID -a MAC_ADDRESS

   Copy to Clipboard Toggle word wrap

   Replace NODE_UUID with the unique identifier for the node. Replace MAC_ADDRESS with the MAC address for a NIC on the node.

9. Validate the node’s setup:

   # ironic node-validate NODE_UUID
   +------------+--------+----------------------------+
   | Interface  | Result | Reason                     |
   +------------+--------+----------------------------+
   | console    | None   | not supported              |
   | deploy     | True   |                            |
   | inspect    | None   | not supported              |
   | management | True   |                            |
   | power      | True   |                            |
   +------------+--------+----------------------------+

   Copy to Clipboard Toggle word wrap

   Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name. The output of the command above 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.

1. Set up the shell to access Identity as the administrative user.

   # source ~stack/overcloudrc

   Copy to Clipboard Toggle word wrap

2. Find the network UUID for the network you want Bare Metal Provisioning to use for cleaning bare metal servers.

   # openstack network list

   Copy to Clipboard Toggle word wrap

   Select the UUID from the id field in the neutron net-list output.

3. Set cleaning_network_uuid in the /etc/ironic/ironic.conf file to the cleaning network UUID.

   # openstack-config --set /etc/ironic/ironic.conf neutron cleaning_network_uuid CLEANING_NETWORK_UUID

   Copy to Clipboard Toggle word wrap

   Replace CLEANING_NETWORK_UUID with the network id retrieved in the earlier step.

4. Restart the Bare Metal Provisioning Service.

   # systemctl restart openstack-ironic-conductor

   Copy to Clipboard Toggle word wrap

Configure Manual Cleaning

1. Ensure that the bare metal server is in the manageable state.

   # ironic node-set-provision-state NODE_ID manage

   Copy to Clipboard Toggle word wrap

   Replace NODE_ID with the bare metal server UUID or node name.

2. Set the bare metal server in cleaning state and provide the cleaning steps.

   # ironic node-set-provision-state NODE_ID clean --clean-steps CLEAN_STEPS

   Copy to Clipboard Toggle word wrap

   Replace NODE_ID with the bare metal server UUID or node name. Replace CLEAN_STEPS with the cleaning steps in JSON format, a path to a file that contains the cleaning steps, or directly from standard input. The following is an example of cleaning steps in JSON format:

    '[{"interface": "deploy", "step": "erase_devices"}]'

   Copy to Clipboard Toggle word wrap

Creating Virtualized Bare Metal Nodes

1. Access the Virtual Machine Manager from the libvirt host.

2. Create two virtual machines with the following configuration:

   • 1 vCPU
   • 2048 MB of memory
   • Network Boot (PXE)
   • 20 GB storage
   • Network source: Host device eth0: macvtap and Source mode: Bridge. Selecting macvtap sets the virtual machines to share the host’s Ethernet network interface. This way the Bare Metal Provisioning node has direct access to the virtualized nodes.
3. Shut down both virtual machines.

Creating an SSH Key Pair

1. On the Bare Metal Provisioning node, create a new SSH key:

   # ssh-keygen -t rsa -b 2048 -C "user@domain.com" -f ./virtkey

   Copy to Clipboard Toggle word wrap

   Replace user@domain.com with an email address or other comment that identifies this key. When the command prompts you for a passphrase, press Enter to proceed without a passphrase. The command creates two files: the private key (virtkey) and the public key (virtkey.pub).

2. Copy the contents of the public key into the /root/.ssh/authorized_keys file of the libvirt host’s root user:

   # ssh-copy-id -i virtkey root@LIBVIRT_HOST

   Copy to Clipboard Toggle word wrap

   Replace LIBVIRT_HOST with the IP address or host name of the libvirt host.

Adding Virtualized Nodes as Bare Metal Nodes

1. On the Bare Metal Provisioning conductor service node, enable the pxe_ssh driver:

   # openstack-config --set /etc/ironic/ironic.conf \
      DEFAULT enabled_drivers pxe_ssh

   Copy to Clipboard Toggle word wrap

   If you are adding pxe_ssh to a list of existing drivers, open the file and add the driver to the list in enabled_drivers, separated by a comma.

2. Set up the shell to use Identity as the administrative user:

   # source ~/keystonerc_admin

   Copy to Clipboard Toggle word wrap

3. Add the first node, and register the SSH details for the libvirt host:

   # ironic node-create -d pxe_ssh -n Node1 \
      -i ssh_virt_type=virsh \
      -i ssh_username=root \
      -i ssh_key_filename=VIRTKEY_FILE_PATH \
      -i ssh_address=LIBVIRT_HOST_IP \
      -i deploy_kernel=KERNEL_UUID \
      -i deploy_ramdisk=INITRAMFS_UUID

   Copy to Clipboard Toggle word wrap

   Replace the following values:

   • Replace VIRTKEY_FILE_PATH with the absolute file path of the virtkey SSH private key file.
   • Replace LIBVIRT_HOST_IP with the IP address or host name of the libvirt host.
   • Replace KERNEL_UUID with the unique identifier for the .kernel image that was uploaded to the Image service.
   • Replace INITRAMFS_UUID with the unique identifier for the .initramfs image that was uploaded to the Image service.
4. Add a second node, using the same command as above, and replacing Node1 with Node2.

5. Configure the node to reboot after initial deployment from a local boot loader installed on the node’s disk, instead of via PXE or virtual media. The local boot capability must also have been set on the flavor you will use to provision the node. To enable local boot, the image used to deploy the node must contain grub2. Configure local boot:

   # ironic node-update Node1 add \
      properties/capabilities="boot_option:local"
   # ironic node-update Node2 add \
      properties/capabilities="boot_option:local"

   Copy to Clipboard Toggle word wrap

6. Move the nodes to the manageable state:

   # ironic node-set-provision-state Node1 manage
   # ironic node-set-provision-state Node2 manage

   Copy to Clipboard Toggle word wrap

7. Start inspection on the nodes:

   # ironic node-set-provision-state Node1 inspect
   # ironic node-set-provision-state Node2 inspect

   Copy to Clipboard Toggle word wrap

   The node discovery and inspection process must run to completion before the node can be provisioned. To check the status of node inspection, run ironic node-list and look for Provision State. Nodes will be in the available state after successful inspection.

8. Validate the node’s setup:

   # ironic node-validate Node1
   # ironic node-validate Node2
   +------------+--------+----------------------------+
   | Interface  | Result | Reason                     |
   +------------+--------+----------------------------+
   | console    | None   | not supported              |
   | deploy     | True   |                            |
   | inspect    | True   |                            |
   | management | True   |                            |
   | power      | True   |                            |
   +------------+--------+----------------------------+

   Copy to Clipboard Toggle word wrap

   The output of the command above 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.

9. When the nodes have been successfully added, launch two instances using Chapter 3, Launch Bare Metal Instances.