tripleo-operator-ansible/roles/tripleo_undercloud_backup
Matthew N Heler b12211cf51 Ensure undercloud backup role runs with root privileges
The undercloud backup command requires root privileges to run,
as such we need to ensure become is available as a boolean option
to the operator. By default this value is set to true.

Change-Id: Idcbc28b107598efec62dd8f4afbb2d404a1a9c14
2021-02-07 16:16:01 -06:00
..
defaults Ensure undercloud backup role runs with root privileges 2021-02-07 16:16:01 -06:00
meta Rename roles to use underscore 2020-01-21 10:12:00 -07:00
molecule/default Ensure undercloud backup role runs with root privileges 2021-02-07 16:16:01 -06:00
tasks Ensure undercloud backup role runs with root privileges 2021-02-07 16:16:01 -06:00
tests Rename roles to use underscore 2020-01-21 10:12:00 -07:00
README.md Ensure undercloud backup role runs with root privileges 2021-02-07 16:16:01 -06:00

README.md

tripleo_undercloud_backup

A role to run backup of a TripleO undercloud.

Requirements

None.

Role Variables

  • tripleo_undercloud_backup_become: (Boolean) Run the command as root. This needs to be true as the commands require root privileges to run. Default: true
  • 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