From be6b38c4d5e17feaeddd29207a54dab80e10331c Mon Sep 17 00:00:00 2001 From: Sagi Shnaidman Date: Thu, 2 Apr 2020 00:52:48 +0300 Subject: [PATCH] Add tripleo_overcloud_support_report_collect role Change-Id: If84b5e9f45a9fd194aa44737826e4cbd783c9a65 Signed-off-by: Sagi Shnaidman --- .../README.md | 55 ++++++++++++++++ .../defaults/main.yml | 10 +++ .../meta/main.yml | 42 ++++++++++++ .../molecule/default/converge.yml | 64 +++++++++++++++++++ .../molecule/default/molecule.yml | 19 ++++++ .../molecule/default/prepare.yml | 8 +++ .../tasks/main.yml | 39 +++++++++++ .../tests/inventory | 1 + .../tests/test.yml | 4 ++ zuul.d/molecule.yaml | 16 +++++ 10 files changed, 258 insertions(+) create mode 100644 roles/tripleo_overcloud_support_report_collect/README.md create mode 100644 roles/tripleo_overcloud_support_report_collect/defaults/main.yml create mode 100644 roles/tripleo_overcloud_support_report_collect/meta/main.yml create mode 100644 roles/tripleo_overcloud_support_report_collect/molecule/default/converge.yml create mode 100644 roles/tripleo_overcloud_support_report_collect/molecule/default/molecule.yml create mode 100644 roles/tripleo_overcloud_support_report_collect/molecule/default/prepare.yml create mode 100644 roles/tripleo_overcloud_support_report_collect/tasks/main.yml create mode 100644 roles/tripleo_overcloud_support_report_collect/tests/inventory create mode 100644 roles/tripleo_overcloud_support_report_collect/tests/test.yml diff --git a/roles/tripleo_overcloud_support_report_collect/README.md b/roles/tripleo_overcloud_support_report_collect/README.md new file mode 100644 index 0000000..a026e70 --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/README.md @@ -0,0 +1,55 @@ +tripleo_overcloud_support_report_collect +======================================== + +A role to run support report collection. + +Requirements +------------ + +None. + +Role Variables +-------------- + +* `tripleo_overcloud_support_report_collect_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false +* `tripleo_overcloud_support_report_collect_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_support_report_collect_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" +* `tripleo_overcloud_support_report_collect_server_name`: Server name, group name, or partial name to match. For example "Controller" will match all controllers for an environment. +* `tripleo_overcloud_support_report_collect_output_dir`: Output directory for the report. +* `tripleo_overcloud_support_report_collect_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_support_report_collect_rc_file`. +* `tripleo_overcloud_support_report_collect_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_support_report_collect_output`: (String) The command standard output. +* `tripleo_overcloud_support_report_collect_result`: Ansible shell execution results + +Dependencies +------------ + +None. + +Example Playbook +---------------- + +Example overcloud support report collecting playbook + +```yaml +- hosts: undercloud + gather_facts: true + tasks: + - name: Report support + import_role: + name: tripleo_overcloud_support_report_collect +``` + +License +------- + +Apache-2.0 diff --git a/roles/tripleo_overcloud_support_report_collect/defaults/main.yml b/roles/tripleo_overcloud_support_report_collect/defaults/main.yml new file mode 100644 index 0000000..1c077f1 --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/defaults/main.yml @@ -0,0 +1,10 @@ +--- +# defaults file for tripleo_overcloud_support_report_collect +openstack_bin: openstack +tripleo_overcloud_support_report_collect_generate_scripts: "{{ tripleo_generate_scripts | default(False) }}" +tripleo_overcloud_support_report_collect_home_dir: "{{ ansible_env.HOME }}" +tripleo_overcloud_support_report_collect_debug: false +tripleo_overcloud_support_report_collect_server_name: +tripleo_overcloud_support_report_collect_output_dir: /var/lib/tripleo/support +tripleo_overcloud_support_report_collect_os_cloud: "{{ tripleo_os_cloud | default('') }}" +tripleo_overcloud_support_report_collect_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}" diff --git a/roles/tripleo_overcloud_support_report_collect/meta/main.yml b/roles/tripleo_overcloud_support_report_collect/meta/main.yml new file mode 100644 index 0000000..4ec9fb6 --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/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_support_report_collect + 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: [] diff --git a/roles/tripleo_overcloud_support_report_collect/molecule/default/converge.yml b/roles/tripleo_overcloud_support_report_collect/molecule/default/converge.yml new file mode 100644 index 0000000..2653b33 --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/molecule/default/converge.yml @@ -0,0 +1,64 @@ +--- +- name: Converge + hosts: all + collections: + - tripleo.operator + tasks: + + - name: "Include tripleo_overcloud_support_report_collect" + include_role: + name: "tripleo_overcloud_support_report_collect" + vars: + openstack_bin: echo + tripleo_overcloud_support_report_collect_debug: true + tripleo_os_cloud: undercloud + + - name: Check role + assert: + that: + - tripleo_overcloud_support_report_collect_output == "overcloud support report collect --output /var/lib/tripleo/support" + + - name: Check parameter "tripleo_overcloud_support_report_collect_server_name" + include_role: + name: "tripleo_overcloud_support_report_collect" + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_support_report_collect_debug: true + tripleo_overcloud_support_report_collect_server_name: value + + - name: Assert "tripleo_overcloud_support_report_collect_server_name" + assert: + that: + - tripleo_overcloud_support_report_collect_output == "overcloud support report collect value --output /var/lib/tripleo/support" + + - name: Check parameter "tripleo_overcloud_support_report_collect_output_dir" + include_role: + name: "tripleo_overcloud_support_report_collect" + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_support_report_collect_debug: true + tripleo_overcloud_support_report_collect_output_dir: value + + - name: Assert "tripleo_overcloud_support_report_collect_output_dir" + assert: + that: + - tripleo_overcloud_support_report_collect_output == "overcloud support report collect --output value" + + + - name: Check all parameters for role tripleo_overcloud_support_report_collect + include_role: + name: "tripleo_overcloud_support_report_collect" + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_support_report_collect_debug: true + tripleo_overcloud_support_report_collect_server_name: value + tripleo_overcloud_support_report_collect_output_dir: value + + - name: Assert all parameters for role tripleo_overcloud_support_report_collect + assert: + that: + - tripleo_overcloud_support_report_collect_output == + "overcloud support report collect value --output value" diff --git a/roles/tripleo_overcloud_support_report_collect/molecule/default/molecule.yml b/roles/tripleo_overcloud_support_report_collect/molecule/default/molecule.yml new file mode 100644 index 0000000..2841806 --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/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 diff --git a/roles/tripleo_overcloud_support_report_collect/molecule/default/prepare.yml b/roles/tripleo_overcloud_support_report_collect/molecule/default/prepare.yml new file mode 100644 index 0000000..63bb6ab --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/molecule/default/prepare.yml @@ -0,0 +1,8 @@ +--- +- name: Prepare + hosts: all + tasks: + + - name: Include molecule prep + include_role: + name: test_molecule_prep diff --git a/roles/tripleo_overcloud_support_report_collect/tasks/main.yml b/roles/tripleo_overcloud_support_report_collect/tasks/main.yml new file mode 100644 index 0000000..f433df4 --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/tasks/main.yml @@ -0,0 +1,39 @@ +--- +# tasks file for tripleo_overcloud_support_report_collect +- name: Setup overcloud support report command + set_fact: + _report_cmd: >- + {{ tripleo_overcloud_support_report_collect_os_cloud | ternary('', "source " ~ tripleo_overcloud_support_report_collect_rc_file ~ "; ") }} + {{ openstack_bin }} overcloud support report collect + {{ tripleo_overcloud_support_report_collect_server_name | ternary(tripleo_overcloud_support_report_collect_server_name, '') }} + {{ tripleo_overcloud_support_report_collect_output_dir | ternary('--output ' ~ tripleo_overcloud_support_report_collect_output_dir, '') }} + _report_env: + OS_CLOUD: "{{ tripleo_overcloud_support_report_collect_os_cloud }}" + +- name: Show debug information + when: tripleo_overcloud_support_report_collect_debug|bool + block: + - name: Show the support report command + debug: + var: _report_cmd + + - name: Show the support report environment + debug: + var: _report_env + +- name: Write reproducer script + tripleo_shell_script: + dest: "{{ tripleo_overcloud_support_report_collect_home_dir }}/tripleo_overcloud_support_report_collect.sh" + shell_command: "{{ _report_cmd }}" + shell_environment: "{{ _report_env }}" + when: tripleo_overcloud_support_report_collect_generate_scripts|bool + +- name: Report support + shell: "{{ _report_cmd }}" # noqa 305 + environment: "{{ _report_env }}" + register: tripleo_overcloud_support_report_collect_result + changed_when: true + +- name: Set output fact + set_fact: + tripleo_overcloud_support_report_collect_output: "{{ tripleo_overcloud_support_report_collect_result.stdout }}" diff --git a/roles/tripleo_overcloud_support_report_collect/tests/inventory b/roles/tripleo_overcloud_support_report_collect/tests/inventory new file mode 100644 index 0000000..2fbb50c --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/tests/inventory @@ -0,0 +1 @@ +localhost diff --git a/roles/tripleo_overcloud_support_report_collect/tests/test.yml b/roles/tripleo_overcloud_support_report_collect/tests/test.yml new file mode 100644 index 0000000..ab8006f --- /dev/null +++ b/roles/tripleo_overcloud_support_report_collect/tests/test.yml @@ -0,0 +1,4 @@ +--- +- hosts: localhost + roles: + - tripleo_overcloud_support_report_collect diff --git a/zuul.d/molecule.yaml b/zuul.d/molecule.yaml index 05d9ce3..76dc60a 100644 --- a/zuul.d/molecule.yaml +++ b/zuul.d/molecule.yaml @@ -46,6 +46,7 @@ - tripleo-operator-molecule-tripleo_overcloud_raid_create - tripleo-operator-molecule-tripleo_overcloud_roles_list - tripleo-operator-molecule-tripleo_overcloud_roles_show + - tripleo-operator-molecule-tripleo_overcloud_support_report_collect - tripleo-operator-molecule-tripleo_overcloud_update_converge - tripleo-operator-molecule-tripleo_overcloud_update_prepare - tripleo-operator-molecule-tripleo_overcloud_update_run @@ -104,6 +105,7 @@ - tripleo-operator-molecule-tripleo_overcloud_raid_create - tripleo-operator-molecule-tripleo_overcloud_roles_list - tripleo-operator-molecule-tripleo_overcloud_roles_show + - tripleo-operator-molecule-tripleo_overcloud_support_report_collect - tripleo-operator-molecule-tripleo_overcloud_update_converge - tripleo-operator-molecule-tripleo_overcloud_update_prepare - tripleo-operator-molecule-tripleo_overcloud_update_run @@ -611,6 +613,20 @@ vars: tox_extra_args: tripleo_overcloud_raid_create +- job: + files: + - ^roles/tripleo_overcloud_support_report_collect/.* + - ^bindep.txt + - ^galaxy.yml + - ^requirements.txt + - ^setup.cfg + - ^test-requirements.txt + - ^tox.ini + name: tripleo-operator-molecule-tripleo_overcloud_support_report_collect + parent: tripleo-operator-molecule-base + vars: + tox_extra_args: tripleo_overcloud_support_report_collect + - job: files: - ^roles/tripleo_overcloud_node_configure/.*