Add role tripleo_overcloud_node_extract_provisioned

This wraps the recently added command `overcloud node extract
provisioned`.

Change-Id: I20e7f611510443f116750ecbe8eb5aee9eff4a47
Blueprint: nova-less-deploy

doc/source/roles/role-tripleo_overcloud_node_extract_provisioned.rst

@@ -0,0 +1,6 @@
+=================================================
+Role - tripleo_overcloud_node_extract_provisioned
+=================================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_extract_provisioned

doc/source/roles/role-tripleo_overcloud_node_provision.rst

@@ -0,0 +1,6 @@
+=======================================
+Role - tripleo_overcloud_node_provision
+=======================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_provision

roles/tripleo_overcloud_node_extract_provisioned/README.md

@@ -0,0 +1,58 @@
+tripleo_overcloud_node_extract_provisioned
+=========
+
+A role to extract the currently provisioned nodes in a format compatible with the
+tripleo_overcloud_node_provision role.
+
+Requirements
+------------
+
+None.
+
+Role Variables
+--------------
+
+* `tripleo_overcloud_node_extract_provisioned_debug`: (Boolean) Flag to print out the delete command. Default: False
+* `tripleo_overcloud_node_extract_provisioned_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}"
+* `tripleo_overcloud_node_extract_provisioned_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_node_extract_provisioned_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true
+* `tripleo_overcloud_node_extract_provisioned_log_output`: (Boolean) Flag to enable logging to a file. Default: true
+* `tripleo_overcloud_node_extract_provisioned_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_node_extract_provisioned_home_dir }}/overcloud_node_extract_provisioned.log"
+* `tripleo_overcloud_node_extract_provisioned_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_extract_provisioned_rc_file`.
+* `tripleo_overcloud_node_extract_provisioned_output_file`: (String) Path to an output file.
+* `tripleo_overcloud_node_extract_provisioned_overwrite_action`: (String) What action to take if `tripleo_overcloud_node_extract_provisioned_output_file` already exists. Can be one of `skip`, `error`, or `overwrite`.
+* `tripleo_overcloud_node_extract_provisioned_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_extract_provisioned_stack`: (String) Name or ID of the heat stack.
+
+Output Variables
+----------------
+
+* `tripleo_overcloud_node_extract_provisioned_output`: (String) The command standard output.
+* `tripleo_overcloud_node_extract_provisioned_result`: Ansible shell execution results
+
+Dependencies
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Example node provisioning
+
+```yaml
+- hosts: undercloud
+  gather_facts: true
+  tasks:
+    - name: Run overcloud node extract provisioned
+      import_role:
+        name: tripleo_overcloud_node_extract_provisioned
+      var:
+        tripleo_overcloud_node_extract_provisioned_debug: true
+        tripleo_overcloud_node_extract_provisioned_output_file: /home/stack/deployment.yaml
+```
+
+License
+-------
+
+Apache-2.0

roles/tripleo_overcloud_node_extract_provisioned/defaults/main.yml

@@ -0,0 +1,14 @@
+# defaults file for tripleo_overcloud_node_extract_provisioned
+---
+openstack_bin: openstack
+tripleo_overcloud_node_extract_provisioned_debug: false
+tripleo_overcloud_node_extract_provisioned_home_dir: "{{ ansible_env.HOME }}"
+tripleo_overcloud_node_extract_provisioned_generate_scripts: "{{ tripleo_generate_scripts | default(False) }}"
+tripleo_overcloud_node_extract_provisioned_log: "{{ tripleo_overcloud_node_extract_provisioned_home_dir }}/overcloud_node_extract_provisioned.log"
+tripleo_overcloud_node_extract_provisioned_log_combine: true
+tripleo_overcloud_node_extract_provisioned_log_output: true
+tripleo_overcloud_node_extract_provisioned_os_cloud: "{{ tripleo_os_cloud | default('') }}"
+tripleo_overcloud_node_extract_provisioned_output_file:
+tripleo_overcloud_node_extract_provisioned_overwrite_action: error
+tripleo_overcloud_node_extract_provisioned_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}"
+tripleo_overcloud_node_extract_provisioned_stack:

roles/tripleo_overcloud_node_extract_provisioned/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_extract_provisioned
+  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_extract_provisioned/molecule/default/converge.yml

@@ -0,0 +1,92 @@
+---
+- name: Converge
+  hosts: all
+  collections:
+    - tripleo.operator
+  vars:
+    openstack_bin: echo
+    tripleo_os_cloud: undercloud
+    tripleo_overcloud_node_extract_provisioned_log_output: false
+    tripleo_overcloud_node_extract_provisioned_debug: true
+  tasks:
+
+    - name: Call with defaults
+      include_role:
+        name: "tripleo_overcloud_node_extract_provisioned"
+
+    - name: Check command for defaults
+      assert:
+        that:
+          - tripleo_overcloud_node_extract_provisioned_output == "overcloud node extract provisioned --yes"
+
+    - name: Call with output file
+      include_role:
+        name: "tripleo_overcloud_node_extract_provisioned"
+      vars:
+        tripleo_overcloud_node_extract_provisioned_output_file: foo.yaml
+
+    - name: Check command with output file
+      assert:
+        that:
+          - tripleo_overcloud_node_extract_provisioned_output ==
+            "overcloud node extract provisioned -o foo.yaml --yes"
+
+    - name: Call with stack name
+      include_role:
+        name: "tripleo_overcloud_node_extract_provisioned"
+      vars:
+        tripleo_overcloud_node_extract_provisioned_stack: foo
+
+    - name: Check command with stack name
+      assert:
+        that:
+          - tripleo_overcloud_node_extract_provisioned_output ==
+            "overcloud node extract provisioned --stack foo --yes"
+
+    - name: Reset output fact
+      set_fact:
+        tripleo_overcloud_node_extract_provisioned_output: "reset"
+
+    - name: Create tempfile name for overwrite action tests
+      tempfile:
+        state: file
+        suffix: temp
+      register: tempfile
+
+    - name: Create tempfile for overwrite action tests
+      file:
+        state: touch
+        path: "{{ tempfile.path }}"
+
+    - name: Call with skip for existing output file
+      include_role:
+        name: "tripleo_overcloud_node_extract_provisioned"
+      vars:
+        tripleo_overcloud_node_extract_provisioned_output_file: "{{ tempfile.path }}"
+        tripleo_overcloud_node_extract_provisioned_overwrite_action: skip
+
+    - debug:
+        msg: "output {{ tripleo_overcloud_node_extract_provisioned_output }}"
+    - name: Check command call skipped
+      assert:
+        that:
+          - tripleo_overcloud_node_extract_provisioned_output == "reset"
+
+    - name: Call with error for existing output file
+      block:
+        - include_role:
+            name: "tripleo_overcloud_node_extract_provisioned"
+          vars:
+            tripleo_overcloud_node_extract_provisioned_output_file: "{{ tempfile.path }}"
+            tripleo_overcloud_node_extract_provisioned_overwrite_action: error
+      rescue:
+        - name: Flag expected error raised
+          set_fact:
+            overwrite_error_raised: true
+        - debug:
+            msg: Expected error raised due to existing output file
+
+    - name: Check command call skipped
+      assert:
+        that:
+          - tripleo_overcloud_node_extract_provisioned_output == "reset"

roles/tripleo_overcloud_node_extract_provisioned/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_extract_provisioned/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_extract_provisioned/tasks/main.yml

@@ -0,0 +1,73 @@
+---
+# tasks file for tripleo_overcloud_node_extract_provisioned
+- name: Check if output file exists
+  stat:
+      path: "{{ tripleo_overcloud_node_extract_provisioned_output_file }}"
+  register: output_file_stat
+
+- name: Raise error for existing output file
+  fail:
+      msg: "output file already exists: {{ tripleo_overcloud_node_extract_provisioned_output_file }}"
+  when:
+      - tripleo_overcloud_node_extract_provisioned_overwrite_action == 'error'
+      - output_file_stat.stat.exists
+
+- name: Output file needs to be written
+  when: not (tripleo_overcloud_node_extract_provisioned_overwrite_action == 'skip' and
+             output_file_stat.stat.exists)
+  block:
+
+      - name: Set overcloud node provision facts
+        set_fact:
+            _provision_cmd: >-
+                {{ tripleo_overcloud_node_extract_provisioned_os_cloud | ternary('', "source " ~ tripleo_overcloud_node_extract_provisioned_rc_file ~ "; ") }}
+                {{ openstack_bin }} overcloud node extract provisioned
+                {{ tripleo_overcloud_node_extract_provisioned_output_file | ternary('-o $EXTRACT_OUTPUT', '') }}
+                {{ tripleo_overcloud_node_extract_provisioned_stack | ternary('--stack $EXTRACT_STACK', '') }}
+                {{ tripleo_overcloud_node_extract_provisioned_log_output | ternary((">" ~ tripleo_overcloud_node_extract_provisioned_log), '') }}
+                {{ tripleo_overcloud_node_extract_provisioned_log_combine | ternary("2>&1", '') }}
+                --yes
+            _provision_env:
+                OS_CLOUD: "{{ tripleo_overcloud_node_extract_provisioned_os_cloud }}"
+                EXTRACT_OUTPUT: "{{ tripleo_overcloud_node_extract_provisioned_output_file | quote }}"
+                EXTRACT_STACK: "{{ tripleo_overcloud_node_extract_provisioned_stack | quote }}"
+
+      - name: Preserve existing log file if exists
+        timestamp_file:
+            path: "{{ tripleo_overcloud_node_extract_provisioned_log }}"
+        when: tripleo_overcloud_node_extract_provisioned_log_output|bool
+
+      - name: Show debug information
+        when: tripleo_overcloud_node_extract_provisioned_debug|bool
+        block:
+            - name: Show the command
+              debug:
+                  var: _provision_cmd
+
+            - name: Show the environment
+              debug:
+                  var: _provision_env
+
+      - name: Write reproducer script
+        tripleo_shell_script:
+            dest: "{{ tripleo_overcloud_node_extract_provisioned_home_dir }}/tripleo_overcloud_node_extract_provisioned.sh"
+            shell_command: "{{ _build_cmd }}"
+            shell_environment: "{{ _build_env }}"
+        when: tripleo_overcloud_node_extract_provisioned_generate_scripts|bool
+
+      - name: overcloud node extract provisioned
+        shell: "{{ _provision_cmd }}"  # noqa 305
+        environment: "{{ _provision_env }}"
+        args:
+            executable: /bin/bash
+            chdir: "{{ tripleo_overcloud_node_extract_provisioned_home_dir }}"
+            warn: false
+        register: tripleo_overcloud_node_extract_provisioned_result
+        changed_when: false
+        when: not ansible_check_mode|bool
+
+      - name: Set output fact
+        when:
+            - tripleo_overcloud_node_extract_provisioned_result.stdout is defined
+        set_fact:
+            tripleo_overcloud_node_extract_provisioned_output: "{{ tripleo_overcloud_node_extract_provisioned_result.stdout }}"

roles/tripleo_overcloud_node_extract_provisioned/tests/inventory

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

roles/tripleo_overcloud_node_extract_provisioned/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - tripleo_overcloud_node_extract_provisioned

roles/tripleo_overcloud_node_provision/README.md

@@ -1,7 +1,7 @@
 tripleo_overcloud_node_provision
 =========
 
-A role to perform overcloud ndoe provisioning with Ironic.
+A role to perform overcloud node provisioning with Ironic.
 
 Requirements
 ------------