Merge "Create tripleo_overcloud_backup role"

roles/tripleo_overcloud_backup/README.md

@@ -0,0 +1,58 @@
+tripleo_overcloud_backup
+=========================
+
+A role to run backup of a TripleO overcloud.
+
+Requirements
+------------
+
+None.
+
+Role Variables
+--------------
+
+* `tripleo_overcloud_backup_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false
+* `tripleo_overcloud_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_overcloud_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_overcloud_backup_home_dir`: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}"
+* `tripleo_overcloud_backup_init`: (String) Flag to initialize environment for backup, using `rear` or `nfs` as args which will check for packages, install and configure ReaR or NFS server. WARNING: This flag will be deprecated and replaced by `--setup-rear` and `--setup-nfs`.
+* `tripleo_overcloud_backup_setup_nfs`: (Boolean) Flag to setup the NFS server on the backup node which will install required packages and configuration.
+* `tripleo_overcloud_backup_setup_rear`: (Boolean) Flag to setup ReaR on undercloud which will install and configure ReaR.
+* `tripleo_overcloud_backup_storage_ip`: (String) Flag to setup an ip for the NFS / Backup server. WARNING: This flag will be deprecated in favor of '--extra-vars' which will allow to pass this and other variables.
+* `tripleo_overcloud_backup_extra_vars`: (String) Flag to set additional variables as JSON or as an absolute path of a JSON or YAML file type.
+* `tripleo_overcloud_backup_log_combine`: (Boolean) Flag to combine stdout and stderr in the logfile. Default: true
+* `tripleo_overcloud_backup_log_output`: (Boolean) Flag to log the output to a file rather than show it in the ansible output. Default: true
+* `tripleo_overcloud_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_overcloud_backup_timeout`: (Integer) Timeout for the backup command. Default: 7200
+* `tripleo_overcloud_backup_log`: (String) Backup log file path. Default: "{{ tripleo_undercloud_backup_home_dir }}/undercloud_backup.log"
+
+Output Variables
+----------------
+
+* `tripleo_overcloud_backup_result`: Ansible shell execution results
+
+Dependencies
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Example backup execution playbook
+
+```yaml
+- hosts: Undercloud
+  gather_facts: true
+  tasks:
+    - name: Backup overcloud
+      import_role:
+        name: tripleo_overcloud_backup
+      vars:
+        tripleo_overcloud_backup_debug: true
+```
+
+License
+-------
+
+Apache-2.0

roles/tripleo_overcloud_backup/defaults/main.yml

@@ -0,0 +1,19 @@
+# defaults file for tripleo_overcloud_backup
+---
+openstack_bin: openstack
+tripleo_overcloud_backup_add_path: []
+tripleo_overcloud_backup_debug: false
+tripleo_overcloud_backup_exclude_path: []
+tripleo_overcloud_backup_init:
+tripleo_overcloud_backup_setup_nfs: false
+tripleo_overcloud_backup_setup_rear: false
+tripleo_overcloud_backup_storage_ip:
+tripleo_overcloud_backup_extra_vars:
+tripleo_overcloud_backup_generate_scripts: "{{ tripleo_generate_scripts | default(False) }}"
+tripleo_overcloud_backup_generate_scripts_only: "{{ tripleo_generate_scripts_only | default(False) }}"
+tripleo_overcloud_backup_home_dir: "{{ ansible_env.HOME }}"
+tripleo_overcloud_backup_log: "{{ tripleo_overcloud_backup_home_dir }}/overcloud_backup.log"
+tripleo_overcloud_backup_log_combine: true
+tripleo_overcloud_backup_log_output: true
+tripleo_overcloud_backup_poll: 10
+tripleo_overcloud_backup_timeout: 7200

roles/tripleo_overcloud_backup/meta/main.yml

@@ -0,0 +1,42 @@
+---
+# Copyright 2019 Red Hat, Inc.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+galaxy_info:
+  author: OpenStack
+  description: TripleO Operator Role -- tripleo_overcloud_backup
+  company: Red Hat
+  license: Apache-2.0
+  min_ansible_version: 2.8
+  #
+  # Provide a list of supported platforms, and for each platform a list of versions.
+  # If you don't wish to enumerate all versions for a particular platform, use 'all'.
+  # To view available platforms and versions (or releases), visit:
+  # https://galaxy.ansible.com/api/v1/platforms/
+  #
+  platforms:
+    - name: CentOS
+      versions:
+        - 7
+        - 8
+
+  galaxy_tags:
+    - tripleo
+
+
+# List your role dependencies here, one per line. Be sure to remove the '[]' above,
+# if you add dependencies to this list.
+dependencies: []

roles/tripleo_overcloud_backup/molecule/default/converge.yml

@@ -0,0 +1,104 @@
+---
+- name: Converge
+  hosts: all
+  collections:
+    - tripleo.operator
+  vars:
+    openstack_bin: echo
+    tripleo_os_cloud: overcloud
+    tripleo_overcloud_backup_debug: true
+    tripleo_overcloud_backup_log_output: false
+    tripleo_overcloud_backup_log_combine: false
+    tripleo_overcloud_backup_poll: 1
+  tasks:
+
+    - name: "Include tripleo_overcloud_backup"
+      include_role:
+        name: "tripleo_overcloud_backup"
+
+    - name: Check role
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == "overcloud backup"
+
+    - name: Check parameter "tripleo_overcloud_backup_init_rear"
+      include_role:
+        name: "tripleo_overcloud_backup"
+      vars:
+        tripleo_overcloud_backup_init: rear
+
+    - name: Assert "tripleo_overcloud_backup_init_rear"
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == "overcloud backup --init rear"
+
+    - name: Check parameter "tripleo_overcloud_backup_init_nfs"
+      include_role:
+        name: "tripleo_overcloud_backup"
+      vars:
+        tripleo_overcloud_backup_init: nfs
+
+    - name: Assert "tripleo_overcloud_backup_init_nfs"
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == "overcloud backup --init nfs"
+
+    - name: Check parameter "tripleo_overcloud_backup_setup_nfs"
+      include_role:
+        name: "tripleo_overcloud_backup"
+      vars:
+        tripleo_overcloud_backup_setup_nfs: true
+
+    - name: Assert "tripleo_overcloud_backup_setup_nfs"
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == "overcloud backup --setup-nfs"
+
+    - name: Check parameter "tripleo_overcloud_backup_setup_rear"
+      include_role:
+        name: "tripleo_overcloud_backup"
+      vars:
+        tripleo_overcloud_backup_setup_rear: true
+
+    - name: Assert "tripleo_overcloud_backup_setup_rear"
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == "overcloud backup --setup-rear"
+
+    - name: Check parameter "tripleo_overcloud_backup_setup_rear_extra_vars_file"
+      include_role:
+        name: "tripleo_overcloud_backup"
+      vars:
+        tripleo_overcloud_backup_setup_rear: true
+        tripleo_overcloud_backup_extra_vars: /path/to/vars.yaml
+
+    - name: Assert "tripleo_overcloud_backup_setup_rear_extra_vars_file"
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == "overcloud backup --setup-rear --extra-vars /path/to/vars.yaml"
+
+    - name: Check parameter "tripleo_overcloud_backup_storage_ip"
+      include_role:
+        name: "tripleo_overcloud_backup"
+      vars:
+        tripleo_overcloud_backup_setup_rear: true
+        tripleo_overcloud_backup_storage_ip: "192.168.24.1"
+
+    - name: Assert "tripleo_overcloud_backup_storage_ip"
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == "overcloud backup --setup-rear --storage-ip 192.168.24.1"
+
+    - name: Check parameter "tripleo_overcloud_backup_setup_rear_extra_vars_string"
+      include_role:
+        name: "tripleo_overcloud_backup"
+      vars:
+        tripleo_overcloud_backup_setup_rear: true
+        tripleo_overcloud_backup_extra_vars: "{{ {'tripleo_backup_and_restore_nfs_server': '192.168.24.1'} | to_json }}"
+
+    - name: Assert "tripleo_overcloud_backup_setup_rear_extra_vars_string"
+      vars:
+        tripleo_overcloud_backup_extra_vars: "{{ {'tripleo_backup_and_restore_nfs_server': '192.168.24.1'} | to_json }}"
+      assert:
+        that:
+          - tripleo_overcloud_backup_result.stdout == 'overcloud backup --setup-rear --extra-vars {{ tripleo_overcloud_backup_extra_vars  }}'

roles/tripleo_overcloud_backup/molecule/default/molecule.yml

@@ -0,0 +1,19 @@
+---
+driver:
+  name: delegated
+  options:
+    managed: false
+    ansible_connection_options:
+      ansible_connection: local
+log: true
+platforms:
+  - name: instance
+provisioner:
+  name: ansible
+scenario:
+  name: default
+  test_sequence:
+    - prepare
+    - syntax
+    - converge
+    - verify

roles/tripleo_overcloud_backup/molecule/default/prepare.yml

@@ -0,0 +1,8 @@
+---
+- name: Prepare
+  hosts: all
+  tasks:
+
+    - name: Include molecule prep
+      include_role:
+        name: test_molecule_prep

roles/tripleo_overcloud_backup/tasks/main.yml

@@ -0,0 +1,50 @@
+---
+- name: Setup overcloud backup facts
+  set_fact:
+    _backup_cmd: >-
+      {{ openstack_bin }} overcloud backup
+      {{ tripleo_overcloud_backup_init | tripleo.operator.shell_arg_list(parameter='--init') }}
+      {{ tripleo_overcloud_backup_setup_nfs | ternary('--setup-nfs', '') }}
+      {{ tripleo_overcloud_backup_setup_rear  | ternary('--setup-rear', '') }}
+      {{ tripleo_overcloud_backup_storage_ip | tripleo.operator.shell_arg_list(parameter='--storage-ip') }}
+      {{ tripleo_overcloud_backup_extra_vars | tripleo.operator.shell_arg_list(parameter='--extra-vars') }}
+      {{ tripleo_overcloud_backup_log_output | ternary((">" ~ tripleo_overcloud_backup_log), '') }}
+      {{ tripleo_overcloud_backup_log_combine | ternary("2>&1", '') }}
+    _backup_env: {}
+
+- name: Preserve existing log file if exists
+  timestamp_file:
+    path: "{{ tripleo_overcloud_backup_log }}"
+  when: tripleo_overcloud_backup_log_output|bool
+
+- name: Show debug information
+  when: tripleo_overcloud_backup_debug|bool
+  block:
+    - name: Show the overcloud backup command
+      debug:
+        var: _backup_cmd
+
+    - name: Show the overcloud backup environment
+      debug:
+        var: _backup_env
+
+- name: Write reproducer script
+  tripleo_shell_script:
+    dest: "{{ tripleo_overcloud_backup_home_dir }}/tripleo_overcloud_backup.sh"
+    shell_command: "{{ _backup_cmd }}"
+    shell_environment: "{{ _backup_env }}"
+  when: tripleo_overcloud_backup_generate_scripts|bool
+
+- name: overcloud backup
+  shell: "{{ _backup_cmd }}"  # noqa 305
+  environment: "{{ _backup_env }}"
+  args:
+    chdir: "{{ tripleo_overcloud_backup_home_dir }}"
+    warn: false
+  async: "{{ tripleo_overcloud_backup_timeout }}"
+  poll: "{{ tripleo_overcloud_backup_poll }}"
+  register: tripleo_overcloud_backup_result
+  changed_when: true
+  when:
+    - not ansible_check_mode|bool
+    - not tripleo_overcloud_backup_generate_scripts_only|bool

roles/tripleo_overcloud_backup/tests/inventory

@@ -0,0 +1 @@
+localhost

roles/tripleo_overcloud_backup/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - tripleo_overcloud_backup

zuul.d/molecule.yaml

@@ -14,6 +14,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_image_upload
       - tripleo-operator-molecule-tripleo_deploy
       - tripleo-operator-molecule-tripleo_overcloud_admin_authorize
+      - tripleo-operator-molecule-tripleo_overcloud_backup
       - tripleo-operator-molecule-tripleo_overcloud_cell_export
       - tripleo-operator-molecule-tripleo_overcloud_config_download
       - tripleo-operator-molecule-tripleo_overcloud_container_image_build
@@ -82,6 +83,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_image_upload
       - tripleo-operator-molecule-tripleo_deploy
       - tripleo-operator-molecule-tripleo_overcloud_admin_authorize
+      - tripleo-operator-molecule-tripleo_overcloud_backup
       - tripleo-operator-molecule-tripleo_overcloud_cell_export
       - tripleo-operator-molecule-tripleo_overcloud_config_download
       - tripleo-operator-molecule-tripleo_overcloud_container_image_build
@@ -295,6 +297,21 @@
     vars:
       tox_extra_args: tripleo_overcloud_admin_authorize
 
+- job:
+    files:
+      - ^bindep.txt
+      - ^galaxy.yml
+      - ^molecule-requirements.txt
+      - ^requirements.txt
+      - ^roles/tripleo_overcloud_backup/.*
+      - ^setup.cfg
+      - ^test-requirements.txt
+      - ^tox.ini
+    name: tripleo-operator-molecule-tripleo_overcloud_backup
+    parent: tripleo-operator-molecule-base
+    vars:
+      tox_extra_args: tripleo_overcloud_backup
+
 - job:
     files:
       - ^bindep.txt