Chapter 10. Configuring the overcloud with Ansible

Procedure

1. Source the stackrc file.

   $ source ~/stackrc

2. Run the overcloud deployment command and include the --config-download option and the environment file to disable heat-based configuration:

   $ openstack overcloud deploy --templates \
       --config-download \
       -e /usr/share/openstack-tripleo-heat-templates/environments/config-download-environment.yaml \
       --overcloud-ssh-user heat-admin \
       --overcloud-ssh-key ~/.ssh/id_rsa \
       [OTHER OPTIONS]

   Note the use of the following options:

   • --config-download enables the additional Mistral workflow, which applies the configuration with ansible-playbook instead of Heat.
   • -e /usr/share/openstack-tripleo-heat-templates/environments/config-download-environment.yaml is a required environment file that maps the Heat software deployment configuration resources to their Ansible-based equivalents. This provides the configuration data through the Heat API without Heat applying configuration.
   • --overcloud-ssh-user and --overcloud-ssh-key are used to SSH into each overcloud node, create an initial tripleo-admin user, and inject an SSH key into /home/tripleo-admin/.ssh/authorized_keys. To inject the SSH key, the user specifies credentials for the initial SSH connection with --overcloud-ssh-user (defaults to heat-admin) and --overcloud-ssh-key (defaults to ~/.ssh/id_rsa). To limit exposure to the private key specified with --overcloud-ssh-key, the director never passes this key to any API service, such as Heat or Mistral, and only the director’s openstack overcloud deploy command uses this key to enable access for the tripleo-admin user.

   When running this command, make sure you also include any other files relevant to your overcloud. For example:

   • Custom configuration environment files with -e
   • A custom roles (roles_data) file with --roles-file
   • A composable network (network_data) file with --networks-file

3. The overcloud deployment command performs the standard stack operations. However, when the overcloud stack reaches the configuration stage, the stack switches to the config-download method for configuring the overcloud:

   2018-05-08 02:48:38Z [overcloud-AllNodesDeploySteps-xzihzsekhwo6]: UPDATE_COMPLETE  Stack UPDATE completed successfully
   2018-05-08 02:48:39Z [AllNodesDeploySteps]: UPDATE_COMPLETE  state changed
   2018-05-08 02:48:45Z [overcloud]: UPDATE_COMPLETE  Stack UPDATE completed successfully
   
    Stack overcloud UPDATE_COMPLETE
   
   Deploying overcloud configuration

   Wait until the overcloud configuration completes.

4. After the Ansible configuration of the overcloud completes, the director provides a report of the successful and failed tasks and the access URLs for the overcloud:

   PLAY RECAP **********************************************************
   192.0.2.101        : ok=173  changed=42   unreachable=0    failed=0
   192.0.2.102        : ok=133  changed=42   unreachable=0    failed=0
   localhost          : ok=2    changed=0    unreachable=0    failed=0
   
   
   Ansible passed.
   Overcloud configuration completed.
   Started Mistral Workflow tripleo.deployment.v1.get_horizon_url. Execution ID: 0e4ca4f6-9d14-418a-9c46-27692649b584
   Overcloud Endpoint: http://10.0.0.1:5000/
   Overcloud Horizon Dashboard URL: http://10.0.0.1:80/dashboard
   Overcloud rc file: /home/stack/overcloudrc
   Overcloud Deployed

Procedure

1. Create an environment file (e.g. hostname-map.yaml) and include the HostnameMap parameter and the hostname mappings. Use the following syntax:

   parameter_defaults:
     HostnameMap:
       [HEAT HOSTNAME]: [ACTUAL HOSTNAME]
       [HEAT HOSTNAME]: [ACTUAL HOSTNAME]

   The [HEAT HOSTNAME] usually follows the following convention: [STACK NAME]-[ROLE]-[INDEX]. For example:

   parameter_defaults:
     HostnameMap:
       overcloud-controller-0: controller-00-rack01
       overcloud-controller-1: controller-01-rack02
       overcloud-controller-2: controller-02-rack03
       overcloud-novacompute-0: compute-00-rack01
       overcloud-novacompute-1: compute-01-rack01
       overcloud-novacompute-2: compute-02-rack01

2. Save the contents of hostname-map.yaml.

3. When running a config-download deployment, include the environment file with the -e option. For example:

   $ openstack overcloud deploy --templates \
       --config-download \
       -e /usr/share/openstack-tripleo-heat-templates/environments/config-download-environment.yaml \
       -e /home/stack/templates/hostname-map.yaml \
       --overcloud-ssh-user heat-admin \
       --overcloud-ssh-key ~/.ssh/id_rsa \
       [OTHER OPTIONS]

Procedure

1. The mistral group can read all files under /var/lib/mistral. Grant the interactive stack user on the undercloud read-only access to these files:

   $ sudo usermod -a -G mistral stack

2. Refresh the stack user’s permissions with the following command:

   [stack@director ~]$ exec su -l stack

   The command prompts you to log in again. Enter the stack user’s password.

3. Test read access to the /var/lib/mistral directory:

   $ ls /var/lib/mistral/

Procedure

1. List all executions using the openstack workflow execution list command and find the workflow ID of the chosen Mistral execution that executed config-download:

   $ openstack workflow execution list
   $ less /var/lib/mistral/<execution uuid>/ansible.log

   <execution uuid> is the UUID of the Mistral execution that ran ansible-playbook.

2. Alternatively, look for the most recently modified directory under /var/lib/mistral to quickly find the log for the most recent deployment:

   $ less /var/lib/mistral/$(ls -t /var/lib/mistral | head -1)/ansible.log

Procedure

1. Change to the directory of the Ansible playbook of your choice:

   $ cd /var/lib/mistral/<execution uuid>/

   <execution uuid> is the UUID of the Mistral execution that ran ansible-playbook.

2. Once in the mistral working directory, run ansible-playbook-command.sh to reproduce the deployment:

   $ ./ansible-playbook-command.sh

3. You can pass additional Ansible arguments to this script, which in turn are passed unchanged to the ansible-playbook command. This makes it is possible to take further advantage of Ansible features, such as check mode (--check), limiting hosts (--limit), or overriding variables (-e). For example:

   $ ./ansible-playbook-command.sh --limit Controller

4. The working directory contains a playbook called deploy_steps_playbook.yaml, which runs the overcloud configuration. To view this playbook:

   $ less deploy_steps_playbook.yaml

   The playbook uses various task files contained with the working directory. Some task files are common to all OpenStack Platform roles and some are specific to certain OpenStack Platform roles and servers.

5. The working directory also contains sub-directories that correspond to each role defined in your overcloud’s roles_data file. For example:

   $ ls Controller/

   Each OpenStack Platform role directory also contains sub-directories for individual servers of that role type. The directories use the composable role hostname format. For example:

   $ ls Controller/overcloud-controller-0

6. The Ansible tasks are tagged. To see the full list of tags use the CLI argument --list-tags for ansible-playbook:

   $ ansible-playbook -i tripleo-ansible-inventory.yaml --list-tags deploy_steps_playbook.yaml

   Then apply tagged configuration using the --tags, --skip-tags, or --start-at-task with the ansible-playbook-command.sh script. For example:

   $ ./ansible-playbook-command.sh --tags overcloud

Procedure

1. Source the stackrc file.

   $ source ~/stackrc

2. Run the overcloud deployment command but do not include the --config-download option or the 'config-download-environment.yaml` environment file:

   $ openstack overcloud deploy --templates \
       [OTHER OPTIONS]

   When running this command, make sure you also include any other files relevant to your overcloud. For example:

   • Custom configuration environment files with -e
   • A custom roles (roles_data) file with --roles-file
   • A composable network (network_data) file with --networks-file
3. The overcloud deployment command performs the standard stack operations, including configuration with Heat.