Add overcloud external update run

Adds tripleo_overcloud_external_update_run to execute an external update
process.

Change-Id: Ibe1da4d580061e15bd4ccf8cb162f76573cfb0a8

roles/tripleo_overcloud_external_update_run/README.md

@@ -0,0 +1,62 @@
+tripleo_overcloud_external_update_run
+=====================================
+
+A role to execute an overcloud external update.
+
+Requirements
+------------
+
+None.
+
+Role Variables
+--------------
+
+* `tripleo_overcloud_external_update_run_debug`: (Boolean) Flag to print out the command that is run. Default: false
+* `tripleo_overcloud_external_update_run_extra_vars`: (List) List of key=value or yaml/json file ansible refernce. Default: []
+* `tripleo_overcloud_external_update_run_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}"
+* `tripleo_overcloud_external_update_run_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true
+* `tripleo_overcloud_external_update_run_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_external_update_run_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_external_update_run_home_dir }}/overcloud_external_update_run.log"
+* `tripleo_overcloud_external_update_run_poll`: (Integer) Number of seconds to wait between each checks to see if the deployment command has completed. Default: 10
+* `tripleo_overcloud_external_update_run_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_external_update_run_skip_tags`: (String) A string specifying the tag or a comma seperated list of tags to be passed as --skip-tags to the playbook.
+* `tripleo_overcloud_external_update_run_ssh_user`: (String) Username of user to be used as the ssh user.
+* `tripleo_overcloud_external_update_run_stack`: (String) Name of the stack to deploy.
+* `tripleo_overcloud_external_update_run_static_inventory`: (String) Path to an existing ansible inventory to use.
+* `tripleo_overcloud_external_update_run_tags`: (String) A string specifying the tag or comma sperate list of tags to be passed as --tags to the playbook.
+* `tripleo_overcloud_external_update_run_timeout`: (Integer) Number in seconds to wait for the ansible execution of the deployment command to finish. Default: 5700
+
+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_external_update_run_output`: (String) The command standard output.
+* `tripleo_overcloud_external_update_run_result`: Ansible shell execution results
+
+Dependencies
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Example overcloud external update run execution playbook
+
+```yaml
+- hosts: undercloud
+  gather_facts: true
+  tasks:
+    - name: Run overcloud external update run
+      import_role:
+        name: tripleo_overcloud_external_update_run
+```
+
+License
+-------
+
+Apache-2.0

roles/tripleo_overcloud_external_update_run/defaults/main.yml

@@ -0,0 +1,19 @@
+---
+# defaults file for tripleo_overcloud_external_update_run
+openstack_bin: openstack
+tripleo_overcloud_external_update_run_debug: false
+tripleo_overcloud_external_update_run_extra_vars: []
+tripleo_overcloud_external_update_run_home_dir: "{{ ansible_env.HOME }}"
+tripleo_overcloud_external_update_run_log: "{{ tripleo_overcloud_external_update_run_home_dir }}/overcloud_external_update_run.log"
+tripleo_overcloud_external_update_run_log_combine: true
+tripleo_overcloud_external_update_run_log_output: true
+tripleo_overcloud_external_update_run_os_cloud: "{{ tripleo_os_cloud | default('') }}"
+tripleo_overcloud_external_update_run_playbook: []
+tripleo_overcloud_external_update_run_poll: 10
+tripleo_overcloud_external_update_run_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}"
+tripleo_overcloud_external_update_run_skip_tags:
+tripleo_overcloud_external_update_run_ssh_user:
+tripleo_overcloud_external_update_run_stack:
+tripleo_overcloud_external_update_run_static_inventory:
+tripleo_overcloud_external_update_run_tags:
+tripleo_overcloud_external_update_run_timeout: 5700

roles/tripleo_overcloud_external_update_run/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_external_update_prepare
+  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_external_update_run/molecule/default/converge.yml

@@ -0,0 +1,91 @@
+---
+- name: Converge
+  hosts: all
+  collections:
+    - tripleo.operator
+  vars:
+    openstack_bin: echo
+    tripleo_os_cloud: undercloud
+    tripleo_overcloud_external_update_run_debug: true
+    tripleo_overcloud_external_update_run_log_output: false
+    tripleo_overcloud_external_update_run_log_combine: false
+    tripleo_overcloud_external_update_run_poll: 1
+  tasks:
+
+    - name: "Include tripleo_overcloud_external_update_run"
+      include_role:
+        name: "tripleo_overcloud_external_update_run"
+
+    - name: Check role
+      assert:
+        that:
+          - tripleo_overcloud_external_update_run_output == "overcloud external-update run"
+
+    - name: Check parameter "tripleo_overcloud_external_update_run_extra_vars"
+      include_role:
+        name: "tripleo_overcloud_external_update_run"
+      vars:
+        tripleo_overcloud_external_update_run_extra_vars:
+          - 'foo=bar'
+          - '@foobar.yaml'
+
+    - name: Assert "tripleo_overcloud_external_update_run_extra_vars"
+      assert:
+        that:
+          - tripleo_overcloud_external_update_run_output ==
+            "overcloud external-update run --extra-vars foo=bar --extra-vars @foobar.yaml"
+
+    - name: Check parameter "tripleo_overcloud_external_update_run_stack"
+      include_role:
+        name: "tripleo_overcloud_external_update_run"
+      vars:
+        tripleo_overcloud_external_update_run_stack: test
+
+    - name: Assert "tripleo_overcloud_external_update_run_stack"
+      assert:
+        that:
+          - tripleo_overcloud_external_update_run_output == "overcloud external-update run --stack test"
+
+    - name: Check parameter "tripleo_overcloud_external_update_run_tags"
+      include_role:
+        name: "tripleo_overcloud_external_update_run"
+      vars:
+        tripleo_overcloud_external_update_run_tags: test
+
+    - name: Assert "tripleo_overcloud_external_update_run_tags"
+      assert:
+        that:
+          - tripleo_overcloud_external_update_run_output == "overcloud external-update run --tags test"
+
+    - name: Check parameter "tripleo_overcloud_external_update_run_skip_tags"
+      include_role:
+        name: "tripleo_overcloud_external_update_run"
+      vars:
+        tripleo_overcloud_external_update_run_skip_tags: test
+
+    - name: Assert "tripleo_overcloud_external_update_run_skip_tags"
+      assert:
+        that:
+          - tripleo_overcloud_external_update_run_output == "overcloud external-update run --skip-tags test"
+
+    - name: Check parameter "tripleo_overcloud_external_update_run_ssh_user"
+      include_role:
+        name: "tripleo_overcloud_external_update_run"
+      vars:
+        tripleo_overcloud_external_update_run_ssh_user: username
+
+    - name: Assert "tripleo_overcloud_external_update_run_ssh_user"
+      assert:
+        that:
+          - tripleo_overcloud_external_update_run_output == "overcloud external-update run --ssh-user username"
+
+    - name: Check parameter "tripleo_overcloud_external_update_run_static_inventory"
+      include_role:
+        name: "tripleo_overcloud_external_update_run"
+      vars:
+        tripleo_overcloud_external_update_run_static_inventory: /home/foo/inventory.yml
+
+    - name: Assert "tripleo_overcloud_external_update_run_static_inventory"
+      assert:
+        that:
+          - tripleo_overcloud_external_update_run_output == "overcloud external-update run --static-inventory /home/foo/inventory.yml"

roles/tripleo_overcloud_external_update_run/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_external_update_run/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_external_update_run/tasks/main.yml

@@ -0,0 +1,54 @@
+---
+# tasks file for tripleo_overcloud_external_update_run
+- name: Setup overcloud external-update run facts
+  set_fact:
+    _update_run_cmd: >-
+      {{ tripleo_overcloud_external_update_run_os_cloud | ternary('', "source " ~ tripleo_overcloud_external_update_run_rc_file ~ "; ") }}
+      {{ openstack_bin }} overcloud external-update run
+      {{ tripleo_overcloud_external_update_run_extra_vars | tripleo.operator.shell_arg_list('--extra-vars') }}
+      {{ tripleo_overcloud_external_update_run_ssh_user | ternary('--ssh-user $UPDATE_SSH_USER', '') }}
+      {{ tripleo_overcloud_external_update_run_tags | ternary('--tags $UPDATE_TAGS', '') }}
+      {{ tripleo_overcloud_external_update_run_skip_tags | ternary('--skip-tags $UPDATE_SKIP_TAGS', '') }}
+      {{ tripleo_overcloud_external_update_run_static_inventory | ternary('--static-inventory $UPDATE_STATIC_INVENTORY', '') }}
+      {{ tripleo_overcloud_external_update_run_stack | ternary('--stack $UPDATE_STACK', '') }}
+      {{ tripleo_overcloud_external_update_run_log_output | ternary((">" ~ tripleo_overcloud_external_update_run_log), '') }}
+      {{ tripleo_overcloud_external_update_run_log_combine | ternary("2>&1", '') }}
+    _update_run_env:
+      OS_CLOUD: "{{ tripleo_overcloud_external_update_run_os_cloud }}"
+      UPDATE_SSH_USER: "{{ tripleo_overcloud_external_update_run_ssh_user }}"
+      UPDATE_TAGS: "{{ tripleo_overcloud_external_update_run_tags | quote }}"
+      UPDATE_SKIP_TAGS: "{{ tripleo_overcloud_external_update_run_skip_tags | quote }}"
+      UPDATE_STATIC_INVENTORY: "{{ tripleo_overcloud_external_update_run_static_inventory }}"
+      UPDATE_STACK: "{{ tripleo_overcloud_external_update_run_stack }}"
+
+- name: Preserve existing log file if exists
+  timestamp_file:
+    path: "{{ tripleo_overcloud_external_update_run_log }}"
+  when: tripleo_overcloud_external_update_run_log_output|bool
+
+- name: Show debug information
+  when: tripleo_overcloud_external_update_run_debug|bool
+  block:
+    - name: Show the overcloud external-update run command
+      debug:
+        var: _update_run_cmd
+
+    - name: Show the overcloud external-update run environment
+      debug:
+        var: _update_run_env
+
+- name: Overcloud external-update run
+  shell: "{{ _update_run_cmd }}"  # noqa 305
+  environment: "{{ _update_run_env }}"
+  args:
+    chdir: "{{ tripleo_overcloud_external_update_run_home_dir }}"
+    warn: false
+  register: tripleo_overcloud_external_update_run_result
+  async: "{{ tripleo_overcloud_external_update_run_timeout }}"
+  poll: "{{ tripleo_overcloud_external_update_run_poll }}"
+  changed_when: false
+  when: not ansible_check_mode|bool
+
+- name: Set output fact
+  set_fact:
+    tripleo_overcloud_external_update_run_output: "{{ tripleo_overcloud_external_update_run_result.stdout }}"

roles/tripleo_overcloud_external_update_run/tests/inventory

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

roles/tripleo_overcloud_external_update_run/tests/test.yml

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

zuul.d/molecule.yaml

@@ -21,6 +21,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_container_image_upload
       - tripleo-operator-molecule-tripleo_overcloud_deploy
       - tripleo-operator-molecule-tripleo_overcloud_export
+      - tripleo-operator-molecule-tripleo_overcloud_external_update_run
       - tripleo-operator-molecule-tripleo_overcloud_failures
       - tripleo-operator-molecule-tripleo_overcloud_image_build
       - tripleo-operator-molecule-tripleo_overcloud_netenv_validate
@@ -67,6 +68,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_container_image_upload
       - tripleo-operator-molecule-tripleo_overcloud_deploy
       - tripleo-operator-molecule-tripleo_overcloud_export
+      - tripleo-operator-molecule-tripleo_overcloud_external_update_run
       - tripleo-operator-molecule-tripleo_overcloud_failures
       - tripleo-operator-molecule-tripleo_overcloud_image_build
       - tripleo-operator-molecule-tripleo_overcloud_netenv_validate
@@ -339,6 +341,20 @@
     vars:
       tox_extra_args: tripleo_overcloud_export
 
+- job:
+    files:
+      - ^roles/tripleo_overcloud_external_update_run/.*
+      - ^bindep.txt
+      - ^galaxy.yml
+      - ^requirements.txt
+      - ^setup.cfg
+      - ^test-requirements.txt
+      - ^tox.ini
+    name: tripleo-operator-molecule-tripleo_overcloud_external_update_run
+    parent: tripleo-operator-molecule-base
+    vars:
+      tox_extra_args: tripleo_overcloud_external_update_run
+
 - job:
     files:
       - ^roles/tripleo_overcloud_failures/.*