Chapter 79. tripleo

--deployment-user DEPLOYMENT_USER

User who executes the tripleo config generate command. Defaults to stack.

--output-dir OUTPUT_DIR

Directory to output ansible.cfg and ansible.log files.

-h, --help

Show this help message and exit

--authfile <authfile>

Path of the authentication file. use REGISTRY_AUTH_FILE environment variable to override. (default: /root/containers/auth.json)

--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: ubi8)

--config-file <config-file>

Yaml config file specifying the images to build. (default: tripleo_containers.yaml)

--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: /usr/share/tripleo- common/container-images)

--distro <distro>

Distro name, if undefined the system will build using the host distro. (default: centos)

--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: [])

--extra-config <extra-config>

Apply additional options from a given configuration YAML file. This will apply to all containers built. (default: None)

--namespace <registry-namespace>

Container registry namespace (default: tripleotrain)

--registry <registry-url>

Container registry url (default: localhost)

--skip-build

Skip or not the build of the images (default: false)

--tag <image-tag>

Image tag (default: latest)

--prefix <image-prefix>

Image prefix. (default: openstack)

--push

Enable image push to a given registry. (default: False)

--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: [/etc/yum.repos.d:/etc/distro.repos.d:z, /etc/pki/rpm-gpg:/etc/pki/rpm-gpg:z])

--work-dir <work-directory>

Tripleo container builds directory, storing configs and logs for each image and its dependencies. (default: /tmp/container-builds)

--rhel-modules <rhel-modules>

A comma separated list of rhel modules to enable with their version. Example: mariadb:10.3,virt:8.3.

<image to delete>

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

-h, --help

Show this help message and exit

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

-h, --help

Show this help message and exit

--image <images>

Fully qualified reference to the source image to be modified. Can be specified multiple times (one per image) (default: []).

--rpms-path <rpms-path>

Path containing rpms to install (default: none).

--tag <image-tag>

Image hotfix tag (default: latest)

-h, --help

Show this help message and exit

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

-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

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

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.

-h, --help

Show this help message and exit

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

-h, --help

Show this help message and exit

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

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

-h, --help

Show this help message and exit

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

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

-h, --help

Show this help message and exit

--username <username>

Username for image registry.

--password <password>

Password for image registry.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--standalone

Run deployment as a standalone deployment with no undercloud.

--upgrade

Upgrade an existing deployment.

-y, --yes

Skip yes/no prompt (assume yes).

--stack STACK

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

--output-dir OUTPUT_DIR

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

--output-only

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

--standalone-role STANDALONE_ROLE

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

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

Deployment timeout in minutes.

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

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

--roles-file ROLES_FILE, -r ROLES_FILE

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

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--heat-api-port <HEAT_API_PORT>

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

--heat-user <HEAT_USER>

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

--deployment-user DEPLOYMENT_USER

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

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

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

--heat-container-image <HEAT_CONTAINER_IMAGE>

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

--heat-native [HEAT_NATIVE]

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

--local-ip <LOCAL_IP>

Local ip/cidr for undercloud traffic. required.

--control-virtual-ip <CONTROL_VIRTUAL_IP>

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

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

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

--local-domain <LOCAL_DOMAIN>

Local domain for standalone cloud and its api endpoints

--cleanup

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

--hieradata-override [HIERADATA_OVERRIDE]

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

--keep-running

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

--inflight-validations

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

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

--force-stack-update

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

--force-stack-create

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

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--standalone

Run deployment as a standalone deployment with no undercloud.

--upgrade

Upgrade an existing deployment.

-y, --yes

Skip yes/no prompt (assume yes).

--stack STACK

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

--output-dir OUTPUT_DIR

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

--output-only

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

--standalone-role STANDALONE_ROLE

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

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

Deployment timeout in minutes.

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

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

--roles-file ROLES_FILE, -r ROLES_FILE

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

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

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

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

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

--heat-api-port <HEAT_API_PORT>

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

--heat-user <HEAT_USER>

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

--deployment-user DEPLOYMENT_USER

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

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

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

--heat-container-image <HEAT_CONTAINER_IMAGE>

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

--heat-native [HEAT_NATIVE]

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

--local-ip <LOCAL_IP>

Local ip/cidr for undercloud traffic. required.

--control-virtual-ip <CONTROL_VIRTUAL_IP>

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

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

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

--local-domain <LOCAL_DOMAIN>

Local domain for standalone cloud and its api endpoints

--cleanup

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

--hieradata-override [HIERADATA_OVERRIDE]

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

--keep-running

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

--inflight-validations

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

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

--force-stack-update

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

--force-stack-create

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

-h, --help

Show this help message and exit

-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

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

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

--config CONFIG

Config file path for validation.

--validation-dir VALIDATION_DIR

Path where the validation playbooks are located.

<validation_name>

The name of the community validation: Validation name is limited to contain only lowercase alphanumeric characters, plus _ or - and starts with an alpha character. Ex: my-val, my_val2. This will generate an Ansible role and a playbook in /root/community-validations. Note that the structure of this directory will be created at the first use.

-h, --help

Show this help message and exit

--config CONFIG

Config file path for validation.

-h, --help

Show this help message and exit

-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

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

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

--config CONFIG

Config file path for validation.

--group <group_id>[,<group_id>,…​], -g <group_id>[,<group_id>,…​]

List specific group of validations, if more than one group is required separate the group names with commas.

--category <category_id>[,<category_id>,…​]

List specific category of validations, if more than one category is required separate the category names with commas.

--product <product_id>[,<product_id>,…​]

List specific product of validations, if more than one product is required separate the product names with commas.

--validation-dir VALIDATION_DIR

Path where the validation playbooks are located.

-h, --help

Show this help message and exit

--config CONFIG

Config file path for validation.

--limit <host1>[,<host2>,<host3>,…​]

A string that identifies a single node or comma- separated list of nodes to be upgraded in parallel in this upgrade run invocation.

--ssh-user SSH_USER

Ssh user name for the ansible ssh connection.

--validation-dir VALIDATION_DIR

Path where the validation playbooks is located.

--ansible-base-dir ANSIBLE_BASE_DIR

Path where the ansible roles, library and plugins are located.

--validation-log-dir VALIDATION_LOG_DIR

Path where the log files and artifacts will be located.

--inventory INVENTORY, -i INVENTORY

Path of the ansible inventory.

--output-log OUTPUT_LOG

Path where the run result will be stored.

--junitxml JUNITXML

Path where the run result in junitxml format will be stored.

--python-interpreter --python-interpreter <PYTHON_INTERPRETER_PATH>

Python interpreter for ansible execution.

--extra-env-vars key1=<val1> [--extra-env-vars key2=<val2>]

Add extra environment variables you may need to provide to your Ansible execution as KEY=VALUE pairs. Note that if you pass the same KEY multiple times, the last given VALUE for that same KEY will override the other(s)

--skiplist SKIP_LIST

Path where the skip list is stored. an example of the skiplist format could be found at the root of the validations-libs repository.

--extra-vars key1=<val1> [--extra-vars key2=<val2>]

Add ansible extra variables to the validation(s) execution as KEY=VALUE pair(s). Note that if you pass the same KEY multiple times, the last given VALUE for that same KEY will override the other(s)

--extra-vars-file /tmp/my_vars_file.[json|yaml]

Absolute or relative path to a json/yaml file containing extra variable(s) to pass to one or multiple validation(s) execution.

--validation <validation_id>[,<validation_id>,…​]

Run specific validations, if more than one validation is required separate the names with commas.

--group <group_id>[,<group_id>,…​], -g <group_id>[,<group_id>,…​]

Run specific group validations, if more than one group is required separate the group names with commas.

--category <category_id>[,<category_id>,…​]

Run specific validations by category, if more than one category is required separate the category names with commas.

--product <product_id>[,<product_id>,…​]

Run specific validations by product, if more than one product is required separate the product names with commas.

-h, --help

Show this help message and exit

-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

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

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

--config CONFIG

Config file path for validation.

--validation <validation_id>

Display execution history for a validation

--limit HISTORY_LIMIT

Display <n> most recent runs of the selected <validation>. <n> must be > 0 The default display limit is set to 15.

--validation-log-dir VALIDATION_LOG_DIR

Path where the validation log files is located.

-h, --help

Show this help message and exit

--config CONFIG

Config file path for validation.

--validation-dir VALIDATION_DIR

Path where the validation playbooks are located.

--validation <validation_id>[,<validation_id>,…​]

List specific validations, if more than one validation is required separate the names with commas.

--group <group_id>[,<group_id>,…​], -g <group_id>[,<group_id>,…​]

List specific group validations, if more than one group is required separate the group names with commas.

--category <category_id>[,<category_id>,…​]

List specific validations by category, if more than one category is required separate the category names with commas.

--product <product_id>[,<product_id>,…​]

List specific validations by product, if more than one product is required separate the product names with commas.

--download DOWNLOAD

Create a json or a yaml file containing all the variables available for the validations: /tmp/myvars

--format-output <format_output>

Print representation of the validation. the choices of the output format is json,yaml.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

<uuid>

Validation uuid run

-h, --help

Show this help message and exit

--config CONFIG

Config file path for validation.

--full

Show full details for the run

--validation-log-dir VALIDATION_LOG_DIR

Path where the validation log files is located.

<validation>

Show a specific validation.

-h, --help

Show this help message and exit

--config CONFIG

Config file path for validation.

--validation-dir VALIDATION_DIR

Path where the validation playbooks are located.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.