diff --git a/roles/tripleo_overcloud_node_clean/README.md b/roles/tripleo_overcloud_node_clean/README.md new file mode 100644 index 0000000..20b46cb --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/README.md @@ -0,0 +1,53 @@ +tripleo_overcloud_node_clean +============================ + +A role to run node clean. + +Requirements +------------ + +None. + +Role Variables +-------------- + +* `tripleo_overcloud_node_clean_node_uuids`: Baremetal Node UUIDs for the node(s) to be cleaned +* `tripleo_overcloud_node_clean_all_manageable`: Clean all nodes currently in 'manageable' state +* `tripleo_overcloud_node_clean_provide`: Provide (make available) the nodes once cleaned. +* `tripleo_overcloud_node_clean_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_node_clean_rc_file`. +* `tripleo_overcloud_node_clean_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" + +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_node_clean_output`: (String) The command standard output. +* `tripleo_overcloud_node_clean_result`: Ansible shell execution results + +Dependencies +------------ + +None. + +Example Playbook +---------------- + +Example overcloud node clean playbook + +```yaml +- hosts: undercloud + gather_facts: true + tasks: + - name: Clean node + import_role: + name: tripleo_overcloud_node_clean +``` + +License +------- + +Apache-2.0 diff --git a/roles/tripleo_overcloud_node_clean/defaults/main.yml b/roles/tripleo_overcloud_node_clean/defaults/main.yml new file mode 100644 index 0000000..0f40a2b --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/defaults/main.yml @@ -0,0 +1,9 @@ +--- +# defaults file for tripleo_overcloud_node_clean +openstack_bin: openstack +tripleo_overcloud_node_clean_debug: false +tripleo_overcloud_node_clean_node_uuids: [] +tripleo_overcloud_node_clean_all_manageable: false +tripleo_overcloud_node_clean_provide: false +tripleo_overcloud_node_clean_os_cloud: "{{ tripleo_os_cloud | default('') }}" +tripleo_overcloud_node_clean_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}" diff --git a/roles/tripleo_overcloud_node_clean/meta/main.yml b/roles/tripleo_overcloud_node_clean/meta/main.yml new file mode 100644 index 0000000..6e27764 --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/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_node_clean + 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_node_clean/molecule/default/molecule.yml b/roles/tripleo_overcloud_node_clean/molecule/default/molecule.yml new file mode 100644 index 0000000..d2d5bd5 --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/molecule/default/molecule.yml @@ -0,0 +1,21 @@ +--- +driver: + name: delegated + options: + managed: false + ansible_connection_options: + ansible_connection: local +log: true +lint: + name: yamllint + enabled: false +platforms: + - name: instance +provisioner: + name: ansible +scenario: + name: default + test_sequence: + - syntax + - converge + - verify diff --git a/roles/tripleo_overcloud_node_clean/molecule/default/playbook.yml b/roles/tripleo_overcloud_node_clean/molecule/default/playbook.yml new file mode 100644 index 0000000..d2427e3 --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/molecule/default/playbook.yml @@ -0,0 +1,77 @@ +--- +- name: Converge + hosts: all + tasks: + + - name: "Include tripleo_overcloud_node_clean" + include_role: + name: "tripleo_overcloud_node_clean" + vars: + openstack_bin: echo + tripleo_overcloud_node_clean_debug: true + tripleo_os_cloud: undercloud + + - name: Check role + assert: + that: + - tripleo_overcloud_node_clean_output == "overcloud node clean" + + - name: Check parameter "tripleo_overcloud_node_clean_node_uuids" + include_role: + name: "tripleo_overcloud_node_clean" + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_node_clean_debug: true + tripleo_overcloud_node_clean_node_uuids: ['test1', 'test2'] + + - name: Assert "tripleo_overcloud_node_clean_node_uuids" + assert: + that: + - tripleo_overcloud_node_clean_output == "overcloud node clean test1 test2" + + - name: Check parameter "tripleo_overcloud_node_clean_all_manageable" + include_role: + name: "tripleo_overcloud_node_clean" + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_node_clean_debug: true + tripleo_overcloud_node_clean_all_manageable: true + + - name: Assert "tripleo_overcloud_node_clean_all_manageable" + assert: + that: + - tripleo_overcloud_node_clean_output == "overcloud node clean --all-manageable" + + - name: Check parameter "tripleo_overcloud_node_clean_provide" + include_role: + name: "tripleo_overcloud_node_clean" + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_node_clean_debug: true + tripleo_overcloud_node_clean_provide: true + + - name: Assert "tripleo_overcloud_node_clean_provide" + assert: + that: + - tripleo_overcloud_node_clean_output == "overcloud node clean --provide" + + + - name: Check all parameters for role tripleo_overcloud_node_clean + include_role: + name: "tripleo_overcloud_node_clean" + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_node_clean_debug: true + tripleo_overcloud_node_clean_node_uuids: ['value1', 'value2'] + tripleo_overcloud_node_clean_all_manageable: true + tripleo_overcloud_node_clean_provide: true + + - name: Assert all parameters for role tripleo_overcloud_node_clean + assert: + that: + - tripleo_overcloud_node_clean_output == + "overcloud node clean value1 value2 --all-manageable --provide" diff --git a/roles/tripleo_overcloud_node_clean/tasks/main.yml b/roles/tripleo_overcloud_node_clean/tasks/main.yml new file mode 100644 index 0000000..663e133 --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/tasks/main.yml @@ -0,0 +1,24 @@ +--- +# tasks file for tripleo_overcloud_node_clean +- name: Setup overcloud node clean command + set_fact: + _clean_cmd: >- + {{ tripleo_overcloud_node_clean_os_cloud | ternary('', "source " ~ tripleo_overcloud_node_clean_rc_file ~ "; ") }} + {{ openstack_bin }} overcloud node clean + {{ tripleo_overcloud_node_clean_node_uuids | join(' ') }} + {{ tripleo_overcloud_node_clean_all_manageable | ternary('--all-manageable', '') }} + {{ tripleo_overcloud_node_clean_provide | ternary('--provide', '') }} + +- name: Show the node clean command + debug: + var: _clean_cmd + when: tripleo_overcloud_node_clean_debug|bool + +- name: Clean node + shell: "{{ _clean_cmd }}" # noqa 305 + register: tripleo_overcloud_node_clean_result + changed_when: true + +- name: Set output fact + set_fact: + tripleo_overcloud_node_clean_output: "{{ tripleo_overcloud_node_clean_result.stdout }}" diff --git a/roles/tripleo_overcloud_node_clean/tests/inventory b/roles/tripleo_overcloud_node_clean/tests/inventory new file mode 100644 index 0000000..2fbb50c --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/tests/inventory @@ -0,0 +1 @@ +localhost diff --git a/roles/tripleo_overcloud_node_clean/tests/test.yml b/roles/tripleo_overcloud_node_clean/tests/test.yml new file mode 100644 index 0000000..dfd7212 --- /dev/null +++ b/roles/tripleo_overcloud_node_clean/tests/test.yml @@ -0,0 +1,4 @@ +--- +- hosts: localhost + roles: + - tripleo_overcloud_node_clean diff --git a/zuul.d/molecule.yaml b/zuul.d/molecule.yaml index a72569c..d4e39b0 100644 --- a/zuul.d/molecule.yaml +++ b/zuul.d/molecule.yaml @@ -4,11 +4,13 @@ jobs: - tripleo-operator-molecule-tripleo_overcloud_node_introspect - tripleo-operator-molecule-tripleo_overcloud_node_configure + - tripleo-operator-molecule-tripleo_overcloud_node_clean gate: jobs: - tripleo-operator-molecule-tripleo_overcloud_node_introspect - tripleo-operator-molecule-tripleo_overcloud_node_configure + - tripleo-operator-molecule-tripleo_overcloud_node_clean - job: name: tripleo-operator-molecule-base @@ -32,3 +34,11 @@ parent: tripleo-operator-molecule-base vars: tox_extra_args: tripleo_overcloud_node_configure + +- job: + files: + - ^roles/tripleo_overcloud_node_clean/.* + name: tripleo-operator-molecule-tripleo_overcloud_node_clean + parent: tripleo-operator-molecule-base + vars: + tox_extra_args: tripleo_overcloud_node_clean