Chapter 15. Performing basic overcloud administration tasks

Procedure

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

2. Find the name of the node that you want to access:

   (undercloud)$ metalsmith list

   Copy to Clipboard Toggle word wrap

3. Connect to the node as the tripleo-admin user:

   (undercloud)$ ssh tripleo-admin@overcloud-controller-0

   Copy to Clipboard Toggle word wrap

Procedure

1. To modify the overcloud, make modifications to your custom environment files and heat templates, then rerun the openstack overcloud deploy command from your initial overcloud creation. For example, if you created an overcloud using Section 11.3, “Configuring and deploying the overcloud”, rerun the following command:

   $ source ~/stackrc
   (undercloud) $ openstack overcloud deploy --templates \
     -e ~/templates/overcloud-baremetal-deployed.yaml \
     -e ~/templates/network-environment.yaml \
     -e ~/templates/storage-environment.yaml \
     --ntp-server pool.ntp.org

   Copy to Clipboard Toggle word wrap

   Director checks the overcloud stack in heat, and then updates each item in the stack with the environment files and heat templates. Director does not recreate the overcloud, but rather changes the existing overcloud.

   Important

   Removing parameters from custom environment files does not revert the parameter value to the default configuration. You must identify the default value from the core heat template collection in /usr/share/openstack-tripleo-heat-templates and set the value in your custom environment file manually.

2. If you want to include a new environment file, add it to the openstack overcloud deploy command with the`-e` option. For example:

   $ source ~/stackrc
   (undercloud) $ openstack overcloud deploy --templates \
     -e ~/templates/new-environment.yaml \
     -e ~/templates/network-environment.yaml \
     -e ~/templates/storage-environment.yaml \
     -e ~/templates/overcloud-baremetal-deployed.yaml \
     --ntp-server pool.ntp.org

   Copy to Clipboard Toggle word wrap

   This command includes the new parameters and resources from the environment file into the stack.

   Important

   It is not advisable to make manual modifications to the overcloud configuration because director might overwrite these modifications later.

Procedure

1. On the existing OpenStack environment, create a new image by taking a snapshot of a running server and download the image:

   $ openstack server image create --name <image_name> <instance_name>
   $ openstack image save --file <exported_vm.qcow2> <image_name>

   Copy to Clipboard Toggle word wrap
   • Replace <instance_name> with the name of the instance.
   • Replace <image_name> with the name of the new image.
   • Replace <exported_vm.qcow2> with the name of the exported virtual machine.

2. Copy the exported image to the undercloud node:

   $ scp exported_vm.qcow2 stack@192.168.0.2:~/.

   Copy to Clipboard Toggle word wrap
3. Log in to the undercloud as the stack user.

4. Source the overcloudrc credentials file:

   $ source ~/overcloudrc

   Copy to Clipboard Toggle word wrap

5. Upload the exported image into the overcloud:

   (overcloud) $ openstack image create --disk-format qcow2  -file <exported_vm.qcow2> --container-format bare <image_name>

   Copy to Clipboard Toggle word wrap

6. Launch a new instance:

   (overcloud) $ openstack server create  --key-name default --flavor m1.demo --image imported_image --nic net-id=net_id <instance_name>

   Copy to Clipboard Toggle word wrap

Procedure

1. Use the openstack tripleo launch heat command to launch the ephemeral Heat process:

   (undercloud)$ openstack tripleo launch heat --heat-dir /home/stack/overcloud-deploy/overcloud/heat-launcher --restore-db

   Copy to Clipboard Toggle word wrap

   The command exits after launching the Heat process, the Heat process continues to run in the background as a podman pod.

2. Use the podman pod ps command to verify that the ephemeral-heat process is running:

   (undercloud)$ sudo podman pod ps
   POD ID        NAME            STATUS      CREATED        INFRA ID      # OF CONTAINERS
   958b141609b2  ephemeral-heat  Running     2 minutes ago  44447995dbcf  3

   Copy to Clipboard Toggle word wrap

3. Use the export command to export the OS_CLOUD environment:

   (undercloud)$ export OS_CLOUD=heat

   Copy to Clipboard Toggle word wrap

4. Use the openstack stack list command to list the installed stacks:

   (undercloud)$ openstack stack list
   +--------------------------------------+------------+---------+-----------------+----------------------+--------------+
   | ID                                   | Stack Name | Project | Stack Status    | Creation Time        | Updated Time |
   +--------------------------------------+------------+---------+-----------------+----------------------+--------------+
   | 761e2a54-c6f9-4e0f-abe6-c8e0ad51a76c | overcloud  | admin   | CREATE_COMPLETE | 2022-08-29T20:48:37Z | None         |
   +--------------------------------------+------------+---------+-----------------+----------------------+--------------+

   Copy to Clipboard Toggle word wrap

   You can debug with commands such as openstack stack environment show and openstack stack resource list.

5. After you have finished debugging, stop the emphemeral Heat process:

   (undercloud)$ openstack tripleo launch heat --kill

   Copy to Clipboard Toggle word wrap

Procedure

1. To view your inventory of nodes, run the following Ansible ad-hoc command:

   (undercloud) [stack@undercloud ~]$ ansible -i ./overcloud-deploy/overcloud/tripleo-ansible-inventory.yaml all --list

   Copy to Clipboard Toggle word wrap

2. To execute Ansible playbooks on your environment, run the ansible command and include the full path to inventory file using the -i option. For example:

   (undercloud) $ ansible <hosts> -i ./overcloud-deploy/tripleo-ansible-inventory.yaml <playbook> <options>

   Copy to Clipboard Toggle word wrap

   • Replace <hosts> with the type of hosts that you want to use to use:

     • controller for all Controller nodes
     • compute for all Compute nodes
     • overcloud for all overcloud child nodes. For example, controller and compute nodes
     • "*" for all nodes

   • Replace <options> with additional Ansible options.

     • Use the --ssh-extra-args='-o StrictHostKeyChecking=no' option to bypass confirmation on host key checking.
     • Use the -u [USER] option to change the SSH user that executes the Ansible automation. The default SSH user for the overcloud is automatically defined using the ansible_ssh_user parameter in the dynamic inventory. The -u option overrides this parameter.
     • Use the -m [MODULE] option to use a specific Ansible module. The default is command, which executes Linux commands.
     • Use the -a [MODULE_ARGS] option to define arguments for the chosen module.

Procedure

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

2. Source the stackrc undercloud credentials file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. Retrieve a list of all the nodes in your stack and their current status:

   (undercloud)$ openstack baremetal node list
   +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+
   | UUID                                 | Name         | Instance UUID                        | Power State | Provisioning State | Maintenance |
   +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+
   | 92ae71b0-3c31-4ebb-b467-6b5f6b0caac7 | compute-0    | 059fb1a1-53ea-4060-9a47-09813de28ea1 | power on    | active             | False       |
   | 9d6f955e-3d98-4d1a-9611-468761cebabf | compute-1    | e73a4b50-9579-4fe1-bd1a-556a2c8b504f | power on    | active             | False       |
   | 8a686fc1-1381-4238-9bf3-3fb16eaec6ab | controller-0 | 6d69e48d-10b4-45dd-9776-155a9b8ad575 | power on    | active             | False       |
   | eb8083cc-5f8f-405f-9b0c-14b772ce4534 | controller-1 | 1f836ac0-a70d-4025-88a3-bbe0583b4b8e | power on    | active             | False       |
   | a6750f1f-8901-41d6-b9f1-f5d6a10a76c7 | controller-2 | e2edd028-cea6-4a98-955e-5c392d91ed46 | power on    | active             | False       |
   +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+

   Copy to Clipboard Toggle word wrap

4. Delete the overcloud stack and unprovision the nodes and networks:

   (undercloud)$ openstack overcloud delete -b <node_definition_file> \
    --networks-file <networks_definition_file> --network-ports <stack>

   Copy to Clipboard Toggle word wrap
   • Replace <node_definition_file> with the name of your node definition file, for example, overcloud-baremetal-deploy.yaml.
   • Replace <networks_definition_file> with the name of your networks definition file, for example, network_data_v2.yaml.
   • Replace <stack> with the name of the stack that you want to delete. If not specified, the default stack is overcloud.

5. Confirm that you want to delete the overcloud:

   Are you sure you want to delete this overcloud [y/N]?

   Copy to Clipboard Toggle word wrap
6. Wait for the overcloud to delete and the nodes and networks to unprovision.

7. Confirm that the bare-metal nodes have been unprovisioned:

   (undercloud) [stack@undercloud-0 ~]$ openstack baremetal node list
   +--------------------------------------+--------------+---------------+-------------+--------------------+-------------+
   | UUID                                 | Name         | Instance UUID | Power State | Provisioning State | Maintenance |
   +--------------------------------------+--------------+---------------+-------------+--------------------+-------------+
   | 92ae71b0-3c31-4ebb-b467-6b5f6b0caac7 | compute-0    | None          | power off   | available          | False       |
   | 9d6f955e-3d98-4d1a-9611-468761cebabf | compute-1    | None          | power off   | available          | False       |
   | 8a686fc1-1381-4238-9bf3-3fb16eaec6ab | controller-0 | None          | power off   | available          | False       |
   | eb8083cc-5f8f-405f-9b0c-14b772ce4534 | controller-1 | None          | power off   | available          | False       |
   | a6750f1f-8901-41d6-b9f1-f5d6a10a76c7 | controller-2 | None          | power off   | available          | False       |
   +--------------------------------------+--------------+---------------+-------------+--------------------+-------------+

   Copy to Clipboard Toggle word wrap

8. Remove the stack directories:

   $ rm -rf ~/overcloud-deploy/<stack>
   $ rm -rf ~/config-download/<stack>

   Copy to Clipboard Toggle word wrap
   Note

   The directory paths for your stack might be different from the default if you used the --output-dir and --working-dir options when deploying the overcloud with the openstack overcloud deploy command.