Chapter 81. tripleo This chapter describes the commands under the tripleo command. 81.1. tripleo config generate ansible Generate the default ansible.cfg for deployments. Usage: Table 81.1. Optional Arguments Value Summary --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. 81.2. tripleo container image delete Delete specified image from registry. Usage: Table 81.2. Positional Arguments Value Summary <image to delete> Full url of image to be deleted in the form <fqdn>:<port>/path/to/image Table 81.3. Optional Arguments Value Summary -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). 81.3. tripleo container image list List images discovered in registry. Usage: Table 81.4. Optional Arguments Value Summary -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. Table 81.5. Output Formatters Value Summary -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 Table 81.6. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 81.7. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 81.8. Table Formatter Value Summary --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. 81.4. tripleo container image prepare default Generate a default ContainerImagePrepare parameter. Usage: Table 81.9. Optional Arguments Value Summary -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. 81.5. tripleo container image prepare Prepare and upload containers from a single command. Usage: Table 81.10. Optional Arguments Value Summary -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. 81.6. tripleo container image push Push specified image to registry. Usage: Table 81.11. Positional Arguments Value Summary <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. Table 81.12. Optional Arguments Value Summary -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 81.7. tripleo container image show Show image selected from the registry. Usage: Table 81.13. Positional Arguments Value Summary <image to inspect> Image to be inspected, for example: docker.io/library/centos:7 or docker://docker.io/library/centos:7 Table 81.14. Optional Arguments Value Summary -h, --help Show this help message and exit --username <username> Username for image registry. --password <password> Password for image registry. Table 81.15. Output Formatters Value Summary -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 Table 81.16. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 81.17. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 81.18. Table Formatter Value Summary --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. 81.8. tripleo deploy Deploy containerized Undercloud Usage: Table 81.19. Optional Arguments Value Summary --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 USDSUDO_USER. If USDSUDO_USER is unset it defaults to stack. --deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER The path to python interpreter to use for the deployment actions. If not specified the python version of the openstackclient will be used. This may need to be used if deploying on a python2 host from a python3 system or vice versa. --heat-container-image <HEAT_CONTAINER_IMAGE> The container image to use when launching the heat-all process. Defaults to: tripleomaster/centos-binary- heat-all:current-tripleo --heat-native [HEAT_NATIVE] Execute the heat-all process natively on this host. This option requires that the heat-all binaries be installed locally on this machine. This option is enabled by default which means heat-all is executed on the host OS directly. --local-ip <LOCAL_IP> Local ip/cidr for undercloud traffic. required. --control-virtual-ip <CONTROL_VIRTUAL_IP> Control plane vip. this allows the undercloud installer to configure a custom VIP on the control plane. --public-virtual-ip <PUBLIC_VIRTUAL_IP> Public nw vip. this allows the undercloud installer to configure a custom VIP on the public (external) NW. --local-domain <LOCAL_DOMAIN> Local domain for standalone cloud and its api endpoints --cleanup Cleanup temporary files. using this flag will remove the temporary files used during deployment in after the command is run. --hieradata-override [HIERADATA_OVERRIDE] Path to hieradata override file. when it points to a heat env file, it is passed in t-h-t via --environment-file. When the file contains legacy instack data, it is wrapped with <role>ExtraConfig and also passed in for t-h-t as a temp file created in --output-dir. Note, instack hiera data may be not t-h-t compatible and will highly likely require a manual revision. --keep-running Keep the ephemeral heat running after the stack operation is complete. This is for debugging purposes only. The ephemeral Heat can be used by openstackclient with: OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list where 8006 is the port specified by --heat- api-port. --inflight-validations Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False. --force-stack-update Do a virtual update of the ephemeral heat stack (it cannot take real updates). New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE. --force-stack-create Do a virtual create of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=CREATE. 81.9. tripleo upgrade Upgrade TripleO Usage: Table 81.20. Optional Arguments Value Summary --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 USDSUDO_USER. If USDSUDO_USER is unset it defaults to stack. --deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER The path to python interpreter to use for the deployment actions. If not specified the python version of the openstackclient will be used. This may need to be used if deploying on a python2 host from a python3 system or vice versa. --heat-container-image <HEAT_CONTAINER_IMAGE> The container image to use when launching the heat-all process. Defaults to: tripleomaster/centos-binary- heat-all:current-tripleo --heat-native [HEAT_NATIVE] Execute the heat-all process natively on this host. This option requires that the heat-all binaries be installed locally on this machine. This option is enabled by default which means heat-all is executed on the host OS directly. --local-ip <LOCAL_IP> Local ip/cidr for undercloud traffic. required. --control-virtual-ip <CONTROL_VIRTUAL_IP> Control plane vip. this allows the undercloud installer to configure a custom VIP on the control plane. --public-virtual-ip <PUBLIC_VIRTUAL_IP> Public nw vip. this allows the undercloud installer to configure a custom VIP on the public (external) NW. --local-domain <LOCAL_DOMAIN> Local domain for standalone cloud and its api endpoints --cleanup Cleanup temporary files. using this flag will remove the temporary files used during deployment in after the command is run. --hieradata-override [HIERADATA_OVERRIDE] Path to hieradata override file. when it points to a heat env file, it is passed in t-h-t via --environment-file. When the file contains legacy instack data, it is wrapped with <role>ExtraConfig and also passed in for t-h-t as a temp file created in --output-dir. Note, instack hiera data may be not t-h-t compatible and will highly likely require a manual revision. --keep-running Keep the ephemeral heat running after the stack operation is complete. This is for debugging purposes only. The ephemeral Heat can be used by openstackclient with: OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list where 8006 is the port specified by --heat- api-port. --inflight-validations Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False. --force-stack-update Do a virtual update of the ephemeral heat stack (it cannot take real updates). New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE. --force-stack-create Do a virtual create of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=CREATE. 81.10. tripleo validator group info Display Information about Validation Groups Usage: Table 81.21. Optional Arguments Value Summary -h, --help Show this help message and exit Table 81.22. Output Formatters Value Summary -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 Table 81.23. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 81.24. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 81.25. Table Formatter Value Summary --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. 81.11. tripleo validator list List the available validations Usage: Table 81.26. Optional Arguments Value Summary -h, --help Show this help message and exit --group <group>[,<group>,... ] List specific group validations, if more than one group is required separate the group names with commas: --group pre-upgrade,prep Table 81.27. Output Formatters Value Summary -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 Table 81.28. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 81.29. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 81.30. Table Formatter Value Summary --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. 81.12. tripleo validator run Run the available validations Usage: Table 81.31. Optional Arguments Value Summary --plan PLAN, --stack PLAN Execute the validations using a custom plan name (default: overcloud) --workers N, -w N The maximum number of threads that can be used to execute the given validations (default: 1) --extra-vars EXTRA_VARS Add a dictionary as extra variable to a validation: --extra-vars {"min_undercloud_ram_gb": 24} (default: {}) --extra-vars-file EXTRA_VARS_FILE Add a json/yaml file containing extra variable to a validation: --extra-vars-file /home/stack/vars.[json yaml] If using Mistral, only a valid JSON file will be supported. (default: ) --validation <validation_id>[,<validation_id>,... ] Run specific validations, if more than one validation is required separate the names with commas: --validation check-ftype,512e --validation 512e (default: []) --group <group>[,<group>,... ] Run specific group validations, if more than one group is required separate the group names with commas: --group pre-upgrade,prep 81.13. tripleo validator show parameter Display Validations Parameters Usage: Table 81.32. Optional Arguments Value Summary -h, --help Show this help message and exit --validation <validation_id>[,<validation_id>,... ] List specific validations, if more than one validation is required separate the names with commas: --validation check-ftype,512e --validation 512e (default: []) --group <group_id>[,<group_id>,... ] List specific group validations, if more than one group is required separate the group names with commas: pre-upgrade,prep openshift-on-openstack (default: []) --download [json yaml] /tmp/myvars Create a json or a yaml file containing all the variables available for the validations: [yaml json] /tmp/myvars (default: []) -f <format>, --format <format> Print representation of the validation. the choices of the output format is json,yaml. (default: json) 81.14. tripleo validator show Display detailed information about a Validation Usage: Table 81.33. Positional Arguments Value Summary <validation> Validation id Table 81.34. Optional Arguments Value Summary -h, --help Show this help message and exit Table 81.35. Output Formatters Value Summary -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 Table 81.36. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 81.37. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 81.38. Table Formatter Value Summary --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.

Commands:
openstack tripleo config generate ansible [--deployment-user DEPLOYMENT_USER] [--output-dir OUTPUT_DIR]
openstack tripleo container image delete [-h] [--registry-url <registry url>] [--username <username>] [--password <password>] [-y] <image to delete>
openstack tripleo container image list [-h] [-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] [--registry-url <registry url>] [--username <username>] [--password <password>]
openstack tripleo container image prepare default [-h] [--output-env-file <file path>] [--local-push-destination]
openstack tripleo container image prepare [-h] [--environment-file <file path>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--output-env-file <file path>] [--dry-run] [--cleanup <full, partial, none>]
openstack tripleo container image push [-h] [--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>
openstack tripleo container image show [-h] [-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>
openstack tripleo deploy [--templates [TEMPLATES]] [--standalone] [--upgrade] [-y] [--stack STACK] [--output-dir OUTPUT_DIR] [--output-only] [--standalone-role STANDALONE_ROLE] [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--heat-api-port <HEAT_API_PORT>] [--heat-user <HEAT_USER>] [--deployment-user DEPLOYMENT_USER] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [--heat-container-image <HEAT_CONTAINER_IMAGE>] [--heat-native [HEAT_NATIVE]] [--local-ip <LOCAL_IP>] [--control-virtual-ip <CONTROL_VIRTUAL_IP>] [--public-virtual-ip <PUBLIC_VIRTUAL_IP>] [--local-domain <LOCAL_DOMAIN>] [--cleanup] [--hieradata-override [HIERADATA_OVERRIDE]] [--keep-running] [--inflight-validations] [--force-stack-update | --force-stack-create]
openstack tripleo upgrade [--templates [TEMPLATES]] [--standalone] [--upgrade] [-y] [--stack STACK] [--output-dir OUTPUT_DIR] [--output-only] [--standalone-role STANDALONE_ROLE] [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--heat-api-port <HEAT_API_PORT>] [--heat-user <HEAT_USER>] [--deployment-user DEPLOYMENT_USER] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [--heat-container-image <HEAT_CONTAINER_IMAGE>] [--heat-native [HEAT_NATIVE]] [--local-ip <LOCAL_IP>] [--control-virtual-ip <CONTROL_VIRTUAL_IP>] [--public-virtual-ip <PUBLIC_VIRTUAL_IP>] [--local-domain <LOCAL_DOMAIN>] [--cleanup] [--hieradata-override [HIERADATA_OVERRIDE]] [--keep-running] [--inflight-validations] [--force-stack-update | --force-stack-create]
openstack tripleo validator group info [-h] [-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]
openstack tripleo validator list [-h] [-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] [--group <group>[,<group>,...]]
openstack tripleo validator run [--plan PLAN] [--workers N] [--extra-vars EXTRA_VARS | --extra-vars-file EXTRA_VARS_FILE] (--validation <validation_id>[,<validation_id>,...] | --group <group>[,<group>,...])
openstack tripleo validator show parameter [-h] [--validation <validation_id>[,<validation_id>,...] | --group <group_id>[,<group_id>,...]] [--download [json|yaml] /tmp/myvars] [-f <format>]
openstack tripleo validator show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <validation>