From 8d02eea30a1e86ce6aaaf1ed35e12fe09df076ef Mon Sep 17 00:00:00 2001 From: Alex Schultz Date: Wed, 11 Mar 2020 16:51:19 -0600 Subject: [PATCH] Add overcloud netenv validate Adds tripleo_overcloud_netenv_validate to perform network environment file validation. Change-Id: I274adbabd4be705c7d746d8e9997d19826ebca19 --- .../README.md | 54 +++++++++++++++++++ .../defaults/main.yml | 11 ++++ .../meta/main.yml | 42 +++++++++++++++ .../molecule/default/converge.yml | 32 +++++++++++ .../molecule/default/molecule.yml | 19 +++++++ .../molecule/default/prepare.yml | 8 +++ .../tasks/main.yml | 45 ++++++++++++++++ .../tests/inventory | 1 + .../tests/test.yml | 5 ++ zuul.d/molecule.yaml | 16 ++++++ 10 files changed, 233 insertions(+) create mode 100644 roles/tripleo_overcloud_netenv_validate/README.md create mode 100644 roles/tripleo_overcloud_netenv_validate/defaults/main.yml create mode 100644 roles/tripleo_overcloud_netenv_validate/meta/main.yml create mode 100644 roles/tripleo_overcloud_netenv_validate/molecule/default/converge.yml create mode 100644 roles/tripleo_overcloud_netenv_validate/molecule/default/molecule.yml create mode 100644 roles/tripleo_overcloud_netenv_validate/molecule/default/prepare.yml create mode 100644 roles/tripleo_overcloud_netenv_validate/tasks/main.yml create mode 100644 roles/tripleo_overcloud_netenv_validate/tests/inventory create mode 100644 roles/tripleo_overcloud_netenv_validate/tests/test.yml diff --git a/roles/tripleo_overcloud_netenv_validate/README.md b/roles/tripleo_overcloud_netenv_validate/README.md new file mode 100644 index 0000000..8e1bbcb --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/README.md @@ -0,0 +1,54 @@ +tripleo_overcloud_netenv_validate +================================= + +A role to perform a netenv validation. + +Requirements +------------ + +None. + +Role Variables +-------------- + +* `tripleo_overcloud_netenv_validate_debug`: (Boolean) Flag to print out the delete command. Default: False +* `tripleo_overcloud_netenv_validate_file`: (String) REQUIRED. Path to the network environment file +* `tripleo_overcloud_netenv_validate_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" +* `tripleo_overcloud_netenv_validate_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_netenv_validate_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true +* `tripleo_overcloud_netenv_validate_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_netenv_validate_home_dir }}/overcloud_netenv_validate.log" +* `tripleo_overcloud_netenv_validate_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10 +* `tripleo_overcloud_netenv_validate_timeout`: (Integer) Number in seconds to wait for the ansible execution of the command to finish. Default: 3600 + +Output Variables +---------------- + +* `tripleo_overcloud_netenv_validate_output`: (String) The command standard output. +* `tripleo_overcloud_netenv_validate_result`: Ansible shell execution results + +Dependencies +------------ + +None. + +Example Playbook +---------------- + +Example network environment validation + +```yaml +- hosts: undercloud + gather_facts: true + tasks: + - name: overcloud netenv validate + import_role: + name: tripleo_overcloud_netenv_validate + var: + tripleo_overcloud_netenv_validate_debug: true + tripleo_overcloud_netenv_validate_file: /home/stack/templates/network-environment.yaml +``` + +License +------- + +Apache-2.0 diff --git a/roles/tripleo_overcloud_netenv_validate/defaults/main.yml b/roles/tripleo_overcloud_netenv_validate/defaults/main.yml new file mode 100644 index 0000000..e46ed6d --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/defaults/main.yml @@ -0,0 +1,11 @@ +--- +# defaults file for tripleo_overcloud_netenv_validate +openstack_bin: openstack +tripleo_overcloud_netenv_validate_debug: false +tripleo_overcloud_netenv_validate_file: +tripleo_overcloud_netenv_validate_home_dir: "{{ ansible_env.HOME }}" +tripleo_overcloud_netenv_validate_log_combine: true +tripleo_overcloud_netenv_validate_log_output: true +tripleo_overcloud_netenv_validate_log: "{{ tripleo_overcloud_netenv_validate_home_dir }}/overcloud_netenv_validate.log" +tripleo_overcloud_netenv_validate_poll: 10 +tripleo_overcloud_netenv_validate_timeout: 3600 diff --git a/roles/tripleo_overcloud_netenv_validate/meta/main.yml b/roles/tripleo_overcloud_netenv_validate/meta/main.yml new file mode 100644 index 0000000..d03c597 --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/meta/main.yml @@ -0,0 +1,42 @@ +--- +# Copyright 2020 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_netenv_validate + 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_netenv_validate/molecule/default/converge.yml b/roles/tripleo_overcloud_netenv_validate/molecule/default/converge.yml new file mode 100644 index 0000000..aa5a3d1 --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/molecule/default/converge.yml @@ -0,0 +1,32 @@ +--- +- name: Converge + hosts: all + collections: + - tripleo.operator + vars: + openstack_bin: echo + tripleo_overcloud_netenv_validate_log_output: false + tripleo_overcloud_netenv_validate_poll: 1 + tripleo_overcloud_netenv_validate_debug: true + tasks: + + - name: "Include tripleo_overcloud_netenv_validate" + include_role: + name: "tripleo_overcloud_netenv_validate" + + - name: Check role + assert: + that: + - tripleo_overcloud_netenv_validate_output == "overcloud netenv validate" + + - name: Assert "tripleo_overcloud_netenv_validate_file" + include_role: + name: "tripleo_overcloud_netenv_validate" + vars: + tripleo_overcloud_netenv_validate_file: /tmp/foo.yaml + + - name: Validate tripleo_overcloud_netenv_validate_file + assert: + that: + - tripleo_overcloud_netenv_validate_output == + "overcloud netenv validate --file /tmp/foo.yaml" diff --git a/roles/tripleo_overcloud_netenv_validate/molecule/default/molecule.yml b/roles/tripleo_overcloud_netenv_validate/molecule/default/molecule.yml new file mode 100644 index 0000000..2841806 --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/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_netenv_validate/molecule/default/prepare.yml b/roles/tripleo_overcloud_netenv_validate/molecule/default/prepare.yml new file mode 100644 index 0000000..63bb6ab --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/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_netenv_validate/tasks/main.yml b/roles/tripleo_overcloud_netenv_validate/tasks/main.yml new file mode 100644 index 0000000..0342184 --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/tasks/main.yml @@ -0,0 +1,45 @@ +--- +# tasks file for tripleo_overcloud_netenv_validate +- name: Set overcloud netenv validate facts + set_fact: + _validate_cmd: >- + {{ openstack_bin }} overcloud netenv validate + {{ tripleo_overcloud_netenv_validate_file | ternary('--file $NETENV_FILE', '') }} + {{ tripleo_overcloud_netenv_validate_log_output | ternary((">" ~ tripleo_overcloud_netenv_validate_log), '') }} + {{ tripleo_overcloud_netenv_validate_log_combine | ternary("2>&1", '') }} + _validate_env: + NETENV_FILE: "{{ tripleo_overcloud_netenv_validate_file | quote }}" + +- name: Preserve existing log file if exists + timestamp_file: + path: "{{ tripleo_overcloud_netenv_validate_log }}" + when: tripleo_overcloud_netenv_validate_log_output|bool + +- name: Show debug information + when: tripleo_overcloud_netenv_validate_debug|bool + block: + - name: Show the command + debug: + var: _validate_cmd + + - name: Show the environment + debug: + var: _validate_env + +- name: Run overcloud netenv validate + shell: "{{ _validate_cmd }}" # noqa 305 + environment: "{{ _validate_env }}" + args: + executable: /bin/bash + chdir: "{{ tripleo_overcloud_netenv_validate_home_dir }}" + warn: false + register: tripleo_overcloud_netenv_validate_result + async: "{{ tripleo_overcloud_netenv_validate_timeout }}" + poll: "{{ tripleo_overcloud_netenv_validate_poll }}" + changed_when: false + when: not ansible_check_mode|bool + + +- name: Set output fact + set_fact: + tripleo_overcloud_netenv_validate_output: "{{ tripleo_overcloud_netenv_validate_result.stdout }}" diff --git a/roles/tripleo_overcloud_netenv_validate/tests/inventory b/roles/tripleo_overcloud_netenv_validate/tests/inventory new file mode 100644 index 0000000..2fbb50c --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/tests/inventory @@ -0,0 +1 @@ +localhost diff --git a/roles/tripleo_overcloud_netenv_validate/tests/test.yml b/roles/tripleo_overcloud_netenv_validate/tests/test.yml new file mode 100644 index 0000000..5f3fa1c --- /dev/null +++ b/roles/tripleo_overcloud_netenv_validate/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - tripleo_overcloud_netenv_validate diff --git a/zuul.d/molecule.yaml b/zuul.d/molecule.yaml index 6abb3db..765e3e7 100644 --- a/zuul.d/molecule.yaml +++ b/zuul.d/molecule.yaml @@ -18,6 +18,7 @@ - tripleo-operator-molecule-tripleo_overcloud_export - tripleo-operator-molecule-tripleo_overcloud_failures - tripleo-operator-molecule-tripleo_overcloud_image_build + - tripleo-operator-molecule-tripleo_overcloud_netenv_validate - tripleo-operator-molecule-tripleo_overcloud_node_bios_configure - tripleo-operator-molecule-tripleo_overcloud_node_bios_reset - tripleo-operator-molecule-tripleo_overcloud_node_clean @@ -55,6 +56,7 @@ - tripleo-operator-molecule-tripleo_overcloud_export - tripleo-operator-molecule-tripleo_overcloud_failures - tripleo-operator-molecule-tripleo_overcloud_image_build + - tripleo-operator-molecule-tripleo_overcloud_netenv_validate - tripleo-operator-molecule-tripleo_overcloud_node_bios_configure - tripleo-operator-molecule-tripleo_overcloud_node_bios_reset - tripleo-operator-molecule-tripleo_overcloud_node_clean @@ -273,6 +275,20 @@ vars: tox_extra_args: tripleo_overcloud_image_build +- job: + files: + - ^roles/tripleo_overcloud_netenv_validate/.* + - ^bindep.txt + - ^galaxy.yml + - ^requirements.txt + - ^setup.cfg + - ^test-requirements.txt + - ^tox.ini + name: tripleo-operator-molecule-tripleo_overcloud_netenv_validate + parent: tripleo-operator-molecule-base + vars: + tox_extra_args: tripleo_overcloud_netenv_validate + - job: files: - ^roles/tripleo_overcloud_node_bios_configure/.*