All Overcloud Commands¶

overcloud backup¶

Backup the Overcloud

openstack overcloud backup
    [--init [INIT]]
    [--setup-nfs]
    [--setup-rear]
    [--cron]
    [--inventory INVENTORY]
    [--storage-ip STORAGE_IP]
    [--extra-vars EXTRA_VARS]

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

--setup-nfs¶: Setup the NFS server on the backup node which will install required packages and configuration on the host ‘BackupNode’ in the ansible inventory.

--setup-rear¶: Setup ReaR on the overcloud ‘Controller’ hosts which will install and configure ReaR.

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

--inventory <INVENTORY>¶: Tripleo inventory file generated with tripleo-ansible-inventory command. Defaults to: /home/stack/tripleo-inventory.yaml.

--storage-ip <STORAGE_IP>¶: Storage IP is an optional parameter which allows for an ip of a storage server to be specified, overriding the default undercloud. WARNING: This flag will be deprecated in favor of ‘–extra-vars’ which will allow to pass this and other variables.

--extra-vars <EXTRA_VARS>¶: Set additional variables as Dict or as an absolute path of a JSON or YAML file type. i.e. –extra-vars ‘{“key”: “val”, “key2”: “val2”}’ i.e. –extra-vars /path/to/my_vars.yaml i.e. –extra-vars /path/to/my_vars.json. For more information about the variables that can be passed, visit: https://opendev.org/openstack/tripleo-ansible/src/branch/master/tripleo_ansible/roles/backup_and_restore/defaults/main.yml.

overcloud cell export¶

Export cell information used as import of another cell

openstack overcloud cell export
    [--control-plane-stack <control plane stack>]
    [--cell-stack <cell stack>]
    [--output-file <output file>]
    [--config-download-dir CONFIG_DOWNLOAD_DIR]
    [--force-overwrite]

--control-plane-stack <control plane stack>¶: Name of the environment main Heat stack to export information from. (default=Env: OVERCLOUD_STACK_NAME)

--cell-stack <cell stack>, -e <cell stack>¶: Name of the controller cell Heat stack to export information from. Used in case of: control plane stack -> cell controller stack -> multiple compute stacks

--output-file <output file>, -o <output file>¶: Name of the output file for the cell data export. It will default to “<name>.yaml”

--config-download-dir <CONFIG_DOWNLOAD_DIR>¶: Directory to search for config-download export data. Defaults to $HOME/config-download

--force-overwrite, -f¶: Overwrite output file if it exists.

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]
    [--work-dir <container builds directory>]
    [--build-timeout <build timeout in seconds>]

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

--work-dir <container builds directory>¶: TripleO container builds directory, storing configs and logs for each image and its dependencies.

--build-timeout <build timeout in seconds>¶: Build timeout in seconds.

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>]
    [--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/tripleo_containers.yaml.j2

--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: quay.io/tripleomaster

--prefix <prefix>¶: Override the default name prefix substitution. Default: openstack-

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

Delete overcloud stack and plan

openstack overcloud delete [-y] [-s] [stack]

-y, --yes¶: Skip yes/no prompt (assume yes).

-s, --skip-ipa-cleanup¶: Skip removing overcloud hosts, services, and DNS records from FreeIPA. This is particularly relevant for deployments using certificates from FreeIPA for TLS. By default, overcloud hosts, services, and DNS records will be removed from FreeIPA before deleting the overcloud. Using this option might require you to manually cleanup FreeIPA later.

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

This command is provided by the python-tripleoclient plugin.

overcloud export¶

Export stack information used as import of another stack

openstack overcloud export
    [--stack <stack>]
    [--output-file <output file>]
    [--force-overwrite]
    [--config-download-dir CONFIG_DOWNLOAD_DIR]
    [--no-password-excludes]

--stack <stack>¶: Name of the environment main Heat stack to export information from. (default=Env: OVERCLOUD_STACK_NAME)

--output-file <output file>, -o <output file>¶: Name of the output file for the stack data export. It will default to “<name>.yaml”

--force-overwrite, -f¶: Overwrite output file if it exists.

--config-download-dir <CONFIG_DOWNLOAD_DIR>¶: Directory to search for config-download export data. Defaults to $HOME/config-download

--no-password-excludes¶: Dont exclude certain passwords from the password export. Defaults to False in that some passwords will be excluded that are not typically necessary.

This command is provided by the python-tripleoclient plugin.

overcloud export ceph¶

Export Ceph information used as import of another stack

Export Ceph information from one or more stacks to be used as input of another stack. Creates a valid YAML file with the CephExternalMultiConfig parameter populated.

openstack overcloud export ceph
    [--stack <stack>]
    [--cephx-key-client-name <cephx>]
    [--output-file <output file>]
    [--force-overwrite]
    [--config-download-dir CONFIG_DOWNLOAD_DIR]

--stack <stack>¶: Name of the overcloud stack(s) to export Ceph information from. If a comma delimited list of stacks is passed, Ceph information for all stacks will be exported into a single file. (default=Env: OVERCLOUD_STACK_NAME)

--cephx-key-client-name <cephx>, -k <cephx>¶: Name of the cephx client key to export. (default=openstack)

--output-file <output file>, -o <output file>¶: Name of the output file for the Ceph data export. Defaults to “ceph-export-<STACK>.yaml” if one stack is provided. Defaults to “ceph-export-<N>-stacks.yaml” if N stacks are provided.

--force-overwrite, -f¶: Overwrite output file if it exists.

--config-download-dir <CONFIG_DOWNLOAD_DIR>¶: Directory to search for config-download export data. Defaults to $HOME/config-download

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]
    [--temp-dir TEMP_DIR]

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

--temp-dir <TEMP_DIR>¶: Temporary directory to use when building the images. Defaults to $TMPDIR or current directory if unset.

This command is provided by the python-tripleoclient plugin.

overcloud image upload¶

Make existing image files available for overcloud deployment.

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]
    [--local]
    [--local-path LOCAL_PATH]

--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 ironic-python-agent image. If uploading images for multiple architectures/platforms, vary this argument such that a distinct folder is created for each architecture/platform.

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

--local¶: Copy files locally, even if there is an image service endpoint

--local-path <LOCAL_PATH>¶: Root directory for image file copy destination when there is no image endpoint, or when –local is specified

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 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]
    [--sort-ascending | --sort-descending]
    [--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 to show multiple columns

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--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 role list¶

List availables roles.

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.

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 support report collect¶

Run sosreport on selected servers.

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

--stack <STACK>¶: Stack name to use for log collection.

-c <CONTAINER>, --container <CONTAINER>¶: This option no-longer has any effect.

-o <DESTINATION>, --output <DESTINATION>¶: Output directory for the report

--skip-container-delete¶: This option no-longer has any effect.

-t <TIMEOUT>, --timeout <TIMEOUT>¶: This option no-longer has any effect.

-n <CONCURRENCY>, --concurrency <CONCURRENCY>¶: This option no-longer has any effect.

--collect-only¶: This option no-longer has any effect.

--download-only¶: This option no-longer has any effect.

server_name¶: Server name, group 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.

Container Commands¶

tripleo container image build¶

Build tripleo container images with tripleo-ansible.

openstack tripleo container image build
    [--authfile <authfile>]
    [--base <base-image>]
    [--config-file <config-file>]
    [--config-path <config-path>]
    [--distro <distro>]
    [--tcib-extras <key=val>]
    [--exclude <container-name>]
    [--extra-config <extra-config>]
    [--namespace <registry-namespace>]
    [--registry <registry-url>]
    [--skip-build]
    [--tag <image-tag>]
    [--prefix <image-prefix>]
    [--push]
    [--label <label-data>]
    [--volume <volume-path>]
    [--work-dir <work-directory>]
    [--rhel-modules <rhel-modules>]
    [--build-timeout <build timeout in seconds>]

--authfile <authfile>¶: Path of the authentication file. Use REGISTRY_AUTH_FILE environment variable to override. (default: %(default)s)

--base <base-image>¶: Base image name, with optional version. Can be ‘centos:8’, base name image will be ‘centos’ but ‘centos:8’ will be pulled to build the base image. (default: %(default)s)

--config-file <config-file>¶: YAML config file specifying the images to build. (default: %(default)s)

--config-path <config-path>¶: Base configuration path. This is the base path for all container-image files. The defined containers must reside within a ‘tcib’ folder that is in this path. If this option is set, the default path for <config-file> will be modified. (default: %(default)s)

--distro <distro>¶: Distro name, if undefined the system will build using the host distro. (default: %(default)s)

--tcib-extras <key=val>¶: TCIB extra variables you want to pass. They can be later used within TCIB files as conditonals. Can be passed multiple times(default: %(default)s)

--exclude <container-name>¶: Name of one container to match against the list of containers to be built to skip. Should be specified multiple times when skipping multiple containers. (default: %(default)s)

--extra-config <extra-config>¶: Apply additional options from a given configuration YAML file. This will apply to all containers built. (default: %(default)s)

--namespace <registry-namespace>¶: Container registry namespace (default: %(default)s)

--registry <registry-url>¶: Container registry URL (default: %(default)s)

--skip-build¶: Skip or not the build of the images (default: %(default)s)

--tag <image-tag>¶: Image tag (default: %(default)s)

--prefix <image-prefix>¶: Image prefix. (default: %(default)s)

--push¶: Enable image push to a given registry. (default: %(default)s)

--label <label-data>¶: Add labels to the containers. This option can be specified multiple times. Each label is a key=value pair.

--volume <volume-path>¶: Container bind mount used when building the image. Should be specified multiple times if multiple volumes.(default: %(default)s)

--work-dir <work-directory>¶: TripleO container builds directory, storing configs and logs for each image and its dependencies. (default: %(default)s)

--rhel-modules <rhel-modules>¶: A comma separated list of RHEL modules to enable with their version. Example: ‘mariadb:10.3,virt:8.3’.

--build-timeout <build timeout in seconds>¶: Build timeout in seconds.

This command is provided by the python-tripleoclient plugin.

tripleo container image delete¶

Delete specified image from registry.

openstack tripleo container image delete
    [--registry-url <registry url>]
    [--username <username>]
    [--password <password>]
    [-y]
    <image
    to
    delete>

--registry-url <registry url>¶: URL of registry images are to be listed from in the form <fqdn>:<port>.

--username <username>¶: Username for image registry.

--password <password>¶: Password for image registry.

-y, --yes¶: Skip yes/no prompt (assume yes).

image to delete¶: Full URL of image to be deleted in the form <fqdn>:<port>/path/to/image

This command is provided by the python-tripleoclient plugin.

tripleo container image hotfix¶

Hotfix tripleo container images with tripleo-ansible.

openstack tripleo container image hotfix
    --image <images>
    --rpms-path <rpms-path>
    [--tag <image-tag>]

--image <images>¶: Fully qualified reference to the source image to be modified. Can be specified multiple times (one per image) (default: %(default)s).

--rpms-path <rpms-path>¶: Path containing RPMs to install (default: %(default)s).

--tag <image-tag>¶: Image hotfix tag (default: %(default)s)

This command is provided by the python-tripleoclient plugin.

tripleo container image list¶

List images discovered in registry.

openstack tripleo container image 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]
    [--sort-ascending | --sort-descending]
    [--registry-url <registry url>]
    [--username <username>]
    [--password <password>]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--registry-url <registry url>¶: URL of registry images are to be listed from in the form <fqdn>:<port>.

--username <username>¶: Username for image registry.

--password <password>¶: Password for image registry.

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>]
    [--log-file LOG_FILE]

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

--log-file <LOG_FILE>¶: Log file to be used for python logging. By default it would be logged to $HOME/container_image_prepare.log.

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]
    [--enable-registry-login]

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

--enable-registry-login¶: Use this flag to enable the flag to have systems attempt to login to a remote registry prior to pulling their containers. This flag should be used when –local-push-destination is NOT used and the target systems will have network connectivity to the remote registries. Do not use this for an overcloud that may not have network connectivity to a remote registry.

This command is provided by the python-tripleoclient plugin.

tripleo container image push¶

Push specified image to registry.

openstack tripleo container image push
    [--local]
    [--registry-url <registry url>]
    [--append-tag APPEND_TAG]
    [--username <username>]
    [--password <password>]
    [--source-username <source_username>]
    [--source-password <source_password>]
    [--dry-run]
    [--multi-arch]
    [--cleanup]
    <image
    to
    push>

--local¶: Use this flag if the container image is already on the current system and does not need to be pulled from a remote registry.

--registry-url <registry url>¶: URL of the destination registry in the form <fqdn>:<port>.

--append-tag <APPEND_TAG>¶: Tag to append to the existing tag when pushing the container.

--username <username>¶: Username for the destination image registry.

--password <password>¶: Password for the destination image registry.

--source-username <source_username>¶: Username for the source image registry.

--source-password <source_password>¶: Password for the source image registry.

--dry-run¶: Perform a dry run upload. The upload action is not performed, but the authentication process is attempted.

--multi-arch¶: Enable multi arch support for the upload.

--cleanup¶: Remove local copy of the image after uploading

image to push¶: Container image to upload. Should be in the form of <registry>/<namespace>/<name>:<tag>. If tag is not provided, then latest will be used.

This command is provided by the python-tripleoclient plugin.

tripleo container image show¶

Show image selected from the registry.

openstack tripleo container image show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--username <username>]
    [--password <password>]
    <image
    to
    inspect>

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to json

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

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

--username <username>¶: Username for image registry.

--password <password>¶: Password for image registry.

image to inspect¶: Image to be inspected, for example: docker.io/library/centos:7 or docker://docker.io/library/centos:7

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]
    [--work-dir <container builds directory>]
    [--build-timeout <build timeout in seconds>]

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

--work-dir <container builds directory>¶: TripleO container builds directory, storing configs and logs for each image and its dependencies.

--build-timeout <build timeout in seconds>¶: Build timeout in seconds.

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

undercloud backup¶

Backup the undercloud

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

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

--setup-nfs¶: Setup the NFS server on the backup node which will install required packages and configuration on the host ‘BackupNode’ in the ansible inventory.

--setup-rear¶: Setup ReaR on the ‘Undercloud’ host which will install and configure ReaR.

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

--db-only¶: Perform a DB backup of the ‘Undercloud’ host. The DB backup file will be stored in /home/stack with the name openstack-backup-mysql-<timestamp>.sql.

--inventory <INVENTORY>¶: Tripleo inventory file generated with tripleo-ansible-inventory command. Defaults to: /home/stack/tripleo-inventory.yaml.

--add-path <ADD_PATH>¶: Add additional files to backup. Defaults to: /home/stack/ i.e. –add-path /this/is/a/folder/ –add-path /this/is/a/texfile.txt.

--exclude-path <EXCLUDE_PATH>¶: Exclude path when performing the Undercloud Backup, this option can be specified multiple times. Defaults to: none i.e. –exclude-path /this/is/a/folder/ –exclude-path /this/is/a/texfile.txt.

--save-swift¶: Save backup to swift. Defaults to: False Special attention should be taken that Swift itself is backed up if you call this multiple times the backup size will grow exponentially.

--extra-vars <EXTRA_VARS>¶: Set additional variables as Dict or as an absolute path of a JSON or YAML file type. i.e. –extra-vars ‘{“key”: “val”, “key2”: “val2”}’ i.e. –extra-vars /path/to/my_vars.yaml i.e. –extra-vars /path/to/my_vars.json. For more information about the variables that can be passed, visit: https://opendev.org/openstack/tripleo-ansible/src/branch/master/tripleo_ansible/roles/backup_and_restore/defaults/main.yml.

undercloud install¶

Install and setup the undercloud

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

--force-stack-update¶: Do a virtual update of the ephemeral heat stack. New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--no-validations¶: Do not perform undercloud configuration validations

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

--dry-run¶: Print the install command instead of running it

-y, --yes¶: Skip yes/no prompt (assume yes).

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

undercloud minion install¶

Install and setup the undercloud minion

openstack undercloud minion 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 minion configuration validations

--dry-run¶: Print the install command instead of running it

-y, --yes¶: Skip yes/no prompt (assume yes).

undercloud minion upgrade¶

Upgrade undercloud minion

openstack undercloud minion 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 minion 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]
    [--inflight-validations]
    [--dry-run]
    [-y]
    [--disable-container-prepare]
    [--skip-package-updates]

--force-stack-update¶: Do a virtual update of the ephemeral heat stack. New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--no-validations¶: Do not perform undercloud configuration validations

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

--dry-run¶: Print the install command instead of running it

-y, --yes¶: Skip yes/no prompt (assume yes).

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

--skip-package-updates¶: Flag to skip the package update when performing upgrades and updates

All Overcloud Commands

All Overcloud Commands¶

overcloud backup¶

overcloud cell export¶

overcloud config download¶

overcloud container image build¶

overcloud container image prepare¶

overcloud container image tag discover¶

overcloud container image upload¶

overcloud delete¶

overcloud export¶

overcloud export ceph¶

overcloud image build¶

overcloud image upload¶

overcloud netenv validate¶

overcloud profiles list¶

overcloud profiles match¶

overcloud role list¶

overcloud role show¶

overcloud roles generate¶

overcloud support report collect¶

Container Commands¶

tripleo container image build¶

tripleo container image delete¶

tripleo container image hotfix¶

tripleo container image list¶

tripleo container image prepare¶

tripleo container image prepare default¶

tripleo container image push¶

tripleo container image show¶

overcloud container image build¶

overcloud container image tag discover¶

overcloud container image upload¶

Undercloud Commands¶

undercloud backup¶

undercloud install¶

undercloud minion install¶

undercloud minion upgrade¶

undercloud upgrade¶

Standalone Commands¶

python-tripleoclient 14.3.1.dev3

Page Contents