Merge pull request #4 from stackhpc/github_role_refactor

Fixes and improvements to `github` role

Author: jackhodgkiss

.github/workflows/test-collection.yml

@@ -0,0 +1,31 @@
+---
+name: Test stackhpc.kayobe_workflows collection
+'on':
+  pull_request:
+
+jobs:
+  test:
+    name: Test github role
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the codebase.
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install Ansible
+        run: pip3 install ansible
+
+      - name: Test the playbook.
+        run: ansible-playbook tests/test.yml
+        env:
+          ANSIBLE_FORCE_COLOR: '1'
+
+      - name: Upload workflows produced
+        uses: actions/upload-artifact@v3
+        with:
+          name: github_kayobe_workflows
+          path: tests/.github/workflows

roles/github/README.md

@@ -38,16 +38,37 @@ The following variables can be used to make small adjustments to the composition
 
 `github_runs_on`: control which runner can accept this workflow. See GitHub for more information on [runs-on](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on).
 
-`github_image_url`: full URL of the kayobe container image complete with registry and tag.
+`github_image_name`: name of the kayobe image defaults to `kayobe`.
+
+`github_image_tag`: tag used to select kayobe image defaults to `latest`
 
 `github_registry_username`: username used to authenticate with the docker registry.
 
 `github_registry_password`: password used to authenticate with the docker registry.
 
+`github_kayobe_base_image`: select the base image used when building the kayobe docker image. Default is `quay.io/centos/centos:stream8` supports OpenStack Wallaby, Xena and Yoga. Zed and higher would require `quay.io/rockylinux/rockylinux:9`.
+
 `github_kayobe_arguments`: a dictionary of arguments that can be used to override the default arguments found within `vars/main.yml`. For example if you wanted to change the value of `KAYOBE_ENVIRONMENT` from its default of `production` you can simply add `KAYOBE_ENVIRONMENT` to this dictionary and it will take precedence over the defaults.
 
 `github_*_hook:` see section [Template Hooks](#template-hooks)  for information about this variables
 
+`github_buildx_enable`: In some deployments the build kayobe docker image workflow has had difficulties successfully pushing the image to container registries such as Pulp if buildx has been used. It situations where failure to push images is been experienced a user might wish to disable buildx. Buildx is enabled by default. 
+
+`github_buildx_inline_config`: provide configuration parameters to buildx. Useful for connecting to insecure docker registry.
+
+```yaml
+github_buildx_inline_config: |
+  [registry."10.20.30.40:80"]
+    http = true
+    insecure = true
+```
+
+`github_buildx_enable_provenance`: whether or not to enable build attestations/provenence. This has been [noted](https://github.com/docker/build-push-action/releases/tag/v4.1.1) to cause issues with docker registries such as Pulp. Default to false.
+
+`github_timeout`: control how a long a job may run before being cancelled. Timeout is defined in minutes and defaults to 360 minutes (6 hours)
+
+`github_tempest_test_suites`: provide a list of load lists to be made available within the drop-down list for running tempest. Defaults to `default` and `tempest-full`.
+
 If you wish to make more impactful changes such as which workflows are built and what they contain then see the list of dictionaries called `workflows` in `defaults/main.yml`
 
 `github_workflows:` is a list of dictionaries that contains each of the workflows described above. A given list element is made up of the following:
@@ -80,8 +101,6 @@ github_build_kayobe_image:
   path_override: "{{ playbook_dir }}/templates/build-kayobe-docker-image.yml.j2"
 ```
 
-
-
 Template Hooks
 --------------