From d8454b0f06a51af99b341c30f582e3f6ca4c88ad Mon Sep 17 00:00:00 2001 From: Katarina Strenkova Date: Fri, 25 Sep 2026 10:17:44 +0200 Subject: [PATCH] [docs] Update images and add s2i variants This change is a documentation update following the new s2i images support. The tcib images can still be used, so the wording is update a bit and explanation for the new s2i images is added. --- docs/source/FAQ.rst | 11 +-- docs/source/images.rst | 86 +++++++++++++++++---- docs/source/samples/tempest-deployment.yaml | 2 +- docs/source/tempest_pod.rst | 6 +- docs/source/tempest_podman.rst | 2 +- 5 files changed, 82 insertions(+), 25 deletions(-) diff --git a/docs/source/FAQ.rst b/docs/source/FAQ.rst index 5641b608..3a868320 100644 --- a/docs/source/FAQ.rst +++ b/docs/source/FAQ.rst @@ -112,11 +112,12 @@ Please refer to this section of the documentation: - :ref:`tempest-images` -Most likely you are using openstack-tempest image instead of openstack-tempest-all. -You can specify which image you want to be used with :code:`containerImage` -parameter in the :code:`Tempest` CR. If your plugin is not included in the -:code:`openstack-tempest-all` image then take a look at the :code:`externalPlugin` -parameter. +Most likely the plugin is not part of the image you are using. The default S2I +:code:`openstack-tempest` image ships a fixed set of plugins, the TCIB +:code:`openstack-tempest` image ships none at all. You can specify which image +you want to be used with :code:`containerImage` parameter in the :code:`Tempest` +CR. If your plugin is not included in any of the images then take a look at the +:code:`externalPlugin` parameter. **6. The test pod is stuck in a pending state. What should I do?** diff --git a/docs/source/images.rst b/docs/source/images.rst index 6302629f..63f6e9a2 100644 --- a/docs/source/images.rst +++ b/docs/source/images.rst @@ -1,9 +1,30 @@ Images Used by test-operator ============================ -The `test-operator` uses images that are built and defined in -`TCIB (The Container Image Build) `_. -The built images are published to `quay.io `_. +The `test-operator` can run images coming from two different builds. Both builds +publish to `quay.io `_ and both can be used with the same custom +resources. The only thing that differs is the value of the :code:`containerImage` +parameter. + +* **S2I images (default)** are built from the upstream source code on top of UBI + in the + `s2i-openstack-containers `_ + repository and published to the + `openstack-s2i-containers organization `_. + The images tracking the `master` branch are tagged `master-latest`. These images + are used when you do not set the :code:`containerImage` parameter. + +* **TCIB images** are built from RPM packages in the + `TCIB (The Container Image Build) `_ + repository and published to the + `podified-antelope-centos9 organization `_ + with the `current-podified` tag. These images used to be the default. They are + still built and still supported, set :code:`containerImage` in your CR if you + want to keep using them. + +.. note:: + Switching between the two builds does not require any other change in the CR. + The test frameworks, the parameters and the produced artifacts stay the same. .. _tempest-images: @@ -15,13 +36,29 @@ Tempest Images running the test-operator, see `Run Tempest in a Pod <./tempest_pod.html>`_ or `Run Tempest via Podman <./tempest_podman.html>`_. -To find all tempest images, go to +S2I tempest image +^^^^^^^^^^^^^^^^^ + +* `openstack-tempest `__ + + The default image. It installs tempest together with a set of tempest plugins, + all of them built from the upstream source code. The list of the plugins that + are installed has a tendency to change. Therefore for the up to date list check + the `sources.txt `_ + file of the image. There is only one S2I tempest image, plugins that are not + part of it can still be installed during the container execution using the + `tempestRun.externalPlugin*` parameters (see :ref:`tempest-custom-resource`). + +TCIB tempest images +^^^^^^^^^^^^^^^^^^^ + +To find all TCIB tempest images, go to `podified-master-centos9 organization `_ and filter for *tempest* results. -Currently, there are the following tempest images: +Currently, there are the following TCIB tempest images: -* `openstack-tempest `_ +* `openstack-tempest `__ An image that installs `openstack-tempest` RPM package that contains only tempest and no other plugins. The user can install any external plugin during the container execution using @@ -41,24 +78,39 @@ Currently, there are the following tempest images: `TCIB definition `_ of the image. +Tobiko Image +------------ -`test-operator` runs, for now, only the following test images: +* `openstack-tobiko `__ -* `openstack-tempest `_ + The default image. It installs tobiko directly from the source code downloaded + from `x/tobiko `_ repository. -Tobiko Image ------------- +* `openstack-tobiko `__ + + The TCIB variant of the same image. + +AnsibleTest Image +----------------- -* `openstack-tobiko `_ +* `openstack-ansible-test `_ - An image that installs tobiko directly from the source code downloaded from - `x/tobiko `_ repository. + The default image. It contains the ansible runtime and the collections that are + needed to execute the playbooks referenced from the :code:`AnsibleTest` CR. + +* `openstack-ansible-tests `_ + + The TCIB variant of the same image. HorizonTest Image ----------------- -* `openstack-horizontest `_ +* `openstack-horizontest `__ + + The default image. It installs horizon directly from the source code downloaded + from `x/horizon `_ repository and + prepares the environment for selenium tests to run. + +* `openstack-horizontest `__ - An image that installs horizon directly from the source code downloaded from - `x/horizon `_ repository and prepares - the environment for selenium tests to run + The TCIB variant of the same image. diff --git a/docs/source/samples/tempest-deployment.yaml b/docs/source/samples/tempest-deployment.yaml index db15bcf9..cc39923d 100644 --- a/docs/source/samples/tempest-deployment.yaml +++ b/docs/source/samples/tempest-deployment.yaml @@ -38,7 +38,7 @@ spec: emptyDir: {} containers: - name: tempest-container - image: quay.io/podified-antelope-centos9/openstack-tempest:current-podified + image: quay.io/openstack-s2i-containers/openstack-tempest:master-latest # Uncomment the following line to make the container sleep - that overrides # any run commands defined in the tempest image - that will allow you to # ssh to the container, install e.g. tempest plugins, change the tempest diff --git a/docs/source/tempest_pod.rst b/docs/source/tempest_pod.rst index cfe96cdd..f8bbfd59 100644 --- a/docs/source/tempest_pod.rst +++ b/docs/source/tempest_pod.rst @@ -130,4 +130,8 @@ configuration to Tempest. Please mind the content of the ``run_tempest.sh`` script defined inside the tempest image as that is the limitation of what can be recognized, parsed and taken into account during the tempest run. -The content of the ``run_tempest.sh`` `can be found here `_. +The content of the ``run_tempest.sh`` can be found in the +`s2i-openstack-containers repository `_ +for the default S2I image and in the +`tcib repository `_ +for the TCIB image. diff --git a/docs/source/tempest_podman.rst b/docs/source/tempest_podman.rst index 4ae30be7..5f4ab6cb 100644 --- a/docs/source/tempest_podman.rst +++ b/docs/source/tempest_podman.rst @@ -42,6 +42,6 @@ Run tempest: .. code-block:: bash - podman run -e CONCURRENCY=4 -v /tmp/tempest/logs/:/var/lib/tempest/external_files:Z quay.io/podified-antelope-centos9/openstack-tempest:current-podified + podman run -e CONCURRENCY=4 -v /tmp/tempest/logs/:/var/lib/tempest/external_files:Z quay.io/openstack-s2i-containers/openstack-tempest:master-latest Profit! Logs will be in ``/tmp/tempest/logs`` (subunit, html files, tempest logs, etc)