openstack/tripleo-operator-ansible
Code Issues Proposed changes
e4e657359a
tripleo-operator-ansible/roles/tripleo_overcloud_export
History
Lance Bragstad 2e983575c1 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
2020-07-14 08:45:15 -05:00
..
defaults Add new parameter in order to get a kind of dry-run 2020-05-12 15:14:47 +02:00
meta Add overcloud export role 2020-01-28 13:36:12 -07:00
molecule/default Add ability to write scripts 2020-04-15 16:25:27 -06:00
tasks Ensure we export result only if we have an stdout 2020-05-15 15:43:20 +02:00
tests Add overcloud export role 2020-01-28 13:36:12 -07:00
README.md trivial: fix spelling mistakes 2020-07-14 08:45:15 -05:00

README.md

tripleo_overcloud_export

A role to run an overcloud export.

Requirements

None.

Role Variables

  • tripleo_overcloud_export_config_download_dir: (String) Directory for config-download export data.
  • 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 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 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 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_export_output: (String) The command standard output.
  • tripleo_overcloud_export_result: Ansible shell execution results

Dependencies

None.

Example Playbook

Example overcloud export execution playbook

- hosts: undercloud
  gather_facts: true
  tasks:
    - name: Get overcloud export
      import_role:
        name: tripleo_overcloud_export
      vars:
        tripleo_overcloud_export_stack: overcloud

License

Apache-2.0