overcloud admin authorize¶

Deploy the ssh keys needed by Mistral.

openstack overcloud admin authorize
    [--stack STACK]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]

--stack <STACK>¶

Name or ID of heat stack (default=Env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

This command is provided by the python-tripleoclient plugin.

overcloud config download¶

Download Overcloud Config

openstack overcloud config download
    [--name NAME]
    [--config-dir CONFIG_DIR]
    [--config-type CONFIG_TYPE]
    [--no-preserve-config]

--name <NAME>¶

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

--config-dir <CONFIG_DIR>¶

The directory where the configuration files will be pushed

--config-type <CONFIG_TYPE>¶

Type of object config to be extract from the deployment, defaults to all keys available

--no-preserve-config¶

If specified, will delete and recreate the –config-dir if it already exists. Default is to use the existing dir location and overwrite files. Files in –config-dir not from the stack will be preserved by default.

This command is provided by the python-tripleoclient plugin.

overcloud container image build¶

Build overcloud container images with kolla-build.

openstack overcloud container image build
    [--config-file <yaml config file>]
    --kolla-config-file <config
    file>
    [--list-images]
    [--list-dependencies]
    [--exclude <container-name>]
    [--use-buildah]

--config-file <yaml config file>¶

YAML config file specifying the images to build. May be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append. If not specified, the default set of containers will be built.

--kolla-config-file <config file>¶

Path to a Kolla config file to use. Multiple config files can be specified, with values in later files taking precedence. By default, tripleo kolla conf file /home/zuul/src/opendev.org/openstack/python-tripleoclient/.tox/docs/share/tripleo-common/container-images/tripleo_kolla_config_overrides.conf is added.

--list-images¶

Show the images which would be built instead of building them.

--list-dependencies¶

Show the image build dependencies instead of building them.

--exclude <container-name>¶

Name of a container to match against the list of containers to be built to skip. Can be specified multiple times.

--use-buildah¶

Use Buildah instead of Docker to build the images with Kolla.

This command is provided by the python-tripleoclient plugin.

overcloud container image prepare¶

Generate files defining the images, tags and registry.

openstack overcloud container image prepare
    [--template-file <yaml template file>]
    [--pull-source <location>]
    [--push-destination <location>]
    [--tag <tag>]
    [--tag-from-label <image label>]
    [--namespace <namespace>]
    [--prefix <prefix>]
    [--suffix <suffix>]
    [--set <variable=value>]
    [--exclude <regex>]
    [--include <regex>]
    [--output-images-file <file path>]
    [--environment-file <file path>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--output-env-file <file path>]
    [--roles-file ROLES_FILE]
    [--modify-role MODIFY_ROLE]
    [--modify-vars MODIFY_VARS]

--template-file <yaml template file>¶

YAML template file which the images config file will be built from. Default: /home/zuul/src/opendev.org/openstack/python-tripleoclient/.tox/docs/share/tripleo-common/container-images/overcloud_containers.yaml.j2

--pull-source <location>¶

Location of image registry to pull images from. (DEPRECATED. Include the registry in –namespace)

--push-destination <location>¶

Location of image registry to push images to. If specified, a push_destination will be set for every image entry.

--tag <tag>¶

Override the default tag substitution. If –tag-from-label is specified, start discovery with this tag. Default: current-tripleo

--tag-from-label <image label>¶

Use the value of the specified label(s) to discover the tag. Labels can be combined in a template format, for example: {version}-{release}

--namespace <namespace>¶

Override the default namespace substitution. Default: docker.io/tripleostein

--prefix <prefix>¶

Override the default name prefix substitution. Default: centos-binary-

--suffix <suffix>¶

Override the default name suffix substitution. Default:

--set <variable=value>¶

Set the value of a variable in the template, even if it has no dedicated argument such as “–suffix”.

--exclude <regex>¶

Pattern to match against resulting imagename entries to exclude from the final output. Can be specified multiple times.

--include <regex>¶

Pattern to match against resulting imagename entries to include in final output. Can be specified multiple times, entries not matching any –include will be excluded. –exclude is ignored if –include is used.

--output-images-file <file path>¶

File to write resulting image entries to, as well as stdout. Any existing file will be overwritten.

--environment-file <file path>, -e <file path>¶

Environment files specifying which services are containerized. Entries will be filtered to only contain images used by containerized services. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the update command. Entries will be filtered to only contain images used by containerized services. Can be specified more than once. Files in directories are loaded in ascending sort order.

--output-env-file <file path>¶

File to write heat environment file which specifies all image parameters. Any existing file will be overwritten.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

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

--modify-role <MODIFY_ROLE>¶

Name of ansible role to run between every image upload pull and push.

--modify-vars <MODIFY_VARS>¶

Ansible variable file containing variables to use when invoking the role –modify-role.

This command is provided by the python-tripleoclient plugin.

overcloud container image tag discover¶

Discover the versioned tag for an image.

openstack overcloud container image tag discover
    --image <container
    image>
    [--tag-from-label <image label>]

--image <container image>¶

Fully qualified name of the image to discover the tag for (Including registry and stable tag).

--tag-from-label <image label>¶

Use the value of the specified label(s) to discover the tag. Labels can be combined in a template format, for example: {version}-{release}

This command is provided by the python-tripleoclient plugin.

overcloud container image upload¶

Push overcloud container images to registries.

openstack overcloud container image upload
    --config-file <yaml
    config
    file>
    [--cleanup <full, partial, none>]

--config-file <yaml config file>¶

YAML config file specifying the image build. May be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append.

--cleanup <full, partial, none>¶

Cleanup behavior for local images left after upload. The default ‘full’ will attempt to delete all local images. ‘partial’ will leave images required for deployment on this host. ‘none’ will do no cleanup.

This command is provided by the python-tripleoclient plugin.

overcloud credentials¶

Create the overcloudrc files

openstack overcloud credentials [--directory [DIRECTORY]] plan

--directory <DIRECTORY>¶

The directory to create the rc files. Defaults to the current directory.

plan¶

The name of the plan you want to create rc files for.

This command is provided by the python-tripleoclient plugin.

overcloud delete¶

Delete overcloud stack and plan

openstack overcloud delete [-y] [stack]

-y, --yes¶

Skip yes/no prompt (assume yes).

stack¶

Name or ID of heat stack to delete(default=Env: OVERCLOUD_STACK_NAME)

This command is provided by the python-tripleoclient plugin.

overcloud deploy¶

Deploy Overcloud

openstack overcloud deploy
    [--templates [TEMPLATES]]
    [--stack STACK]
    [--timeout <TIMEOUT>]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
    [--libvirt-type {kvm,qemu}]
    [--ntp-server NTP_SERVER]
    [--no-proxy NO_PROXY]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
    [--environment-file <HEAT ENVIRONMENT FILE>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--no-cleanup]
    [--update-plan-only]
    [--validation-errors-nonfatal]
    [--validation-warnings-fatal]
    [--disable-validations]
    [--inflight-validations]
    [--dry-run]
    [--run-validations]
    [--skip-postconfig]
    [--force-postconfig]
    [--skip-deploy-identifier]
    [--rhel-reg]
    [--reg-method {satellite,portal}]
    [--reg-org REG_ORG]
    [--reg-force]
    [--reg-sat-url REG_SAT_URL]
    [--reg-activation-key REG_ACTIVATION_KEY]
    [--answers-file ANSWERS_FILE]
    [--disable-password-generation]
    [--deployed-server]
    [--config-download]
    [--no-config-download]
    [--config-download-only]
    [--output-dir OUTPUT_DIR]
    [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
    [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy

--stack <STACK>¶

Stack name to create or update

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

Deployment timeout in minutes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes. (DEPRECATED. Use an environment file and set the parameter ControllerCount. It will be removed after the “P” release.)

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes. (DEPRECATED. Use an environment file and set the parameter ComputeCount. It will be removed after the “P” release.)

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter CephStorageCount. It will be removed after the “P” release.)

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes. (DEPRECATED. Use an environment file and set the parameter BlockStorageCount. It will be removed after the “P” release.)

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes. (DEPRECATED. Use an environment file and set the parameter ObjectStorageCount. It will be removed after the “P” release.)

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the “P” release.)

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the “P” release.)

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the “P” release.)

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the “P” release.)

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the “P” release.)

--libvirt-type <LIBVIRT_TYPE>¶

Libvirt domain type.

--ntp-server <NTP_SERVER>¶

The NTP for overcloud nodes.

--no-proxy <NO_PROXY>¶

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

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

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

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

Roles file, overrides the default roles_data.yaml in the –templates directory. May be an absolute path or the path relative to –templates

--networks-file <NETWORKS_FILE>, -n <NETWORKS_FILE>¶

Networks file, overrides the default network_data.yaml in the –templates directory

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--no-cleanup¶

Don’t cleanup temporary files, just log their location

--update-plan-only¶

Only update the plan. Do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal¶

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal¶

Exit if there are warnings from the configuration pre-checks.

--disable-validations¶

DEPRECATED. Disable the pre-deployment validations entirely. These validations are the built-in pre-deployment validations. To enable external validations from tripleo-validations, use the –run-validations flag. These validations are now run via the external validations in tripleo-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¶

Only run validations, but do not apply any changes.

--run-validations¶

Run external validations from the tripleo-validations project.

--skip-postconfig¶

Skip the overcloud post-deployment configuration.

--force-postconfig¶

Force the overcloud post-deployment configuration.

--skip-deploy-identifier¶

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--rhel-reg¶

Register overcloud nodes to the customer portal or a satellite.

--reg-method <REG_METHOD>¶

RHEL registration method to use for the overcloud nodes.

--reg-org <REG_ORG>¶

Organization key to use for registration.

--reg-force¶

Register the system even if it is already registered.

--reg-sat-url <REG_SAT_URL>¶

Satellite server to register overcloud nodes.

--reg-activation-key <REG_ACTIVATION_KEY>¶

Activation key to use for registration.

--answers-file <ANSWERS_FILE>¶

Path to a YAML file with arguments and parameters.

--disable-password-generation¶

Disable password generation.

--deployed-server¶

Use pre-provisioned overcloud nodes. Removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the–disable-validations.

--config-download¶

Run deployment via config-download mechanism. This is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only¶

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only¶

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir <OUTPUT_DIR>¶

Directory to use for saved output when using –config-download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg <OVERRIDE_ANSIBLE_CFG>¶

Path to ansible configuration file. The configuration in the file will override any configuration used by config-download by default.

--config-download-timeout <CONFIG_DOWNLOAD_TIMEOUT>¶

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the –timeout parameter after the stack operation.

--deployment-python-interpreter <DEPLOYMENT_PYTHON_INTERPRETER>¶

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

overcloud execute¶

Execute a Heat software config on the servers.

openstack overcloud execute [-s SERVER_NAME] [-g GROUP] file_in

-s <SERVER_NAME>, --server_name <SERVER_NAME>¶

Nova server_name or partial name to match.

-g <GROUP>, --group <GROUP>¶

Heat Software config “group” type. Defaults to “script”.

file_in¶

This command is provided by the python-tripleoclient plugin.

overcloud external-update run¶

Run external minor update Ansible playbook

This will run the external minor update Ansible playbook, executing tasks from the undercloud. The update playbooks are made available after completion of the ‘overcloud update prepare’ command.

openstack overcloud external-update run
    [--static-inventory STATIC_INVENTORY]
    [--ssh-user SSH_USER]
    [--tags TAGS]
    [--skip-tags SKIP_TAGS]
    [--stack STACK]
    [-e EXTRA_VARS]

--static-inventory <STATIC_INVENTORY>¶

Path to an existing ansible inventory to use. If not specified, one will be generated in ~/tripleo-ansible-inventory.yaml

--ssh-user <SSH_USER>¶

DEPRECATED: Only tripleo-admin should be used as ssh user.

--tags <TAGS>¶

A string specifying the tag or comma separated list of tags to be passed as –tags to ansible-playbook.

--skip-tags <SKIP_TAGS>¶

A string specifying the tag or comma separated list of tags to be passed as –skip-tags to ansible-playbook.

--stack <STACK>¶

Name or ID of heat stack (default=Env: OVERCLOUD_STACK_NAME)

-e <EXTRA_VARS>, --extra-vars <EXTRA_VARS>¶

Set additional variables as key=value or yaml/json

This command is provided by the python-tripleoclient plugin.

overcloud external-upgrade run¶

Run external major upgrade Ansible playbook

This will run the external major upgrade Ansible playbook, executing tasks from the undercloud. The upgrade playbooks are made available after completion of the ‘overcloud upgrade prepare’ command.

openstack overcloud external-upgrade run
    [--static-inventory STATIC_INVENTORY]
    [--ssh-user SSH_USER]
    [--tags TAGS]
    [--skip-tags SKIP_TAGS]
    [--stack STACK]
    [-e EXTRA_VARS]

--static-inventory <STATIC_INVENTORY>¶

Path to an existing ansible inventory to use. If not specified, one will be generated in ~/tripleo-ansible-inventory.yaml

--ssh-user <SSH_USER>¶

DEPRECATED: Only tripleo-admin should be used as ssh user.

--tags <TAGS>¶

A string specifying the tag or comma separated list of tags to be passed as –tags to ansible-playbook.

--skip-tags <SKIP_TAGS>¶

A string specifying the tag or comma separated list of tags to be passed as –skip-tags to ansible-playbook.

--stack <STACK>¶

Name or ID of heat stack (default=Env: OVERCLOUD_STACK_NAME)

-e <EXTRA_VARS>, --extra-vars <EXTRA_VARS>¶

Set additional variables as key=value or yaml/json

This command is provided by the python-tripleoclient plugin.

overcloud failures¶

Get deployment failures

openstack overcloud failures [--plan PLAN]

--plan <PLAN>, --stack <PLAN>¶

Name of the stack/plan. (default: overcloud)

This command is provided by the python-tripleoclient plugin.

overcloud ffwd-upgrade converge¶

Converge the fast-forward upgrade on Overcloud Nodes

This is the last step for completion of a fast forward upgrade. The main task is updating the plan and stack to unblock future stack updates. For the ffwd upgrade workflow we have set and used the config-download Software/Structured Deployment for the OS::TripleO and OS::Heat resources. This unsets those back to their default values.

openstack overcloud ffwd-upgrade converge
    [--templates [TEMPLATES]]
    [--stack STACK]
    [--timeout <TIMEOUT>]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
    [--libvirt-type {kvm,qemu}]
    [--ntp-server NTP_SERVER]
    [--no-proxy NO_PROXY]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
    [--environment-file <HEAT ENVIRONMENT FILE>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--no-cleanup]
    [--update-plan-only]
    [--validation-errors-nonfatal]
    [--validation-warnings-fatal]
    [--disable-validations]
    [--inflight-validations]
    [--dry-run]
    [--run-validations]
    [--skip-postconfig]
    [--force-postconfig]
    [--skip-deploy-identifier]
    [--rhel-reg]
    [--reg-method {satellite,portal}]
    [--reg-org REG_ORG]
    [--reg-force]
    [--reg-sat-url REG_SAT_URL]
    [--reg-activation-key REG_ACTIVATION_KEY]
    [--answers-file ANSWERS_FILE]
    [--disable-password-generation]
    [--deployed-server]
    [--config-download]
    [--no-config-download]
    [--config-download-only]
    [--output-dir OUTPUT_DIR]
    [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
    [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
    [--yes]

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy

--stack <STACK>¶

Stack name to create or update

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

Deployment timeout in minutes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes. (DEPRECATED. Use an environment file and set the parameter ControllerCount. It will be removed after the “P” release.)

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes. (DEPRECATED. Use an environment file and set the parameter ComputeCount. It will be removed after the “P” release.)

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter CephStorageCount. It will be removed after the “P” release.)

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes. (DEPRECATED. Use an environment file and set the parameter BlockStorageCount. It will be removed after the “P” release.)

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes. (DEPRECATED. Use an environment file and set the parameter ObjectStorageCount. It will be removed after the “P” release.)

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the “P” release.)

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the “P” release.)

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the “P” release.)

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the “P” release.)

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the “P” release.)

--libvirt-type <LIBVIRT_TYPE>¶

Libvirt domain type.

--ntp-server <NTP_SERVER>¶

The NTP for overcloud nodes.

--no-proxy <NO_PROXY>¶

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

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

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

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

Roles file, overrides the default roles_data.yaml in the –templates directory. May be an absolute path or the path relative to –templates

--networks-file <NETWORKS_FILE>, -n <NETWORKS_FILE>¶

Networks file, overrides the default network_data.yaml in the –templates directory

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--no-cleanup¶

Don’t cleanup temporary files, just log their location

--update-plan-only¶

Only update the plan. Do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal¶

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal¶

Exit if there are warnings from the configuration pre-checks.

--disable-validations¶

DEPRECATED. Disable the pre-deployment validations entirely. These validations are the built-in pre-deployment validations. To enable external validations from tripleo-validations, use the –run-validations flag. These validations are now run via the external validations in tripleo-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¶

Only run validations, but do not apply any changes.

--run-validations¶

Run external validations from the tripleo-validations project.

--skip-postconfig¶

Skip the overcloud post-deployment configuration.

--force-postconfig¶

Force the overcloud post-deployment configuration.

--skip-deploy-identifier¶

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--rhel-reg¶

Register overcloud nodes to the customer portal or a satellite.

--reg-method <REG_METHOD>¶

RHEL registration method to use for the overcloud nodes.

--reg-org <REG_ORG>¶

Organization key to use for registration.

--reg-force¶

Register the system even if it is already registered.

--reg-sat-url <REG_SAT_URL>¶

Satellite server to register overcloud nodes.

--reg-activation-key <REG_ACTIVATION_KEY>¶

Activation key to use for registration.

--answers-file <ANSWERS_FILE>¶

Path to a YAML file with arguments and parameters.

--disable-password-generation¶

Disable password generation.

--deployed-server¶

Use pre-provisioned overcloud nodes. Removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the–disable-validations.

--config-download¶

Run deployment via config-download mechanism. This is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only¶

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only¶

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir <OUTPUT_DIR>¶

Directory to use for saved output when using –config-download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg <OVERRIDE_ANSIBLE_CFG>¶

Path to ansible configuration file. The configuration in the file will override any configuration used by config-download by default.

--config-download-timeout <CONFIG_DOWNLOAD_TIMEOUT>¶

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the –timeout parameter after the stack operation.

--deployment-python-interpreter <DEPLOYMENT_PYTHON_INTERPRETER>¶

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

--yes¶

Use –yes to skip the confirmation required before any ffwd-upgrade operation. Use this with caution!

overcloud ffwd-upgrade prepare¶

Run heat stack update for overcloud nodes to refresh heat stack outputs.

The heat stack outputs are what we use later on to generate ansible playbooks which deliver the ffwd upgrade workflow. This is used as the first step for a fast forward upgrade of your overcloud.

openstack overcloud ffwd-upgrade prepare
    [--templates [TEMPLATES]]
    [--stack STACK]
    [--timeout <TIMEOUT>]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
    [--libvirt-type {kvm,qemu}]
    [--ntp-server NTP_SERVER]
    [--no-proxy NO_PROXY]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
    [--environment-file <HEAT ENVIRONMENT FILE>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--no-cleanup]
    [--update-plan-only]
    [--validation-errors-nonfatal]
    [--validation-warnings-fatal]
    [--disable-validations]
    [--inflight-validations]
    [--dry-run]
    [--run-validations]
    [--skip-postconfig]
    [--force-postconfig]
    [--skip-deploy-identifier]
    [--rhel-reg]
    [--reg-method {satellite,portal}]
    [--reg-org REG_ORG]
    [--reg-force]
    [--reg-sat-url REG_SAT_URL]
    [--reg-activation-key REG_ACTIVATION_KEY]
    [--answers-file ANSWERS_FILE]
    [--disable-password-generation]
    [--deployed-server]
    [--config-download]
    [--no-config-download]
    [--config-download-only]
    [--output-dir OUTPUT_DIR]
    [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
    [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
    [--yes]

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy

--stack <STACK>¶

Stack name to create or update

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

Deployment timeout in minutes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes. (DEPRECATED. Use an environment file and set the parameter ControllerCount. It will be removed after the “P” release.)

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes. (DEPRECATED. Use an environment file and set the parameter ComputeCount. It will be removed after the “P” release.)

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter CephStorageCount. It will be removed after the “P” release.)

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes. (DEPRECATED. Use an environment file and set the parameter BlockStorageCount. It will be removed after the “P” release.)

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes. (DEPRECATED. Use an environment file and set the parameter ObjectStorageCount. It will be removed after the “P” release.)

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the “P” release.)

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the “P” release.)

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the “P” release.)

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the “P” release.)

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the “P” release.)

--libvirt-type <LIBVIRT_TYPE>¶

Libvirt domain type.

--ntp-server <NTP_SERVER>¶

The NTP for overcloud nodes.

--no-proxy <NO_PROXY>¶

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

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

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

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

Roles file, overrides the default roles_data.yaml in the –templates directory. May be an absolute path or the path relative to –templates

--networks-file <NETWORKS_FILE>, -n <NETWORKS_FILE>¶

Networks file, overrides the default network_data.yaml in the –templates directory

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--no-cleanup¶

Don’t cleanup temporary files, just log their location

--update-plan-only¶

Only update the plan. Do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal¶

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal¶

Exit if there are warnings from the configuration pre-checks.

--disable-validations¶

DEPRECATED. Disable the pre-deployment validations entirely. These validations are the built-in pre-deployment validations. To enable external validations from tripleo-validations, use the –run-validations flag. These validations are now run via the external validations in tripleo-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¶

Only run validations, but do not apply any changes.

--run-validations¶

Run external validations from the tripleo-validations project.

--skip-postconfig¶

Skip the overcloud post-deployment configuration.

--force-postconfig¶

Force the overcloud post-deployment configuration.

--skip-deploy-identifier¶

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--rhel-reg¶

Register overcloud nodes to the customer portal or a satellite.

--reg-method <REG_METHOD>¶

RHEL registration method to use for the overcloud nodes.

--reg-org <REG_ORG>¶

Organization key to use for registration.

--reg-force¶

Register the system even if it is already registered.

--reg-sat-url <REG_SAT_URL>¶

Satellite server to register overcloud nodes.

--reg-activation-key <REG_ACTIVATION_KEY>¶

Activation key to use for registration.

--answers-file <ANSWERS_FILE>¶

Path to a YAML file with arguments and parameters.

--disable-password-generation¶

Disable password generation.

--deployed-server¶

Use pre-provisioned overcloud nodes. Removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the–disable-validations.

--config-download¶

Run deployment via config-download mechanism. This is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only¶

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only¶

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir <OUTPUT_DIR>¶

Directory to use for saved output when using –config-download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg <OVERRIDE_ANSIBLE_CFG>¶

Path to ansible configuration file. The configuration in the file will override any configuration used by config-download by default.

--config-download-timeout <CONFIG_DOWNLOAD_TIMEOUT>¶

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the –timeout parameter after the stack operation.

--deployment-python-interpreter <DEPLOYMENT_PYTHON_INTERPRETER>¶

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

--yes¶

Use –yes to skip the confirmation required before any ffwd-upgrade operation. Use this with caution!

overcloud ffwd-upgrade run¶

Run fast forward upgrade ansible playbooks on Overcloud nodes

This will run the fast_forward_upgrade_playbook.yaml ansible playbook. This playbook was generated when you ran the ‘ffwd-upgrade prepare’ command. Running ‘ffwd-upgrade run ‘ is the second step in the ffwd upgrade workflow.

openstack overcloud ffwd-upgrade run
    [--yes]
    [--static-inventory STATIC_INVENTORY]
    [--ssh-user SSH_USER]
    [--stack STACK]

--yes¶

Use –yes to skip the confirmation required before any ffwd-upgrade operation. Use this with caution!

--static-inventory <STATIC_INVENTORY>¶

Path to an existing ansible inventory to use. If not specified, one will be generated in ~/tripleo-ansible-inventory.yaml

--ssh-user <SSH_USER>¶

DEPRECATED: Only tripleo-admin should be used as ssh user.

--stack <STACK>¶

Name or ID of heat stack (default=Env: OVERCLOUD_STACK_NAME)

This command is provided by the python-tripleoclient plugin.

overcloud generate fencing¶

Generate fencing parameters

openstack overcloud generate fencing
    [-a FENCE_ACTION]
    [--delay DELAY]
    [--ipmi-lanplus]
    [--ipmi-no-lanplus]
    [--ipmi-cipher IPMI_CIPHER]
    [--ipmi-level IPMI_LEVEL]
    [--output OUTPUT]
    instackenv

-a <FENCE_ACTION>, --action <FENCE_ACTION>¶

DEPRECATED: This option is ignored.

--delay <DELAY>¶

Wait DELAY seconds before fencing is started

--ipmi-lanplus¶

DEPRECATED: This is the default.

--ipmi-no-lanplus¶

Do not use Lanplus. Defaults to: false

--ipmi-cipher <IPMI_CIPHER>¶

Ciphersuite to use (same as ipmitool -C parameter.

--ipmi-level <IPMI_LEVEL>¶

Privilegel level on IPMI device. Valid levels: callback, user, operator, administrator.

--output <OUTPUT>¶

Write parameters to a file

instackenv¶

This command is provided by the python-tripleoclient plugin.

overcloud image build¶

Build images for the overcloud

openstack overcloud image build
    [--config-file <yaml config file>]
    [--image-name <image name>]
    [--no-skip]
    [--output-directory OUTPUT_DIRECTORY]

--config-file <yaml config file>¶

YAML config file specifying the image build. May be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append.

--image-name <image name>¶

Name of image to build. May be specified multiple times. If unspecified, will build all images in given YAML files.

--no-skip¶

Skip build if cached image exists.

--output-directory <OUTPUT_DIRECTORY>¶

Output directory for images. Defaults to $TRIPLEO_ROOT,or current directory if unset.

This command is provided by the python-tripleoclient plugin.

overcloud image upload¶

Create overcloud glance images from existing image files.

openstack overcloud image upload
    [--image-path IMAGE_PATH]
    [--os-image-name OS_IMAGE_NAME]
    [--ironic-python-agent-name IPA_NAME]
    [--http-boot HTTP_BOOT]
    [--update-existing]
    [--whole-disk]
    [--architecture ARCHITECTURE]
    [--platform PLATFORM]
    [--image-type {os,ironic-python-agent}]
    [--progress]

--image-path <IMAGE_PATH>¶

Path to directory containing image files

--os-image-name <OS_IMAGE_NAME>¶

OpenStack disk image filename

--ironic-python-agent-name <IPA_NAME>¶

OpenStack ironic-python-agent (agent) image filename

--http-boot <HTTP_BOOT>¶

Root directory for the introspection image

--update-existing¶

Update images if already exist

--whole-disk¶

When set, the overcloud-full image to be uploaded will be considered as a whole disk one

--architecture <ARCHITECTURE>¶

Architecture type for these images, ‘x86_64’, ‘i386’ and ‘ppc64le’ are common options. This option should match at least one ‘arch’ value in instackenv.json

--platform <PLATFORM>¶

Platform type for these images. Platform is a sub-category of architecture. For example you may have generic images for x86_64 but offer images specific to SandyBridge (SNB).

--image-type <IMAGE_TYPE>¶

If specified, allows to restrict the image type to upload (os for the overcloud image or ironic-python-agent for the ironic-python-agent one)

--progress¶

Show progress bar for upload files action

This command is provided by the python-tripleoclient plugin.

overcloud netenv validate¶

Validate the network environment file.

openstack overcloud netenv validate [-f NETENV]

-f <NETENV>, --file <NETENV>¶

Path to the network environment file

This command is provided by the python-tripleoclient plugin.

overcloud node bios configure¶

Apply BIOS configuration on given nodes

openstack overcloud node bios configure
    [--all-manageable]
    [--configuration <configuration>]
    [<node_uuid> [<node_uuid> ...]]

--all-manageable¶

Configure BIOS for all nodes currently in ‘manageable’ state

--configuration <configuration>¶

BIOS configuration (YAML/JSON string or file name).

node_uuid¶

Baremetal Node UUIDs for the node(s) to configure BIOS

This command is provided by the python-tripleoclient plugin.

overcloud node bios reset¶

Reset BIOS configuration to factory default

openstack overcloud node bios reset
    [--all-manageable]
    [<node_uuid> [<node_uuid> ...]]

--all-manageable¶

Reset BIOS on all nodes currently in ‘manageable’ state

node_uuid¶

Baremetal Node UUIDs for the node(s) to reset BIOS

This command is provided by the python-tripleoclient plugin.

overcloud node clean¶

Run node(s) through cleaning.

openstack overcloud node clean
    [--all-manageable]
    [--provide]
    [<node_uuid> [<node_uuid> ...]]

--all-manageable¶

Clean all nodes currently in ‘manageable’ state

--provide¶

Provide (make available) the nodes once cleaned

node_uuid¶

Baremetal Node UUIDs for the node(s) to be cleaned

This command is provided by the python-tripleoclient plugin.

overcloud node configure¶

Configure Node boot options.

openstack overcloud node configure
    [--all-manageable]
    [--deploy-kernel DEPLOY_KERNEL]
    [--deploy-ramdisk DEPLOY_RAMDISK]
    [--instance-boot-option {local,netboot}]
    [--root-device ROOT_DEVICE]
    [--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE]
    [--overwrite-root-device-hints]
    [<node_uuid> [<node_uuid> ...]]

--all-manageable¶

Configure all nodes currently in ‘manageable’ state

--deploy-kernel <DEPLOY_KERNEL>¶

Image with deploy kernel.

--deploy-ramdisk <DEPLOY_RAMDISK>¶

Image with deploy ramdisk.

--instance-boot-option <INSTANCE_BOOT_OPTION>¶

Whether to set instances for booting from local hard drive (local) or network (netboot).

--root-device <ROOT_DEVICE>¶

Define the root device for nodes. Can be either a list of device names (without /dev) to choose from or one of two strategies: largest or smallest. For it to work this command should be run after the introspection.

--root-device-minimum-size <ROOT_DEVICE_MINIMUM_SIZE>¶

Minimum size (in GiB) of the detected root device. Used with –root-device.

--overwrite-root-device-hints¶

Whether to overwrite existing root device hints when –root-device is used.

node_uuid¶

Baremetal Node UUIDs for the node(s) to be configured

This command is provided by the python-tripleoclient plugin.

overcloud node delete¶

Delete overcloud nodes.

openstack overcloud node delete
    [--stack STACK]
    [--templates [TEMPLATES]]
    [-e <HEAT ENVIRONMENT FILE>]
    [--timeout <TIMEOUT>]
    <node>
    [<node> ...]

--stack <STACK>¶

Name or ID of heat stack to scale (default=Env: OVERCLOUD_STACK_NAME)

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy. This argument is deprecated. The command now utilizes a deployment plan, which should be updated prior to running this command, should that be required. Otherwise this argument will be silently ignored.

-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.) This argument is deprecated. The command now utilizes a deployment plan, which should be updated prior to running this command, should that be required. Otherwise this argument will be silently ignored.

--timeout <TIMEOUT>¶

Timeout in minutes to wait for the nodes to be deleted. Keep in mind that due to keystone session duration that timeout has an upper bound of 4 hours

node¶

Node ID(s) to delete

This command is provided by the python-tripleoclient plugin.

overcloud node discover¶

Discover overcloud nodes by polling their BMCs.

openstack overcloud node discover
    (--ip <ips> | --range <range>)
    --credentials <key
    :value>
    [--port <ports>]
    [--introspect]
    [--run-validations]
    [--provide]
    [--no-deploy-image]
    [--instance-boot-option {local,netboot}]

--ip <ips>¶

IP address(es) to probe

--range <range>¶

IP range to probe

--credentials <key:value>¶

Key/value pairs of possible credentials

--port <ports>¶

BMC port(s) to probe

--introspect¶

Introspect the imported nodes

--run-validations¶

Run the pre-deployment validations. These external validations are from the TripleO Validations project.

--provide¶

Provide (make available) the nodes

--no-deploy-image¶

Skip setting the deploy kernel and ramdisk.

--instance-boot-option <INSTANCE_BOOT_OPTION>¶

Whether to set instances for booting from local hard drive (local) or network (netboot).

This command is provided by the python-tripleoclient plugin.

overcloud node import¶

Import baremetal nodes from a JSON, YAML or CSV file.

The node status will be set to ‘manageable’ by default.

openstack overcloud node import
    [--introspect]
    [--run-validations]
    [--validate-only]
    [--provide]
    [--no-deploy-image]
    [--instance-boot-option {local,netboot}]
    env_file

--introspect¶

Introspect the imported nodes

--run-validations¶

Run the pre-deployment validations. These external validations are from the TripleO Validations project.

--validate-only¶

Validate the env_file and then exit without actually importing the nodes.

--provide¶

Provide (make available) the nodes

--no-deploy-image¶

Skip setting the deploy kernel and ramdisk.

--instance-boot-option <INSTANCE_BOOT_OPTION>¶

Whether to set instances for booting from local hard drive (local) or network (netboot).

env_file¶

This command is provided by the python-tripleoclient plugin.

overcloud node introspect¶

Introspect specified nodes or all nodes in ‘manageable’ state.

openstack overcloud node introspect
    [--all-manageable]
    [--provide]
    [--run-validations]
    [<node_uuid> [<node_uuid> ...]]

--all-manageable¶

Introspect all nodes currently in ‘manageable’ state

--provide¶

Provide (make available) the nodes once introspected

--run-validations¶

Run the pre-deployment validations. These external validations are from the TripleO Validations project.

node_uuid¶

Baremetal Node UUIDs for the node(s) to be introspected

This command is provided by the python-tripleoclient plugin.

overcloud node provide¶

Mark nodes as available based on UUIDs or current ‘manageable’ state.

openstack overcloud node provide
    [--all-manageable]
    [<node_uuid> [<node_uuid> ...]]

--all-manageable¶

Provide all nodes currently in ‘manageable’ state

node_uuid¶

Baremetal Node UUIDs for the node(s) to be provided

This command is provided by the python-tripleoclient plugin.

overcloud node provision¶

Provision a new node using Ironic.

openstack overcloud node provision
    [-o OUTPUT]
    [--stack STACK]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    <baremetal_deployment.yaml>

-o <OUTPUT>, --output <OUTPUT>¶

The output environment file path

--stack <STACK>¶

Name or ID of heat stack (default=Env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for SSH access to newly deployed nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Public key path for SSH access to newly deployed nodes

baremetal_deployment.yaml¶

Configuration file describing the baremetal deployment

This command is provided by the python-tripleoclient plugin.

overcloud parameters set¶

Set a parameters for a plan

openstack overcloud parameters set name file_in

name¶

The name of the plan, which is used for the Swift container, Mistral environment and Heat stack names.

file_in¶

This command is provided by the python-tripleoclient plugin.

overcloud plan create¶

Create a deployment plan

openstack overcloud plan create
    [--templates TEMPLATES]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--disable-password-generation]
    [--source-url SOURCE_URL]
    name

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy. If this or –source_url isn’t provided, the templates packaged on the Undercloud will be used.

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--disable-password-generation¶

Disable password generation.

--source-url <SOURCE_URL>¶

The url of a git repository containing the Heat templates to deploy. If this or –templates isn’t provided, the templates packaged on the Undercloud will be used.

name¶

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

This command is provided by the python-tripleoclient plugin.

overcloud plan delete¶

Delete an overcloud deployment plan.

The plan will not be deleted if a stack exists with the same name.

openstack overcloud plan delete <name> [<name> ...]

name¶

Name of the plan(s) to delete

This command is provided by the python-tripleoclient plugin.

overcloud plan deploy¶

Deploy a deployment plan

openstack overcloud plan deploy
    [--timeout <TIMEOUT>]
    [--run-validations]
    name

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

Deployment timeout in minutes.

--run-validations¶

Run the pre-deployment validations. These external validations are from the TripleO Validations project.

name¶

The name of the plan to deploy.

This command is provided by the python-tripleoclient plugin.

overcloud plan export¶

Export a deployment plan

openstack overcloud plan export
    [--output-file <output file>]
    [--force-overwrite]
    <name>

--output-file <output file>, -o <output file>¶

Name of the output file for export. It will default to “<name>.tar.gz”.

--force-overwrite, -f¶

Overwrite output file if it exists.

name¶

Name of the plan to export.

This command is provided by the python-tripleoclient plugin.

overcloud plan list¶

List overcloud deployment plans.

openstack overcloud plan list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

--noindent¶

whether to disable indenting the JSON

--max-width <integer>¶

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶

Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶

Print empty table if there is no data to show.

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

This command is provided by the python-tripleoclient plugin.

overcloud profiles list¶

List overcloud node profiles

openstack overcloud profiles list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--all]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

--noindent¶

whether to disable indenting the JSON

--max-width <integer>¶

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶

Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶

Print empty table if there is no data to show.

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--all¶

List all nodes, even those not available to Nova.

--control-scale <CONTROL_SCALE>¶

New number of control nodes.

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes.

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes.

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes.

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes.

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes.

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes.

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes.

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes

This command is provided by the python-tripleoclient plugin.

overcloud profiles match¶

Assign and validate profiles on nodes

openstack overcloud profiles match
    [--dry-run]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

--dry-run¶

Only run validations, but do not apply any changes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes.

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes.

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes.

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes.

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes.

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes.

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes.

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes.

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes

This command is provided by the python-tripleoclient plugin.

overcloud raid create¶

Create RAID on given nodes

openstack overcloud raid create --node NODE configuration

--node <NODE>¶

Nodes to create RAID on (expected to be in manageable state). Can be specified multiple times.

configuration¶

RAID configuration (YAML/JSON string or file name).

This command is provided by the python-tripleoclient plugin.

overcloud role list¶

List availables roles (DEPRECATED).

Please use “openstack overcloud roles list” instead.

openstack overcloud role list [--roles-path <roles directory>]

--roles-path <roles directory>¶

Filesystem path containing the role yaml files. By default this is /usr/share/openstack-tripleo-heat-templates/roles

This command is provided by the python-tripleoclient plugin.

overcloud role show¶

Show information about a given role (DEPRECATED).

Please use “openstack overcloud roles show” intead.

openstack overcloud role show [--roles-path <roles directory>] <role>

--roles-path <roles directory>¶

Filesystem path containing the role yaml files. By default this is /usr/share/openstack-tripleo-heat-templates/roles

role¶

Role to display more information about.

This command is provided by the python-tripleoclient plugin.

overcloud roles generate¶

Generate roles_data.yaml file

openstack overcloud roles generate
    [--roles-path <roles directory>]
    [-o <output file>]
    [--skip-validate]
    <role>
    [<role> ...]

--roles-path <roles directory>¶

Filesystem path containing the role yaml files. By default this is /usr/share/openstack-tripleo-heat-templates/roles

-o <output file>, --output-file <output file>¶

File to capture all output to. For example, roles_data.yaml

--skip-validate¶

Skip role metadata type validation whengenerating the roles_data.yaml

role¶

List of roles to use to generate the roles_data.yaml file for the deployment. NOTE: Ordering is important if no role has the “primary” and “controller” tags. If no role is tagged then the first role listed will be considered the primary role. This usually is the controller role.

This command is provided by the python-tripleoclient plugin.

overcloud roles list¶

List the current and available roles in a given plan

openstack overcloud roles list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--name NAME]
    [--detail]
    [--current]

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

--noindent¶

whether to disable indenting the JSON

--max-width <integer>¶

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶

Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶

Print empty table if there is no data to show.

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--name <NAME>¶

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

--detail¶

Include details about each role

--current¶

Only show the information for the roles currently enabled for the plan.

This command is provided by the python-tripleoclient plugin.

overcloud roles show¶

Show details for a specific role, given a plan

openstack overcloud roles show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--name NAME]
    <role>

-f <FORMATTER>, --format <FORMATTER>¶

the output format, defaults to table

-c COLUMN, --column COLUMN¶

specify the column(s) to include, can be repeated

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--max-width <integer>¶

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶

Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶

Print empty table if there is no data to show.

--name <NAME>¶

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

role¶

Name of the role to look up.

This command is provided by the python-tripleoclient plugin.

overcloud status¶

Get deployment status

openstack overcloud status [--plan PLAN]

--plan <PLAN>, --stack <PLAN>¶

Name of the stack/plan. (default: overcloud)

This command is provided by the python-tripleoclient plugin.

overcloud support report collect¶

Run sosreport on selected servers.

openstack overcloud support report collect
    [-c CONTAINER]
    [-o DESTINATION]
    [--skip-container-delete]
    [-t TIMEOUT]
    [-n CONCURRENCY]
    [--collect-only | --download-only]
    server_name

-c <CONTAINER>, --container <CONTAINER>¶

Swift Container to store logs to

-o <DESTINATION>, --output <DESTINATION>¶

Output directory for the report

--skip-container-delete¶

Do not delete the container after the files have been downloaded. Ignored if –collect-only or –download-only is provided.

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

Maximum time to wait for the log collection and container deletion workflows to finish.

-n <CONCURRENCY>, --concurrency <CONCURRENCY>¶

Number of parallel log collection and object deletion tasks to run.

--collect-only¶

Skip log downloads, only collect logs and put in the container

--download-only¶

Skip generation, only download from the provided container

server_name¶

Nova server_name or partial name to match. For example “controller” will match all controllers for an environment.

This command is provided by the python-tripleoclient plugin.

overcloud update converge¶

Converge the update on Overcloud nodes.

This restores the plan and stack so that normal deployment workflow is back in place.

openstack overcloud update converge
    [--templates [TEMPLATES]]
    [--stack STACK]
    [--timeout <TIMEOUT>]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
    [--libvirt-type {kvm,qemu}]
    [--ntp-server NTP_SERVER]
    [--no-proxy NO_PROXY]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
    [--environment-file <HEAT ENVIRONMENT FILE>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--no-cleanup]
    [--update-plan-only]
    [--validation-errors-nonfatal]
    [--validation-warnings-fatal]
    [--disable-validations]
    [--inflight-validations]
    [--dry-run]
    [--run-validations]
    [--skip-postconfig]
    [--force-postconfig]
    [--skip-deploy-identifier]
    [--rhel-reg]
    [--reg-method {satellite,portal}]
    [--reg-org REG_ORG]
    [--reg-force]
    [--reg-sat-url REG_SAT_URL]
    [--reg-activation-key REG_ACTIVATION_KEY]
    [--answers-file ANSWERS_FILE]
    [--disable-password-generation]
    [--deployed-server]
    [--config-download]
    [--no-config-download]
    [--config-download-only]
    [--output-dir OUTPUT_DIR]
    [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
    [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy

--stack <STACK>¶

Stack name to create or update

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

Deployment timeout in minutes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes. (DEPRECATED. Use an environment file and set the parameter ControllerCount. It will be removed after the “P” release.)

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes. (DEPRECATED. Use an environment file and set the parameter ComputeCount. It will be removed after the “P” release.)

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter CephStorageCount. It will be removed after the “P” release.)

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes. (DEPRECATED. Use an environment file and set the parameter BlockStorageCount. It will be removed after the “P” release.)

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes. (DEPRECATED. Use an environment file and set the parameter ObjectStorageCount. It will be removed after the “P” release.)

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the “P” release.)

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the “P” release.)

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the “P” release.)

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the “P” release.)

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the “P” release.)

--libvirt-type <LIBVIRT_TYPE>¶

Libvirt domain type.

--ntp-server <NTP_SERVER>¶

The NTP for overcloud nodes.

--no-proxy <NO_PROXY>¶

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

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

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

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

Roles file, overrides the default roles_data.yaml in the –templates directory. May be an absolute path or the path relative to –templates

--networks-file <NETWORKS_FILE>, -n <NETWORKS_FILE>¶

Networks file, overrides the default network_data.yaml in the –templates directory

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--no-cleanup¶

Don’t cleanup temporary files, just log their location

--update-plan-only¶

Only update the plan. Do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal¶

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal¶

Exit if there are warnings from the configuration pre-checks.

--disable-validations¶

DEPRECATED. Disable the pre-deployment validations entirely. These validations are the built-in pre-deployment validations. To enable external validations from tripleo-validations, use the –run-validations flag. These validations are now run via the external validations in tripleo-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¶

Only run validations, but do not apply any changes.

--run-validations¶

Run external validations from the tripleo-validations project.

--skip-postconfig¶

Skip the overcloud post-deployment configuration.

--force-postconfig¶

Force the overcloud post-deployment configuration.

--skip-deploy-identifier¶

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--rhel-reg¶

Register overcloud nodes to the customer portal or a satellite.

--reg-method <REG_METHOD>¶

RHEL registration method to use for the overcloud nodes.

--reg-org <REG_ORG>¶

Organization key to use for registration.

--reg-force¶

Register the system even if it is already registered.

--reg-sat-url <REG_SAT_URL>¶

Satellite server to register overcloud nodes.

--reg-activation-key <REG_ACTIVATION_KEY>¶

Activation key to use for registration.

--answers-file <ANSWERS_FILE>¶

Path to a YAML file with arguments and parameters.

--disable-password-generation¶

Disable password generation.

--deployed-server¶

Use pre-provisioned overcloud nodes. Removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the–disable-validations.

--config-download¶

Run deployment via config-download mechanism. This is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only¶

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only¶

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir <OUTPUT_DIR>¶

Directory to use for saved output when using –config-download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg <OVERRIDE_ANSIBLE_CFG>¶

Path to ansible configuration file. The configuration in the file will override any configuration used by config-download by default.

--config-download-timeout <CONFIG_DOWNLOAD_TIMEOUT>¶

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the –timeout parameter after the stack operation.

--deployment-python-interpreter <DEPLOYMENT_PYTHON_INTERPRETER>¶

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

overcloud update prepare¶

Run heat stack update for overcloud nodes to refresh heat stack outputs.

The heat stack outputs are what we use later on to generate ansible playbooks which deliver the minor update workflow. This is used as the first step for a minor update of your overcloud.

openstack overcloud update prepare
    [--templates [TEMPLATES]]
    [--stack STACK]
    [--timeout <TIMEOUT>]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
    [--libvirt-type {kvm,qemu}]
    [--ntp-server NTP_SERVER]
    [--no-proxy NO_PROXY]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
    [--environment-file <HEAT ENVIRONMENT FILE>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--no-cleanup]
    [--update-plan-only]
    [--validation-errors-nonfatal]
    [--validation-warnings-fatal]
    [--disable-validations]
    [--inflight-validations]
    [--dry-run]
    [--run-validations]
    [--skip-postconfig]
    [--force-postconfig]
    [--skip-deploy-identifier]
    [--rhel-reg]
    [--reg-method {satellite,portal}]
    [--reg-org REG_ORG]
    [--reg-force]
    [--reg-sat-url REG_SAT_URL]
    [--reg-activation-key REG_ACTIVATION_KEY]
    [--answers-file ANSWERS_FILE]
    [--disable-password-generation]
    [--deployed-server]
    [--config-download]
    [--no-config-download]
    [--config-download-only]
    [--output-dir OUTPUT_DIR]
    [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
    [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy

--stack <STACK>¶

Stack name to create or update

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

Deployment timeout in minutes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes. (DEPRECATED. Use an environment file and set the parameter ControllerCount. It will be removed after the “P” release.)

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes. (DEPRECATED. Use an environment file and set the parameter ComputeCount. It will be removed after the “P” release.)

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter CephStorageCount. It will be removed after the “P” release.)

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes. (DEPRECATED. Use an environment file and set the parameter BlockStorageCount. It will be removed after the “P” release.)

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes. (DEPRECATED. Use an environment file and set the parameter ObjectStorageCount. It will be removed after the “P” release.)

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the “P” release.)

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the “P” release.)

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the “P” release.)

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the “P” release.)

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the “P” release.)

--libvirt-type <LIBVIRT_TYPE>¶

Libvirt domain type.

--ntp-server <NTP_SERVER>¶

The NTP for overcloud nodes.

--no-proxy <NO_PROXY>¶

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

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

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

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

Roles file, overrides the default roles_data.yaml in the –templates directory. May be an absolute path or the path relative to –templates

--networks-file <NETWORKS_FILE>, -n <NETWORKS_FILE>¶

Networks file, overrides the default network_data.yaml in the –templates directory

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--no-cleanup¶

Don’t cleanup temporary files, just log their location

--update-plan-only¶

Only update the plan. Do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal¶

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal¶

Exit if there are warnings from the configuration pre-checks.

--disable-validations¶

DEPRECATED. Disable the pre-deployment validations entirely. These validations are the built-in pre-deployment validations. To enable external validations from tripleo-validations, use the –run-validations flag. These validations are now run via the external validations in tripleo-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¶

Only run validations, but do not apply any changes.

--run-validations¶

Run external validations from the tripleo-validations project.

--skip-postconfig¶

Skip the overcloud post-deployment configuration.

--force-postconfig¶

Force the overcloud post-deployment configuration.

--skip-deploy-identifier¶

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--rhel-reg¶

Register overcloud nodes to the customer portal or a satellite.

--reg-method <REG_METHOD>¶

RHEL registration method to use for the overcloud nodes.

--reg-org <REG_ORG>¶

Organization key to use for registration.

--reg-force¶

Register the system even if it is already registered.

--reg-sat-url <REG_SAT_URL>¶

Satellite server to register overcloud nodes.

--reg-activation-key <REG_ACTIVATION_KEY>¶

Activation key to use for registration.

--answers-file <ANSWERS_FILE>¶

Path to a YAML file with arguments and parameters.

--disable-password-generation¶

Disable password generation.

--deployed-server¶

Use pre-provisioned overcloud nodes. Removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the–disable-validations.

--config-download¶

Run deployment via config-download mechanism. This is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only¶

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only¶

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir <OUTPUT_DIR>¶

Directory to use for saved output when using –config-download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg <OVERRIDE_ANSIBLE_CFG>¶

Path to ansible configuration file. The configuration in the file will override any configuration used by config-download by default.

--config-download-timeout <CONFIG_DOWNLOAD_TIMEOUT>¶

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the –timeout parameter after the stack operation.

--deployment-python-interpreter <DEPLOYMENT_PYTHON_INTERPRETER>¶

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

overcloud update run¶

Run minor update ansible playbooks on Overcloud nodes

openstack overcloud update run
    (--nodes NODES | --roles ROLES | --limit LIMIT)
    [--playbook PLAYBOOK]
    [--ssh-user SSH_USER]
    [--static-inventory STATIC_INVENTORY]
    [--stack STACK]

--nodes <NODES>¶

DEPRECATED: This option will be remove in the future release Use the limit option instead.A string that identifies a single node or comma-separated list of nodes to be upgraded in parallel in this upgrade run invocation. For example: –nodes “compute-0, compute-1, compute-5”. NOTE: Using this parameter with nodes of controlplane roles (e.g. “–nodes controller-1”) is NOT supported and WILL end badly unless you include ALL nodes of that role as a comma separated string. You should instead use the –roles parameter for controlplane roles and specify the role name.

--roles <ROLES>¶

DEPRECATED: This option will be remove in the future release Use the limit option instead.A string that identifies the role or comma-separated list ofroles to be upgraded in this upgrade run invocation. NOTE: nodes of specified role(s) are upgraded in parallel. This is REQUIRED for controlplane roles. For non controlplane roles (e.g., “Compute”), you may consider instead using the –nodes argument to limit the upgrade to a specific node or list (comma separated string) of nodes.

--limit <LIMIT>¶

A string that identifies a single node or comma-separated list of nodes to be upgraded in parallel in this upgrade run invocation. For example: –limit “compute-0, compute-1, compute-5”.

--playbook <PLAYBOOK>¶

Ansible playbook to use for the minor update. Defaults to the special value ‘all’ which causes all the update playbooks to be executed. That is the update_steps_playbook.yaml and then thedeploy_steps_playbook.yaml. Set this to each of those playbooks in consecutive invocations of this command if you prefer to run them manually. Note: make sure to run both those playbooks so that all services are updated and running with the target version configuration.

--ssh-user <SSH_USER>¶

DEPRECATED: Only tripleo-admin should be used as ssh user.

--static-inventory <STATIC_INVENTORY>¶

Path to an existing ansible inventory to use. If not specified, one will be generated in ~/tripleo-ansible-inventory.yaml

--stack <STACK>¶

Name or ID of heat stack (default=Env: OVERCLOUD_STACK_NAME)

This command is provided by the python-tripleoclient plugin.

overcloud upgrade converge¶

Major upgrade converge - reset Heat resources in the stored plan

This is the last step for completion of a overcloud major upgrade. The main task is updating the plan and stack to unblock future stack updates. For the major upgrade workflow we have set specific values for some stack Heat resources. This unsets those back to their default values.

openstack overcloud upgrade converge
    [--templates [TEMPLATES]]
    [--stack STACK]
    [--timeout <TIMEOUT>]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
    [--libvirt-type {kvm,qemu}]
    [--ntp-server NTP_SERVER]
    [--no-proxy NO_PROXY]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
    [--environment-file <HEAT ENVIRONMENT FILE>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--no-cleanup]
    [--update-plan-only]
    [--validation-errors-nonfatal]
    [--validation-warnings-fatal]
    [--disable-validations]
    [--inflight-validations]
    [--dry-run]
    [--run-validations]
    [--skip-postconfig]
    [--force-postconfig]
    [--skip-deploy-identifier]
    [--rhel-reg]
    [--reg-method {satellite,portal}]
    [--reg-org REG_ORG]
    [--reg-force]
    [--reg-sat-url REG_SAT_URL]
    [--reg-activation-key REG_ACTIVATION_KEY]
    [--answers-file ANSWERS_FILE]
    [--disable-password-generation]
    [--deployed-server]
    [--config-download]
    [--no-config-download]
    [--config-download-only]
    [--output-dir OUTPUT_DIR]
    [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
    [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy

--stack <STACK>¶

Stack name to create or update

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

Deployment timeout in minutes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes. (DEPRECATED. Use an environment file and set the parameter ControllerCount. It will be removed after the “P” release.)

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes. (DEPRECATED. Use an environment file and set the parameter ComputeCount. It will be removed after the “P” release.)

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter CephStorageCount. It will be removed after the “P” release.)

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes. (DEPRECATED. Use an environment file and set the parameter BlockStorageCount. It will be removed after the “P” release.)

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes. (DEPRECATED. Use an environment file and set the parameter ObjectStorageCount. It will be removed after the “P” release.)

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the “P” release.)

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the “P” release.)

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the “P” release.)

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the “P” release.)

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the “P” release.)

--libvirt-type <LIBVIRT_TYPE>¶

Libvirt domain type.

--ntp-server <NTP_SERVER>¶

The NTP for overcloud nodes.

--no-proxy <NO_PROXY>¶

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

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

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

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

Roles file, overrides the default roles_data.yaml in the –templates directory. May be an absolute path or the path relative to –templates

--networks-file <NETWORKS_FILE>, -n <NETWORKS_FILE>¶

Networks file, overrides the default network_data.yaml in the –templates directory

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--no-cleanup¶

Don’t cleanup temporary files, just log their location

--update-plan-only¶

Only update the plan. Do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal¶

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal¶

Exit if there are warnings from the configuration pre-checks.

--disable-validations¶

DEPRECATED. Disable the pre-deployment validations entirely. These validations are the built-in pre-deployment validations. To enable external validations from tripleo-validations, use the –run-validations flag. These validations are now run via the external validations in tripleo-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¶

Only run validations, but do not apply any changes.

--run-validations¶

Run external validations from the tripleo-validations project.

--skip-postconfig¶

Skip the overcloud post-deployment configuration.

--force-postconfig¶

Force the overcloud post-deployment configuration.

--skip-deploy-identifier¶

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--rhel-reg¶

Register overcloud nodes to the customer portal or a satellite.

--reg-method <REG_METHOD>¶

RHEL registration method to use for the overcloud nodes.

--reg-org <REG_ORG>¶

Organization key to use for registration.

--reg-force¶

Register the system even if it is already registered.

--reg-sat-url <REG_SAT_URL>¶

Satellite server to register overcloud nodes.

--reg-activation-key <REG_ACTIVATION_KEY>¶

Activation key to use for registration.

--answers-file <ANSWERS_FILE>¶

Path to a YAML file with arguments and parameters.

--disable-password-generation¶

Disable password generation.

--deployed-server¶

Use pre-provisioned overcloud nodes. Removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the–disable-validations.

--config-download¶

Run deployment via config-download mechanism. This is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only¶

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only¶

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir <OUTPUT_DIR>¶

Directory to use for saved output when using –config-download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg <OVERRIDE_ANSIBLE_CFG>¶

Path to ansible configuration file. The configuration in the file will override any configuration used by config-download by default.

--config-download-timeout <CONFIG_DOWNLOAD_TIMEOUT>¶

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the –timeout parameter after the stack operation.

--deployment-python-interpreter <DEPLOYMENT_PYTHON_INTERPRETER>¶

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

overcloud upgrade prepare¶

Run heat stack update for overcloud nodes to refresh heat stack outputs.

The heat stack outputs are what we use later on to generate ansible playbooks which deliver the major upgrade workflow. This is used as the first step for a major upgrade of your overcloud.

openstack overcloud upgrade prepare
    [--templates [TEMPLATES]]
    [--stack STACK]
    [--timeout <TIMEOUT>]
    [--control-scale CONTROL_SCALE]
    [--compute-scale COMPUTE_SCALE]
    [--ceph-storage-scale CEPH_STORAGE_SCALE]
    [--block-storage-scale BLOCK_STORAGE_SCALE]
    [--swift-storage-scale SWIFT_STORAGE_SCALE]
    [--control-flavor CONTROL_FLAVOR]
    [--compute-flavor COMPUTE_FLAVOR]
    [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
    [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
    [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
    [--libvirt-type {kvm,qemu}]
    [--ntp-server NTP_SERVER]
    [--no-proxy NO_PROXY]
    [--overcloud-ssh-user OVERCLOUD_SSH_USER]
    [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
    [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
    [--environment-file <HEAT ENVIRONMENT FILE>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--no-cleanup]
    [--update-plan-only]
    [--validation-errors-nonfatal]
    [--validation-warnings-fatal]
    [--disable-validations]
    [--inflight-validations]
    [--dry-run]
    [--run-validations]
    [--skip-postconfig]
    [--force-postconfig]
    [--skip-deploy-identifier]
    [--rhel-reg]
    [--reg-method {satellite,portal}]
    [--reg-org REG_ORG]
    [--reg-force]
    [--reg-sat-url REG_SAT_URL]
    [--reg-activation-key REG_ACTIVATION_KEY]
    [--answers-file ANSWERS_FILE]
    [--disable-password-generation]
    [--deployed-server]
    [--config-download]
    [--no-config-download]
    [--config-download-only]
    [--output-dir OUTPUT_DIR]
    [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
    [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

--templates <TEMPLATES>¶

The directory containing the Heat templates to deploy

--stack <STACK>¶

Stack name to create or update

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

Deployment timeout in minutes.

--control-scale <CONTROL_SCALE>¶

New number of control nodes. (DEPRECATED. Use an environment file and set the parameter ControllerCount. It will be removed after the “P” release.)

--compute-scale <COMPUTE_SCALE>¶

New number of compute nodes. (DEPRECATED. Use an environment file and set the parameter ComputeCount. It will be removed after the “P” release.)

--ceph-storage-scale <CEPH_STORAGE_SCALE>¶

New number of ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter CephStorageCount. It will be removed after the “P” release.)

--block-storage-scale <BLOCK_STORAGE_SCALE>¶

New number of cinder storage nodes. (DEPRECATED. Use an environment file and set the parameter BlockStorageCount. It will be removed after the “P” release.)

--swift-storage-scale <SWIFT_STORAGE_SCALE>¶

New number of swift storage nodes. (DEPRECATED. Use an environment file and set the parameter ObjectStorageCount. It will be removed after the “P” release.)

--control-flavor <CONTROL_FLAVOR>¶

Nova flavor to use for control nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the “P” release.)

--compute-flavor <COMPUTE_FLAVOR>¶

Nova flavor to use for compute nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the “P” release.)

--ceph-storage-flavor <CEPH_STORAGE_FLAVOR>¶

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the “P” release.)

--block-storage-flavor <BLOCK_STORAGE_FLAVOR>¶

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the “P” release.)

--swift-storage-flavor <SWIFT_STORAGE_FLAVOR>¶

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the “P” release.)

--libvirt-type <LIBVIRT_TYPE>¶

Libvirt domain type.

--ntp-server <NTP_SERVER>¶

The NTP for overcloud nodes.

--no-proxy <NO_PROXY>¶

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user <OVERCLOUD_SSH_USER>¶

User for ssh access to overcloud nodes

--overcloud-ssh-key <OVERCLOUD_SSH_KEY>¶

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network <OVERCLOUD_SSH_NETWORK>¶

Network name to use for ssh access to overcloud nodes.

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

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

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

Roles file, overrides the default roles_data.yaml in the –templates directory. May be an absolute path or the path relative to –templates

--networks-file <NETWORKS_FILE>, -n <NETWORKS_FILE>¶

Networks file, overrides the default network_data.yaml in the –templates directory

--plan-environment-file <PLAN_ENVIRONMENT_FILE>, -p <PLAN_ENVIRONMENT_FILE>¶

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

--no-cleanup¶

Don’t cleanup temporary files, just log their location

--update-plan-only¶

Only update the plan. Do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal¶

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal¶

Exit if there are warnings from the configuration pre-checks.

--disable-validations¶

DEPRECATED. Disable the pre-deployment validations entirely. These validations are the built-in pre-deployment validations. To enable external validations from tripleo-validations, use the –run-validations flag. These validations are now run via the external validations in tripleo-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¶

Only run validations, but do not apply any changes.

--run-validations¶

Run external validations from the tripleo-validations project.

--skip-postconfig¶

Skip the overcloud post-deployment configuration.

--force-postconfig¶

Force the overcloud post-deployment configuration.

--skip-deploy-identifier¶

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--rhel-reg¶

Register overcloud nodes to the customer portal or a satellite.

--reg-method <REG_METHOD>¶

RHEL registration method to use for the overcloud nodes.

--reg-org <REG_ORG>¶

Organization key to use for registration.

--reg-force¶

Register the system even if it is already registered.

--reg-sat-url <REG_SAT_URL>¶

Satellite server to register overcloud nodes.

--reg-activation-key <REG_ACTIVATION_KEY>¶

Activation key to use for registration.

--answers-file <ANSWERS_FILE>¶

Path to a YAML file with arguments and parameters.

--disable-password-generation¶

Disable password generation.

--deployed-server¶

Use pre-provisioned overcloud nodes. Removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the–disable-validations.

--config-download¶

Run deployment via config-download mechanism. This is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only¶

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only¶

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir <OUTPUT_DIR>¶

Directory to use for saved output when using –config-download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg <OVERRIDE_ANSIBLE_CFG>¶

Path to ansible configuration file. The configuration in the file will override any configuration used by config-download by default.

--config-download-timeout <CONFIG_DOWNLOAD_TIMEOUT>¶

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the –timeout parameter after the stack operation.

--deployment-python-interpreter <DEPLOYMENT_PYTHON_INTERPRETER>¶

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

overcloud upgrade run¶

Run major upgrade ansible playbooks on Overcloud nodes

This will run the major upgrade ansible playbooks on the overcloud. By default all playbooks are executed, that is the upgrade_steps_playbook.yaml then the deploy_steps_playbook.yaml and then the post_upgrade_steps_playbook.yaml. The upgrade playbooks are made available after completion of the ‘overcloud upgrade prepare’ command. This ‘overcloud upgrade run’ command is the second step in the major upgrade workflow.

openstack overcloud upgrade run
    (--nodes NODES | --roles ROLES | --limit LIMIT)
    [--playbook PLAYBOOK]
    [--static-inventory STATIC_INVENTORY]
    [--ssh-user SSH_USER]
    [--tags TAGS]
    [--skip-tags SKIP_TAGS]
    [--stack STACK]

--nodes <NODES>¶

DEPRECATED: This option will be remove in the future release Use the limit option instead.A string that identifies a single node or comma-separated list of nodes to be upgraded in parallel in this upgrade run invocation. For example: –nodes “compute-0, compute-1, compute-5”. NOTE: Using this parameter with nodes of controlplane roles (e.g. “–nodes controller-1”) is NOT supported and WILL end badly unless you include ALL nodes of that role as a comma separated string. You should instead use the –roles parameter for controlplane roles and specify the role name.

--roles <ROLES>¶

DEPRECATED: This option will be remove in the future release Use the limit option instead.A string that identifies the role or comma-separated list ofroles to be upgraded in this upgrade run invocation. NOTE: nodes of specified role(s) are upgraded in parallel. This is REQUIRED for controlplane roles. For non controlplane roles (e.g., “Compute”), you may consider instead using the –nodes argument to limit the upgrade to a specific node or list (comma separated string) of nodes.

--limit <LIMIT>¶

A string that identifies a single node or comma-separatedlist of nodes to be upgraded in parallel in this upgrade run invocation. For example: –limit “compute-0, compute-1, compute-5”.

--playbook <PLAYBOOK>¶

Ansible playbook to use for the major upgrade. Defaults to the special value ‘all’ which causes all the upgrade playbooks to run. That is the upgrade_steps_playbook.yaml then deploy_steps_playbook.yaml and then post_upgrade_steps_playbook.yaml. Set this to each of those playbooks in consecutive invocations of this command if you prefer to run them manually. Note: you will have to run all of those playbooks so that all services are upgraded and running with the target version configuration.

--static-inventory <STATIC_INVENTORY>¶

Path to an existing ansible inventory to use. If not specified, one will be generated in ~/tripleo-ansible-inventory.yaml

--ssh-user <SSH_USER>¶

DEPRECATED: Only tripleo-admin should be used as ssh user.

--tags <TAGS>¶

A string specifying the tag or comma separated list of tags to be passed as –tags to ansible-playbook.

--skip-tags <SKIP_TAGS>¶

A string specifying the tag or comma separated list of tags to be passed as –skip-tags to ansible-playbook. The currently supported values are ‘validation’ and ‘pre-upgrade’. In particular ‘validation’ is useful if you must re-run following a failed upgrade and some services cannot be started.

--stack <STACK>¶

Name or ID of heat stack (default=Env: OVERCLOUD_STACK_NAME)

This command is provided by the python-tripleoclient plugin.

tripleo container image prepare¶

Prepare and upload containers from a single command.

openstack tripleo container image prepare
    [--environment-file <file path>]
    [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
    [--roles-file ROLES_FILE]
    [--output-env-file <file path>]
    [--dry-run]
    [--cleanup <full, partial, none>]

--environment-file <file path>, -e <file path>¶

Environment file containing the ContainerImagePrepare parameter which specifies all prepare actions. Also, environment files specifying which services are containerized. Entries will be filtered to only contain images used by containerized services. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>¶

Environment file directories that are automatically added to the environment. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file <ROLES_FILE>, -r <ROLES_FILE>¶

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

--output-env-file <file path>¶

File to write heat environment file which specifies all image parameters. Any existing file will be overwritten.

--dry-run¶

Do not perform any pull, modify, or push operations. The environment file will still be populated as if these operations were performed.

--cleanup <full, partial, none>¶

Cleanup behavior for local images left after upload. The default ‘full’ will attempt to delete all local images. ‘partial’ will leave images required for deployment on this host. ‘none’ will do no cleanup.

This command is provided by the python-tripleoclient plugin.

tripleo container image prepare default¶

Generate a default ContainerImagePrepare parameter.

openstack tripleo container image prepare default
    [--output-env-file <file path>]
    [--local-push-destination]

--output-env-file <file path>¶

File to write environment file containing default ContainerImagePrepare value.

--local-push-destination¶

Include a push_destination to trigger upload to a local registry.

This command is provided by the python-tripleoclient plugin.

overcloud container image build¶

Build overcloud container images with kolla-build.

openstack overcloud container image build
    [--config-file <yaml config file>]
    --kolla-config-file <config
    file>
    [--list-images]
    [--list-dependencies]
    [--exclude <container-name>]
    [--use-buildah]

--config-file <yaml config file>¶

YAML config file specifying the images to build. May be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append. If not specified, the default set of containers will be built.

--kolla-config-file <config file>¶

Path to a Kolla config file to use. Multiple config files can be specified, with values in later files taking precedence. By default, tripleo kolla conf file /home/zuul/src/opendev.org/openstack/python-tripleoclient/.tox/docs/share/tripleo-common/container-images/tripleo_kolla_config_overrides.conf is added.

--list-images¶

Show the images which would be built instead of building them.

--list-dependencies¶

Show the image build dependencies instead of building them.

--exclude <container-name>¶

Name of a container to match against the list of containers to be built to skip. Can be specified multiple times.

--use-buildah¶

Use Buildah instead of Docker to build the images with Kolla.

This command is provided by the python-tripleoclient plugin.

overcloud container image tag discover¶

Discover the versioned tag for an image.

openstack overcloud container image tag discover
    --image <container
    image>
    [--tag-from-label <image label>]

--image <container image>¶

Fully qualified name of the image to discover the tag for (Including registry and stable tag).

--tag-from-label <image label>¶

Use the value of the specified label(s) to discover the tag. Labels can be combined in a template format, for example: {version}-{release}

This command is provided by the python-tripleoclient plugin.

overcloud container image upload¶

Push overcloud container images to registries.

openstack overcloud container image upload
    --config-file <yaml
    config
    file>
    [--cleanup <full, partial, none>]

--config-file <yaml config file>¶

YAML config file specifying the image build. May be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append.

--cleanup <full, partial, none>¶

Cleanup behavior for local images left after upload. The default ‘full’ will attempt to delete all local images. ‘partial’ will leave images required for deployment on this host. ‘none’ will do no cleanup.

This command is provided by the python-tripleoclient plugin.

undercloud backup¶

Backup the undercloud

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

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

undercloud deploy¶

Deploy containerized Undercloud

openstack undercloud deploy
    [--templates [TEMPLATES]]
    [--standalone]
    [--upgrade]
    [-y]
    [--stack STACK]
    [--output-dir OUTPUT_DIR]
    [--output-only]
    [--standalone-role STANDALONE_ROLE]
    [-t <TIMEOUT>]
    [-e <HEAT ENVIRONMENT FILE>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--heat-api-port <HEAT_API_PORT>]
    [--heat-user <HEAT_USER>]
    [--deployment-user DEPLOYMENT_USER]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
    [--heat-container-image <HEAT_CONTAINER_IMAGE>]
    [--heat-native [HEAT_NATIVE]]
    [--local-ip <LOCAL_IP>]
    [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
    [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
    [--local-domain <LOCAL_DOMAIN>]
    [--cleanup]
    [--hieradata-override [HIERADATA_OVERRIDE]]
    [--keep-running]
    [--inflight-validations]
    [--force-stack-update | --force-stack-create]

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

undercloud install¶

Install and setup the undercloud

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

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

undercloud upgrade¶

Upgrade undercloud

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

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

tripleo deploy¶

Deploy containerized Undercloud

openstack tripleo deploy
    [--templates [TEMPLATES]]
    [--standalone]
    [--upgrade]
    [-y]
    [--stack STACK]
    [--output-dir OUTPUT_DIR]
    [--output-only]
    [--standalone-role STANDALONE_ROLE]
    [-t <TIMEOUT>]
    [-e <HEAT ENVIRONMENT FILE>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--heat-api-port <HEAT_API_PORT>]
    [--heat-user <HEAT_USER>]
    [--deployment-user DEPLOYMENT_USER]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
    [--heat-container-image <HEAT_CONTAINER_IMAGE>]
    [--heat-native [HEAT_NATIVE]]
    [--local-ip <LOCAL_IP>]
    [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
    [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
    [--local-domain <LOCAL_DOMAIN>]
    [--cleanup]
    [--hieradata-override [HIERADATA_OVERRIDE]]
    [--keep-running]
    [--inflight-validations]
    [--force-stack-update | --force-stack-create]

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

tripleo upgrade¶

Upgrade TripleO

openstack tripleo upgrade
    [--templates [TEMPLATES]]
    [--standalone]
    [--upgrade]
    [-y]
    [--stack STACK]
    [--output-dir OUTPUT_DIR]
    [--output-only]
    [--standalone-role STANDALONE_ROLE]
    [-t <TIMEOUT>]
    [-e <HEAT ENVIRONMENT FILE>]
    [--roles-file ROLES_FILE]
    [--networks-file NETWORKS_FILE]
    [--plan-environment-file PLAN_ENVIRONMENT_FILE]
    [--heat-api-port <HEAT_API_PORT>]
    [--heat-user <HEAT_USER>]
    [--deployment-user DEPLOYMENT_USER]
    [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
    [--heat-container-image <HEAT_CONTAINER_IMAGE>]
    [--heat-native [HEAT_NATIVE]]
    [--local-ip <LOCAL_IP>]
    [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
    [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
    [--local-domain <LOCAL_DOMAIN>]
    [--cleanup]
    [--hieradata-override [HIERADATA_OVERRIDE]]
    [--keep-running]
    [--inflight-validations]
    [--force-stack-update | --force-stack-create]

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