Chapter 46. overcloud

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

Path to switch the ceph-ansible playbook used for update.

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

--config-type CONFIG_TYPE

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

-h, --help

Show this help message and exit

--config-dir CONFIG_DIR

The directory where the configuration files will be pushed

--name NAME

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

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

-h, --help

Show this help message and exit

--list-dependencies

Show the image build dependencies instead of building them.

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

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

--pull-source <location>

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

--env-file <file path>

File to write heat environment file which specifies all image parameters. Any existing file will be overwritten.(DEPRECATED. Use --output-env-file instead)

--output-images-file <file path>

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

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

--prefix <prefix>

Override the default name prefix substitution. Default: openstack-

--tag-from-label <image label>

Use the value of the specified label to discover the versioned tag.

--push-destination <location>

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

--exclude <regex>

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

--images-file <file path>

File to write resulting image entries to, as well as stdout. Any existing file will be overwritten.(DEPRECATED. Use --output-images-file instead)

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml

--template-file <yaml template file>

Yaml template file which the images config file will be built from. Default: /usr/share/tripleo-common/container- images/overcloud_containers.yaml.j2

--output-env-file <file path>

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

-h, --help

Show this help message and exit

--service-environment-file <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.)(DEPRECATED. Use --environment-file instead)

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

--namespace <namespace>

Override the default namespace substitution. Default: registry.access.redhat.com/rhosp13

--tag <tag>

Override the default tag substitution. if --tag-from- label is specified, start discovery with this tag. Default: latest

--tag-from-label <image label>

Use the value of the specified label to discover the tag.

-h, --help

Show this help message and exit

--image <container image>

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

-h, --help

Show this help message and exit

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

plan

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

-h, --help

Show this help message and exit

--directory [DIRECTORY]

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

stack

Name or id of heat stack to delete(default=env: OVERCLOUD_STACK_NAME)

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes).

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

file_in

None

-h, --help

Show this help message and exit

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

-h, --help

Show this help message and exit

--plan PLAN, --stack PLAN

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

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--yes

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

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--yes

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

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

Path to switch the ceph-ansible playbook used for upgrade.

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

-h, --help

Show this help message and exit

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--static-inventory STATIC_INVENTORY

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

--yes

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

--ssh-user SSH_USER

The ssh user name for connecting to the overcloud nodes.

instackenv

None

--ipmi-no-lanplus

Do not use lanplus. defaults to: false

--output OUTPUT

Write parameters to a file

--delay DELAY

Wait delay seconds before fencing is started

--ipmi-lanplus

Deprecated: this is the default.

-a FENCE_ACTION, --action FENCE_ACTION

Deprecated: this option is ignored.

--ipmi-level IPMI_LEVEL

Privilegel level on ipmi device. valid levels: callback, user, operator, administrator.

--ipmi-cipher IPMI_CIPHER

Ciphersuite to use (same as ipmitool -c parameter.

-h, --help

Show this help message and exit

--no-skip

Skip build if cached image exists.

-h, --help

Show this help message and exit

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

--output-directory OUTPUT_DIRECTORY

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

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

--update-existing

Update images if already exist

--os-image-name OS_IMAGE_NAME

Openstack disk image filename

--image-path IMAGE_PATH

Path to directory containing image files

--http-boot HTTP_BOOT

Root directory for the introspection image

--whole-disk

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

-h, --help

Show this help message and exit

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

--ironic-python-agent-name IPA_NAME

Openstack ironic-python-agent (agent) image filename

-h, --help

Show this help message and exit

-f NETENV, --file NETENV

Path to the network environment file

<node_uuid>

Baremetal node uuids for the node(s) to be configured

--deploy-kernel DEPLOY_KERNEL

Image with deploy kernel.

--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE

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

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

--all-manageable

Configure all nodes currently in manageable state

--deploy-ramdisk DEPLOY_RAMDISK

Image with deploy ramdisk.

--instance-boot-option {local,netboot}

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

-h, --help

Show this help message and exit

--overwrite-root-device-hints

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

<node>

Node id(s) to delete

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

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

-h, --help

Show this help message and exit

--stack STACK

Name or id of heat stack to scale (default=env: OVERCLOUD_STACK_NAME)

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

--provide

Provide (make available) the nodes

--no-deploy-image

Skip setting the deploy kernel and ramdisk.

--instance-boot-option {local,netboot}

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

--credentials <key:value>

Key/value pairs of possible credentials

--range <range>

Ip range to probe

--port <ports>

Bmc port(s) to probe

--run-validations

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

-h, --help

Show this help message and exit

--introspect

Introspect the imported nodes

--ip <ips>

Ip address(es) to probe

env_file

None

--provide

Provide (make available) the nodes

--no-deploy-image

Skip setting the deploy kernel and ramdisk.

--validate-only

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

--run-validations

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

--instance-boot-option {local,netboot}

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

-h, --help

Show this help message and exit

--introspect

Introspect the imported nodes

<node_uuid>

Baremetal node uuids for the node(s) to be introspected

--provide

Provide (make available) the nodes once introspected

--all-manageable

Introspect all nodes currently in manageable state

-h, --help

Show this help message and exit

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

--all-manageable

Provide all nodes currently in manageable state

-h, --help

Show this help message and exit

name

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

file_in

None

-h, --help

Show this help message and exit

name

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

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

-h, --help

Show this help message and exit

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

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

<name>

Name of the plan(s) to delete

-h, --help

Show this help message and exit

name

The name of the plan to deploy.

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

Deployment timeout in minutes.

-h, --help

Show this help message and exit

--run-validations

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

<name>

Name of the plan to export.

-h, --help

Show this help message and exit

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

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

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

--noindent

Whether to disable indenting the json

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control 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

--control-scale CONTROL_SCALE

New number of control 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.

--compute-scale COMPUTE_SCALE

New number of compute nodes.

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes.

-h, --help

Show this help message and exit

--all

List all nodes, even those not available to nova.

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes.

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control 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

--control-scale CONTROL_SCALE

New number of control 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.

--dry-run

Only run validations, but do not apply any changes.

--compute-scale COMPUTE_SCALE

New number of compute nodes.

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes.

-h, --help

Show this help message and exit

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes.

configuration

Raid configuration (yaml/json string or file name).

-h, --help

Show this help message and exit

--node NODE

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

-h, --help

Show this help message and exit

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

-h, --help

Show this help message and exit

--roles-path <roles directory>

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

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

-h, --help

Show this help message and exit

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

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

--roles-path <roles directory>

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

--skip-validate

Skip role metadata type validation whengenerating the roles_data.yaml

-h, --help

Show this help message and exit

--plan PLAN, --stack PLAN

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

server_name

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

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

--collect-only

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

--download-only

Skip generation, only download from the provided container

-n CONCURRENCY, --concurrency CONCURRENCY

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

-t TIMEOUT, --timeout TIMEOUT

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

-h, --help

Show this help message and exit

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

Path to switch the ceph-ansible playbook used for update.

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

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

The ssh user name for connecting to the overcloud nodes.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--static-inventory STATIC_INVENTORY

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

--nodes NODES

Required parameter. this specifies the overcloud nodes to run the minor update playbooks on. You can use the name of a specific node, or the name of the role (e.g. Compute). You may also use the special value all to run the minor on all nodes. In all cases the minor update ansible playbook is executed on one node at a time (with serial 1)

-h, --help

Show this help message and exit

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--no-proxy NO_PROXY

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

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

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

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

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

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

--disable-validations

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.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

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

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

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

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

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

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

--config-download

Run deployment via config-download mechanism

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

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

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

Path to switch the ceph-ansible playbook used for upgrade.

--disable-password-generation

Disable password generation.

--no-cleanup

Don’t cleanup temporary files, just log their location

--validation-errors-nonfatal

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

--update-plan-only

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

--run-validations

Run external validations from the tripleo-validations project.

--stack STACK

Stack name to create or update

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

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

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

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

--force-postconfig

Force the overcloud post-deployment configuration.

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

Deployment timeout in minutes.

--libvirt-type {kvm,qemu}

Libvirt domain type.

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

--dry-run

Only run validations, but do not apply any changes.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory

--validation-warnings-fatal

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

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-force

Register the system even if it is already registered.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-org REG_ORG

Organization key to use for registration.

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

--roles ROLES

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.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--static-inventory STATIC_INVENTORY

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

--nodes NODES

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.

-h, --help

Show this help message and exit

--ssh-user SSH_USER

The ssh user name for connecting to the overcloud nodes.

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