Add overcloud node import role

Adds tripleo_overcloud_node_import_role to perform the node import
process.

Change-Id: I0903e057c3515fe20cae526f1e498e59367b9edd

roles/tripleo_overcloud_node_import/README.md

@@ -0,0 +1,66 @@
+tripleo_overcloud_node_import
+=================================
+
+A role to run node import.
+
+Requirements
+------------
+
+None.
+
+Role Variables
+--------------
+
+* `tripleo_overcloud_node_import_concurrency`: (Integer) Max number of nodes to introspect at once.
+* `tripleo_overcloud_node_import_debug`: (Boolean) Flag used to enable the debug version of commands. Default: false
+* `tripleo_overcloud_node_import_environment_file`: (String) Path to the file that contains the baremetal node information. Can be a JSON, YAML or CSV file. Default: environment.json
+* `tripleo_overcloud_node_import_home_dir`: (String) Path to the directory to execute the command in. Default: “{{ ansible_env.HOME }}”
+* `tripleo_overcloud_node_import_http_boot`: (String) Root directory for the ironic-python-agent image.
+* `tripleo_overcloud_node_import_instance_boot_option`: (String) Wheither to set instances for booting from local hard drive (local) or network (netboot).
+* `tripleo_overcloud_node_import_introspect`: (Boolean) Flag to enable introspection of the nodes when importing. Default: false
+* `tripleo_overcloud_node_import_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true
+* `tripleo_overcloud_node_import_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_import_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_node_import_home_dir }}/overcloud_node_import.log"
+* `tripleo_overcloud_node_import_no_deploy_image`: (Boolean) Flag to skip setting teh deploy kernel and ramdisk. Default: false
+* `tripleo_overcloud_node_import_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_node_import_rc_file`.
+* `tripleo_overcloud_node_import_poll`: (Integer) Number of seconds to wait between each checks to see if the deployment command has completed. Default: 10
+* `tripleo_overcloud_node_import_provide`: (Boolean) Flag to provide the nodes. Default: false
+* `tripleo_overcloud_node_import_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"
+* `tripleo_overcloud_node_import_run_validations`: (Boolean) Flag to runt he pre-deployment validations. false
+* `tripleo_overcloud_node_import_timeout`: (Integer) Time in seconds to wait for the command to complete. Default: 900
+* `tripleo_overcloud_node_import_validate_only`: (Boolean) Flag to validate teh environment file and exit without running the import. Default: false
+
+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_import_output`: (String) The command standard output.
+* `tripleo_overcloud_node_import_result`: Ansible shell execution results
+
+Dependencies
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Example overcloud node import playbook
+
+```yaml
+- hosts: undercloud
+  gather_facts: true
+  tasks:
+    - name: Introspect node
+      import_role:
+        name: tripleo_overcloud_node_import
+```
+
+License
+-------
+
+Apache-2.0

roles/tripleo_overcloud_node_import/defaults/main.yml

@@ -0,0 +1,21 @@
+---
+# defaults file for tripleo_overcloud_node_import
+openstack_bin: openstack
+tripleo_overcloud_node_import_concurrency:
+tripleo_overcloud_node_import_debug: false
+tripleo_overcloud_node_import_environment_file: environment.json
+tripleo_overcloud_node_import_home_dir: "{{ ansible_env.HOME }}"
+tripleo_overcloud_node_import_http_boot:
+tripleo_overcloud_node_import_instance_boot_option:
+tripleo_overcloud_node_import_introspect: false
+tripleo_overcloud_node_import_log: "{{ tripleo_overcloud_node_import_home_dir }}/overcloud_node_import.log"
+tripleo_overcloud_node_import_log_combine: true
+tripleo_overcloud_node_import_log_output: true
+tripleo_overcloud_node_import_no_deploy_image: false
+tripleo_overcloud_node_import_os_cloud: "{{ tripleo_os_cloud | default('') }}"
+tripleo_overcloud_node_import_poll: 10
+tripleo_overcloud_node_import_provide: false
+tripleo_overcloud_node_import_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}"
+tripleo_overcloud_node_import_run_validations: false
+tripleo_overcloud_node_import_timeout: 900
+tripleo_overcloud_node_import_validate_only: false

roles/tripleo_overcloud_node_import/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_import
+  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_node_import/molecule/default/converge.yml

@@ -0,0 +1,121 @@
+---
+- name: Converge
+  hosts: all
+  collections:
+    - tripleo.operator
+  vars:
+    openstack_bin: echo
+    tripleo_os_cloud: undercloud
+    tripleo_overcloud_node_import_debug: true
+    tripleo_overcloud_node_import_log_combine: false
+    tripleo_overcloud_node_import_log_output: false
+    tripleo_overcloud_node_import_poll: 1
+  tasks:
+
+    - name: "Include tripleo_overcloud_node_import"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+
+    - name: Check role
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_concurrency"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_concurrency: 10
+
+    - name: Assert "tripleo_overcloud_node_import_concurrency"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --concurrency 10 environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_environment_file"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_environment_file: /tmp/foo.json
+
+    - name: Assert "tripleo_overcloud_node_import_environment_file"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import /tmp/foo.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_http_boot"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_http_boot: /foo
+
+    - name: Assert "tripleo_overcloud_node_import_http_boot"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --http-boot /foo environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_instance_boot_option"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_instance_boot_option: local
+
+    - name: Assert "tripleo_overcloud_node_import_instance_boot_option"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --instance-boot-option local environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_introspect"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_introspect: true
+
+    - name: Assert "tripleo_overcloud_node_import_introspect"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --introspect environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_no_deploy_image"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_no_deploy_image: true
+
+    - name: Assert "tripleo_overcloud_node_import_no_deploy_image"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --no-deploy-image environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_provide"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_provide: true
+
+    - name: Assert "tripleo_overcloud_node_import_provide"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --provide environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_run_validations"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_run_validations: true
+
+    - name: Assert "tripleo_overcloud_node_import_run_validations"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --run-validations environment.json"
+
+    - name: Check parameter "tripleo_overcloud_node_import_validate_only"
+      include_role:
+        name: "tripleo_overcloud_node_import"
+      vars:
+        tripleo_overcloud_node_import_validate_only: true
+
+    - name: Assert "tripleo_overcloud_node_import_validate_only"
+      assert:
+        that:
+          - tripleo_overcloud_node_import_output == "overcloud node import --validate-only environment.json"

roles/tripleo_overcloud_node_import/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_node_import/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_node_import/tasks/main.yml

@@ -0,0 +1,46 @@
+---
+# tasks file for tripleo_overcloud_node_import
+- name: Setup overcloud node import command
+  set_fact:
+    _import_cmd: >-
+      {{ tripleo_overcloud_node_import_os_cloud | ternary('', "source " ~ tripleo_overcloud_node_import_rc_file ~ "; ") }}
+      {{ openstack_bin }} overcloud node import
+      {{ tripleo_overcloud_node_import_introspect | ternary('--introspect', '') }}
+      {{ tripleo_overcloud_node_import_run_validations | ternary('--run-validations', '') }}
+      {{ tripleo_overcloud_node_import_validate_only | ternary('--validate-only', '') }}
+      {{ tripleo_overcloud_node_import_provide | ternary('--provide', '') }}
+      {{ tripleo_overcloud_node_import_no_deploy_image | ternary('--no-deploy-image', '') }}
+      {{ tripleo_overcloud_node_import_instance_boot_option | ternary('--instance-boot-option $IMPORT_INSTANCE_BOOT_OPTION', '') }}
+      {{ tripleo_overcloud_node_import_http_boot | ternary('--http-boot $IMPORT_HTTP_BOOT', '') }}
+      {{ tripleo_overcloud_node_import_concurrency | ternary('--concurrency ' ~ tripleo_overcloud_node_import_concurrency, '') }}
+      {{ tripleo_overcloud_node_import_environment_file }}
+    _import_env:
+      IMPORT_INSTANCE_BOOT_OPTION: "{{ tripleo_overcloud_node_import_instance_boot_option }}"
+      IMPORT_HTTP_BOOT: "{{ tripleo_overcloud_node_import_http_boot }}"
+      OS_CLOUD: "{{ tripleo_overcloud_node_import_os_cloud }}"
+
+- name: Show debug information
+  when: tripleo_overcloud_node_import_debug|bool
+  block:
+    - name: Show the node import command
+      debug:
+        var: _import_cmd
+
+    - name: Show the node import environment
+      debug:
+        var: _import_env
+
+- name: Import node(s)
+  shell: "{{ _import_cmd }}"  # noqa 305
+  environment: "{{ _import_env }}"
+  args:
+    chdir: "{{ tripleo_overcloud_node_import_home_dir }}"
+    warn: false
+  async: "{{ tripleo_overcloud_node_import_timeout }}"
+  poll: "{{ tripleo_overcloud_node_import_poll }}"
+  register: tripleo_overcloud_node_import_result
+  changed_when: true
+
+- name: Set output fact
+  set_fact:
+    tripleo_overcloud_node_import_output: "{{ tripleo_overcloud_node_import_result.stdout }}"

roles/tripleo_overcloud_node_import/tests/inventory

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

roles/tripleo_overcloud_node_import/tests/test.yml

@@ -0,0 +1,4 @@
+---
+- hosts: localhost
+  roles:
+    - tripleo_overcloud_node_import

zuul.d/molecule.yaml

@@ -17,6 +17,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_node_clean
       - tripleo-operator-molecule-tripleo_overcloud_node_configure
       - tripleo-operator-molecule-tripleo_overcloud_node_introspect
+      - tripleo-operator-molecule-tripleo_overcloud_node_import
       - tripleo-operator-molecule-tripleo_undercloud_backup
       - tripleo-operator-molecule-tripleo_undercloud_install
       - tripleo-operator-molecule-tripleo_undercloud_minion_install
@@ -40,6 +41,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_node_clean
       - tripleo-operator-molecule-tripleo_overcloud_node_configure
       - tripleo-operator-molecule-tripleo_overcloud_node_introspect
+      - tripleo-operator-molecule-tripleo_overcloud_node_import
       - tripleo-operator-molecule-tripleo_undercloud_backup
       - tripleo-operator-molecule-tripleo_undercloud_install
       - tripleo-operator-molecule-tripleo_undercloud_minion_install
@@ -143,6 +145,14 @@
     vars:
       tox_extra_args: tripleo_overcloud_node_introspect
 
+- job:
+    files:
+      - ^roles/tripleo_overcloud_node_import/.*
+    name: tripleo-operator-molecule-tripleo_overcloud_node_import
+    parent: tripleo-operator-molecule-base
+    vars:
+      tox_extra_args: tripleo_overcloud_node_import
+
 - job:
     files:
       - ^roles/tripleo_overcloud_node_configure/.*