2e983575c1
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 |
||
---|---|---|
.. | ||
defaults | ||
meta | ||
molecule/default | ||
tasks | ||
tests | ||
README.md |
README.md
tripleo_overcloud_roles_show
A role to run roles show.
Requirements
None.
Role Variables
tripleo_overcloud_roles_show_debug
: (Boolean) Flag used to enable the debug version of commands. Default: falsetripleo_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 oftripleo_generate_scripts
or False iftripleo_generate_scripts
is not defined.tripleo_overcloud_roles_show_generate_scripts_only
: (Boolean) Do not run the actual command - to be used in conjunction withtripleo_overcloud_roles_show_generate_scripts
. By default uses the value oftripleo_generate_scripts_only
or False iftripleo_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, workflow environment and orchestration stack names.tripleo_overcloud_roles_show_os_cloud
: (String) OS_CLOUD value to use when running the command. Iftripleo_os_cloud
is defined, it will be the default. Otherwise the default is ''. This variable takes precedence overtripleo_overcloud_roles_show_rc_file
.tripleo_overcloud_roles_show_rc_file
: (String) Path to the credential file to use. Iftripleo_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
OS_CLOUD or rc file variables should be set to use the 'undercloud' when
calling this role. If you are not defining tripleo_os_cloud
or tripleo_rc_file
,
stackrc will be used by default.
Output Variables
tripleo_overcloud_roles_show_output
: (String) The command standard output.tripleo_overcloud_roles_show_result
: Ansible shell execution results
Dependencies
None.
Example Playbook
Example overcloud roles show playbook
- hosts: undercloud
gather_facts: true
tasks:
- name: Show roles
import_role:
name: tripleo_overcloud_roles_show
License
Apache-2.0