Chapter 85. undercloud

This chapter describes the commands under the undercloud command.

85.1. undercloud backup

Backup the undercloud

Usage:

openstack undercloud backup [--init [INIT]] [--setup-nfs]
                                   [--setup-rear] [--cron] [--db-only]
                                   [--inventory INVENTORY]
                                   [--add-path ADD_PATH]
                                   [--exclude-path EXCLUDE_PATH]
                                   [--save-swift] [--extra-vars EXTRA_VARS]

Table 85.1. Command arguments

ValueSummary

--init [INIT]

Initialize environment for backup, using rear or nfs as args which will check for package install and configured ReaR or NFS server. Defaults to: rear. i.e. --init rear. WARNING: This flag will be deprecated and replaced by --setup-rear and --setup-nfs.

--setup-nfs

Setup the nfs server on the backup node which will install required packages and configuration on the host BackupNode in the ansible inventory.

--setup-rear

Setup rear on the undercloud host which will install and configure ReaR.

--cron

Sets up a new cron job that by default will execute a weekly backup at Sundays midnight, but that can be customized by using the tripleo_backup_and_restore_cron extra-var.

--db-only

Perform a db backup of the undercloud host. the db backup file will be stored in /home/stack with the name openstack-backup-mysql-<timestamp>.sql.

--inventory INVENTORY

Tripleo inventory file generated with tripleo-ansible- inventory command. Defaults to: /root/config- download/overcloud/tripleo-ansible-inventory.yaml

--add-path ADD_PATH

Add additional files to backup. defaults to: /home/stack/ i.e. --add-path /this/is/a/folder/ --add- path /this/is/a/texfile.txt.

--exclude-path EXCLUDE_PATH

Exclude path when performing the undercloud backup, this option can be specified multiple times. Defaults to: none i.e. --exclude-path /this/is/a/folder/ --exclude-path /this/is/a/texfile.txt.

--save-swift

Save backup to swift. defaults to: false special attention should be taken that Swift itself is backed up if you call this multiple times the backup size will grow exponentially.

--extra-vars EXTRA_VARS

Set additional variables as dict or as an absolute path of a JSON or YAML file type. i.e. --extra-vars {"key": "val", "key2": "val2"} i.e. --extra-vars /path/to/my_vars.yaml i.e. --extra-vars /path/to/my_vars.json. For more information about the variables that can be passed, visit: https://opendev.org/openstack/tripleo-ansible/src/bran ch/master/tripleo_ansible/roles/backup_and_restore/def aults/main.yml.

85.2. undercloud install

Install and setup the undercloud

Usage:

openstack undercloud install [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]
                                    [--disable-container-prepare]
                                    [--reproduce-command]

Table 85.2. Command arguments

ValueSummary

--force-stack-update

Do a virtual update of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--no-validations

Do not perform undercloud configuration validations

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).

--disable-container-prepare

Disable the container preparation actions to prevent container tags from being updated and new containers from being fetched. If you skip this but do not have the container parameters configured, the deployment action may fail.

--reproduce-command

Create a reproducer command with ansible commandline and all environments variables.

85.3. undercloud upgrade

Upgrade undercloud

Usage:

openstack undercloud upgrade [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]
                                    [--disable-container-prepare]
                                    [--reproduce-command]
                                    [--skip-package-updates]

Table 85.3. Command arguments

ValueSummary

--force-stack-update

Do a virtual update of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--no-validations

Do not perform undercloud configuration validations

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).

--disable-container-prepare

Disable the container preparation actions to prevent container tags from being updated and new containers from being fetched. If you skip this but do not have the container parameters configured, the deployment action may fail.

--reproduce-command

Create a reproducer command with ansible commandline and all environments variables.

--skip-package-updates

Flag to skip the package update when performing upgrades and updates