8821471c60
Change-Id: I359df050ca598028bdefc6b336ccbd9a4c8ee0f2 Signed-off-by: Sagi Shnaidman <sshnaidm@redhat.com>
58 lines
2.0 KiB
Markdown
58 lines
2.0 KiB
Markdown
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: 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_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. If `tripleo_os_cloud` is defined, it will be the default.
|
|
Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_roles_show_rc_file`.
|
|
* `tripleo_overcloud_roles_show_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"
|
|
|
|
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
|
|
|
|
```yaml
|
|
- hosts: undercloud
|
|
gather_facts: true
|
|
tasks:
|
|
- name: Show roles
|
|
import_role:
|
|
name: tripleo_overcloud_roles_show
|
|
```
|
|
|
|
License
|
|
-------
|
|
|
|
Apache-2.0
|