openstack/tripleo-operator-ansible
Code Issues Proposed changes
e4e657359a
tripleo-operator-ansible/roles/tripleo_undercloud_backup
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 Revert "New parameters in order to set how we want to redirect logs" 2020-07-13 15:34:30 +00:00
meta Rename roles to use underscore 2020-01-21 10:12:00 -07:00
molecule/default Bump molecule version 2020-02-06 17:25:26 -07:00
tasks Revert "New parameters in order to set how we want to redirect logs" 2020-07-13 15:34:30 +00:00
tests Rename roles to use underscore 2020-01-21 10:12:00 -07:00
README.md trivial: fix spelling mistakes 2020-07-14 08:45:15 -05:00

README.md

tripleo_undercloud_backup

A role to run backup of a TripleO undercloud.

Requirements

None.

Role Variables

  • tripleo_undercloud_backup_add_path: (List) List of additional filesystem paths to backup. Default: []
  • tripleo_undercloud_backup_debug: (Boolean) Flag used to enable the debug version of commands. Default: false
  • tripleo_undercloud_backup_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_undercloud_backup_generate_scripts_only: (Boolean) Do not run the actual command - to be used in conjunction with tripleo_undercloud_backup_generate_scripts. By default uses the value of tripleo_generate_scripts_only or False if tripleo_generate_scripts_only is not defined.
  • tripleo_undercloud_backup_exclude_path: (List) List of filesystems path to skip backing up. Default: []
  • tripleo_undercloud_backup_home_dir: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}"
  • tripleo_undercloud_backup_log_combine: (Boolean) Flag to combine stdout and stderr in the logfile. Default: true
  • tripleo_undercloud_backup_log_output: (Boolean) Flag to log the output to a file rather than show it in the ansible output. Default: true
  • tripleo_undercloud_backup_poll: (Integer) Number of seconds to wait between checks to see if the backup command has completed. This should be set to a value greater or equal to 1. Default: 10
  • tripleo_undercloud_backup_timeout: (Integer) Timeout for the backup command. Default: 7200
  • tripleo_undercloud_backup_log: (String) Backup log file path. Default: "{{ tripleo_undercloud_backup_home_dir }}/undercloud_backup.log"

Output Variables

  • tripleo_undercloud_backup_result: Ansible shell execution results

Dependencies

None.

Example Playbook

Example backup execution playbook

- hosts: undercloud
  gather_facts: true
  tasks:
    - name: Backup undercloud
      import_role:
        name: tripleo_undercloud_backup
      vars:
        tripleo_undercloud_backup_debug: true

License

Apache-2.0