Chapter 16. Configuring the overcloud with Ansible

Procedure

1. View the log with the less command:

   $ less ~/ansible.log

Procedure

1. Change to the config-download working directory for your overcloud, usually named overcloud:

   $ cd ~/config-download/overcloud

2. Run the git log command to list the commits in your working directory. You can also format the log output to show the date:

   $ git log --format=format:"%h%x09%cd%x09"
   a7e9063 Mon Oct 8 21:17:52 2018 +1000
   dfb9d12 Fri Oct 5 20:23:44 2018 +1000
   d0a910b Wed Oct 3 19:30:16 2018 +1000
   ...

   By default, the most recent commit appears first.

3. Run the git diff command against two commit hashes to see all changes between the deployments:

   $ git diff a7e9063 dfb9d12

Procedure

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

2. Source the stackrc file:

   $ source ~/stackrc

3. Run the deployment command. Include any environment files that you require for your overcloud:

   $ openstack overcloud deploy \
     --templates \
     -e environment-file1.yaml \
     -e environment-file2.yaml \
     ...

4. Wait until the deployment process completes.

Procedure

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

2. Source the stackrc file:

   $ source ~/stackrc

3. Run the deployment command with the --stack-only option. Include any environment files you require for your overcloud:

   $ openstack overcloud deploy \
     --templates \
     -e environment-file1.yaml \
     -e environment-file2.yaml \
     ...
     --stack-only

4. Wait until the provisioning process completes.

5. Enable SSH access from the undercloud to the overcloud for the tripleo-admin user. The config-download process uses the tripleo-admin user to perform the Ansible-based configuration:

   $ openstack overcloud admin authorize

6. Perform any manual pre-configuration tasks on nodes. If you use Ansible for configuration, use the tripleo-admin user to access the nodes.

7. Run the deployment command with the --config-download-only option. Include any environment files required for your overcloud:

   $ openstack overcloud deploy \
     --templates \
     -e environment-file1.yaml \
     -e environment-file2.yaml \
     ...
     --config-download-only

8. Wait until the configuration process completes.

Procedure

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

2. Run the ansible-playbook-command.sh script.

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

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

   Warning

   When --limit is used to deploy at scale, only hosts included in the execution are added to the SSH known_hosts file across the nodes. Therefore, some operations, such as live migration, may not work across nodes that are not in the known_hosts file.

   Note

   To ensure that the /etc/hosts file, on all nodes, is up-to-date, run the following command as the stack user:

   (undercloud)$ cd /home/stack/overcloud-deploy/overcloud/config-download/overcloud
   (undercloud)$ ANSIBLE_REMOTE_USER="tripleo-admin" ansible allovercloud \
     -i /home/stack/overcloud-deploy/overcloud/tripleo-ansible-inventory.yaml \
     -m include_role \
     -a name=tripleo_hosts_entries \
     -e @global_vars.yaml

3. Wait until the configuration process completes.

   Additional information

   • The working directory contains a playbook called deploy_steps_playbook.yaml, which manages the overcloud configuration tasks. To view this playbook, run the following command:

     $ less deploy_steps_playbook.yaml

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

   • The working directory also contains sub-directories that correspond to each role that you define in your overcloud 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:

     $ ls Controller/overcloud-controller-0

   • The Ansible tasks in deploy_steps_playbook.yaml are tagged. To see the full list of tags, use the CLI option --list-tags with 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:

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

4. When you run the config-download playbooks against the overcloud, you might receive a message regarding the SSH fingerprint for each host. To avoid these messages, include --ssh-common-args="-o StrictHostKeyChecking=no" when you run the ansible-playbook-command.sh script:

   $ ./ansible-playbook-command.sh --tags overcloud --ssh-common-args="-o StrictHostKeyChecking=no"

Procedure

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

2. Source the stackrc file:

   $ source ~/stackrc

3. Run the deployment command with the --stack-only option. Include any environment files required for your overcloud:

   $ openstack overcloud deploy \
     --templates \
     -e environment-file1.yaml \
     -e environment-file2.yaml \
     ...
     --stack-only

4. Wait until the provisioning process completes.

5. Enable SSH access from the undercloud to the overcloud for the tripleo-admin user. The config-download process uses the tripleo-admin user to perform the Ansible-based configuration:

   $ openstack overcloud admin authorize

6. Generate the config-download files:

   $ openstack overcloud deploy \
     --stack overcloud --stack-only \
     --config-dir  ~/overcloud-deploy/overcloud/config-download/overcloud/

   • --stack specifies the name of the overcloud.
   • --stack-only ensures that the command only deploys the heat stack and skips any software configuration.
   • --config-dir specifies the location of the config-download files.

7. Change to the directory that contains your config-download files:

   $ cd ~/config-download

8. Generate a static inventory file:

   $ tripleo-ansible-inventory \
     --stack <overcloud> \
     --ansible_ssh_user tripleo-admin \
     --static-yaml-inventory inventory.yaml

   • Replace <overcloud> with the name of your overcloud.

9. Use the ~/overcloud-deploy/overcloud/config-download/overcloud files and the static inventory file to perform a configuration. To execute the deployment playbook, run the ansible-playbook command:

   $ ansible-playbook \
     -i inventory.yaml \
     -e gather_facts=true \
     -e @global_vars.yaml \
     --private-key ~/.ssh/id_rsa \
     --become \
     ~/overcloud-deploy/overcloud/config-download/overcloud/deploy_steps_playbook.yaml

   Note

   When you run the config-download/overcloud playbooks against the overcloud, you might receive a message regarding the SSH fingerprint for each host. To avoid these messages, include --ssh-common-args="-o StrictHostKeyChecking=no" in your ansible-playbook command:

   $ ansible-playbook \
     -i inventory.yaml \
     -e gather_facts=true \
     -e @global_vars.yaml \
     --private-key ~/.ssh/id_rsa \
     --ssh-common-args="-o StrictHostKeyChecking=no" \
     --become \
     --tags overcloud \
     ~/overcloud-deploy/overcloud/config-download/overcloud/deploy_steps_playbook.yaml

10. Wait until the configuration process completes.

11. Generate an overcloudrc file manually from the ansible-based configuration:

    $ openstack action execution run \
      --save-result \
      --run-sync \
      tripleo.deployment.overcloudrc \
      '{"container":"overcloud"}' \
      | jq -r '.["result"]["overcloudrc.v3"]' > overcloudrc.v3

12. Manually set the deployment status to success:

    $ openstack workflow execution create tripleo.deployment.v1.set_deployment_status_success '{"plan": "<overcloud>"}'

    • Replace <overcloud> with the name of your overcloud.