Add overcloud container image upload

Adds tripleo_overcloud_container_image_upload role to manage the
overcloud image upload.

Change-Id: I00e5a8751eaec943fdf0c165c4dd27db39c0536f

roles/tripleo_overcloud_container_image_upload/README.md

@@ -0,0 +1,56 @@
+tripleo_overcloud_container_image_upload
+========================================
+
+A role to perform an overcloud container image upload.
+
+Requirements
+------------
+
+None.
+
+Role Variables
+--------------
+
+* `tripleo_overcloud_container_image_upload_cleanup`: (String) Cleanup behaviour for local images
+* `tripleo_overcloud_container_image_upload_config_files`: (List) REQUIRED. YAML config files specifying images. Default: []
+* `tripleo_overcloud_container_image_upload_debug`: (Boolean) Flag to print out the delete command. Default: False
+* `tripleo_overcloud_container_image_upload_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}"
+* `tripleo_overcloud_container_image_upload_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true
+* `tripleo_overcloud_container_image_upload_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_container_image_upload_log`: (String) Path to a log file for the command output. Default: "{{ CHANGEME_home_dir }}/CHANGEME.log"
+* `tripleo_overcloud_container_image_upload_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10
+* `tripleo_overcloud_container_image_upload_timeout`: (Integer) Number in seconds to wait for the ansible execution of the command to finish. Default: 3600
+
+Output Variables
+----------------
+
+* `tripleo_overcloud_container_image_upload_output`: (String) The command standard output.
+* `tripleo_overcloud_container_image_upload_result`: Ansible shell execution results
+
+Dependencies
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Example overcloud container image upload
+
+```yaml
+- hosts: undercloud
+  gather_facts: true
+  tasks:
+    - name: overcloud container image upload
+      import_role:
+        name: tripleo_overcloud_container_image_upload
+      var:
+        tripleo_overcloud_container_image_upload_config_files:
+          - /home/stack/containers.yaml
+        tripleo_overcloud_container_image_upload_debug: true
+```
+
+License
+-------
+
+Apache-2.0

roles/tripleo_overcloud_container_image_upload/defaults/main.yml

@@ -0,0 +1,12 @@
+---
+# defaults file for tripleo_overcloud_container_image_upload
+openstack_bin: openstack
+tripleo_overcloud_container_image_upload_cleanup:
+tripleo_overcloud_container_image_upload_config_files: []
+tripleo_overcloud_container_image_upload_debug: false
+tripleo_overcloud_container_image_upload_home_dir: "{{ ansible_env.HOME }}"
+tripleo_overcloud_container_image_upload_log: "{{ tripleo_overcloud_container_image_upload_home_dir }}/overcloud_container_image_upload.log"
+tripleo_overcloud_container_image_upload_log_combine: true
+tripleo_overcloud_container_image_upload_log_output: true
+tripleo_overcloud_container_image_upload_poll: 10
+tripleo_overcloud_container_image_upload_timeout: 3600

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

@@ -0,0 +1,46 @@
+---
+- name: Converge
+  hosts: all
+  collections:
+    - tripleo.operator
+  vars:
+    openstack_bin: echo
+    tripleo_overcloud_container_image_upload_log_output: false
+    tripleo_overcloud_container_image_upload_poll: 1
+    tripleo_overcloud_container_image_upload_debug: true
+  tasks:
+
+    - name: "Include tripleo_overcloud_container_image_upload"
+      include_role:
+        name: "tripleo_overcloud_container_image_upload"
+
+    - name: Check role
+      assert:
+        that:
+          - tripleo_overcloud_container_image_upload_output == "overcloud container image upload"
+
+    - name: Assert "tripleo_overcloud_container_image_upload_config_files"
+      include_role:
+        name: "tripleo_overcloud_container_image_upload"
+      vars:
+        tripleo_overcloud_container_image_upload_config_files:
+          - a.yaml
+          - b.yaml
+
+    - name: Validate tripleo_overcloud_container_image_upload_config_files
+      assert:
+        that:
+          - tripleo_overcloud_container_image_upload_output ==
+            "overcloud container image upload --config-file a.yaml --config-file b.yaml"
+
+    - name: Assert "tripleo_overcloud_container_image_upload_cleanup"
+      include_role:
+        name: "tripleo_overcloud_container_image_upload"
+      vars:
+        tripleo_overcloud_container_image_upload_cleanup: full
+
+    - name: Validate tripleo_overcloud_container_image_upload_cleanup
+      assert:
+        that:
+          - tripleo_overcloud_container_image_upload_output ==
+            "overcloud container image upload --cleanup full"

roles/tripleo_overcloud_container_image_upload/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_container_image_upload/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_container_image_upload/tasks/main.yml

@@ -0,0 +1,46 @@
+---
+# tasks file for tripleo_overcloud_container_image_upload
+- name: Set overcloud container image upload facts
+  set_fact:
+    _upload_cmd: >-
+      {{ openstack_bin }} overcloud container image upload
+      {{ tripleo_overcloud_container_image_upload_config_files | tripleo.operator.shell_arg_list('--config-file') }}
+      {{ tripleo_overcloud_container_image_upload_cleanup | ternary('--cleanup $UPLOAD_CLEANUP', '') }}
+      {{ tripleo_overcloud_container_image_upload_log_output | ternary((">" ~ tripleo_overcloud_container_image_upload_log), '') }}
+      {{ tripleo_overcloud_container_image_upload_log_combine | ternary("2>&1", '') }}
+    _upload_env:
+      UPLOAD_CLEANUP: "{{ tripleo_overcloud_container_image_upload_cleanup | quote }}"
+
+- name: Preserve existing log file if exists
+  timestamp_file:
+    path: "{{ tripleo_overcloud_container_image_upload_log }}"
+  when: tripleo_overcloud_container_image_upload_log_output|bool
+
+- name: Show debug information
+  when: tripleo_overcloud_container_image_upload_debug|bool
+  block:
+    - name: Show the command
+      debug:
+        var: _upload_cmd
+
+    - name: Show the environment
+      debug:
+        var: _upload_env
+
+- name: Run overcloud container image upload
+  shell: "{{ _upload_cmd }}"  # noqa 305
+  environment: "{{ _upload_env }}"
+  args:
+    executable: /bin/bash
+    chdir: "{{ tripleo_overcloud_container_image_upload_home_dir }}"
+    warn: false
+  register: tripleo_overcloud_container_image_upload_result
+  async: "{{ tripleo_overcloud_container_image_upload_timeout }}"
+  poll: "{{ tripleo_overcloud_container_image_upload_poll }}"
+  changed_when: false
+  when: not ansible_check_mode|bool
+
+
+- name: Set output fact
+  set_fact:
+    tripleo_overcloud_container_image_upload_output: "{{ tripleo_overcloud_container_image_upload_result.stdout }}"

roles/tripleo_overcloud_container_image_upload/tests/inventory

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

roles/tripleo_overcloud_container_image_upload/tests/test.yml

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

zuul.d/molecule.yaml

@@ -16,6 +16,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_container_image_build
       - tripleo-operator-molecule-tripleo_overcloud_container_image_prepare
       - tripleo-operator-molecule-tripleo_overcloud_container_image_tag_discover
+      - 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_failures
@@ -55,6 +56,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_container_image_build
       - tripleo-operator-molecule-tripleo_overcloud_container_image_prepare
       - tripleo-operator-molecule-tripleo_overcloud_container_image_tag_discover
+      - 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_failures
@@ -255,6 +257,20 @@
     vars:
       tox_extra_args: tripleo_overcloud_container_image_tag_discover
 
+- job:
+    files:
+      - ^roles/tripleo_overcloud_container_image_upload/.*
+      - ^bindep.txt
+      - ^galaxy.yml
+      - ^requirements.txt
+      - ^setup.cfg
+      - ^test-requirements.txt
+      - ^tox.ini
+    name: tripleo-operator-molecule-tripleo_overcloud_container_image_upload
+    parent: tripleo-operator-molecule-base
+    vars:
+      tox_extra_args: tripleo_overcloud_container_image_upload
+
 - job:
     files:
       - ^roles/tripleo_overcloud_deploy/.*