Chapter 6. Configuring a basic overcloud with CLI tools

Procedure

1. Create a template that lists your nodes. Use the following JSON and YAML template examples to understand how to structure your node definition template:

   Example JSON template

   {
       "nodes":[
           {
               "mac":[
                   "bb:bb:bb:bb:bb:bb"
               ],
               "name":"node01",
               "cpu":"4",
               "memory":"6144",
               "disk":"40",
               "arch":"x86_64",
               "pm_type":"ipmi",
               "pm_user":"admin",
               "pm_password":"p@55w0rd!",
               "pm_addr":"192.168.24.205"
           },
           {
               "mac":[
                   "cc:cc:cc:cc:cc:cc"
               ],
               "name":"node02",
               "cpu":"4",
               "memory":"6144",
               "disk":"40",
               "arch":"x86_64",
               "pm_type":"ipmi",
               "pm_user":"admin",
               "pm_password":"p@55w0rd!",
               "pm_addr":"192.168.24.206"
           }
       ]
   }

   Copy to Clipboard Toggle word wrap

   Example YAML template

   nodes:
     - mac:
         - "bb:bb:bb:bb:bb:bb"
       name: "node01"
       cpu: 4
       memory: 6144
       disk: 40
       arch: "x86_64"
       pm_type: "ipmi"
       pm_user: "admin"
       pm_password: "p@55w0rd!"
       pm_addr: "192.168.24.205"
     - mac:
         - cc:cc:cc:cc:cc:cc
       name: "node02"
       cpu: 4
       memory: 6144
       disk: 40
       arch: "x86_64"
       pm_type: "ipmi"
       pm_user: "admin"
       pm_password: "p@55w0rd!"
       pm_addr: "192.168.24.206"

   Copy to Clipboard Toggle word wrap

   This template contains the following attributes:

   name

   The logical name for the node.

   pm_type

   The power management driver to use. This example uses the IPMI driver (ipmi).

   Note

   IPMI is the preferred supported power management driver. For more supported power management types and their options, see Appendix B, Power Management Drivers. If these power management drivers do not work as expected, use IPMI for your power management.

   pm_user; pm_password

   The IPMI username and password.

   pm_addr

   The IP address of the IPMI device.

   pm_port (Optional)

   The port to access the specific IPMI device.

   mac

   (Optional) A list of MAC addresses for the network interfaces on the node. Use only the MAC address for the Provisioning NIC of each system.

   cpu

   (Optional) The number of CPUs on the node.

   memory

   (Optional) The amount of memory in MB.

   disk

   (Optional) The size of the hard disk in GB.

   arch

   (Optional) The system architecture.

   Important

   When building a multi-architecture cloud, the arch key is mandatory to distinguish nodes using x86_64 and ppc64le architectures.

2. After creating the template, run the following command to verify the formatting and syntax:

   (undercloud) $ openstack overcloud node import --validate-only ~/nodes.json

   Copy to Clipboard Toggle word wrap

3. Save the file to the stack user’s home directory (/home/stack/nodes.json), then run the following commands to import the template to the director:

   $ source ~/stackrc
   (undercloud) $ openstack overcloud node import ~/nodes.json

   Copy to Clipboard Toggle word wrap

   This command registers each node from the template into the director.

4. Wait for the node registration and configuration to completes. Once complete, confirm the director has successfully registered the nodes:

   (undercloud) $ openstack baremetal node list

   Copy to Clipboard Toggle word wrap

Procedure

1. Run the following command to inspect the hardware attributes of each node:

   (undercloud) $ openstack overcloud node introspect --all-manageable --provide

   Copy to Clipboard Toggle word wrap
   • The --all-manageable option introspects only nodes in a managed state. In this example, all nodes are in a managed state.
   • The --provide option resets all nodes to an available state after introspection.

2. Monitor the progress of the introspection using the following command in a separate terminal window:

   (undercloud) $ sudo tail -f /var/log/containers/ironic-inspector/ironic-inspector.log

   Copy to Clipboard Toggle word wrap
   Important

   Ensure this process runs to completion. This process usually takes 15 minutes for bare metal nodes.

3. After the introspection completes, all nodes change to an available state.

Procedure

1. To tag a node into a specific profile, add a profile option to the properties/capabilities parameter for each node. For example, to tag your nodes to use Controller and Compute profiles respectively, use the following commands:

   (undercloud) $ openstack baremetal node set --property capabilities='profile:compute,boot_option:local' 58c3d07e-24f2-48a7-bbb6-6843f0e8ee13
   (undercloud) $ openstack baremetal node set --property capabilities='profile:control,boot_option:local' 1a4e30da-b6dc-499d-ba87-0bd8a3819bc0

   Copy to Clipboard Toggle word wrap

   The addition of the profile:compute and profile:control options tag the two nodes into each respective profiles.

   These commands also set the boot_option:local parameter, which defines how each node boots.

2. After completing node tagging, check the assigned profiles or possible profiles:

   (undercloud) $ openstack overcloud profiles list

   Copy to Clipboard Toggle word wrap

Procedure

1. Set the following parameters in your undercloud.conf file:

   ipxe_enabled = True
   inspection_enable_uefi = True

   Copy to Clipboard Toggle word wrap

2. Save the undercloud.conf file and run the undercloud installation:

   $ openstack undercloud install

   Copy to Clipboard Toggle word wrap

   Wait until the installation script completes.

3. Set the boot mode to uefi for each registered node. For example, to add or replace the existing boot_mode parameters in the capabilities property, run the following command:

   $ NODE=<NODE NAME OR ID> ; openstack baremetal node set --property capabilities="boot_mode:uefi,$(openstack baremetal node show $NODE -f json -c properties | jq -r .properties.capabilities | sed "s/boot_mode:[^,]*,//g")" $NODE

   Copy to Clipboard Toggle word wrap
   Note

   Check that you have retained the profile and boot_option capabilities:

   $ openstack baremetal node show r530-12 -f json -c properties | jq -r .properties.capabilities

   Copy to Clipboard Toggle word wrap

4. Set the boot mode to uefi for each flavor:

   $ openstack flavor set --property capabilities:boot_mode='uefi' control

   Copy to Clipboard Toggle word wrap

Procedure

1. Check the disk information from the hardware introspection of each node. Run the following command to display the disk information of a node:

   (undercloud) $ openstack baremetal introspection data save 1a4e30da-b6dc-499d-ba87-0bd8a3819bc0 | jq ".inventory.disks"

   Copy to Clipboard Toggle word wrap

   For example, the data for one node might show three disks:

   [
     {
       "size": 299439751168,
       "rotational": true,
       "vendor": "DELL",
       "name": "/dev/sda",
       "wwn_vendor_extension": "0x1ea4dcc412a9632b",
       "wwn_with_extension": "0x61866da04f3807001ea4dcc412a9632b",
       "model": "PERC H330 Mini",
       "wwn": "0x61866da04f380700",
       "serial": "61866da04f3807001ea4dcc412a9632b"
     }
     {
       "size": 299439751168,
       "rotational": true,
       "vendor": "DELL",
       "name": "/dev/sdb",
       "wwn_vendor_extension": "0x1ea4e13c12e36ad6",
       "wwn_with_extension": "0x61866da04f380d001ea4e13c12e36ad6",
       "model": "PERC H330 Mini",
       "wwn": "0x61866da04f380d00",
       "serial": "61866da04f380d001ea4e13c12e36ad6"
     }
     {
       "size": 299439751168,
       "rotational": true,
       "vendor": "DELL",
       "name": "/dev/sdc",
       "wwn_vendor_extension": "0x1ea4e31e121cfb45",
       "wwn_with_extension": "0x61866da04f37fc001ea4e31e121cfb45",
       "model": "PERC H330 Mini",
       "wwn": "0x61866da04f37fc00",
       "serial": "61866da04f37fc001ea4e31e121cfb45"
     }
   ]

   Copy to Clipboard Toggle word wrap

2. Change to the root_device parameter for the node definition. The following example shows how to set the root device to disk 2, which has 61866da04f380d001ea4e13c12e36ad6 as the serial number:

   (undercloud) $ openstack baremetal node set --property root_device='{"serial": "61866da04f380d001ea4e13c12e36ad6"}' 1a4e30da-b6dc-499d-ba87-0bd8a3819bc0

   Copy to Clipboard Toggle word wrap
   Note

   Ensure that you configure the BIOS of each node to include booting from the root disk that you choose. Configure the boot order to boot from the network first, then to boot from the root disk.

Procedure

1. To configure director to use the overcloud-minimal image, create an environment file that contains the following image definition:

   parameter_defaults:
     <roleName>Image: overcloud-minimal

   Copy to Clipboard Toggle word wrap

2. Replace <roleName> with the name of the role and append Image to the name of the role. The following example shows an overcloud-minimal image for Ceph storage nodes:

   parameter_defaults:
     CephStorageImage: overcloud-minimal

   Copy to Clipboard Toggle word wrap
3. Pass the environment file to the openstack overcloud deploy command.

Procedure

1. Create a node-info.yaml file in the /home/stack/templates/ directory:

   (undercloud) $ touch /home/stack/templates/node-info.yaml

   Copy to Clipboard Toggle word wrap

2. Edit the file to include the node counts and flavors your need. This example contains 3 Controller nodes and 3 Compute nodes:

   parameter_defaults:
     OvercloudControllerFlavor: control
     OvercloudComputeFlavor: compute
     ControllerCount: 3
     ComputeCount: 3

   Copy to Clipboard Toggle word wrap

Procedure

1. Open the certificate file and copy only the certificate portion. Do not include the key:

   $ vi /home/stack/ca.crt.pem

   Copy to Clipboard Toggle word wrap

   The certificate portion you need will look similar to this shortened example:

   -----BEGIN CERTIFICATE-----
   MIIDlTCCAn2gAwIBAgIJAOnPtx2hHEhrMA0GCSqGSIb3DQEBCwUAMGExCzAJBgNV
   BAYTAlVTMQswCQYDVQQIDAJOQzEQMA4GA1UEBwwHUmFsZWlnaDEQMA4GA1UECgwH
   UmVkIEhhdDELMAkGA1UECwwCUUUxFDASBgNVBAMMCzE5Mi4xNjguMC4yMB4XDTE3
   -----END CERTIFICATE-----

   Copy to Clipboard Toggle word wrap

2. Create a new YAML file called /home/stack/inject-trust-anchor-hiera.yaml with the following contents, and include the certificate you copied from the PEM file:

   parameter_defaults:
     CAMap:
       undercloud-ca:
         content: |
           -----BEGIN CERTIFICATE-----
           MIIDlTCCAn2gAwIBAgIJAOnPtx2hHEhrMA0GCSqGSIb3DQEBCwUAMGExCzAJBgNV
           BAYTAlVTMQswCQYDVQQIDAJOQzEQMA4GA1UEBwwHUmFsZWlnaDEQMA4GA1UECgwH
           UmVkIEhhdDELMAkGA1UECwwCUUUxFDASBgNVBAMMCzE5Mi4xNjguMC4yMB4XDTE3
           -----END CERTIFICATE-----

   Copy to Clipboard Toggle word wrap

1. Modify parameters in the custom environment files and Heat templates
2. Run the openstack overcloud deploy command again with the same environment files

Procedure

1. The core Heat templates for the overcloud are in a Jinja2 format. To validate your templates, render a version without Jinja2 formatting using the following commands:

   $ cd /usr/share/openstack-tripleo-heat-templates
   $ ./tools/process-templates.py -o ~/overcloud-validation

   Copy to Clipboard Toggle word wrap

2. Use the following command to validate the template syntax:

   (undercloud) $ openstack orchestration template validate --show-nested \
     --template ~/overcloud-validation/overcloud.yaml
     -e ~/overcloud-validation/overcloud-resource-registry-puppet.yaml \
     -e [ENVIRONMENT FILE] \
     -e [ENVIRONMENT FILE]

   Copy to Clipboard Toggle word wrap

   The validation requires the overcloud-resource-registry-puppet.yaml environment file to include overcloud-specific resources. Add any additional environment files to this command with -e option. Also include the --show-nested option to resolve parameters from nested templates.

3. The validation command identifies any syntax errors in the template. If the template syntax validates successfully, the command returns a preview of the resulting overcloud template.