tripleo-operator-ansible/roles/tripleo_overcloud_profiles_.../README.md

66 lines
3.3 KiB
Markdown

tripleo_overcloud_profiles_match
================================
A role to run profiles match.
Requirements
------------
None.
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_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.
* `tripleo_overcloud_profiles_list_compute_flavor`: (Deprecated in U) Nova flavor to use for compute nodes.
* `tripleo_overcloud_profiles_list_ceph_storage_flavor`: (Deprecated in U) Nova flavor to use for ceph storage nodes.
* `tripleo_overcloud_profiles_list_block_storage_flavor`: (Deprecated in U) Nova flavor to use for cinder storage nodes.
* `tripleo_overcloud_profiles_list_swift_storage_flavor`: (Deprecated in U) Nova flavor to use for swift storage nodes.
* `tripleo_overcloud_profiles_match_control_scale`: (Deprecated in U) New number of control nodes.
* `tripleo_overcloud_profiles_match_compute_scale`: (Deprecated in U) New number of compute nodes.
* `tripleo_overcloud_profiles_match_ceph_storage_scale`: (Deprecated in U) New number of ceph storage nodes.
* `tripleo_overcloud_profiles_match_block_storage_scale`: (Deprecated in U) New number of cinder storage nodes.
* `tripleo_overcloud_profiles_match_swift_storage_scale`: (Deprecated in U) New number of swift storage nodes.
* `tripleo_overcloud_profiles_match_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_profiles_match_rc_file`.
* `tripleo_overcloud_profiles_match_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_profiles_match_output`: (String) The command standard output.
* `tripleo_overcloud_profiles_match_result`: Ansible shell execution results
Dependencies
------------
None.
Example Playbook
----------------
Example overcloud profiles match playbook
```yaml
- hosts: undercloud
gather_facts: true
tasks:
- name: Match profiles
import_role:
name: tripleo_overcloud_profiles_match
```
License
-------
Apache-2.0