3.6. Configuring the Director
The director installation process requires certain settings to determine your network configurations. The settings are stored in a template located in the
stack
user's home directory as undercloud.conf
.
Red Hat provides a basic template to help determine the required settings for your installation. Copy this template to the
stack
user's home directory:
$ cp /usr/share/instack-undercloud/undercloud.conf.sample ~/undercloud.conf
The basic template contains the following parameters:
- local_ip
- The IP address defined for the director's Provisioning NIC. This is also the IP address the director uses for its DHCP and PXE boot services. Leave this value as the default
192.0.2.1/24
unless your are using a different subnet for the Provisioning network i.e. it conflicts with an existing IP address or subnet in your environment. - undercloud_public_vip
- The IP address defined for the director's Public API. Use an IP address on the Provisioning network that does not conflict with any other IP addresses or address ranges. For example,
192.0.2.2
. The director configuration attaches this IP address to its software bridge as a routed IP address, which uses the/32
netmask. - undercloud_admin_vip
- The IP address defined for the director's Admin API. Use an IP address on the Provisioning network that does not conflict with any other IP addresses or address ranges. For example,
192.0.2.3
. The director configuration attaches this IP address to its software bridge as a routed IP address, which uses the/32
netmask. - undercloud_service_certificate
- The location and filename of the certificate for OpenStack SSL communication. Ideally, you obtain this certificate from a trusted certificate authority. Otherwise generate your own self-signed certificate using the guidelines in Appendix B, SSL/TLS Certificate Configuration. These guidelines also contain instructions on setting the SELinux context for your certificate, whether self-signed or from an authority.
- local_interface
- The chosen interface for the director's Provisioning NIC. This is also the device the director uses for its DHCP and PXE boot services. Change this value to your chosen device. To see which device is connected, use the
ip addr
. For example, this is the result of anip addr
command:2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000 link/ether 52:54:00:75:24:09 brd ff:ff:ff:ff:ff:ff inet 192.168.122.178/24 brd 192.168.122.255 scope global dynamic eth0 valid_lft 3462sec preferred_lft 3462sec inet6 fe80::5054:ff:fe75:2409/64 scope link valid_lft forever preferred_lft forever 3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noop state DOWN link/ether 42:0b:c2:a5:c1:26 brd ff:ff:ff:ff:ff:ff
In this example, the External NIC useseth0
and the Provisioning NIC useseth1
, which is currently not configured. In this case, set thelocal_interface
toeth1
. The configuration script attaches this interface to a custom bridge defined with thediscovery_interface
parameter. - masquerade_network
- Defines the network to masquerade for external access. This provides the Provisioning network with a degree of network address translation (NAT) so that it has external access through the director. Leave this as the default (
192.0.2.0/24
) unless you are using a different subnet for the Provisioning network. - dhcp_start, dhcp_end
- The start and end of the DHCP allocation range for Overcloud nodes. Ensure this range contains enough IP addresses to allocate to your nodes.
- network_cidr
- The network that the director uses to manage Overcloud instances. This is the Provisioning network. Leave this as the default
192.0.2.0/24
unless you are using a different subnet for the Provisioning network. - network_gateway
- The gateway for the Overcloud instances. This is the discovery host, which forwards traffic to the External network. Leave this as the default
192.0.2.1
unless you are either using a different IP address for the director or want to directly use an external gateway.Note
The director's configuration script also automatically enables IP forwarding using the relevantsysctl
kernel parameter. - discovery_interface
- The bridge the director uses for node discovery. This is custom bridge that the director configuration creates. The
LOCAL_INTERFACE
attaches to this bridge. Leave this as the defaultbr-ctlplane
. - discovery_iprange
- A range of IP address that the director's discovery service uses during the PXE boot and provisioning process. Use comma-separated values to define the start and end of this range. For example,
192.0.2.100,192.0.2.120
. Make sure this range contains enough IP addresses for your nodes and does not conflict with the range fordhcp_start
anddhcp_end
. - discovery_runbench
- Runs a set of benchmarks during node discovery. Set to
1
to enable. This option is necessary if you aim to perform benchmark analysis when inspecting the hardware of registered nodes in the Advanced Scenario. See Section 6.2.3, “Automatically Tagging Nodes with Automated Health Check (AHC) Tools” for more details. - undercloud_debug
- Sets the log level of Undercloud services to
DEBUG
. Set this value totrue
to enable. - undercloud_db_password, undercloud_admin_token, undercloud_admin_password, undercloud_glance_password, etc
- The remaining parameters are the access details for all of the director's services. No change is required for the values. The director's configuration script automatically generates these values if blank in
undercloud.conf
. You can retrieve all values after the configuration script completes.Important
The configuration file examples for these parameters use<None>
as a placeholder value. Setting these values to<None>
leads to a deployment error.
Modify the values for these parameters to suit your network. When complete, save the file and run the following command:
$ openstack undercloud install
This launches the director's configuration script. The director installs additional packages and configures its services to suit the settings in the
undercloud.conf
. This script takes several minutes to complete.
The configuration script generates two files when complete:
undercloud-passwords.conf
- A list of all passwords for the director's services.stackrc
- A set of initialization variables to help you access the director's command line tools.
To initialize the
stack
user to use the command line tools, run the following command:
$ source ~/stackrc
You can now use the director's command line tools.