Director Installation and Usage

Procedure

1. Log in to your undercloud as the root user.

2. Create the stack user:

   [root@director ~]# useradd stack

   Copy to Clipboard Toggle word wrap

3. Set a password for the user:

   [root@director ~]# passwd stack

   Copy to Clipboard Toggle word wrap

4. Disable password requirements when using sudo:

   [root@director ~]# echo "stack ALL=(root) NOPASSWD:ALL" | tee -a /etc/sudoers.d/stack
   [root@director ~]# chmod 0440 /etc/sudoers.d/stack

   Copy to Clipboard Toggle word wrap

5. Switch to the new stack user:

   [root@director ~]# su - stack
   [stack@director ~]$

   Copy to Clipboard Toggle word wrap

6. Create directories for system images and heat templates:

   [stack@director ~]$ mkdir ~/images
   [stack@director ~]$ mkdir ~/templates

   Copy to Clipboard Toggle word wrap

   Director uses system images and heat templates to create the overcloud environment. Red Hat recommends creating these directories to help you organize your local file system.

7. Check the base and full hostname of the undercloud:

   [stack@director ~]$ hostname
   [stack@director ~]$ hostname -f

   Copy to Clipboard Toggle word wrap

   If either of the previous commands do not report the correct fully-qualified hostname or report an error, use hostnamectl to set a hostname:

   [stack@director ~]$ sudo hostnamectl set-hostname manager.example.com
   [stack@director ~]$ sudo hostnamectl set-hostname --transient manager.example.com

   Copy to Clipboard Toggle word wrap

8. Edit the /etc/hosts and include an entry for the system hostname. The IP address in /etc/hosts must match the address that you plan to use for your undercloud public API. For example, if the system is named manager.example.com and uses 10.0.0.1 for its IP address, add the following line to the /etc/hosts file:

   10.0.0.1  manager.example.com manager

   Copy to Clipboard Toggle word wrap

9. Register your system either with the Red Hat Content Delivery Network or with a Red Hat Satellite. For example, run the following command to register the system to the Content Delivery Network. Enter your Customer Portal user name and password when prompted:

   [stack@director ~]$ sudo subscription-manager register

   Copy to Clipboard Toggle word wrap

10. Find the entitlement pool ID for Red Hat OpenStack Platform (RHOSP) director:

    [stack@director ~]$ sudo subscription-manager list --available --all --matches="Red Hat OpenStack"
    Subscription Name:   Name of SKU
    Provides:            Red Hat Single Sign-On
                         Red Hat Enterprise Linux Workstation
                         Red Hat CloudForms
                         Red Hat OpenStack
                         Red Hat Software Collections (for RHEL Workstation)
                         Red Hat Virtualization
    SKU:                 SKU-Number
    Contract:            Contract-Number
    Pool ID:             Valid-Pool-Number-123456
    Provides Management: Yes
    Available:           1
    Suggested:           1
    Service Level:       Support-level
    Service Type:        Service-Type
    Subscription Type:   Sub-type
    Ends:                End-date
    System Type:         Physical

    Copy to Clipboard Toggle word wrap

11. Locate the Pool ID value and attach the Red Hat OpenStack Platform 16.0 entitlement:

    [stack@director ~]$ sudo subscription-manager attach --pool=Valid-Pool-Number-123456

    Copy to Clipboard Toggle word wrap

12. Lock the undercloud to Red Hat Enterprise Linux 8.1:

    $ sudo subscription-manager release --set=8.1

    Copy to Clipboard Toggle word wrap

13. Disable all default repositories, and then enable the required Red Hat Enterprise Linux repositories:

    [stack@director ~]$ sudo subscription-manager repos --disable=*
    [stack@director ~]$ sudo subscription-manager repos --enable=rhel-8-for-x86_64-baseos-eus-rpms --enable=rhel-8-for-x86_64-appstream-eus-rpms --enable=rhel-8-for-x86_64-highavailability-eus-rpms --enable=ansible-2.8-for-rhel-8-x86_64-rpms --enable=openstack-16-for-rhel-8-x86_64-rpms --enable=fast-datapath-for-rhel-8-x86_64-rpms

    Copy to Clipboard Toggle word wrap

    These repositories contain packages that the director installation requires.

14. Perform an update on your system to ensure that you have the latest base system packages:

    [stack@director ~]$ sudo dnf update -y
    [stack@director ~]$ sudo reboot

    Copy to Clipboard Toggle word wrap

15. Install the command line tools for director installation and configuration:

    [stack@director ~]$ sudo dnf install -y python3-tripleoclient

    Copy to Clipboard Toggle word wrap

Procedure

1. Enable the Ceph Tools repository:

   [stack@director ~]$ sudo subscription-manager repos --enable=rhceph-4-tools-for-rhel-8-x86_64-rpms

   Copy to Clipboard Toggle word wrap

2. Install the ceph-ansible package:

   [stack@director ~]$ sudo dnf install -y ceph-ansible

   Copy to Clipboard Toggle word wrap

Procedure

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

2. Generate the default container image preparation file:

   $ openstack tripleo container image prepare default \
     --local-push-destination \
     --output-env-file containers-prepare-parameter.yaml

   Copy to Clipboard Toggle word wrap

   This command includes the following additional options:

   • --local-push-destination sets the registry on the undercloud as the location for container images. This means the director pulls the necessary images from the Red Hat Container Catalog and pushes them to the registry on the undercloud. The director uses this registry as the container image source. To pull directly from the Red Hat Container Catalog, omit this option.

   • --output-env-file is an environment file name. The contents of this file include the parameters for preparing your container images. In this case, the name of the file is containers-prepare-parameter.yaml.

     Note

     You can use the same containers-prepare-parameter.yaml file to define a container image source for both the undercloud and the overcloud.

3. Modify the containers-prepare-parameter.yaml to suit your requirements.

Procedure

1. Edit the containers-prepare-parameter.yaml file to exclude the Ceph Storage containers:

   parameter_defaults:
     ContainerImagePrepare:
     - push_destination: true
       excludes:
         - ceph
         - prometheus
       set:
         …​

   Copy to Clipboard Toggle word wrap

   The excludes parameter uses regular expressions to exclude any container images that contain the ceph or prometheus strings.

2. Save the containers-prepare-parameter.yaml file.

Procedure

1. Create a list of all container images:

   $ sudo podman search --limit 1000 "registry.redhat.io/rhosp" | grep rhosp-rhel8 | awk '{ print $2 }' | grep -v beta | sed "s/registry.redhat.io\///g" | tail -n+2 > satellite_images

   Copy to Clipboard Toggle word wrap
2. Copy the satellite_images file to a system that contains the Satellite 6 hammer tool. Alternatively, use the instructions in the Hammer CLI Guide to install the hammer tool to the undercloud.

3. Run the following hammer command to create a new product (OSP16 Containers) in your Satellite organization:

   $ hammer product create \
     --organization "ACME" \
     --name "OSP16 Containers"

   Copy to Clipboard Toggle word wrap

   This custom product will contain your images.

4. Add the base container image to the product:

   $ hammer repository create \
     --organization "ACME" \
     --product "OSP16 Containers" \
     --content-type docker \
     --url https://registry.redhat.io \
     --docker-upstream-name rhosp-rhel8/openstack-base \
     --upstream-username USERNAME \
     --upstream-password PASSWORD \
     --name base

   Copy to Clipboard Toggle word wrap

5. Add the overcloud container images from the satellite_images file:

   $ while read IMAGE; do \
     IMAGENAME=$(echo $IMAGE | cut -d"/" -f2 | sed "s/openstack-//g" | sed "s/:.*//g") ; \
     hammer repository create \
     --organization "ACME" \
     --product "OSP16 Containers" \
     --content-type docker \
     --url https://registry.redhat.io \
     --docker-upstream-name $IMAGE \
     --upstream-username USERNAME \
     --upstream-password PASSWORD \
     --name $IMAGENAME ; done < satellite_images

   Copy to Clipboard Toggle word wrap

6. Add the Ceph Storage 4 container image:

   $ hammer repository create \
     --organization "ACME" \
     --product "OSP16 Containers" \
     --content-type docker \
     --url https://registry.redhat.io \
     --docker-upstream-name rhceph-beta/rhceph-4-rhel8 \
     --upstream-username USERNAME \
     --upstream-password PASSWORD \
     --name rhceph-4-rhel8

   Copy to Clipboard Toggle word wrap

7. Synchronize the container images:

   $ hammer product synchronize \
     --organization "ACME" \
     --name "OSP16 Containers"

   Copy to Clipboard Toggle word wrap

   Wait for the Satellite server to complete synchronization.

   Note

   Depending on your configuration, hammer might prompt you for your Satellite server username and password. You can configure hammer to log in automatically using a configuration file. For more information, see the "Authentication" section in the Hammer CLI Guide.

8. If your Satellite 6 server uses content views, create a new content view version to incorporate the images and promote it along environments in your application life cycle. This largely depends on how you structure your application lifecycle. For example, if you have an environment called production in your lifecycle and you want the container images to be available in that environment, create a content view that includes the container images and promote that content view to the production environment. For more information, see "Managing Content Views".

9. Check the available tags for the base image:

   $ hammer docker tag list --repository "base" \
     --organization "ACME" \
     --lifecycle-environment "production" \
     --content-view "myosp16" \
     --product "OSP16 Containers"

   Copy to Clipboard Toggle word wrap

   This command displays tags for the OpenStack Platform container images within a content view for a particular environment.

10. Return to the undercloud and generate a default environment file that prepares images using your Satellite server as a source. Run the following example command to generate the environment file:

    $ openstack tripleo container image prepare default \
      --output-env-file containers-prepare-parameter.yaml

    Copy to Clipboard Toggle word wrap
    • --output-env-file is an environment file name. The contents of this file include the parameters for preparing your container images for the undercloud. In this case, the name of the file is containers-prepare-parameter.yaml.

11. Edit the containers-prepare-parameter.yaml file and modify the following parameters:

    • push_destination - Set this to true or false depending on your chosen container image management strategy. If you set this parameter to false, the overcloud nodes pull images directly from the Satellite. If you set this parameter to true, the director pulls the images from the Satellite to the undercloud registry and the overcloud pulls the images from the undercloud registry.
    • namespace - The URL and port of the registry on the Satellite server. The default registry port on Red Hat Satellite is 5000.

    • name_prefix - The prefix is based on a Satellite 6 convention. This differs depending on whether you use content views:

      • If you use content views, the structure is [org]-[environment]-[content view]-[product]-. For example: acme-production-myosp16-osp16_containers-.
      • If you do not use content views, the structure is [org]-[product]-. For example: acme-osp16_containers-.
    • ceph_namespace, ceph_image, ceph_tag - If you use Ceph Storage, include these additional parameters to define the Ceph Storage container image location. Note that ceph_image now includes a Satellite-specific prefix. This prefix is the same value as the name_prefix option.

Procedure

1. Copy the default template to the home directory of the stack user’s:

   [stack@director ~]$ cp \
     /usr/share/python-tripleoclient/undercloud.conf.sample \
     ~/undercloud.conf

   Copy to Clipboard Toggle word wrap
2. Edit the undercloud.conf file. This file contains settings to configure your undercloud. If you omit or comment out a parameter, the undercloud installation uses the default value.

Procedure

1. Create an environment file named /home/stack/templates/custom-undercloud-params.yaml.

2. Edit this file and include your heat parameters. For example, to enable debugging for certain OpenStack Platform services include the following snippet in the custom-undercloud-params.yaml file:

   parameter_defaults:
     Debug: True

   Copy to Clipboard Toggle word wrap

   Save this file when you have finished.

3. Edit your undercloud.conf file and scroll to the custom_env_files parameter. Edit the parameter to point to your custom-undercloud-params.yaml environment file:

   custom_env_files = /home/stack/templates/custom-undercloud-params.yaml

   Copy to Clipboard Toggle word wrap
   Note

   You can specify multiple environment files using a comma-separated list.

Procedure

1. Create a hieradata override file, for example, /home/stack/hieradata.yaml.

2. Add the customized hieradata to the file. For example, add the following snippet to modify the Compute (nova) service parameter force_raw_images from the default value of True to False:

   nova::compute::force_raw_images: False

   Copy to Clipboard Toggle word wrap

   If there is no Puppet implementation for the parameter you want to set, then use the following method to configure the parameter:

   nova::config::nova_config:
     DEFAULT/<parameter_name>:
       value: <parameter_value>

   Copy to Clipboard Toggle word wrap

   For example:

   nova::config::nova_config:
     DEFAULT/network_allocate_retries:
       value: 20
     ironic/serial_console_state_timeout:
       value: 15

   Copy to Clipboard Toggle word wrap

3. Set the hieradata_override parameter in the undercloud.conf file to the path of the new /home/stack/hieradata.yaml file:

   hieradata_override = /home/stack/hieradata.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. Copy the sample undercloud.conf file, or modify your existing undercloud.conf file.

2. Set the following parameter values in the undercloud.conf file:

   1. Set ipv6_address_mode to dhcpv6-stateless or dhcpv6-stateful if your NIC supports stateful DHCPv6 with Red Hat OpenStack Platform. For more information about stateful DHCPv6 availability, see Bugzilla #1575026.
   2. Set enable_routed_networks to true if you do not want the undercloud to create a router on the provisioning network. In this case, the data center router must provide router advertisements. Otherwise, set this value to false.
   3. Set local_ip to the IPv6 address of the undercloud.
   4. Use IPv6 addressing for the undercloud interface parameters undercloud_public_host and undercloud_admin_host.

   5. In the [ctlplane-subnet] section, use IPv6 addressing in the following parameters:

      • cidr
      • dhcp_start
      • dhcp_end
      • gateway
      • inspection_iprange

   6. In the [ctlplane-subnet] section, set an IPv6 nameserver for the subnet in the dns_nameservers parameter.

      ipv6_address_mode = dhcpv6-stateless
      enable_routed_networks: false
      local_ip = <ipv6-address>
      undercloud_admin_host = <ipv6-address>
      undercloud_public_host = <ipv6-address>
      
      [ctlplane-subnet]
      cidr = <ipv6-address>::<ipv6-mask>
      dhcp_start = <ipv6-address>
      dhcp_end = <ipv6-address>
      dns_nameservers = <ipv6-dns>
      gateway = <ipv6-address>
      inspection_iprange = <ipv6-address>,<ipv6-address>

      Copy to Clipboard Toggle word wrap

Procedure

1. Run the following command to install director on the undercloud:

   [stack@director ~]$ openstack undercloud install

   Copy to Clipboard Toggle word wrap

   This command launches the director configuration script. Director installs additional packages and configures its services according to the configuration in the undercloud.conf. This script takes several minutes to complete.

   The script generates two files:

   • undercloud-passwords.conf - A list of all passwords for the director services.
   • stackrc - A set of initialization variables to help you access the director command line tools.

2. The script also starts all OpenStack Platform service containers automatically. You can check the enabled containers with the following command:

   [stack@director ~]$ sudo podman ps

   Copy to Clipboard Toggle word wrap

3. To initialize the stack user to use the command line tools, run the following command:

   [stack@director ~]$ source ~/stackrc

   Copy to Clipboard Toggle word wrap

   The prompt now indicates that OpenStack commands authenticate and execute against the undercloud;

   (undercloud) [stack@director ~]$

   Copy to Clipboard Toggle word wrap

Procedure

1. Source the stackrc file to enable the director command line tools:

   [stack@director ~]$ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Set the nameservers for the ctlplane-subnet subnet:

   (undercloud) [stack@director images]$ openstack subnet set --dns-nameserver [nameserver1-ip] --dns-nameserver [nameserver2-ip] ctlplane-subnet

   Copy to Clipboard Toggle word wrap

   Use the --dns-nameserver option for each nameserver.

3. View the subnet to verify the nameserver:

   (undercloud) [stack@director images]$ openstack subnet show ctlplane-subnet
   +-------------------+-----------------------------------------------+
   | Field             | Value                                         |
   +-------------------+-----------------------------------------------+
   | ...               |                                               |
   | dns_nameservers   | 8.8.8.8                                       |
   | ...               |                                               |
   +-------------------+-----------------------------------------------+

   Copy to Clipboard Toggle word wrap

Procedure

1. Modify the undercloud configuration files. For example, edit the undercloud.conf file and add the idrac hardware type to the list of enabled hardware types:

   enabled_hardware_types = ipmi,redfish,idrac

   Copy to Clipboard Toggle word wrap

2. Run the openstack undercloud install command to refresh your undercloud with the new changes:

   [stack@director ~]$ openstack undercloud install

   Copy to Clipboard Toggle word wrap

   Wait until the command runs to completion.

3. Initialize the stack user to use the command line tools,:

   [stack@director ~]$ source ~/stackrc

   Copy to Clipboard Toggle word wrap

   The prompt now indicates that OpenStack commands authenticate and execute against the undercloud:

   (undercloud) [stack@director ~]$

   Copy to Clipboard Toggle word wrap

4. Verify that director has applied the new configuration. For this example, check the list of enabled hardware types:

   (undercloud) [stack@director ~]$ openstack baremetal driver list
   +---------------------+----------------+
   | Supported driver(s) | Active host(s) |
   +---------------------+----------------+
   | idrac               | unused         |
   | ipmi                | unused         |
   | redfish             | unused         |
   +---------------------+----------------+

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the minion host as the root user.

2. Create the stack user:

   [root@minion ~]# useradd stack

   Copy to Clipboard Toggle word wrap

3. Set a password for the stack user:

   [root@minion ~]# passwd stack

   Copy to Clipboard Toggle word wrap

4. Disable password requirements when using sudo:

   [root@minion ~]# echo "stack ALL=(root) NOPASSWD:ALL" | tee -a /etc/sudoers.d/stack
   [root@minion ~]# chmod 0440 /etc/sudoers.d/stack

   Copy to Clipboard Toggle word wrap

5. Switch to the new stack user:

   [root@minion ~]# su - stack
   [stack@minion ~]$

   Copy to Clipboard Toggle word wrap

6. Check the base and full hostname of the minion:

   [stack@minion ~]$ hostname
   [stack@minion ~]$ hostname -f

   Copy to Clipboard Toggle word wrap

   If either of the previous commands do not report the correct fully-qualified hostname or report an error, use hostnamectl to set a hostname:

   [stack@minion ~]$ sudo hostnamectl set-hostname minion.example.com
   [stack@minion ~]$ sudo hostnamectl set-hostname --transient minion.example.com

   Copy to Clipboard Toggle word wrap

7. Edit the /etc/hosts file and include an entry for the system hostname. For example, if the system is named minion.example.com and uses the IP address 10.0.0.1, add the following line to the /etc/hosts file:

   10.0.0.1  minion.example.com manager

   Copy to Clipboard Toggle word wrap

8. Register your system either with the Red Hat Content Delivery Network or Red Hat Satellite. For example, run the following command to register the system to the Content Delivery Network. Enter your Customer Portal user name and password when prompted:

   [stack@minion ~]$ sudo subscription-manager register

   Copy to Clipboard Toggle word wrap

9. Find the entitlement pool ID for Red Hat OpenStack Platform (RHOSP) director:

   [stack@minion ~]$ sudo subscription-manager list --available --all --matches="Red Hat OpenStack"
   Subscription Name:   Name of SKU
   Provides:            Red Hat Single Sign-On
                        Red Hat Enterprise Linux Workstation
                        Red Hat CloudForms
                        Red Hat OpenStack
                        Red Hat Software Collections (for RHEL Workstation)
                        Red Hat Virtualization
   SKU:                 SKU-Number
   Contract:            Contract-Number
   Pool ID:             Valid-Pool-Number-123456
   Provides Management: Yes
   Available:           1
   Suggested:           1
   Service Level:       Support-level
   Service Type:        Service-Type
   Subscription Type:   Sub-type
   Ends:                End-date
   System Type:         Physical

   Copy to Clipboard Toggle word wrap

10. Locate the Pool ID value and attach the Red Hat OpenStack Platform 16.0 entitlement:

    [stack@minion ~]$ sudo subscription-manager attach --pool=Valid-Pool-Number-123456

    Copy to Clipboard Toggle word wrap

11. Disable all default repositories, and then enable the required Red Hat Enterprise Linux repositories:

    [stack@minion ~]$ sudo subscription-manager repos --disable=*
    [stack@minion ~]$ sudo subscription-manager repos --enable=rhel-8-for-x86_64-baseos-eus-rpms --enable=rhel-8-for-x86_64-appstream-eus-rpms --enable=rhel-8-for-x86_64-highavailability-eus-rpms --enable=ansible-2.8-for-rhel-8-x86_64-rpms --enable=openstack-16-for-rhel-8-x86_64-rpms --enable=fast-datapath-for-rhel-8-x86_64-rpms

    Copy to Clipboard Toggle word wrap

    These repositories contain packages that the minion installation requires.

12. Perform an update on your system to ensure that you have the latest base system packages:

    [stack@minion ~]$ sudo dnf update -y
    [stack@minion ~]$ sudo reboot

    Copy to Clipboard Toggle word wrap

13. Install the command line tools for minion installation and configuration:

    [stack@minion ~]$ sudo dnf install -y python3-tripleoclient

    Copy to Clipboard Toggle word wrap

Procedure

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

2. Copy the files from the undercloud to the minion:

   $ scp ~/tripleo-undercloud-outputs.yaml ~/tripleo-undercloud-passwords.yaml stack@<minion-host>:~/.

   Copy to Clipboard Toggle word wrap

   Replace <minion-host> with the hostname or IP address of the minion.

Procedure

1. Log in to the minion host as the root user.

2. Copy the certificate authority file from the undercloud to the minion:

   [root@minion ~]# scp \
       root@<undercloud-host>:/etc/pki/ca-trust/source/anchors/cm-local-ca.pem \
       /etc/pki/ca-trust/source/anchors/undercloud-ca.pem

   Copy to Clipboard Toggle word wrap

   Replace <undercloud-host> with the hostname or IP address of the undercloud.

3. Update the trusted certificate authorities for the minion host:

   [root@minion ~]# update-ca-trust enable
   [root@minion ~]# update-ca-trust extract

   Copy to Clipboard Toggle word wrap

Procedure

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

2. Copy the default template to the home directory of the stack user:

   [stack@minion ~]$ cp \
     /usr/share/python-tripleoclient/minion.conf.sample \
     ~/minion.conf

   Copy to Clipboard Toggle word wrap

3. Edit the minion.conf file. This file contains settings to configure your minion. If you omit or comment out a parameter, the minion installation uses the default value. Review the following recommended parameters:

   • minion_hostname, which you set to the hostname of the minion.
   • minion_local_interface, which you set to the interface that connects to the undercloud through the Provisioning Network.
   • minion_local_ip, which you set to a free IP address on the Provisioning Network.
   • minion_nameservers, which you set to the DNS nameservers so that the minion can resolve hostnames.
   • enable_ironic_conductor, which defines whether to enable the ironic-conductor service.
   • enable_heat_engine, which defines whether to enable the heat-engine service.

Procedure

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

2. Run the following command to install the minion:

   [stack@minion ~]$ openstack undercloud minion install

   Copy to Clipboard Toggle word wrap

   This command launches the configuration script for the minion, installs additional packages, and configures minion services according to the configuration in the minion.conf file. This script takes several minutes to complete.

Procedure

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

2. Source the stackrc file:

   [stack@director ~]$ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. If you enabled the heat engine service on the minion, verify that the heat-engine service from the minion appears on the undercloud service list:

   [stack@director ~]$ $ openstack orchestration service list

   Copy to Clipboard Toggle word wrap

   The command output displays a table with heat-engine workers for both the undercloud and any minions.

4. If you enabled the ironic conductor service on the minion, verify that the ironic-conductor service from the minion appears on the undercloud service list:

   [stack@director ~]$ $ openstack baremetal conductor list

   Copy to Clipboard Toggle word wrap

   The command output displays a table with ironic-conductor services for both the undercloud and any minions.

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 that you want to use. This example uses the IPMI driver (ipmi).

   Note

   IPMI is the preferred supported power management driver. For more information about supported power management types and their options, see Appendix A, 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 you create the template, run the following commands to verify the formatting and syntax:

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

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

   This command registers each node from the template into director.

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

   (undercloud) $ openstack baremetal node list

   Copy to Clipboard Toggle word wrap

Procedure

1. Source the stackrc file.

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Run the openstack tripleo validator run command with the --group pre-introspection option:

   $ openstack tripleo validator run --group pre-introspection

   Copy to Clipboard Toggle word wrap
3. Review the results of the validation report.

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
   • Use the --all-manageable option to introspect only the nodes that are in a managed state. In this example, all nodes are in a managed state.
   • Use the --provide option to reset all nodes to an available state after introspection.

2. Monitor the introspection progress logs 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 that this process runs to completion. This process usually takes 15 minutes for bare metal nodes.

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

   Copy to Clipboard Toggle word wrap

   The addition of the profile:control and profile:compute 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 you complete 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. Set the Bare Metal service (ironic) boot interface to redfish-virtual-media:

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

   Copy to Clipboard Toggle word wrap

   Replace $NODE_NAME with the name of the node.

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

   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

   Replace $NODE 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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

   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.

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. Run the openstack baremetal node set --property root_device= command to set the root disk for a node. Include the most appropriate hardware attribute value to define the root disk.

   (undercloud) $ openstack baremetal node set --property root_device=’{“serial”:”<serial_number>”}' <node-uuid>

   Copy to Clipboard Toggle word wrap

   For example, to set the root device to disk 2, which has the serial number 61866da04f380d001ea4e13c12e36ad6 run the following command:

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 that you 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