Files
tripleo-operator-ansible/roles/tripleo_overcloud_status/README.md
Alex Schultz b379c66729 Add overcloud status role
Adds tripleo_overcloud_status role that can be used to collect the
overcloud deployment status.

Change-Id: I79be50ce14648efdc2b1cbba56cba5c98cc2fc3a
2020-01-29 09:17:10 -07:00

53 lines
1.5 KiB
Markdown

tripleo_overcloud_status
==========================
A role to get the deployment status output.
Requirements
------------
None.
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_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
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_status_output`: (String) The command standard output.
* `tripleo_overcloud_status_result`: Ansible shell execution results
Dependencies
------------
None.
Example Playbook
----------------
Example overcloud status execution playbook
```yaml
- hosts: undercloud
gather_facts: true
tasks:
- name: Get overcloud status
import_role:
name: tripleo_overcloud_status
```
License
-------
Apache-2.0