Chapter 85. undercloud

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

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--standalone

Run deployment as a standalone deployment with no undercloud.

--upgrade

Upgrade an existing deployment.

-y, --yes

Skip yes/no prompt (assume yes).

--stack STACK

Name for the ephemeral (one-time create and forget) heat stack.

--output-dir OUTPUT_DIR

Directory to output state, processed heat templates, ansible deployment files.

--output-only

Do not execute the ansible playbooks. by default the playbooks are saved to the output-dir and then executed.

--standalone-role STANDALONE_ROLE

The role to use for standalone configuration when populating the deployment actions.

-t <TIMEOUT>, --timeout <TIMEOUT>

Deployment timeout in minutes.

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data_undercloud.yaml in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Roles file, overrides the default /dev/null in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--heat-api-port <HEAT_API_PORT>

Heat api port to use for the installers private heat API instance. Optional. Default: 8006.)

--heat-user <HEAT_USER>

User to execute the non-privileged heat-all process. Defaults to heat.

--deployment-user DEPLOYMENT_USER

User who executes the tripleo deploy command. defaults to $SUDO_USER. If $SUDO_USER is unset it defaults to stack.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. If not specified the python version of the openstackclient will be used. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

--heat-container-image <HEAT_CONTAINER_IMAGE>

The container image to use when launching the heat-all process. Defaults to: tripleomaster/centos-binary- heat-all:current-tripleo

--heat-native [HEAT_NATIVE]

Execute the heat-all process natively on this host. This option requires that the heat-all binaries be installed locally on this machine. This option is enabled by default which means heat-all is executed on the host OS directly.

--local-ip <LOCAL_IP>

Local ip/cidr for undercloud traffic. required.

--control-virtual-ip <CONTROL_VIRTUAL_IP>

Control plane vip. this allows the undercloud installer to configure a custom VIP on the control plane.

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

Public nw vip. this allows the undercloud installer to configure a custom VIP on the public (external) NW.

--local-domain <LOCAL_DOMAIN>

Local domain for standalone cloud and its api endpoints

--cleanup

Cleanup temporary files. using this flag will remove the temporary files used during deployment in after the command is run.

--hieradata-override [HIERADATA_OVERRIDE]

Path to hieradata override file. when it points to a heat env file, it is passed in t-h-t via --environment-file. When the file contains legacy instack data, it is wrapped with <role>ExtraConfig and also passed in for t-h-t as a temp file created in --output-dir. Note, instack hiera data may be not t-h-t compatible and will highly likely require a manual revision.

--keep-running

Keep the ephemeral heat running after the stack operation is complete. This is for debugging purposes only. The ephemeral Heat can be used by openstackclient with: OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list where 8006 is the port specified by --heat- api-port.

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

--force-stack-update

Do a virtual update of the ephemeral heat stack (it cannot take real updates). New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--force-stack-create

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

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

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).

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

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).