This role helps with running OpenShift's conformance test suite against OpenShift clusters and OKD clusters.
First, Podman will be installed because it will be used later to run the OpenShift's conformance test suite container. A directory, defined in variable openshift_tests_artifact_dir, will be created to store
artifacts such as logs and test results. When a pull secret has been defined in variable
openshift_tests_pullsecret, then it will be written to file openshift_tests_pullsecret_file.
OpenShift Client aka oc will wait until:
- the number of nodes matches the number of machines,
- all nodes are ready, because the tests might require workload capacity, and
- cluster operators have finished progressing to ensure that any outstanding configuration has been achieved.
When the cluster is ready for testing, the image for OpenShift's conformance test suite will be read from the release
image defined in openshift_tests_release_image. Finally, the former container image will be used to run the test suite
defined in openshift_tests_suite in a Podman container. Its output will be written to file e2e.log in
directory openshift_tests_artifact_dir and test results will be written to its subdirectory junit.
Tested OS images
- Cloud image (
amd64) of Debian 11 (Bullseye) - Cloud image (
amd64) of Debian 12 (Bookworm) - Cloud image (
amd64) of Debian 13 (Trixie) - Cloud image (
amd64) of CentOS 8 (Stream) - Cloud image (
amd64) of CentOS 9 (Stream) - Cloud image (
amd64) of Fedora Cloud Base 40 - Cloud image (
amd64) of Ubuntu 22.04 LTS (Jammy Jellyfish) - Cloud image (
amd64) of Ubuntu 24.04 LTS (Noble Numbat)
Available on Ansible Galaxy in Collection jm1.cloudy.
OpenShift Client aka oc is required for waiting until the cluster is ready and for identifying the container
image which contains the openshift-tests binary. You may use role jm1.cloudy.openshift_client to install it.
This role uses module(s) from collection jm1.pkg. To install this collection you may follow the
steps described in README.md using the provided requirements.yml.
Podman is required to run OpenShift's conformance test suite container but it will be installed automatically upfront.
| Name | Default value | Required | Description |
|---|---|---|---|
openshift_tests_artifact_dir |
~/tests |
false | Directory where logs and test results will be stored. Defaults to tests in ansible_user's home |
openshift_tests_kubeconfig_file |
undefined | true | Path to a kubeconfig file which contains cluster details, certificates, authentication tokens etc. |
openshift_tests_pullsecret |
undefined | false | Pull secret downloaded from Red Hat Cloud Console which will be used to authenticate with Container registries Quay.io and registry.redhat.io, which serve the container images for OpenShift Container Platform components. A pull secret is required for OpenShift deployments only, but not for OKD deployments. |
openshift_tests_pullsecret_file |
~/pull-secret.txt |
false | Path to pull secret file |
openshift_tests_release_image |
undefined | true | Container image from which openstack-install will be extracted, e.g. 'quay.io/okd/scos-release:4.13.0-0.okd-scos-2023-07-20-165025' |
openshift_tests_suite |
openshift/conformance/parallel |
false | The test suite to run. Use openshift-tests run --help to list available suites. Defaults to OpenShift CI's default test suite |
| Name | Description |
|---|---|
jm1.pkg.setup |
Installs necessary software for module jm1.pkg.meta_pkg from collection jm1.pkg. This role is called automatically, manual execution is NOT required. |
- hosts: all
become: true
roles:
- name: Run OpenShift's conformance test suite
role: jm1.cloudy.openshift_tests
tags: ["jm1.cloudy.openshift_tests"]For a complete example on how to use this role and jm1.cloudy.openshift_ipi, refer to hosts
lvrt-lcl-session-srv-400-okd-ipi-router up to lvrt-lcl-session-srv-430-okd-ipi-provisioner from the provided
examples inventory. The top-level README.md describes how these hosts can be
provisioned with playbook playbooks/site.yml.
If you want to run tests for OpenShift instead of OKD, download a pull secret from Red Hat
Cloud Console. It is required to authenticate with Container registries Quay.io and
registry.redhat.io, which serve the container images for OpenShift Container Platform components. Next, change the
following host_vars of Ansible host lvrt-lcl-session-srv-430-okd-ipi-provisioner:
openshift_tests_pullsecret: |
{"auths":{"xxxxxxx": {"auth": "xxxxxx","email": "xxxxxx"}}}
# Or read pull secret from file ~/pull-secret.txt residing at the Ansible controller
#openshift_tests_pullsecret: |
# {{ lookup('ansible.builtin.file', lookup('ansible.builtin.env', 'HOME') + '/pull-secret.txt') }}
openshift_tests_release_image: "{{ lookup('ansible.builtin.pipe', openshift_tests_release_image_query) }}"
openshift_tests_release_image_query: |
curl -s https://mirror.openshift.com/pub/openshift-v4/amd64/clients/ocp/stable-4.13/release.txt \
| grep 'Pull From: quay.io' \
| awk -F ' ' '{print $3}'For instructions on how to run Ansible playbooks have look at Ansible's Getting Started Guide.
GNU General Public License v3.0 or later
See LICENSE.md to see the full text.