Chapter 4. Installing director on the undercloud

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

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

   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

   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

   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>

   For example:

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

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

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.
   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. When you use stateful addressing models, firmware, chain loaders, and operating systems might use different algorithms to generate an ID that the DHCP server tracks. DHCPv6 does not track addresses by MAC, and does not provide the same address back if the identifier value from the requester changes but the MAC address remains the same. If you want to use stateful DHCPv6, use the ironic_enabled_network_interfaces parameter to specify the neutron interface. You can also use the ironic_default_network_interface parameter to set the neutron interface as the default network interface for bare metal nodes:

      • ironic_enabled_network_interfaces = neutron,flat
      • ironic_default_network_interface = neutron

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

      • cidr
      • dhcp_start
      • dhcp_end
      • gateway
      • inspection_iprange

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

      [DEFAULT]
      ipv6_address_mode = dhcpv6-stateless
      enable_routed_networks: false
      local_ip = <ipv6-address>
      ironic_enabled_network_interfaces = neutron,flat
      ironic_default_network_interface = neutron
      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>

Procedure

1. Log in to the undercloud host.

2. Create a new file undercloud-os-net-config.json and include the network configuration that you require. For more information, see Network interface reference in the Advanced Overcloud Customization guide.

   Here is an example:

   {
     "network_config": [
       {
         "name": "br-ctlplane",
         "type": "ovs_bridge",
         "use_dhcp": false,
         "dns_servers": "192.168.122.1",
         "domain": "lab.example.com",
         "ovs_extra": [
           "br-set-external-id br-ctlplane bridge-id br-ctlplane"
         ],
         "addresses": [
           {
             "ip_netmask": "172.20.0.1/26"
           }
         ],
         "members": [
           {
             "type": "interface",
             "name": "nic2"
           }
         ]
       }
     ]
   }

   To create a network bond for a specific interface, use the following sample:

   {
     "network_config": [
       {
         "name": "br-ctlplane",
         "type": "ovs_bridge",
         "use_dhcp": false,
         "dns_servers": "192.168.122.1",
         "domain": "lab.example.com",
         "ovs_extra": [
           "br-set-external-id br-ctlplane bridge-id br-ctlplane"
         ],
         "addresses": [
           {
             "ip_netmask": "172.20.0.1/26"
           }
         ],
         "members": [
           {
             "name": "bond-ctlplane",
             "type": "linux_bond",
             "use_dhcp": false,
             "bonding_options": "mode=active-backup",
             "mtu": 1500,
             "members": [
               {
                 "type": "interface",
                 "name": "nic2"
               },
               {
                 "type": "interface",
                 "name": "nic3"
               }
             ]
           }
         ]
       }
     ]
   }

3. Include the path to the undercloud-os-net-config.json file in the net_config_override parameter in the undercloud.conf file:

   [DEFAULT]
   ...
   net_config_override=undercloud-os-net-config.json
   ...

   Note

   Director uses the file that you include in the net_config_override parameter as the template to generate the /etc/os-net-config/config.yaml file. os-net-config manages the interfaces that you define in the template, so you must perform all undercloud network interface customization in this file.

4. Install the undercloud.

Procedure

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

   [stack@director ~]$ openstack undercloud install

   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

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

   [stack@director ~]$ source ~/stackrc

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

   (undercloud) [stack@director ~]$

Procedure

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

   [stack@director ~]$ source ~/stackrc

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

   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                                       |
   | ...               |                                               |
   +-------------------+-----------------------------------------------+

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

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

   [stack@director ~]$ openstack undercloud install

   Wait until the command runs to completion.

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

   [stack@director ~]$ source ~/stackrc

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

   (undercloud) [stack@director ~]$

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               | director.example.com |
   | ipmi                | director.example.com |
   | redfish             | director.example.com |
   +---------------------+----------------------+