From eaf66208cb1c6607f6b7b55209e6979d368860e9 Mon Sep 17 00:00:00 2001 From: Alex Schultz Date: Tue, 17 Mar 2020 10:39:08 -0600 Subject: [PATCH] Add overcloud node provision Adds tripleo_overcloud_node_provision to perform baremetal node provisioning via Ironic. Change-Id: I8b670ef8006609e3ce3e1bb9f6a4f177dc3ad477 --- .../README.md | 62 +++++++++++ .../defaults/main.yml | 19 ++++ .../meta/main.yml | 42 +++++++ .../molecule/default/converge.yml | 105 ++++++++++++++++++ .../molecule/default/molecule.yml | 19 ++++ .../molecule/default/prepare.yml | 8 ++ .../tasks/main.yml | 59 ++++++++++ .../tests/inventory | 1 + .../tests/test.yml | 5 + zuul.d/molecule.yaml | 16 +++ 10 files changed, 336 insertions(+) create mode 100644 roles/tripleo_overcloud_node_provision/README.md create mode 100644 roles/tripleo_overcloud_node_provision/defaults/main.yml create mode 100644 roles/tripleo_overcloud_node_provision/meta/main.yml create mode 100644 roles/tripleo_overcloud_node_provision/molecule/default/converge.yml create mode 100644 roles/tripleo_overcloud_node_provision/molecule/default/molecule.yml create mode 100644 roles/tripleo_overcloud_node_provision/molecule/default/prepare.yml create mode 100644 roles/tripleo_overcloud_node_provision/tasks/main.yml create mode 100644 roles/tripleo_overcloud_node_provision/tests/inventory create mode 100644 roles/tripleo_overcloud_node_provision/tests/test.yml diff --git a/roles/tripleo_overcloud_node_provision/README.md b/roles/tripleo_overcloud_node_provision/README.md new file mode 100644 index 0000000..97b9470 --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/README.md @@ -0,0 +1,62 @@ +tripleo_overcloud_node_provision +========= + +A role to perform overcloud ndoe provisioning with Ironic. + +Requirements +------------ + +None. + +Role Variables +-------------- + +* `tripleo_overcloud_node_provision_concurrency`: (Integer) Number of nodes to provision at once +* `tripleo_overcloud_node_provision_debug`: (Boolean) Flag to print out the delete command. Default: False +* `tripleo_overcloud_node_provision_deployment_file`: (String) REQUIRED. File path to the deployment file describing the nodes. +* `tripleo_overcloud_node_provision_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" +* `tripleo_overcloud_node_provision_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_node_provision_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_node_provision_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_node_provision_home_dir }}/overcloud_node_provision.log" +* `tripleo_overcloud_node_provision_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_provision_rc_file`. +* `tripleo_overcloud_node_provision_output_file`: (String) Path to an output file. +* `tripleo_overcloud_node_provision_overcloud_ssh_key`: (String) Key path for ssh access to overcloud nodes. When not defined, the key will attempt to be autodected. +* `tripleo_overcloud_node_provision_overcloud_ssh_user`: (String) User for ssh access to the newly deployed nodes. +* `tripleo_overcloud_node_provision_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10 +* `tripleo_overcloud_node_provision_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" +* `tripleo_overcloud_node_provision_stack`: (String) Name or ID of the heat stack. +* `tripleo_overcloud_node_provision_timeout_arg`: (Integer) Numebr of seconds to wait for node to complete. Should be smaller than the `overcloud_node_provision_timeout` variable. +* `tripleo_overcloud_node_provision_timeout`: (Integer) Number in seconds to wait for the ansible execution of the command to finish. Default: 3700 + +Output Variables +---------------- + +* `tripleo_overcloud_node_provision_output`: (String) The command standard output. +* `tripleo_overcloud_node_provision_result`: Ansible shell execution results + +Dependencies +------------ + +None. + +Example Playbook +---------------- + +Example node provisioning + +```yaml +- hosts: undercloud + gather_facts: true + tasks: + - name: Run overcloud node provision + import_role: + name: tripleo_overcloud_node_provision + var: + tripleo_overcloud_node_provision_debug: true + tripleo_overcloud_node_provision_deployment_file: /home/stack/deployment.yaml +``` + +License +------- + +Apache-2.0 diff --git a/roles/tripleo_overcloud_node_provision/defaults/main.yml b/roles/tripleo_overcloud_node_provision/defaults/main.yml new file mode 100644 index 0000000..4f107e4 --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/defaults/main.yml @@ -0,0 +1,19 @@ +--- +# defaults file for tripleo_overcloud_node_provision +openstack_bin: openstack +tripleo_overcloud_node_provision_concurrency: +tripleo_overcloud_node_provision_debug: false +tripleo_overcloud_node_provision_deployment_file: +tripleo_overcloud_node_provision_home_dir: "{{ ansible_env.HOME }}" +tripleo_overcloud_node_provision_log: "{{ tripleo_overcloud_node_provision_home_dir }}/overcloud_node_provision.log" +tripleo_overcloud_node_provision_log_combine: true +tripleo_overcloud_node_provision_log_output: true +tripleo_overcloud_node_provision_os_cloud: "{{ tripleo_os_cloud | default('') }}" +tripleo_overcloud_node_provision_output_file: +tripleo_overcloud_node_provision_overcloud_ssh_key: +tripleo_overcloud_node_provision_overcloud_ssh_user: +tripleo_overcloud_node_provision_poll: 10 +tripleo_overcloud_node_provision_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}" +tripleo_overcloud_node_provision_stack: +tripleo_overcloud_node_provision_timeout: 3700 +tripleo_overcloud_node_provision_timeout_arg: diff --git a/roles/tripleo_overcloud_node_provision/meta/main.yml b/roles/tripleo_overcloud_node_provision/meta/main.yml new file mode 100644 index 0000000..b6e30c8 --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/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_node_provision + 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_provision/molecule/default/converge.yml b/roles/tripleo_overcloud_node_provision/molecule/default/converge.yml new file mode 100644 index 0000000..cd3fd19 --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/molecule/default/converge.yml @@ -0,0 +1,105 @@ +--- +- name: Converge + hosts: all + collections: + - tripleo.operator + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_node_provision_log_output: false + tripleo_overcloud_node_provision_poll: 1 + tripleo_overcloud_node_provision_debug: true + tasks: + + - name: "Include tripleo_overcloud_node_provision" + include_role: + name: "tripleo_overcloud_node_provision" + + - name: Check role + assert: + that: + - tripleo_overcloud_node_provision_output == "overcloud node provision" + + - name: Assert "tripleo_overcloud_node_provision_output_file" + include_role: + name: "tripleo_overcloud_node_provision" + vars: + tripleo_overcloud_node_provision_output_file: foo.yaml + + - name: Validate tripleo_overcloud_node_provision_output_file + assert: + that: + - tripleo_overcloud_node_provision_output == + "overcloud node provision -o foo.yaml" + + - name: Assert "tripleo_overcloud_node_provision_stack" + include_role: + name: "tripleo_overcloud_node_provision" + vars: + tripleo_overcloud_node_provision_stack: foo + + - name: Validate tripleo_overcloud_node_provision_stack + assert: + that: + - tripleo_overcloud_node_provision_output == + "overcloud node provision --stack foo" + + - name: Assert "tripleo_overcloud_node_provision_overcloud_ssh_user" + include_role: + name: "tripleo_overcloud_node_provision" + vars: + tripleo_overcloud_node_provision_overcloud_ssh_user: foo + + - name: Validate tripleo_overcloud_node_provision_overcloud_ssh_user + assert: + that: + - tripleo_overcloud_node_provision_output == + "overcloud node provision --overcloud-ssh-user foo" + + - name: Assert "tripleo_overcloud_node_provision_overcloud_ssh_key" + include_role: + name: "tripleo_overcloud_node_provision" + vars: + tripleo_overcloud_node_provision_overcloud_ssh_key: foo.pub + + - name: Validate tripleo_overcloud_node_provision_overcloud_ssh_key + assert: + that: + - tripleo_overcloud_node_provision_output == + "overcloud node provision --overcloud-ssh-key foo.pub" + + - name: Assert "tripleo_overcloud_node_provision_concurrency" + include_role: + name: "tripleo_overcloud_node_provision" + vars: + tripleo_overcloud_node_provision_concurrency: 5 + + - name: Validate tripleo_overcloud_node_provision_concurrency + assert: + that: + - tripleo_overcloud_node_provision_output == + "overcloud node provision --concurrency 5" + + - name: Assert "tripleo_overcloud_node_provision_timeout_arg" + include_role: + name: "tripleo_overcloud_node_provision" + vars: + tripleo_overcloud_node_provision_timeout_arg: 12 + + - name: Validate tripleo_overcloud_node_provision_timeout_arg + assert: + that: + - tripleo_overcloud_node_provision_output == + "overcloud node provision --timeout 12" + + - name: Assert "tripleo_overcloud_node_provision_deployment_file" + include_role: + name: "tripleo_overcloud_node_provision" + vars: + tripleo_overcloud_node_provision_deployment_file: deploy.yaml + + - name: Validate tripleo_overcloud_node_provision_deployment_file + assert: + that: + - tripleo_overcloud_node_provision_output == + "overcloud node provision deploy.yaml" diff --git a/roles/tripleo_overcloud_node_provision/molecule/default/molecule.yml b/roles/tripleo_overcloud_node_provision/molecule/default/molecule.yml new file mode 100644 index 0000000..2841806 --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/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_node_provision/molecule/default/prepare.yml b/roles/tripleo_overcloud_node_provision/molecule/default/prepare.yml new file mode 100644 index 0000000..63bb6ab --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/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_node_provision/tasks/main.yml b/roles/tripleo_overcloud_node_provision/tasks/main.yml new file mode 100644 index 0000000..13a65ae --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/tasks/main.yml @@ -0,0 +1,59 @@ +--- +# tasks file for tripleo_overcloud_node_provision +- name: Set overcloud node provision facts + set_fact: + _provision_cmd: >- + {{ tripleo_overcloud_node_provision_os_cloud | ternary('', "source " ~ tripleo_overcloud_node_provision_rc_file ~ "; ") }} + {{ openstack_bin }} overcloud node provision + {{ tripleo_overcloud_node_provision_output_file | ternary('-o $PROVISION_OUTPUT', '') }} + {{ tripleo_overcloud_node_provision_stack | ternary('--stack $PROVISION_STACK', '') }} + {{ tripleo_overcloud_node_provision_overcloud_ssh_user | ternary('--overcloud-ssh-user $PROVISION_USER', '') }} + {{ tripleo_overcloud_node_provision_overcloud_ssh_key | ternary('--overcloud-ssh-key $PROVISION_KEY', '') }} + {{ tripleo_overcloud_node_provision_concurrency | ternary('--concurrency $PROVISION_CONCURRENCY', '') }} + {{ tripleo_overcloud_node_provision_timeout_arg | ternary('--timeout $PROVISION_TIMEOUT', '') }} + {{ tripleo_overcloud_node_provision_deployment_file }} + {{ tripleo_overcloud_node_provision_log_output | ternary((">" ~ tripleo_overcloud_node_provision_log), '') }} + {{ tripleo_overcloud_node_provision_log_combine | ternary("2>&1", '') }} + _provision_env: + OS_CLOUD: "{{ tripleo_overcloud_node_provision_os_cloud }}" + PROVISION_OUTPUT: "{{ tripleo_overcloud_node_provision_output_file | quote }}" + PROVISION_STACK: "{{ tripleo_overcloud_node_provision_stack | quote }}" + PROVISION_USER: "{{ tripleo_overcloud_node_provision_overcloud_ssh_user | quote }}" + PROVISION_KEY: "{{ tripleo_overcloud_node_provision_overcloud_ssh_key | quote }}" + PROVISION_CONCURRENCY: "{{ tripleo_overcloud_node_provision_concurrency | quote }}" + PROVISION_TIMEOUT: "{{ tripleo_overcloud_node_provision_timeout_arg | quote }}" + + +- name: Preserve existing log file if exists + timestamp_file: + path: "{{ tripleo_overcloud_node_provision_log }}" + when: tripleo_overcloud_node_provision_log_output|bool + +- name: Show debug information + when: tripleo_overcloud_node_provision_debug|bool + block: + - name: Show the command + debug: + var: _provision_cmd + + - name: Show the environment + debug: + var: _provision_env + +- name: overcloud node provision + shell: "{{ _provision_cmd }}" # noqa 305 + environment: "{{ _provision_env }}" + args: + executable: /bin/bash + chdir: "{{ tripleo_overcloud_node_provision_home_dir }}" + warn: false + register: tripleo_overcloud_node_provision_result + async: "{{ tripleo_overcloud_node_provision_timeout }}" + poll: "{{ tripleo_overcloud_node_provision_poll }}" + changed_when: false + when: not ansible_check_mode|bool + + +- name: Set output fact + set_fact: + tripleo_overcloud_node_provision_output: "{{ tripleo_overcloud_node_provision_result.stdout }}" diff --git a/roles/tripleo_overcloud_node_provision/tests/inventory b/roles/tripleo_overcloud_node_provision/tests/inventory new file mode 100644 index 0000000..2fbb50c --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/tests/inventory @@ -0,0 +1 @@ +localhost diff --git a/roles/tripleo_overcloud_node_provision/tests/test.yml b/roles/tripleo_overcloud_node_provision/tests/test.yml new file mode 100644 index 0000000..491f94d --- /dev/null +++ b/roles/tripleo_overcloud_node_provision/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - tripleo_overcloud_node_provision diff --git a/zuul.d/molecule.yaml b/zuul.d/molecule.yaml index a8fbd9d..59688bb 100644 --- a/zuul.d/molecule.yaml +++ b/zuul.d/molecule.yaml @@ -27,6 +27,7 @@ - tripleo-operator-molecule-tripleo_overcloud_node_introspect - tripleo-operator-molecule-tripleo_overcloud_node_import - tripleo-operator-molecule-tripleo_overcloud_node_provide + - tripleo-operator-molecule-tripleo_overcloud_node_provision - tripleo-operator-molecule-tripleo_overcloud_update_converge - tripleo-operator-molecule-tripleo_overcloud_update_prepare - tripleo-operator-molecule-tripleo_overcloud_update_run @@ -65,6 +66,7 @@ - tripleo-operator-molecule-tripleo_overcloud_node_introspect - tripleo-operator-molecule-tripleo_overcloud_node_import - tripleo-operator-molecule-tripleo_overcloud_node_provide + - tripleo-operator-molecule-tripleo_overcloud_node_provision - tripleo-operator-molecule-tripleo_overcloud_update_converge - tripleo-operator-molecule-tripleo_overcloud_update_prepare - tripleo-operator-molecule-tripleo_overcloud_update_run @@ -333,6 +335,20 @@ vars: tox_extra_args: tripleo_overcloud_node_provide +- job: + files: + - ^roles/tripleo_overcloud_node_provision/.* + - ^bindep.txt + - ^galaxy.yml + - ^requirements.txt + - ^setup.cfg + - ^test-requirements.txt + - ^tox.ini + name: tripleo-operator-molecule-tripleo_overcloud_node_provision + parent: tripleo-operator-molecule-base + vars: + tox_extra_args: tripleo_overcloud_node_provision + - job: files: - ^roles/tripleo_overcloud_node_configure/.*