From 2e983575c1e979a686a53b8ced2cc81f56d8a027 Mon Sep 17 00:00:00 2001 From: Lance Bragstad Date: Mon, 13 Jul 2020 10:03:09 -0500 Subject: [PATCH] trivial: fix spelling mistakes Looking through the documentation I noticed several spelling mistakes that were likely copy-pasted to documentation for various roles. This commit attempts to update all the README's and fix trivial misspellings. Change-Id: I26096360f6b0fffd3272a52c8303f1c8e81829cd --- roles/tripleo_config_generate_ansible/README.md | 2 +- roles/tripleo_container_image_build/README.md | 2 +- roles/tripleo_container_image_prepare/README.md | 2 +- roles/tripleo_container_image_push/README.md | 6 +++--- roles/tripleo_deploy/README.md | 16 ++++++++-------- .../tripleo_overcloud_admin_authorize/README.md | 4 ++-- roles/tripleo_overcloud_cell_export/README.md | 4 ++-- .../tripleo_overcloud_config_download/README.md | 4 ++-- .../README.md | 6 +++--- .../README.md | 16 ++++++++-------- .../README.md | 4 ++-- .../README.md | 4 ++-- roles/tripleo_overcloud_credentials/README.md | 6 +++--- roles/tripleo_overcloud_delete/README.md | 4 ++-- roles/tripleo_overcloud_deploy/README.md | 16 ++++++++-------- roles/tripleo_overcloud_export/README.md | 4 ++-- .../README.md | 10 +++++----- .../README.md | 10 +++++----- roles/tripleo_overcloud_failures/README.md | 2 +- .../README.md | 16 ++++++++-------- .../README.md | 16 ++++++++-------- .../tripleo_overcloud_ffwd_upgrade_run/README.md | 4 ++-- .../tripleo_overcloud_generate_fencing/README.md | 4 ++-- roles/tripleo_overcloud_image_build/README.md | 8 ++++---- roles/tripleo_overcloud_image_upload/README.md | 6 +++--- .../tripleo_overcloud_netenv_validate/README.md | 4 ++-- roles/tripleo_overcloud_node_delete/README.md | 2 +- roles/tripleo_overcloud_node_import/README.md | 10 +++++----- .../tripleo_overcloud_node_introspect/README.md | 2 +- roles/tripleo_overcloud_node_provide/README.md | 2 +- roles/tripleo_overcloud_node_provision/README.md | 10 +++++----- .../tripleo_overcloud_node_unprovision/README.md | 4 ++-- roles/tripleo_overcloud_profiles_list/README.md | 2 +- roles/tripleo_overcloud_profiles_match/README.md | 2 +- roles/tripleo_overcloud_raid_create/README.md | 4 ++-- roles/tripleo_overcloud_roles_generate/README.md | 4 ++-- roles/tripleo_overcloud_roles_list/README.md | 2 +- roles/tripleo_overcloud_roles_show/README.md | 2 +- roles/tripleo_overcloud_status/README.md | 2 +- .../README.md | 2 +- .../tripleo_overcloud_update_converge/README.md | 16 ++++++++-------- roles/tripleo_overcloud_update_prepare/README.md | 16 ++++++++-------- roles/tripleo_overcloud_update_run/README.md | 4 ++-- .../tripleo_overcloud_upgrade_converge/README.md | 16 ++++++++-------- .../tripleo_overcloud_upgrade_prepare/README.md | 16 ++++++++-------- roles/tripleo_overcloud_upgrade_run/README.md | 8 ++++---- roles/tripleo_undercloud_backup/README.md | 2 +- roles/tripleo_undercloud_install/README.md | 2 +- .../tripleo_undercloud_minion_install/README.md | 2 +- .../tripleo_undercloud_minion_upgrade/README.md | 2 +- roles/tripleo_undercloud_upgrade/README.md | 2 +- roles/tripleo_validator_run/README.md | 2 +- 52 files changed, 159 insertions(+), 159 deletions(-) diff --git a/roles/tripleo_config_generate_ansible/README.md b/roles/tripleo_config_generate_ansible/README.md index c2aa713..ae4091e 100644 --- a/roles/tripleo_config_generate_ansible/README.md +++ b/roles/tripleo_config_generate_ansible/README.md @@ -14,7 +14,7 @@ Role Variables * `tripleo_config_generate_ansible_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_config_generate_ansible_deployment_user`: (String) Deployment user to use. Default: "{{ ansible_user }}" * `tripleo_config_generate_ansible_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_config_generate_ansible_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_config_generate_ansible_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_config_generate_ansible_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_config_generate_ansible_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_config_generate_ansible_home_dir`: (String) Directory to run the command in. This is the default location for the output if `tripleo_config_generate_ansible_output_dir` is not specified.. Default: "{{ ansible_env.HOME }}" * `tripleo_config_generate_ansible_os_cloud`: (String) OS_CLOUD value to use when running the command. If tripleo_os_cloud is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_config_generate_ansible_rc_file`. * `tripleo_config_generate_ansible_output_dir`: (String) Directory to output ansible.cfg and ansible.log files. diff --git a/roles/tripleo_container_image_build/README.md b/roles/tripleo_container_image_build/README.md index e9ec923..7a82519 100644 --- a/roles/tripleo_container_image_build/README.md +++ b/roles/tripleo_container_image_build/README.md @@ -19,7 +19,7 @@ Role Variables * `tripleo_container_image_build_distro`: (String) Ability to override the distro name; e.g. rhel. Default: '' * `tripleo_container_image_build_excludes`: (List) Name of containers to exclude from the build. Default: [] * `tripleo_container_image_build_extra_config`: (String) YAML Config file specifying the extra metadata to override; e.g. labels. Default: '' -* `tripleo_container_image_build_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_container_image_build_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_container_image_build_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_container_image_build_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_container_image_build_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. * `tripleo_container_image_build_home_dir` (String): Path to the home directory. Default: {{ ansible_env.HOME }} * `tripleo_container_image_build_log` (String): Path to the log file. Default to {{ tripleo_container_image_build_home_dir }}/container_image_build.log diff --git a/roles/tripleo_container_image_prepare/README.md b/roles/tripleo_container_image_prepare/README.md index b1047ea..5e7433d 100644 --- a/roles/tripleo_container_image_prepare/README.md +++ b/roles/tripleo_container_image_prepare/README.md @@ -14,7 +14,7 @@ Role Variables * `tripleo_container_image_prepare_become`: (Boolean) Run the command as root. This needs to be true when uploading to the local undercloud registry. Default: true * `tripleo_container_image_prepare_cleanup`: (String) Cleanup behavior for local images left after upload. Can be one of full, partial, or none. Default is not set. * `tripleo_container_image_prepare_debug`: (Boolean) Flag to print out the prepare command. Default: False -* `tripleo_container_image_prepare_dry_run`: (Boolean) Perform a dry run upload which will not perform any push, pull or modify operations. The environment file will still be populaged. Default: false +* `tripleo_container_image_prepare_dry_run`: (Boolean) Perform a dry run upload which will not perform any push, pull or modify operations. The environment file will still be populated. Default: false * `tripleo_container_image_prepare_environment_files`: (List) List of environment files. Default: [] * `tripleo_container_image_prepare_environment_directory`: (List) Directories containing environment files. Should not be used if `tripleo_container_image_prepare_environment_files` is defined. Default: [] * `tripleo_container_image_prepare_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}" diff --git a/roles/tripleo_container_image_push/README.md b/roles/tripleo_container_image_push/README.md index 87e38a2..bc612f6 100644 --- a/roles/tripleo_container_image_push/README.md +++ b/roles/tripleo_container_image_push/README.md @@ -17,11 +17,11 @@ Role Variables * `tripleo_container_image_push_debug`: (Boolean) Flag to print out the push command. Default: False * `tripleo_container_image_push_dry_run`: (Boolean) Perform a dry run upload which will exercise the authentication process but not upload the container. Default: false * `tripleo_container_image_push_image`: (String) REQUIRED. Container image to upload. Should be in the form of //:tag. If the tag is not provided, 'latest' is used. -* `tripleo_container_image_push_local`: (Boolean) Use this flag if teh container image is already on the current system and does not need to be pulled from a remote registry. Default: false +* `tripleo_container_image_push_local`: (Boolean) Use this flag if the container image is already on the current system and does not need to be pulled from a remote registry. Default: false * `tripleo_container_image_push_multi_arch`: (Boolean) Enable multi arch support for the upload. Default: false * `tripleo_container_image_push_password`: (String) Password for the registry -* `tripleo_container_image_push_registry_url`: (String) URL of the destiantionr egistry in the form :. -* `tripleo_container_image_push_timeout`: (Number) Amount of time to wait for the command to conplete. Default: 360 +* `tripleo_container_image_push_registry_url`: (String) URL of the destination registry in the form :. +* `tripleo_container_image_push_timeout`: (Number) Amount of time to wait for the command to complete. Default: 360 * `tripleo_container_image_push_username`: (String) Username for the registry Output Variables diff --git a/roles/tripleo_deploy/README.md b/roles/tripleo_deploy/README.md index 8ef4440..7728dfc 100644 --- a/roles/tripleo_deploy/README.md +++ b/roles/tripleo_deploy/README.md @@ -17,22 +17,22 @@ Role Variables * `tripleo_deploy_debug`: (Boolean) Flag to print out the command that is run. Default: false * `tripleo_deploy_debug_arg`: (Boolean) Flag for ansible to use -vv. Default: false * `tripleo_deploy_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_deploy_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_deploy_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_deploy_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_deploy_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_deploy_deployment_python_interpreter`: (String) Path to a python interpreter for the deployment actions. * `tripleo_deploy_deployment_user`: (String) User who is executing the tripleo deployment via sudo. Defaults: "{{ ansible_env.USER }}" * `tripleo_deploy_environment_files`: (List) A list of environment file paths for the deployment. * `tripleo_deploy_force_stack_create`: (Boolean) Flag to force stack create. Default: false * `tripleo_deploy_force_stack_update`: (Boolean) Flag to force stack update. Default: false * `tripleo_deploy_heat_api_port`: (Number) Heat API port to use for the installer. -* `tripleo_deploy_heat_user`: (String) User to execute the non-privleged heat-all process. -* `tripleo_deploy_hieradata_override`: (String) Path to hierdata override file. +* `tripleo_deploy_heat_user`: (String) User to execute the non-privileged heat-all process. +* `tripleo_deploy_hieradata_override`: (String) Path to hiera data override file. * `tripleo_deploy_home_dir`: (String) Path to the directory to execute the command in. Default: "{{ ansible_env.HOME }}" -* `tripleo_deploy_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false +* `tripleo_deploy_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false * `tripleo_deploy_keep_running`: (Boolean) Flag to keep the heat instance running after the deploy has run. Default: false -* `tripleo_deploy_local_domain`: (String): Local domaon for standalone cloud and the endpoints. -* `tripleo_deploy_local_ip`: (String) Local IP address to use for the cloud trafic. REQUIRED. +* `tripleo_deploy_local_domain`: (String): Local domain for standalone cloud and the endpoints. +* `tripleo_deploy_local_ip`: (String) Local IP address to use for the cloud traffic. REQUIRED. * `tripleo_deploy_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_deploy_home_dir }}/overcloud_deploy.log" -* `tripleo_deploy_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_deploy_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_deploy_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_deploy_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_deploy_output_dir`: (String) Directory to write output data to. @@ -42,7 +42,7 @@ Role Variables * `tripleo_deploy_public_virtual_ip`: (String) Public network VIP. * `tripleo_deploy_roles_file`: (String) File path to a deployment roles file. * `tripleo_deploy_stack`: (String) Name for ephemeral stack. Default: standalone -* `tripleo_deploy_standalone`: (Boolean) Flag to inidicate that a standalone cloud is being deployed. Default: true +* `tripleo_deploy_standalone`: (Boolean) Flag to indicate that a standalone cloud is being deployed. Default: true * `tripleo_deploy_standalone_role`: (String) Role name to deploy. Default: Standalone * `tripleo_deploy_templates`: (String) Path to the directory containing heat templates for the deployment. Default: /usr/share/openstack-tripleo-heat-templates * `tripleo_deploy_timeout`: (Integer) Number in seconds to wait for the ansible execution of the deployment command to finish. This should be larger than the `tripleo_deploy_timeout_arg` value. Default: 5700 diff --git a/roles/tripleo_overcloud_admin_authorize/README.md b/roles/tripleo_overcloud_admin_authorize/README.md index f7ba5e8..c50e138 100644 --- a/roles/tripleo_overcloud_admin_authorize/README.md +++ b/roles/tripleo_overcloud_admin_authorize/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_admin_authorize_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_admin_authorize_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_admin_authorize_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_admin_authorize_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_admin_authorize_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_admin_authorize_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_admin_authorize_home_dir`: (String) Location to execute the command in. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_admin_authorize_os_cloud`: (String) OS_CLOUD value to use when running the command. If tripleo_os_cloud is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_admin_authorize_rc_file`. * `tripleo_overcloud_admin_authorize_output_dir`: (String) Directory to output ansible.cfg and ansible.log files. If not specified, will output to the `tripleo_overcloud_admin_authorize_home_dir`. @@ -22,7 +22,7 @@ Role Variables * `tripleo_overcloud_admin_authorize_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish (Train version only) * `tripleo_overcloud_admin_authorize_ssh_key`: (String) Path to ssh key for the overcloud nodes. * `tripleo_overcloud_admin_authorize_ssh_network`: (String) Network name to use for ssh access to the overcloud nodes. -* `tripleo_overcloud_admin_authorize_ssh_port_timeout`: (Integer) Timeout for teh ssh port to become active. +* `tripleo_overcloud_admin_authorize_ssh_port_timeout`: (Integer) Timeout for the ssh port to become active. * `tripleo_overcloud_admin_authorize_ssh_user`: (String) User for ssh access to overcloud nodes * `tripleo_overcloud_admin_authorize_stack`: (String) Name or ID of the heat stack * `tripleo_overcloud_admin_authorize_timeout`: (Integer) Number in seconds to wait for the ansible execution of the deployment command to finish. Default: 3600 diff --git a/roles/tripleo_overcloud_cell_export/README.md b/roles/tripleo_overcloud_cell_export/README.md index 5fc7d93..68a7318 100644 --- a/roles/tripleo_overcloud_cell_export/README.md +++ b/roles/tripleo_overcloud_cell_export/README.md @@ -16,9 +16,9 @@ Role Variables * `tripleo_overcloud_cell_export_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_cell_export_force_overwrite`: (Boolean) Flag to overwrite the output file. Default: false * `tripleo_overcloud_cell_export_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_cell_export_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_cell_export_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_cell_export_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_cell_export_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_cell_export_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_cell_export_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_cell_export_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_cell_export_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_cell_export_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_cell_export_home_dir }}/overcloud_cell_export.log" * `tripleo_overcloud_cell_export_name`: (String) REQUIRED. Name of the stack used for additional cell. diff --git a/roles/tripleo_overcloud_config_download/README.md b/roles/tripleo_overcloud_config_download/README.md index db610d3..7694877 100644 --- a/roles/tripleo_overcloud_config_download/README.md +++ b/roles/tripleo_overcloud_config_download/README.md @@ -15,9 +15,9 @@ Role Variables * `tripleo_overcloud_config_download_config_type`: (String) Type of object config to extract from the deployment * `tripleo_overcloud_config_download_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_config_download_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_config_download_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_config_download_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_config_download_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_config_download_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_config_download_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_config_download_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_config_download_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_config_download_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_config_download_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_config_download_home_dir }}/overcloud_config_download.log" * `tripleo_overcloud_config_download_name`: (String) Name of the plan diff --git a/roles/tripleo_overcloud_container_image_build/README.md b/roles/tripleo_overcloud_container_image_build/README.md index 30ef994..9bf3ec6 100644 --- a/roles/tripleo_overcloud_container_image_build/README.md +++ b/roles/tripleo_overcloud_container_image_build/README.md @@ -11,16 +11,16 @@ None. Role Variables -------------- -* `tripleo_overcloud_container_image_build_config_files`: (List) YAML COnfig file(s) specifyign the image to build. Default: [] +* `tripleo_overcloud_container_image_build_config_files`: (List) YAML Config file(s) specifyign the image to build. Default: [] * `tripleo_overcloud_container_image_build_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_container_image_build_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_container_image_build_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_container_image_build_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_container_image_build_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_container_image_build_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_container_image_build_excludes`: (List) Name of containers to exclude from the build. Default: [] * `tripleo_overcloud_container_image_build_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_container_image_build_kolla_config_file`: (String) Path to Kolla config file. * `tripleo_overcloud_container_image_build_list_dependencies`: (Boolean) Show the image build dependencies instead of building. Default: false * `tripleo_overcloud_container_image_build_list_images`: (Boolean) Show the images which would be built rather than building. Default: false -* `tripleo_overcloud_container_image_build_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_container_image_build_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_container_image_build_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_container_image_build_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_container_image_build_home_dir }}/overcloud_container_image_build.log" * `tripleo_overcloud_container_image_build_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10 diff --git a/roles/tripleo_overcloud_container_image_prepare/README.md b/roles/tripleo_overcloud_container_image_prepare/README.md index 57a0b05..d7e8fd1 100644 --- a/roles/tripleo_overcloud_container_image_prepare/README.md +++ b/roles/tripleo_overcloud_container_image_prepare/README.md @@ -17,16 +17,16 @@ Role Variables * `tripleo_overcloud_container_image_prepare_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_container_image_prepare_environment_directory`: (String) Path to a directory containing the environment files specifying which services are containerized. * `tripleo_overcloud_container_image_prepare_environment_files`: (List) List of environment files specifying which services are containerized. Default: [] -* `tripleo_overcloud_container_image_prepare_excludes`: (List) List of patterns to match the imagename against to exclude from the output. Default: [] +* `tripleo_overcloud_container_image_prepare_excludes`: (List) List of patterns to match the image name against to exclude from the output. Default: [] * `tripleo_overcloud_container_image_prepare_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_container_image_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_container_image_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_container_image_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_container_image_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_container_image_prepare_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_container_image_prepare_includes`: (List) List of patterns to match the imagename against to include in the output. Default: [] -* `tripleo_overcloud_container_image_prepare_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_container_image_prepare_includes`: (List) List of patterns to match the image name against to include in the output. Default: [] +* `tripleo_overcloud_container_image_prepare_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_container_image_prepare_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_container_image_prepare_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_container_image_prepare_home_dir }}/overcloud_container_image_prepare.log" * `tripleo_overcloud_container_image_prepare_modify_role`: (String) Name of ansible role to run between every image pull and push. -* `tripleo_overcloud_container_image_prepare_modify_vars`: (String) Ansible vairables file containing varisables to use when using modify role. +* `tripleo_overcloud_container_image_prepare_modify_vars`: (String) Ansible variables file containing variables to use when using modify role. * `tripleo_overcloud_container_image_prepare_namespace`: (String) Override the default namespace substitution * `tripleo_overcloud_container_image_prepare_output_env_file`: (String) Output heat environment file which specifies all image parameters. * `tripleo_overcloud_container_image_prepare_output_images_file`: (String) Path to write the output image entries to. @@ -34,10 +34,10 @@ Role Variables * `tripleo_overcloud_container_image_prepare_prefix`: (String) Override the default name prefix substitution * `tripleo_overcloud_container_image_prepare_push_destination`: (String) Location of image registry to push images to * `tripleo_overcloud_container_image_prepare_roles_file`: (String) Roles file path for the cloud. -* `tripleo_overcloud_container_image_prepare_set`: (List) Set the value of a vaiable in the template even if it has no dedicated argument. Default: [] +* `tripleo_overcloud_container_image_prepare_set`: (List) Set the value of a variable in the template even if it has no dedicated argument. Default: [] * `tripleo_overcloud_container_image_prepare_suffix`: (String) Override the default name suffix substitution -* `tripleo_overcloud_container_image_prepare_tag_from_label`: (String) Use teh value of teh specify label to discover the tag -* `tripleo_overcloud_container_image_prepare_tag`: (String) Overide the default tag substitution +* `tripleo_overcloud_container_image_prepare_tag_from_label`: (String) Use the value of the specify label to discover the tag +* `tripleo_overcloud_container_image_prepare_tag`: (String) Override the default tag substitution * `tripleo_overcloud_container_image_prepare_template_file`: (String) YAML template file for image config * `tripleo_overcloud_container_image_prepare_timeout`: (Integer) Number in seconds to wait for the ansible execution of the command to finish. Default: 3600 diff --git a/roles/tripleo_overcloud_container_image_tag_discover/README.md b/roles/tripleo_overcloud_container_image_tag_discover/README.md index bf14651..d50a0ab 100644 --- a/roles/tripleo_overcloud_container_image_tag_discover/README.md +++ b/roles/tripleo_overcloud_container_image_tag_discover/README.md @@ -16,10 +16,10 @@ Role Variables * `tripleo_overcloud_container_image_tag_discover_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_container_image_tag_discover_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_container_image_tag_discover_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_container_image_tag_discover_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_container_image_tag_discover_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_container_image_tag_discover_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_container_image_tag_discover_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_container_image_tag_discover_image`: (String) REQUIRED. Fully qualified name of the image to discover the tag. -* `tripleo_overcloud_container_image_tag_discover_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_container_image_tag_discover_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_container_image_tag_discover_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_container_image_tag_discover_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_container_image_tag_discover_home_dir }}/overcloud_container_image_tag_discover.log" * `tripleo_overcloud_container_image_tag_discover_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10 diff --git a/roles/tripleo_overcloud_container_image_upload/README.md b/roles/tripleo_overcloud_container_image_upload/README.md index 8b5bdaf..5a5bb2d 100644 --- a/roles/tripleo_overcloud_container_image_upload/README.md +++ b/roles/tripleo_overcloud_container_image_upload/README.md @@ -18,9 +18,9 @@ Role Variables * `tripleo_overcloud_container_image_upload_config_files`: (List) REQUIRED. YAML config files specifying images. Default: [] * `tripleo_overcloud_container_image_upload_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_container_image_upload_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_container_image_upload_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_container_image_upload_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_container_image_upload_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_container_image_upload_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_container_image_upload_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_container_image_upload_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_container_image_upload_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_container_image_upload_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_container_image_upload_log`: (String) Path to a log file for the command output. Default: "{{ CHANGEME_home_dir }}/CHANGEME.log" * `tripleo_overcloud_container_image_upload_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10 diff --git a/roles/tripleo_overcloud_credentials/README.md b/roles/tripleo_overcloud_credentials/README.md index b6b2d0f..cbe7983 100644 --- a/roles/tripleo_overcloud_credentials/README.md +++ b/roles/tripleo_overcloud_credentials/README.md @@ -13,10 +13,10 @@ Role Variables * `tripleo_overcloud_credentials_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_credentials_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_credentials_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_credentials_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_credentials_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_credentials_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_credentials_directory`: (String) The directory to create the rc files in. Defaults to current working directory which will be `tripleo_overcloud_credentials_home_dir`. * `tripleo_overcloud_credentials_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_credentials_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_credentials_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_credentials_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_credentials_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_credentials_home_dir }}/overcloud_credentials.log" * `tripleo_overcloud_credentials_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_credentials_rc_file`. @@ -39,7 +39,7 @@ None. Example Playbook ---------------- -Example overcloud crednetials playbook +Example overcloud credentials playbook ```yaml - hosts: undercloud diff --git a/roles/tripleo_overcloud_delete/README.md b/roles/tripleo_overcloud_delete/README.md index e8c8e6c..680c280 100644 --- a/roles/tripleo_overcloud_delete/README.md +++ b/roles/tripleo_overcloud_delete/README.md @@ -13,9 +13,9 @@ Role Variables * `tripleo_overcloud_delete_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_delete_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_delete_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_delete_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_delete_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_delete_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_delete_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_delete_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_delete_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_delete_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_delete_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_delete_home_dir }}/overcloud_delete.log" * `tripleo_overcloud_delete_name`: (String) REQUIRED. Name or ID of heat stack to delete. diff --git a/roles/tripleo_overcloud_deploy/README.md b/roles/tripleo_overcloud_deploy/README.md index 0c9e58c..8a24f36 100644 --- a/roles/tripleo_overcloud_deploy/README.md +++ b/roles/tripleo_overcloud_deploy/README.md @@ -20,23 +20,23 @@ Role Variables * `tripleo_overcloud_deploy_deployment_python_interpreter`: (String) Path to a python interpreter for the deployment actions. * `tripleo_overcloud_deploy_disable_password_generation`: (Boolean) Flag to disable password generation. Default: false * `tripleo_overcloud_deploy_disable_validations`: (Boolean) Flag to disable validations. Default: false -* `tripleo_overcloud_deploy_dry_run`: (Boolean) Flag to enabel dry run. Default: false +* `tripleo_overcloud_deploy_dry_run`: (Boolean) Flag to enable dry run. Default: false * `tripleo_overcloud_deploy_environment_dirs`: (List) A list of directory paths containing environment files for the deployment. Should not be used with environment files. * `tripleo_overcloud_deploy_environment_files`: (List) A list of environment file paths for the deployment. Should not be used with environment dirs. -* `tripleo_overcloud_deploy_force_postconfig`: (Boolean) Force the overclodu post-deployment configuration. Default: false +* `tripleo_overcloud_deploy_force_postconfig`: (Boolean) Force the overcloud post-deployment configuration. Default: false * `tripleo_overcloud_deploy_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By defaukt uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` isn't defined. -* `tripleo_overcloud_deploy_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_deploy_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_deploy_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_deploy_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_deploy_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_deploy_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false -* `tripleo_overcloud_deploy_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is prefered over this option. +* `tripleo_overcloud_deploy_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false +* `tripleo_overcloud_deploy_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is preferred over this option. * `tripleo_overcloud_deploy_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_deploy_home_dir }}/overcloud_deploy.log" -* `tripleo_overcloud_deploy_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_deploy_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_deploy_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_deploy_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_overcloud_deploy_no_cleanup`: (Boolean) String to enable no cleanup. Default: false * `tripleo_overcloud_deploy_no_config_download`: (Boolean) String to disable the config download software configuration. Default: false -* `tripleo_overcloud_deploy_no_proxy`: (String) String containing a comma seperated list of hosts to skip proxing when http_proxy and https_proxy are used. -* `tripleo_overcloud_deploy_ntp_server`: (String) String containing a comma seperated list of ntp servers. Setting `NtpServer` in an environment file is prefered over this option. +* `tripleo_overcloud_deploy_no_proxy`: (String) String containing a comma separated list of hosts to skip proxying when http_proxy and https_proxy are used. +* `tripleo_overcloud_deploy_ntp_server`: (String) String containing a comma separated list of NTP servers. Setting `NtpServer` in an environment file is preferred over this option. * `tripleo_overcloud_deploy_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_deploy_rc_file`. * `tripleo_overcloud_deploy_output_dir`: (String) Path to a directory to output for the configuration download output. * `tripleo_overcloud_deploy_overcloud_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish. diff --git a/roles/tripleo_overcloud_export/README.md b/roles/tripleo_overcloud_export/README.md index 1fa7098..157c9fc 100644 --- a/roles/tripleo_overcloud_export/README.md +++ b/roles/tripleo_overcloud_export/README.md @@ -15,13 +15,13 @@ Role Variables * `tripleo_overcloud_export_debug`: (Boolean) Flag to print out the command that is run. Default: False * `tripleo_overcloud_export_force_overwrite`: (Boolean) Overwrite the output file if it exists. Default: false * `tripleo_overcloud_export_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_export_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_export_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_export_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_export_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_export_home_dir`: (String) Location to runt he command in. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_export_no_password_excludes`: (Boolean) Do not exclude certain passwords from the export. Default: false * `tripleo_overcloud_export_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_export_rc_file`. * `tripleo_overcloud_export_output_file`: (String) Name of the output file for the stack data export. * `tripleo_overcloud_export_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" -* `tripleo_overcloud_export_stack`: (String) The name of the stakc/plan. Default: overcloud +* `tripleo_overcloud_export_stack`: (String) The name of the stack/plan. Default: overcloud NOTE: Please note that this command should be run against the undercloud so the OS_CLOUD or rc file variables should be set to use the 'undercloud' when diff --git a/roles/tripleo_overcloud_external_update_run/README.md b/roles/tripleo_overcloud_external_update_run/README.md index 732c8c0..e09573d 100644 --- a/roles/tripleo_overcloud_external_update_run/README.md +++ b/roles/tripleo_overcloud_external_update_run/README.md @@ -12,20 +12,20 @@ Role Variables -------------- * `tripleo_overcloud_external_update_run_debug`: (Boolean) Flag to print out the command that is run. Default: false -* `tripleo_overcloud_external_update_run_extra_vars`: (List) List of key=value or yaml/json file ansible refernce. Default: [] +* `tripleo_overcloud_external_update_run_extra_vars`: (List) List of key=value or yaml/json file ansible reference. Default: [] * `tripleo_overcloud_external_update_run_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_external_update_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_external_update_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_external_update_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_external_update_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_external_update_run_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_external_update_run_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_external_update_run_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_external_update_run_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_external_update_run_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_external_update_run_home_dir }}/overcloud_external_update_run.log" * `tripleo_overcloud_external_update_run_poll`: (Integer) Number of seconds to wait between each checks to see if the deployment command has completed. Default: 10 * `tripleo_overcloud_external_update_run_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" -* `tripleo_overcloud_external_update_run_skip_tags`: (String) A string specifying the tag or a comma seperated list of tags to be passed as --skip-tags to the playbook. +* `tripleo_overcloud_external_update_run_skip_tags`: (String) A string specifying the tag or a comma separated list of tags to be passed as --skip-tags to the playbook. * `tripleo_overcloud_external_update_run_ssh_user`: (String) Username of user to be used as the ssh user. * `tripleo_overcloud_external_update_run_stack`: (String) Name of the stack to deploy. * `tripleo_overcloud_external_update_run_static_inventory`: (String) Path to an existing ansible inventory to use. -* `tripleo_overcloud_external_update_run_tags`: (String) A string specifying the tag or comma sperate list of tags to be passed as --tags to the playbook. +* `tripleo_overcloud_external_update_run_tags`: (String) A string specifying the tag or comma separate list of tags to be passed as --tags to the playbook. * `tripleo_overcloud_external_update_run_timeout`: (Integer) Number in seconds to wait for the ansible execution of the deployment command to finish. Default: 5700 NOTE: Please note that this command should be run against the undercloud so the diff --git a/roles/tripleo_overcloud_external_upgrade_run/README.md b/roles/tripleo_overcloud_external_upgrade_run/README.md index b747993..b84b646 100644 --- a/roles/tripleo_overcloud_external_upgrade_run/README.md +++ b/roles/tripleo_overcloud_external_upgrade_run/README.md @@ -12,20 +12,20 @@ Role Variables -------------- * `tripleo_overcloud_external_upgrade_run_debug`: (Boolean) Flag to print out the command that is run. Default: false -* `tripleo_overcloud_external_upgrade_run_extra_vars`: (List) List of key=value or yaml/json file ansible refernce. Default: [] +* `tripleo_overcloud_external_upgrade_run_extra_vars`: (List) List of key=value or yaml/json file ansible reference. Default: [] * `tripleo_overcloud_external_upgrade_run_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_external_upgrade_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_external_upgrade_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_external_upgrade_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_external_upgrade_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_external_upgrade_run_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_external_upgrade_run_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_external_upgrade_run_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_external_upgrade_run_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_external_upgrade_run_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_external_upgrade_run_home_dir }}/overcloud_external_upgrade_run.log" * `tripleo_overcloud_external_upgrade_run_poll`: (Integer) Number of seconds to wait between each checks to see if the deployment command has completed. Default: 10 * `tripleo_overcloud_external_upgrade_run_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" -* `tripleo_overcloud_external_upgrade_run_skip_tags`: (String) A string specifying the tag or a comma seperated list of tags to be passed as --skip-tags to the playbook. +* `tripleo_overcloud_external_upgrade_run_skip_tags`: (String) A string specifying the tag or a comma separated list of tags to be passed as --skip-tags to the playbook. * `tripleo_overcloud_external_upgrade_run_ssh_user`: (String) Username of user to be used as the ssh user. * `tripleo_overcloud_external_upgrade_run_stack`: (String) Name of the stack to deploy. * `tripleo_overcloud_external_upgrade_run_static_inventory`: (String) Path to an existing ansible inventory to use. -* `tripleo_overcloud_external_upgrade_run_tags`: (String) A string specifying the tag or comma sperate list of tags to be passed as --tags to the playbook. +* `tripleo_overcloud_external_upgrade_run_tags`: (String) A string specifying the tag or comma separate list of tags to be passed as --tags to the playbook. * `tripleo_overcloud_external_upgrade_run_timeout`: (Integer) Number in seconds to wait for the ansible execution of the deployment command to finish. Default: 5700 NOTE: Please note that this command should be run against the undercloud so the diff --git a/roles/tripleo_overcloud_failures/README.md b/roles/tripleo_overcloud_failures/README.md index 54e7d0a..8974cd7 100644 --- a/roles/tripleo_overcloud_failures/README.md +++ b/roles/tripleo_overcloud_failures/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_failures_debug`: (Boolean) Flag to print out the command that is run. Default: False * `tripleo_overcloud_failures_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_failures_rc_file`. -* `tripleo_overcloud_failures_plan`: (String) The name of the stakc/plan. Default: overcloud +* `tripleo_overcloud_failures_plan`: (String) The name of the stack/plan. Default: overcloud * `tripleo_overcloud_failures_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" NOTE: Please note that this command should be run against the undercloud so the diff --git a/roles/tripleo_overcloud_ffwd_upgrade_converge/README.md b/roles/tripleo_overcloud_ffwd_upgrade_converge/README.md index 377e7c2..d3f4baa 100644 --- a/roles/tripleo_overcloud_ffwd_upgrade_converge/README.md +++ b/roles/tripleo_overcloud_ffwd_upgrade_converge/README.md @@ -12,7 +12,7 @@ Role Variables -------------- * `tripleo_overcloud_ffwd_upgrade_converge_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_ffwd_upgrade_converge_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_ffwd_upgrade_converge_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_ffwd_upgrade_converge_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_ffwd_upgrade_converge_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_upgrade_ffwd_converge_answers_file`: (String) File path to a deployment answers file. * `tripleo_overcloud_upgrade_ffwd_converge_baremetal_deployment`: (String) File path to a baremetal deployment configuration. * `tripleo_overcloud_upgrade_ffwd_converge_config_download_timeout`: (Integer) Timeout in minutes for the config-download steps. @@ -21,21 +21,21 @@ Role Variables * `tripleo_overcloud_upgrade_ffwd_converge_deployed_server`: (Boolean) Flag to use pre-provisioned nodes. Default: false * `tripleo_overcloud_upgrade_ffwd_converge_disable_password_generation`: (Boolean) Flag to disable password generation. Default: false * `tripleo_overcloud_upgrade_ffwd_converge_disable_validations`: (Boolean) Flag to disable validations. Default: false -* `tripleo_overcloud_upgrade_ffwd_converge_dry_run`: (Boolean) Flag to enabel dry run. Default: false +* `tripleo_overcloud_upgrade_ffwd_converge_dry_run`: (Boolean) Flag to enable dry run. Default: false * `tripleo_overcloud_upgrade_ffwd_converge_environment_dirs`: (List) A list of directory paths containing environment files for the deployment. Should not be used with environment files. * `tripleo_overcloud_upgrade_ffwd_converge_environment_files`: (List) A list of environment file paths for the deployment. Should not be used with environment dirs. -* `tripleo_overcloud_upgrade_ffwd_converge_force_postconfig`: (Boolean) Force the overclodu post-deployment configuration. Default: false +* `tripleo_overcloud_upgrade_ffwd_converge_force_postconfig`: (Boolean) Force the overcloud post-deployment configuration. Default: false * `tripleo_overcloud_upgrade_ffwd_converge_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_upgrade_ffwd_converge_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false -* `tripleo_overcloud_upgrade_ffwd_converge_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is prefered over this option. -* `tripleo_overcloud_upgrade_ffwd_converge_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_upgrade_ffwd_converge_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false +* `tripleo_overcloud_upgrade_ffwd_converge_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is preferred over this option. +* `tripleo_overcloud_upgrade_ffwd_converge_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_upgrade_ffwd_converge_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_upgrade_ffwd_converge_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_upgrade_ffwd_converge_home_dir }}/overcloud_upgrade_ffwd_converge.log" * `tripleo_overcloud_upgrade_ffwd_converge_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_overcloud_upgrade_ffwd_converge_no_cleanup`: (Boolean) String to enable no cleanup. Default: false * `tripleo_overcloud_upgrade_ffwd_converge_no_config_download`: (Boolean) String to disable the config download software configuration. Default: false -* `tripleo_overcloud_upgrade_ffwd_converge_no_proxy`: (String) String containing a comma seperated list of hosts to skip proxing when http_proxy and https_proxy are used. -* `tripleo_overcloud_upgrade_ffwd_converge_ntp_server`: (String) String containing a comma seperated list of ntp servers. Setting `NtpServer` in an environment file is prefered over this option. +* `tripleo_overcloud_upgrade_ffwd_converge_no_proxy`: (String) String containing a comma separated list of hosts to skip proxing when http_proxy and https_proxy are used. +* `tripleo_overcloud_upgrade_ffwd_converge_ntp_server`: (String) String containing a comma separated list of NTP servers. Setting `NtpServer` in an environment file is preferred over this option. * `tripleo_overcloud_upgrade_ffwd_converge_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_upgrade_ffwd_converge_rc_file`. * `tripleo_overcloud_upgrade_ffwd_converge_output_dir`: (String) Path to a directory to output for the configuration download output. * `tripleo_overcloud_upgrade_ffwd_converge_overcloud_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish. diff --git a/roles/tripleo_overcloud_ffwd_upgrade_prepare/README.md b/roles/tripleo_overcloud_ffwd_upgrade_prepare/README.md index 88e570a..499c0cb 100644 --- a/roles/tripleo_overcloud_ffwd_upgrade_prepare/README.md +++ b/roles/tripleo_overcloud_ffwd_upgrade_prepare/README.md @@ -17,25 +17,25 @@ Role Variables * `tripleo_overcloud_ffwd_upgrade_prepare_config_download_timeout`: (Integer) Timeout in minutes for the config-download steps. * `tripleo_overcloud_ffwd_upgrade_prepare_debug`: (Boolean) Flag to print out the command that is run. Default: false * `tripleo_overcloud_ffwd_upgrade_prepare_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_ffwd_upgrade_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_ffwd_upgrade_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_ffwd_upgrade_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_ffwd_upgrade_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_ffwd_upgrade_prepare_deployed_server`: (Boolean) Flag to use pre-provisioned nodes. Default: false * `tripleo_overcloud_ffwd_upgrade_prepare_disable_password_generation`: (Boolean) Flag to disable password generation. Default: false * `tripleo_overcloud_ffwd_upgrade_prepare_disable_validations`: (Boolean) Flag to disable validations. Default: false -* `tripleo_overcloud_ffwd_upgrade_prepare_dry_run`: (Boolean) Flag to enabel dry run. Default: false +* `tripleo_overcloud_ffwd_upgrade_prepare_dry_run`: (Boolean) Flag to enable dry run. Default: false * `tripleo_overcloud_ffwd_upgrade_prepare_environment_dirs`: (List) A list of directory paths containing environment files for the deployment. Should not be used with environment files. * `tripleo_overcloud_ffwd_upgrade_prepare_environment_files`: (List) A list of environment file paths for the deployment. Should not be used with environment dirs. -* `tripleo_overcloud_ffwd_upgrade_prepare_force_postconfig`: (Boolean) Force the overclodu post-deployment configuration. Default: false +* `tripleo_overcloud_ffwd_upgrade_prepare_force_postconfig`: (Boolean) Force the overcloud post-deployment configuration. Default: false * `tripleo_overcloud_ffwd_upgrade_prepare_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_ffwd_upgrade_prepare_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false -* `tripleo_overcloud_ffwd_upgrade_prepare_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is prefered over this option. +* `tripleo_overcloud_ffwd_upgrade_prepare_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false +* `tripleo_overcloud_ffwd_upgrade_prepare_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is preferred over this option. * `tripleo_overcloud_ffwd_upgrade_prepare_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_ffwd_upgrade_prepare_home_dir }}/overcloud_ffwd_upgrade_prepare.log" -* `tripleo_overcloud_ffwd_upgrade_prepare_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_ffwd_upgrade_prepare_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_ffwd_upgrade_prepare_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_ffwd_upgrade_prepare_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_overcloud_ffwd_upgrade_prepare_no_cleanup`: (Boolean) String to enable no cleanup. Default: false * `tripleo_overcloud_ffwd_upgrade_prepare_no_config_download`: (Boolean) String to disable the config download software configuration. Default: false -* `tripleo_overcloud_ffwd_upgrade_prepare_no_proxy`: (String) String containing a comma seperated list of hosts to skip proxing when http_proxy and https_proxy are used. -* `tripleo_overcloud_ffwd_upgrade_prepare_ntp_server`: (String) String containing a comma seperated list of ntp servers. Setting `NtpServer` in an environment file is prefered over this option. +* `tripleo_overcloud_ffwd_upgrade_prepare_no_proxy`: (String) String containing a comma separated list of hosts to skip proxing when http_proxy and https_proxy are used. +* `tripleo_overcloud_ffwd_upgrade_prepare_ntp_server`: (String) String containing a comma separated list of NTP servers. Setting `NtpServer` in an environment file is preferred over this option. * `tripleo_overcloud_ffwd_upgrade_prepare_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_ffwd_upgrade_prepare_rc_file`. * `tripleo_overcloud_ffwd_upgrade_prepare_output_dir`: (String) Path to a directory to output for the configuration download output. * `tripleo_overcloud_ffwd_upgrade_prepare_overcloud_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish. diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/README.md b/roles/tripleo_overcloud_ffwd_upgrade_run/README.md index dceb6e1..72afa2a 100644 --- a/roles/tripleo_overcloud_ffwd_upgrade_run/README.md +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/README.md @@ -13,9 +13,9 @@ Role Variables * `tripleo_overcloud_ffwd_upgrade_run_debug`: (Boolean) Flag to print out the command that is run. Default: false * `tripleo_overcloud_ffwd_upgrade_run_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_ffwd_upgrade_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_ffwd_upgrade_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_ffwd_upgrade_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_ffwd_upgrade_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_ffwd_upgrade_run_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_ffwd_upgrade_run_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_ffwd_upgrade_run_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_ffwd_upgrade_run_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_ffwd_upgrade_run_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_ffwd_upgrade_run_home_dir }}/overcloud_ffwd_upgrade_run.log" * `tripleo_overcloud_ffwd_upgrade_run_playbook`: (List) List of playbook(s) to use for the upgrade. Defaults: [] diff --git a/roles/tripleo_overcloud_generate_fencing/README.md b/roles/tripleo_overcloud_generate_fencing/README.md index 423b36a..52081e3 100644 --- a/roles/tripleo_overcloud_generate_fencing/README.md +++ b/roles/tripleo_overcloud_generate_fencing/README.md @@ -16,13 +16,13 @@ Role Variables * `tripleo_overcloud_generate_fencing_delay`: (Integer) Number of seconds to wait before fencing is started. * `tripleo_overcloud_generate_fencing_environment_file`: (String) REQUIRED. Path to the environment file. * `tripleo_overcloud_generate_fencing_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_generate_fencing_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_generate_fencing_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_generate_fencing_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_generate_fencing_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_generate_fencing_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_generate_fencing_ipmi_cipher`: (String) Cipher squit to use (same as ipmitool -C) * `tripleo_overcloud_generate_fencing_ipmi_lanplus`: (Boolean) Use lanplus. Option deprecated because it's the default. Default: false * `tripleo_overcloud_generate_fencing_ipmi_level`: (String) Privilege level on IPMI device. (callback, user, operator, administrator) * `tripleo_overcloud_generate_fencing_ipmi_no_lanplus`: (Boolean) Do not use lanplus. Default: false -* `tripleo_overcloud_generate_fencing_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_generate_fencing_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_generate_fencing_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_generate_fencing_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_generate_fencing_home_dir }}/overcloud_generate_fencing.log" * `tripleo_overcloud_generate_fencing_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_generate_fencing_rc_file`. diff --git a/roles/tripleo_overcloud_image_build/README.md b/roles/tripleo_overcloud_image_build/README.md index ad60770..3a03bc3 100644 --- a/roles/tripleo_overcloud_image_build/README.md +++ b/roles/tripleo_overcloud_image_build/README.md @@ -17,17 +17,17 @@ Role Variables * `tripleo_overcloud_image_build_dib_yum_repo_conf`: (String) String containing the path to the yum files for the image building process. Default: "/etc/yum.repos.d/*" * `tripleo_overcloud_image_build_extra_env_vars`: (Dictionary) Dictionary containing extra environment variables to be set for the build. Default: {} * `tripleo_overcloud_image_build_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_image_build_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_image_build_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_image_build_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_image_build_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_image_build_home_dir`: (String) Path that the command should be executed in. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_image_build_image_names`: (List) List of image names to build. * `tripleo_overcloud_image_build_log_combine`: (Boolean) Flag to combine stdout and stderr in the logfile. Default: true * `tripleo_overcloud_image_build_log_output`: (Boolean) Flag to log the output to a file rather than show it in the ansible output. Default: true * `tripleo_overcloud_image_build_log`: (String) Install log file path. Default: "{{ tripleo_overcloud_image_build_home_dir }}/overcloud_image_build.log" -* `tripleo_overcloud_image_build_no_skip`: (Boolean) Flag to skipp build if cached image exists. Default: False +* `tripleo_overcloud_image_build_no_skip`: (Boolean) Flag to skip build if cached image exists. Default: False * `tripleo_overcloud_image_build_output_directory`: (String) Path to the output directory for the images. * `tripleo_overcloud_image_build_poll`: (Integer) Number of seconds to wait between checks to see if the build command has completed. This should be set to a value greater or equal to 1. Default: 10 -* `tripleo_overcloud_image_build_stable_release`: (String) String containing the name of teh stable branch being built. -* `tripleo_overcloud_image_build_timeout`: (Integer) Amount of time to wait for the command to conplete. Default: 1800 +* `tripleo_overcloud_image_build_stable_release`: (String) String containing the name of the stable branch being built. +* `tripleo_overcloud_image_build_timeout`: (Integer) Amount of time to wait for the command to complete. Default: 1800 Output Variables ---------------- diff --git a/roles/tripleo_overcloud_image_upload/README.md b/roles/tripleo_overcloud_image_upload/README.md index 99ea076..80d428f 100644 --- a/roles/tripleo_overcloud_image_upload/README.md +++ b/roles/tripleo_overcloud_image_upload/README.md @@ -14,9 +14,9 @@ Role Variables * `tripleo_overcloud_image_upload_architecture`: (String) Architecture type for the images being uploaded. * `tripleo_overcloud_image_upload_debug`: (Boolean) Flag to print out the command that is run. Default: False * `tripleo_overcloud_image_upload_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_image_upload_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_image_upload_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_image_upload_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_image_upload_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_image_upload_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_image_upload_http_boot`: (String) Root directory for the ironic-pytho-agent-image +* `tripleo_overcloud_image_upload_http_boot`: (String) Root directory for the ironic-python-agent-image * `tripleo_overcloud_image_upload_image_path`: (String) Path to directory overcloud images. By default the command will use the images in `tripleo_overcloud_image_upload_home_dir` if this is not specified. * `tripleo_overcloud_image_upload_image_type`: (String) If specified, restrict the image type to upload. Should be one of {os,ironic-python-agent} * `tripleo_overcloud_image_upload_ironic_python_agent_name`: (String) OpenStack ironic-python-agent image filename @@ -28,7 +28,7 @@ Role Variables * `tripleo_overcloud_image_upload_platform`: (String) Platform type for the images being uploaded. * `tripleo_overcloud_image_upload_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" * `tripleo_overcloud_image_upload_update_existing`: (Boolean) Update the images if they already exist. Default: false -* `tripleo_overcloud_image_upload_whole_disk`: (Boolean) Overcloud iamge bneing uploaded is considered a whole disk image. Default: false +* `tripleo_overcloud_image_upload_whole_disk`: (Boolean) Overcloud image being uploaded is considered a whole disk image. Default: false NOTE: Please note that this command should be run against the undercloud so the OS_CLOUD or rc file variables should be set to use the 'undercloud' when diff --git a/roles/tripleo_overcloud_netenv_validate/README.md b/roles/tripleo_overcloud_netenv_validate/README.md index d3b41c4..6877bdb 100644 --- a/roles/tripleo_overcloud_netenv_validate/README.md +++ b/roles/tripleo_overcloud_netenv_validate/README.md @@ -14,9 +14,9 @@ Role Variables * `tripleo_overcloud_netenv_validate_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_netenv_validate_file`: (String) REQUIRED. Path to the network environment file * `tripleo_overcloud_netenv_validate_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_netenv_validate_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_netenv_validate_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_netenv_validate_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_netenv_validate_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_netenv_validate_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_netenv_validate_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_netenv_validate_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_netenv_validate_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_netenv_validate_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_netenv_validate_home_dir }}/overcloud_netenv_validate.log" * `tripleo_overcloud_netenv_validate_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10 diff --git a/roles/tripleo_overcloud_node_delete/README.md b/roles/tripleo_overcloud_node_delete/README.md index e680eeb..7dc3bfe 100644 --- a/roles/tripleo_overcloud_node_delete/README.md +++ b/roles/tripleo_overcloud_node_delete/README.md @@ -14,7 +14,7 @@ Role Variables * `tripleo_overcloud_node_delete_nodes`: Node ID(s) to delete (otherwise specified in the --baremetal-deployment file) * `tripleo_overcloud_node_delete_baremetal_deployment`: Configuration file describing the baremetal deployment * `tripleo_overcloud_node_delete_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_node_delete_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_node_delete_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_node_delete_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_node_delete_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_node_delete_home_dir`: (String) Location to run the command in. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_node_delete_stack`: Name or ID of heat stack to scale (default=Env: OVERCLOUD_STACK_NAME) * `tripleo_overcloud_node_delete_templates`: The directory containing the Heat templates to deploy. diff --git a/roles/tripleo_overcloud_node_import/README.md b/roles/tripleo_overcloud_node_import/README.md index 3dbc7ae..774adff 100644 --- a/roles/tripleo_overcloud_node_import/README.md +++ b/roles/tripleo_overcloud_node_import/README.md @@ -15,22 +15,22 @@ Role Variables * `tripleo_overcloud_node_import_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_node_import_environment_file`: (String) Path to the file that contains the baremetal node information. Can be a JSON, YAML or CSV file. Default: environment.json * `tripleo_overcloud_node_import_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_node_import_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_node_import_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_node_import_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_node_import_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_node_import_home_dir`: (String) Path to the directory to execute the command in. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_node_import_http_boot`: (String) Root directory for the ironic-python-agent image. -* `tripleo_overcloud_node_import_instance_boot_option`: (String) Wheither to set instances for booting from local hard drive (local) or network (netboot). +* `tripleo_overcloud_node_import_instance_boot_option`: (String) Whether to set instances for booting from local hard drive (local) or network (netboot). * `tripleo_overcloud_node_import_introspect`: (Boolean) Flag to enable introspection of the nodes when importing. Default: false -* `tripleo_overcloud_node_import_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_node_import_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_node_import_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_node_import_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_node_import_home_dir }}/overcloud_node_import.log" -* `tripleo_overcloud_node_import_no_deploy_image`: (Boolean) Flag to skip setting teh deploy kernel and ramdisk. Default: false +* `tripleo_overcloud_node_import_no_deploy_image`: (Boolean) Flag to skip setting the deploy kernel and ramdisk. Default: false * `tripleo_overcloud_node_import_os_cloud`: (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_node_import_rc_file`. * `tripleo_overcloud_node_import_poll`: (Integer) Number of seconds to wait between each checks to see if the deployment command has completed. Default: 10 * `tripleo_overcloud_node_import_provide`: (Boolean) Flag to provide the nodes. Default: false * `tripleo_overcloud_node_import_rc_file`: (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" * `tripleo_overcloud_node_import_run_validations`: (Boolean) Flag to runt he pre-deployment validations. false * `tripleo_overcloud_node_import_timeout`: (Integer) Time in seconds to wait for the command to complete. Default: 900 -* `tripleo_overcloud_node_import_validate_only`: (Boolean) Flag to validate teh environment file and exit without running the import. Default: false +* `tripleo_overcloud_node_import_validate_only`: (Boolean) Flag to validate the environment file and exit without running the import. Default: false NOTE: Please note that this command should be run against the undercloud so the OS_CLOUD or rc file variables should be set to use the 'undercloud' when diff --git a/roles/tripleo_overcloud_node_introspect/README.md b/roles/tripleo_overcloud_node_introspect/README.md index 95937ae..1d6b0b4 100644 --- a/roles/tripleo_overcloud_node_introspect/README.md +++ b/roles/tripleo_overcloud_node_introspect/README.md @@ -20,7 +20,7 @@ Role Variables * `tripleo_overcloud_node_introspect_os_cloud`: (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_node_introspect_rc_file`. * `tripleo_overcloud_node_introspect_rc_file`: (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" * `tripleo_overcloud_node_introspect_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_node_introspect_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_node_introspect_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_node_introspect_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_node_introspect_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_node_introspect_home_dir`: (String) Path to the directory to execute the command in. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_node_introspect_node_timeout`: (Integer) Maximum timeout for node introspection. * `tripleo_overcloud_node_introspect_max_retries`: (Integer) Maximum introspection retries. diff --git a/roles/tripleo_overcloud_node_provide/README.md b/roles/tripleo_overcloud_node_provide/README.md index eb4dd54..279cbdc 100644 --- a/roles/tripleo_overcloud_node_provide/README.md +++ b/roles/tripleo_overcloud_node_provide/README.md @@ -14,7 +14,7 @@ Role Variables * `tripleo_overcloud_node_provide_all_manageable`: (Boolean) Provide all nodes in manageable state. REQUIRED if UUIDs are not passed. Default: False * `tripleo_overcloud_node_provide_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_node_provide_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_node_provide_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_node_provide_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_node_provide_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_node_provide_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_node_provide_home_dir }}/overcloud_node_provide.log" * `tripleo_overcloud_node_provide_node_uuids`: (List) List of UUIDs to provide. REQUIRED if '--all-manageable' is not passed. Default [] diff --git a/roles/tripleo_overcloud_node_provision/README.md b/roles/tripleo_overcloud_node_provision/README.md index b8908fb..398516f 100644 --- a/roles/tripleo_overcloud_node_provision/README.md +++ b/roles/tripleo_overcloud_node_provision/README.md @@ -1,7 +1,7 @@ tripleo_overcloud_node_provision ========= -A role to perform overcloud ndoe provisioning with Ironic. +A role to perform overcloud node provisioning with Ironic. Requirements ------------ @@ -15,19 +15,19 @@ Role Variables * `tripleo_overcloud_node_provision_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_node_provision_deployment_file`: (String) REQUIRED. File path to the deployment file describing the nodes. * `tripleo_overcloud_node_provision_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_node_provision_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_node_provision_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_node_provision_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_node_provision_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_node_provision_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_node_provision_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_node_provision_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_node_provision_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_node_provision_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_node_provision_home_dir }}/overcloud_node_provision.log" * `tripleo_overcloud_node_provision_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_node_provision_rc_file`. * `tripleo_overcloud_node_provision_output_file`: (String) Path to an output file. -* `tripleo_overcloud_node_provision_overcloud_ssh_key`: (String) Key path for ssh access to overcloud nodes. When not defined, the key will attempt to be autodected. +* `tripleo_overcloud_node_provision_overcloud_ssh_key`: (String) Key path for ssh access to overcloud nodes. When not defined, the key will attempt to be auto-detected. * `tripleo_overcloud_node_provision_overcloud_ssh_user`: (String) User for ssh access to the newly deployed nodes. * `tripleo_overcloud_node_provision_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10 * `tripleo_overcloud_node_provision_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" * `tripleo_overcloud_node_provision_stack`: (String) Name or ID of the heat stack. -* `tripleo_overcloud_node_provision_timeout_arg`: (Integer) Numebr of seconds to wait for node to complete. Should be smaller than the `overcloud_node_provision_timeout` variable. +* `tripleo_overcloud_node_provision_timeout_arg`: (Integer) Number of seconds to wait for node to complete. Should be smaller than the `overcloud_node_provision_timeout` variable. * `tripleo_overcloud_node_provision_timeout`: (Integer) Number in seconds to wait for the ansible execution of the command to finish. Default: 3700 Output Variables diff --git a/roles/tripleo_overcloud_node_unprovision/README.md b/roles/tripleo_overcloud_node_unprovision/README.md index 3ae7f70..2a28809 100644 --- a/roles/tripleo_overcloud_node_unprovision/README.md +++ b/roles/tripleo_overcloud_node_unprovision/README.md @@ -15,7 +15,7 @@ Role Variables * `tripleo_overcloud_node_unprovision_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_node_unprovision_deployment_file`: (String) REQUIRED. Configuration file describing the baremetal deployment. * `tripleo_overcloud_node_unprovision_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_node_unprovision_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_node_unprovision_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_node_unprovision_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_node_unprovision_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_node_unprovision_home_dir }}/overcloud_node_unprovision.log" * `tripleo_overcloud_node_unprovision_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_node_unprovision_rc_file`. @@ -23,7 +23,7 @@ Role Variables * `tripleo_overcloud_node_unprovision_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" * `tripleo_overcloud_node_unprovision_stack`: (String) Name or ID of the heat stack * `tripleo_overcloud_node_unprovision_timeout`: (Integer) Number in seconds to wait for the ansible execution of the command to finish. Default: 3600 -* `tripleo_overcloud_node_unprovision_yes`: (Boolean) Skip yes/no prompt. Defualt: true +* `tripleo_overcloud_node_unprovision_yes`: (Boolean) Skip yes/no prompt. Default: true Output Variables ---------------- diff --git a/roles/tripleo_overcloud_profiles_list/README.md b/roles/tripleo_overcloud_profiles_list/README.md index 9cc4076..1d3e74e 100644 --- a/roles/tripleo_overcloud_profiles_list/README.md +++ b/roles/tripleo_overcloud_profiles_list/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_profiles_list_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_profiles_list_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_profiles_list_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_profiles_list_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_profiles_list_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_profiles_list_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_profiles_list_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_profiles_list_all`: List all nodes, even those not available to Nova. * `tripleo_overcloud_profiles_list_control_flavor`: (Deprecated in U) Nova flavor to use for control nodes. diff --git a/roles/tripleo_overcloud_profiles_match/README.md b/roles/tripleo_overcloud_profiles_match/README.md index 2e1f5d7..18cc8be 100644 --- a/roles/tripleo_overcloud_profiles_match/README.md +++ b/roles/tripleo_overcloud_profiles_match/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_profiles_match_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_profiles_match_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_profiles_match_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_profiles_match_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_profiles_match_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_profiles_match_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_profiles_match_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_profiles_match_all`: List all nodes, even those not available to Nova. * `tripleo_overcloud_profiles_list_control_flavor`: (Deprecated in U) Nova flavor to use for control nodes. diff --git a/roles/tripleo_overcloud_raid_create/README.md b/roles/tripleo_overcloud_raid_create/README.md index 6def625..7367f2e 100644 --- a/roles/tripleo_overcloud_raid_create/README.md +++ b/roles/tripleo_overcloud_raid_create/README.md @@ -14,9 +14,9 @@ Role Variables * `tripleo_overcloud_raid_create_configuration`: (String) REQUIRED. Path to file containing raid configuration. * `tripleo_overcloud_raid_create_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_overcloud_raid_create_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_raid_create_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_raid_create_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_raid_create_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_raid_create_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_raid_create_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_raid_create_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_raid_create_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_raid_create_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_raid_create_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_raid_create_home_dir }}/overcloud_raid_create.log" * `tripleo_overcloud_raid_create_nodes`: (List) REQUIRED. Nodes to create RAID on. Default: [] diff --git a/roles/tripleo_overcloud_roles_generate/README.md b/roles/tripleo_overcloud_roles_generate/README.md index 3fe12f6..e2856d2 100644 --- a/roles/tripleo_overcloud_roles_generate/README.md +++ b/roles/tripleo_overcloud_roles_generate/README.md @@ -15,9 +15,9 @@ Role Variables * `tripleo_overcloud_roles_generate_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_roles_generate_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_roles_generate_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_roles_generate_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_roles_generate_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_roles_generate_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_roles_generate_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_roles_generate_roles_path`: Filesystem path containing the role yaml files. By default this is in tripleo-heat-templates/roles. +* `tripleo_overcloud_roles_generate_roles_path`: File system path containing the role yaml files. By default this is in tripleo-heat-templates/roles. * `tripleo_overcloud_roles_generate_output_file`: File to capture all output to. For example, roles_data.yaml * `tripleo_overcloud_roles_generate_skip_validate`: Skip role metadata type validation when generating the roles_data.yaml * `tripleo_overcloud_roles_generate_roles`: REQUIRED - 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. diff --git a/roles/tripleo_overcloud_roles_list/README.md b/roles/tripleo_overcloud_roles_list/README.md index 1164644..1a90edf 100644 --- a/roles/tripleo_overcloud_roles_list/README.md +++ b/roles/tripleo_overcloud_roles_list/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_roles_list_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_roles_list_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_roles_list_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_roles_list_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_roles_list_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_roles_list_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_roles_list_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_roles_list_name`: The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names. * `tripleo_overcloud_roles_list_detail`: Include details about each role. diff --git a/roles/tripleo_overcloud_roles_show/README.md b/roles/tripleo_overcloud_roles_show/README.md index bf41c51..3dcbc42 100644 --- a/roles/tripleo_overcloud_roles_show/README.md +++ b/roles/tripleo_overcloud_roles_show/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_roles_show_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_roles_show_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_roles_show_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_roles_show_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_roles_show_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_roles_show_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_roles_show_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_roles_show_role`: Role to display more information about. * `tripleo_overcloud_roles_show_name`: The name of the plan, which is used for the object storage container, diff --git a/roles/tripleo_overcloud_status/README.md b/roles/tripleo_overcloud_status/README.md index 5c04494..6cf793c 100644 --- a/roles/tripleo_overcloud_status/README.md +++ b/roles/tripleo_overcloud_status/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_status_debug`: (Boolean) Flag to print out the command that is run. Default: False * `tripleo_overcloud_status_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_status_rc_file`. -* `tripleo_overcloud_status_plan`: (String) The name of the stakc/plan. Default: overcloud +* `tripleo_overcloud_status_plan`: (String) The name of the stack/plan. Default: overcloud * `tripleo_overcloud_status_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" NOTE: Please note that this command should be run against the undercloud so the diff --git a/roles/tripleo_overcloud_support_report_collect/README.md b/roles/tripleo_overcloud_support_report_collect/README.md index 1d0528b..936f968 100644 --- a/roles/tripleo_overcloud_support_report_collect/README.md +++ b/roles/tripleo_overcloud_support_report_collect/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_overcloud_support_report_collect_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_overcloud_support_report_collect_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_support_report_collect_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_support_report_collect_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_support_report_collect_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_support_report_collect_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_support_report_collect_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_support_report_collect_server_name`: Server name, group name, or partial name to match. For example "Controller" will match all controllers for an environment. * `tripleo_overcloud_support_report_collect_output_dir`: Output directory for the report. diff --git a/roles/tripleo_overcloud_update_converge/README.md b/roles/tripleo_overcloud_update_converge/README.md index e2e95bc..6676a39 100644 --- a/roles/tripleo_overcloud_update_converge/README.md +++ b/roles/tripleo_overcloud_update_converge/README.md @@ -19,23 +19,23 @@ Role Variables * `tripleo_overcloud_update_converge_deployed_server`: (Boolean) Flag to use pre-provisioned nodes. Default: false * `tripleo_overcloud_update_converge_disable_password_generation`: (Boolean) Flag to disable password generation. Default: false * `tripleo_overcloud_update_converge_disable_validations`: (Boolean) Flag to disable validations. Default: false -* `tripleo_overcloud_update_converge_dry_run`: (Boolean) Flag to enabel dry run. Default: false +* `tripleo_overcloud_update_converge_dry_run`: (Boolean) Flag to enable dry run. Default: false * `tripleo_overcloud_update_converge_environment_dirs`: (List) A list of directory paths containing environment files for the deployment. Should not be used with environment files. * `tripleo_overcloud_update_converge_environment_files`: (List) A list of environment file paths for the deployment. Should not be used with environment dirs. -* `tripleo_overcloud_update_converge_force_postconfig`: (Boolean) Force the overclodu post-deployment configuration. Default: false +* `tripleo_overcloud_update_converge_force_postconfig`: (Boolean) Force the overcloud post-deployment configuration. Default: false * `tripleo_overcloud_update_converge_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_update_converge_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_update_converge_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_update_converge_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_update_converge_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_update_converge_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_update_converge_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false -* `tripleo_overcloud_update_converge_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is prefered over this option. -* `tripleo_overcloud_update_converge_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_update_converge_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false +* `tripleo_overcloud_update_converge_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is preferred over this option. +* `tripleo_overcloud_update_converge_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_update_converge_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_update_converge_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_update_converge_home_dir }}/overcloud_update_converge.log" * `tripleo_overcloud_update_converge_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_overcloud_update_converge_no_cleanup`: (Boolean) String to enable no cleanup. Default: false * `tripleo_overcloud_update_converge_no_config_download`: (Boolean) String to disable the config download software configuration. Default: false -* `tripleo_overcloud_update_converge_no_proxy`: (String) String containing a comma seperated list of hosts to skip proxing when http_proxy and https_proxy are used. -* `tripleo_overcloud_update_converge_ntp_server`: (String) String containing a comma seperated list of ntp servers. Setting `NtpServer` in an environment file is prefered over this option. +* `tripleo_overcloud_update_converge_no_proxy`: (String) String containing a comma separated list of hosts to skip proxying when http_proxy and https_proxy are used. +* `tripleo_overcloud_update_converge_ntp_server`: (String) String containing a comma separated list of NTP servers. Setting `NtpServer` in an environment file is preferred over this option. * `tripleo_overcloud_update_converge_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_update_converge_rc_file`. * `tripleo_overcloud_update_converge_output_dir`: (String) Path to a directory to output for the configuration download output. * `tripleo_overcloud_update_converge_overcloud_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish. diff --git a/roles/tripleo_overcloud_update_prepare/README.md b/roles/tripleo_overcloud_update_prepare/README.md index cd2c3d0..6172bbd 100644 --- a/roles/tripleo_overcloud_update_prepare/README.md +++ b/roles/tripleo_overcloud_update_prepare/README.md @@ -18,23 +18,23 @@ Role Variables * `tripleo_overcloud_update_prepare_debug`: (Boolean) Flag to print out the command that is run. Default: false * `tripleo_overcloud_update_prepare_disable_password_generation`: (Boolean) Flag to disable password generation. Default: false * `tripleo_overcloud_update_prepare_disable_validations`: (Boolean) Flag to disable validations. Default: false -* `tripleo_overcloud_update_prepare_dry_run`: (Boolean) Flag to enabel dry run. Default: false +* `tripleo_overcloud_update_prepare_dry_run`: (Boolean) Flag to enable dry run. Default: false * `tripleo_overcloud_update_prepare_environment_dirs`: (List) A list of directory paths containing environment files for the deployment. Should not be used with environment files. * `tripleo_overcloud_update_prepare_environment_files`: (List) A list of environment file paths for the deployment. Should not be used with environment dirs. -* `tripleo_overcloud_update_prepare_force_postconfig`: (Boolean) Force the overclodu post-deployment configuration. Default: false +* `tripleo_overcloud_update_prepare_force_postconfig`: (Boolean) Force the overcloud post-deployment configuration. Default: false * `tripleo_overcloud_update_prepare_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_update_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_update_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_update_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_update_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_update_prepare_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_update_prepare_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false -* `tripleo_overcloud_update_prepare_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is prefered over this option. -* `tripleo_overcloud_update_prepare_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_update_prepare_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false +* `tripleo_overcloud_update_prepare_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is preferred over this option. +* `tripleo_overcloud_update_prepare_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_update_prepare_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_update_prepare_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_update_prepare_home_dir }}/overcloud_update_prepare.log" * `tripleo_overcloud_update_prepare_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_overcloud_update_prepare_no_cleanup`: (Boolean) String to enable no cleanup. Default: false * `tripleo_overcloud_update_prepare_no_config_download`: (Boolean) String to disable the config download software configuration. Default: false -* `tripleo_overcloud_update_prepare_no_proxy`: (String) String containing a comma seperated list of hosts to skip proxing when http_proxy and https_proxy are used. -* `tripleo_overcloud_update_prepare_ntp_server`: (String) String containing a comma seperated list of ntp servers. Setting `NtpServer` in an environment file is prefered over this option. +* `tripleo_overcloud_update_prepare_no_proxy`: (String) String containing a comma separated list of hosts to skip proxying when http_proxy and https_proxy are used. +* `tripleo_overcloud_update_prepare_ntp_server`: (String) String containing a comma separated list of NTP servers. Setting `NtpServer` in an environment file is preferred over this option. * `tripleo_overcloud_update_prepare_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_update_prepare_rc_file`. * `tripleo_overcloud_update_prepare_output_dir`: (String) Path to a directory to output for the configuration download output. * `tripleo_overcloud_update_prepare_overcloud_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish. diff --git a/roles/tripleo_overcloud_update_run/README.md b/roles/tripleo_overcloud_update_run/README.md index 408c40d..02545b6 100644 --- a/roles/tripleo_overcloud_update_run/README.md +++ b/roles/tripleo_overcloud_update_run/README.md @@ -13,10 +13,10 @@ Role Variables * `tripleo_overcloud_update_run_debug`: (Boolean) Flag to print out the command that is run. Default: false * `tripleo_overcloud_update_run_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_update_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_update_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_update_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_update_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_update_run_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_update_run_limit`: (String) String that identifies a single node or a list of nodes to be upgraded. -* `tripleo_overcloud_update_run_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_update_run_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_update_run_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_update_run_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_update_run_home_dir }}/overcloud_update_run.log" * `tripleo_overcloud_update_run_playbook`: (List) List of playbook(s) to use for the minor update. Defaults: [] diff --git a/roles/tripleo_overcloud_upgrade_converge/README.md b/roles/tripleo_overcloud_upgrade_converge/README.md index 3f93ec4..bf0cc2c 100644 --- a/roles/tripleo_overcloud_upgrade_converge/README.md +++ b/roles/tripleo_overcloud_upgrade_converge/README.md @@ -19,23 +19,23 @@ Role Variables * `tripleo_overcloud_upgrade_converge_deployed_server`: (Boolean) Flag to use pre-provisioned nodes. Default: false * `tripleo_overcloud_upgrade_converge_disable_password_generation`: (Boolean) Flag to disable password generation. Default: false * `tripleo_overcloud_upgrade_converge_disable_validations`: (Boolean) Flag to disable validations. Default: false -* `tripleo_overcloud_upgrade_converge_dry_run`: (Boolean) Flag to enabel dry run. Default: false +* `tripleo_overcloud_upgrade_converge_dry_run`: (Boolean) Flag to enable dry run. Default: false * `tripleo_overcloud_upgrade_converge_environment_dirs`: (List) A list of directory paths containing environment files for the deployment. Should not be used with environment files. * `tripleo_overcloud_upgrade_converge_environment_files`: (List) A list of environment file paths for the deployment. Should not be used with environment dirs. -* `tripleo_overcloud_upgrade_converge_force_postconfig`: (Boolean) Force the overclodu post-deployment configuration. Default: false +* `tripleo_overcloud_upgrade_converge_force_postconfig`: (Boolean) Force the overcloud post-deployment configuration. Default: false * `tripleo_overcloud_upgrade_converge_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_upgrade_converge_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_upgrade_converge_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_upgrade_converge_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_upgrade_converge_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_upgrade_converge_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_upgrade_converge_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false -* `tripleo_overcloud_upgrade_converge_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is prefered over this option. +* `tripleo_overcloud_upgrade_converge_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false +* `tripleo_overcloud_upgrade_converge_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is preferred over this option. * `tripleo_overcloud_upgrade_converge_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_upgrade_converge_home_dir }}/overcloud_upgrade_converge.log" -* `tripleo_overcloud_upgrade_converge_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_upgrade_converge_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_upgrade_converge_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_upgrade_converge_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_overcloud_upgrade_converge_no_cleanup`: (Boolean) String to enable no cleanup. Default: false * `tripleo_overcloud_upgrade_converge_no_config_download`: (Boolean) String to disable the config download software configuration. Default: false -* `tripleo_overcloud_upgrade_converge_no_proxy`: (String) String containing a comma seperated list of hosts to skip proxing when http_proxy and https_proxy are used. -* `tripleo_overcloud_upgrade_converge_ntp_server`: (String) String containing a comma seperated list of ntp servers. Setting `NtpServer` in an environment file is prefered over this option. +* `tripleo_overcloud_upgrade_converge_no_proxy`: (String) String containing a comma separated list of hosts to skip proxying when http_proxy and https_proxy are used. +* `tripleo_overcloud_upgrade_converge_ntp_server`: (String) String containing a comma separated list of NTP servers. Setting `NtpServer` in an environment file is preferred over this option. * `tripleo_overcloud_upgrade_converge_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_upgrade_converge_rc_file`. * `tripleo_overcloud_upgrade_converge_output_dir`: (String) Path to a directory to output for the configuration download output. * `tripleo_overcloud_upgrade_converge_overcloud_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish. diff --git a/roles/tripleo_overcloud_upgrade_prepare/README.md b/roles/tripleo_overcloud_upgrade_prepare/README.md index 9faaba6..e855891 100644 --- a/roles/tripleo_overcloud_upgrade_prepare/README.md +++ b/roles/tripleo_overcloud_upgrade_prepare/README.md @@ -19,23 +19,23 @@ Role Variables * `tripleo_overcloud_upgrade_prepare_deployed_server`: (Boolean) Flag to use pre-provisioned nodes. Default: false * `tripleo_overcloud_upgrade_prepare_disable_password_generation`: (Boolean) Flag to disable password generation. Default: false * `tripleo_overcloud_upgrade_prepare_disable_validations`: (Boolean) Flag to disable validations. Default: false -* `tripleo_overcloud_upgrade_prepare_dry_run`: (Boolean) Flag to enabel dry run. Default: false +* `tripleo_overcloud_upgrade_prepare_dry_run`: (Boolean) Flag to enable dry run. Default: false * `tripleo_overcloud_upgrade_prepare_environment_dirs`: (List) A list of directory paths containing environment files for the deployment. Should not be used with environment files. * `tripleo_overcloud_upgrade_prepare_environment_files`: (List) A list of environment file paths for the deployment. Should not be used with environment dirs. -* `tripleo_overcloud_upgrade_prepare_force_postconfig`: (Boolean) Force the overclodu post-deployment configuration. Default: false +* `tripleo_overcloud_upgrade_prepare_force_postconfig`: (Boolean) Force the overcloud post-deployment configuration. Default: false * `tripleo_overcloud_upgrade_prepare_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_upgrade_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_upgrade_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_upgrade_prepare_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_upgrade_prepare_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_upgrade_prepare_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" -* `tripleo_overcloud_upgrade_prepare_inflight_validations`: (Boolean) Flag to enable inflight validations. Default: false -* `tripleo_overcloud_upgrade_prepare_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is prefered over this option. +* `tripleo_overcloud_upgrade_prepare_inflight_validations`: (Boolean) Flag to enable in-flight validations. Default: false +* `tripleo_overcloud_upgrade_prepare_libvirt_type`: (String) Libvirt domain time. Setting `NovaComputeLibvirtType` in an environment file is preferred over this option. * `tripleo_overcloud_upgrade_prepare_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_upgrade_prepare_home_dir }}/overcloud_upgrade_prepare.log" -* `tripleo_overcloud_upgrade_prepare_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_upgrade_prepare_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_upgrade_prepare_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_upgrade_prepare_networks_file`: (String) File path to a networks file for the deployment. * `tripleo_overcloud_upgrade_prepare_no_cleanup`: (Boolean) String to enable no cleanup. Default: false * `tripleo_overcloud_upgrade_prepare_no_config_download`: (Boolean) String to disable the config download software configuration. Default: false -* `tripleo_overcloud_upgrade_prepare_no_proxy`: (String) String containing a comma seperated list of hosts to skip proxing when http_proxy and https_proxy are used. -* `tripleo_overcloud_upgrade_prepare_ntp_server`: (String) String containing a comma seperated list of ntp servers. Setting `NtpServer` in an environment file is prefered over this option. +* `tripleo_overcloud_upgrade_prepare_no_proxy`: (String) String containing a comma separated list of hosts to skip proxying when http_proxy and https_proxy are used. +* `tripleo_overcloud_upgrade_prepare_ntp_server`: (String) String containing a comma separated list of NTP servers. Setting `NtpServer` in an environment file is preferred over this option. * `tripleo_overcloud_upgrade_prepare_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_upgrade_prepare_rc_file`. * `tripleo_overcloud_upgrade_prepare_output_dir`: (String) Path to a directory to output for the configuration download output. * `tripleo_overcloud_upgrade_prepare_overcloud_ssh_enable_timeout`: (Integer) Timeout for the ssh enable process to finish. diff --git a/roles/tripleo_overcloud_upgrade_run/README.md b/roles/tripleo_overcloud_upgrade_run/README.md index 6d8ceeb..2f98fec 100644 --- a/roles/tripleo_overcloud_upgrade_run/README.md +++ b/roles/tripleo_overcloud_upgrade_run/README.md @@ -13,20 +13,20 @@ Role Variables * `tripleo_overcloud_upgrade_run_debug`: (Boolean) Flag to print out the command that is run. Default: false * `tripleo_overcloud_upgrade_run_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_overcloud_upgrade_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_overcloud_upgrade_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_overcloud_upgrade_run_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_overcloud_upgrade_run_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_overcloud_upgrade_run_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" * `tripleo_overcloud_upgrade_run_limit`: (String) String that identifies a single node or a list of nodes to be upgraded. -* `tripleo_overcloud_upgrade_run_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_upgrade_run_log_combine`: (Boolean) Flag to enable capturing stderr with stdout. Default: true * `tripleo_overcloud_upgrade_run_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true * `tripleo_overcloud_upgrade_run_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_upgrade_run_home_dir }}/overcloud_upgrade_run.log" * `tripleo_overcloud_upgrade_run_playbook`: (List) List of playbook(s) to use for the upgrade. Defaults: [] * `tripleo_overcloud_upgrade_run_poll`: (Integer) Number of seconds to wait between each checks to see if the deployment command has completed. Default: 10 * `tripleo_overcloud_upgrade_run_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" -* `tripleo_overcloud_upgrade_run_skip_tags`: (String) A string specifying the tag or a comma seperated list of tags to be excluded. +* `tripleo_overcloud_upgrade_run_skip_tags`: (String) A string specifying the tag or a comma separated list of tags to be excluded. * `tripleo_overcloud_upgrade_run_ssh_user`: (String) Username of user to be used as the ssh user. * `tripleo_overcloud_upgrade_run_stack`: (String) Name of the stack to deploy. * `tripleo_overcloud_upgrade_run_static_inventory`: (String) Path to an existing ansible inventory to use. -* `tripleo_overcloud_upgrade_run_tags`: (String) A string specifying the tag or a comma seperated list of tags to be included. +* `tripleo_overcloud_upgrade_run_tags`: (String) A string specifying the tag or a comma separated list of tags to be included. * `tripleo_overcloud_upgrade_run_timeout`: (Integer) Number in seconds to wait for the ansible execution of the deployment command to finish. Default: 5700 NOTE: Please note that this command should be run against the undercloud so the diff --git a/roles/tripleo_undercloud_backup/README.md b/roles/tripleo_undercloud_backup/README.md index fe9df06..f0c80a7 100644 --- a/roles/tripleo_undercloud_backup/README.md +++ b/roles/tripleo_undercloud_backup/README.md @@ -14,7 +14,7 @@ Role Variables * `tripleo_undercloud_backup_add_path`: (List) List of additional filesystem paths to backup. Default: [] * `tripleo_undercloud_backup_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_undercloud_backup_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_undercloud_backup_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_undercloud_backup_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_undercloud_backup_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_undercloud_backup_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_undercloud_backup_exclude_path`: (List) List of filesystems path to skip backing up. Default: [] * `tripleo_undercloud_backup_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}" * `tripleo_undercloud_backup_log_combine`: (Boolean) Flag to combine stdout and stderr in the logfile. Default: true diff --git a/roles/tripleo_undercloud_install/README.md b/roles/tripleo_undercloud_install/README.md index 6fd206c..1bd6d71 100644 --- a/roles/tripleo_undercloud_install/README.md +++ b/roles/tripleo_undercloud_install/README.md @@ -15,7 +15,7 @@ Role Variables * `tripleo_undercloud_install_dry_run`: (Boolean) Flag to add --dry-run to the install. Default: false * `tripleo_undercloud_install_force_stack_update`: (Boolean) Flag to add --force-stack-update to the install. Default: false * `tripleo_undercloud_install_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_undercloud_install_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_undercloud_install_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_undercloud_install_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_undercloud_install_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_undercloud_install_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}" * `tripleo_undercloud_install_inflight_validations`: (Boolean) Flag to add --inflight-validations to the install. Default: false * `tripleo_undercloud_install_log_combine`: (Boolean) Flag to combine stdout and stderr in the logfile. Default: true diff --git a/roles/tripleo_undercloud_minion_install/README.md b/roles/tripleo_undercloud_minion_install/README.md index 0dcd311..7a36d6f 100644 --- a/roles/tripleo_undercloud_minion_install/README.md +++ b/roles/tripleo_undercloud_minion_install/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_undercloud_minion_install_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_undercloud_minion_install_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_undercloud_minion_install_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_undercloud_minion_install_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_undercloud_minion_install_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_undercloud_minion_install_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_undercloud_minion_install_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}" * `tripleo_undercloud_minion_install_dry_run`: (Boolean) Flag to add --dry-run to the install. Default: false * `tripleo_undercloud_minion_install_force_stack_update`: (Boolean) Flag to add --force-stack-update to the install. Default: false diff --git a/roles/tripleo_undercloud_minion_upgrade/README.md b/roles/tripleo_undercloud_minion_upgrade/README.md index aeaa2b6..f7c4520 100644 --- a/roles/tripleo_undercloud_minion_upgrade/README.md +++ b/roles/tripleo_undercloud_minion_upgrade/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_undercloud_minion_upgrade_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_undercloud_minion_upgrade_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_undercloud_minion_upgrade_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_undercloud_minion_upgrade_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_undercloud_minion_upgrade_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_undercloud_minion_upgrade_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_undercloud_minion_upgrade_dry_run`: (Boolean) Flag to add --dry-run to the upgrade command. Default: false * `tripleo_undercloud_minion_upgrade_force_stack_update`: (Boolean) Flag to add --force-stack-update to the upgrade command. Default: false * `tripleo_undercloud_minion_upgrade_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}" diff --git a/roles/tripleo_undercloud_upgrade/README.md b/roles/tripleo_undercloud_upgrade/README.md index 1c257bd..eaa73b8 100644 --- a/roles/tripleo_undercloud_upgrade/README.md +++ b/roles/tripleo_undercloud_upgrade/README.md @@ -13,7 +13,7 @@ Role Variables * `tripleo_undercloud_upgrade_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false * `tripleo_undercloud_upgrade_generate_scripts`: (Boolean) Write out a shell script that can be used to reproduce the command being executed. By default uses the value of `tripleo_generate_scripts` or False if `tripleo_generate_scripts` is not defined. -* `tripleo_undercloud_upgrade_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjonction with `tripleo_undercloud_upgrade_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. +* `tripleo_undercloud_upgrade_generate_scripts_only`: (Boolean) Do not run the actual command - to be used in conjunction with `tripleo_undercloud_upgrade_generate_scripts`. By default uses the value of `tripleo_generate_scripts_only` or False if `tripleo_generate_scripts_only` is not defined. * `tripleo_undercloud_upgrade_dry_run`: (Boolean) Flag to add --dry-run to the upgrade command. Default: false * `tripleo_undercloud_upgrade_force_stack_update`: (Boolean) Flag to add --force-stack-update to the upgrade command. Default: false * `tripleo_undercloud_upgrade_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}" diff --git a/roles/tripleo_validator_run/README.md b/roles/tripleo_validator_run/README.md index a3c69cd..879882e 100644 --- a/roles/tripleo_validator_run/README.md +++ b/roles/tripleo_validator_run/README.md @@ -14,7 +14,7 @@ Role Variables * `tripleo_validator_run_debug`: (Boolean) Flag to print out the delete command. Default: False * `tripleo_validator_run_plan`: (String) Plan to run validations against * `tripleo_validator_run_workers`: (Integer) Number of workers -* `tripleo_validator_run_extra_vars_file`: (String) Path to an ansible vars file to use when running the valdations +* `tripleo_validator_run_extra_vars_file`: (String) Path to an ansible vars file to use when running the validations * `tripleo_validator_run_validation`: (String) Specific validation to run * `tripleo_validator_run_group`: (String) Group of validations to run