Chapter 84. undercloud

This chapter describes the commands under the undercloud command.

84.1. undercloud backup

Backup the undercloud

Usage:

openstack undercloud backup [--add-path ADD_PATH]
                                   [--exclude-path EXCLUDE_PATH]

Table 84.1. Optional Arguments

ValueSummary

--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

84.2. undercloud install

Install and setup the undercloud

Usage:

openstack undercloud install [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]

Table 84.2. Optional 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).

84.3. undercloud minion install

Install and setup the undercloud minion

Usage:

openstack undercloud minion install [--force-stack-update]
                                           [--no-validations] [--dry-run] [-y]

Table 84.3. Optional 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 minion configuration validations

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).

84.4. undercloud minion upgrade

Upgrade undercloud minion

Usage:

openstack undercloud minion upgrade [--force-stack-update]
                                           [--no-validations] [--dry-run] [-y]

Table 84.4. Optional 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 minion configuration validations

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).

84.5. undercloud upgrade

Upgrade undercloud

Usage:

openstack undercloud upgrade [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]

Table 84.5. Optional 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).