Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/source/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?**
Expand Down
86 changes: 69 additions & 17 deletions docs/source/images.rst
Original file line number Diff line number Diff line change
@@ -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) <https://github.com/openstack-k8s-operators/tcib>`_.
The built images are published to `quay.io <https://quay.io/>`_.
The `test-operator` can run images coming from two different builds. Both builds
publish to `quay.io <https://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 <https://github.com/openstack-k8s-operators/s2i-openstack-containers>`_
repository and published to the
`openstack-s2i-containers organization <https://quay.io/organization/openstack-s2i-containers>`_.
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) <https://github.com/openstack-k8s-operators/tcib>`_
repository and published to the
`podified-antelope-centos9 organization <https://quay.io/organization/podified-antelope-centos9>`_
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:

Expand All @@ -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 <https://quay.io/openstack-s2i-containers/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 <https://github.com/openstack-k8s-operators/s2i-openstack-containers/blob/main/containers/tempest/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 <https://quay.io/organization/podified-master-centos9>`_
and filter for *tempest* results.

Currently, there are the following tempest images:
Currently, there are the following TCIB tempest images:

* `openstack-tempest <https://quay.io/podified-antelope-centos9/openstack-tempest>`_
* `openstack-tempest <https://quay.io/podified-antelope-centos9/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
Expand All @@ -41,24 +78,39 @@ Currently, there are the following tempest images:
`TCIB definition <https://github.com/openstack-k8s-operators/tcib/blob/main/container-images/tcib/base/os/tempest/tempest-extras/tempest-extras.yaml>`_
of the image.

Tobiko Image
------------

`test-operator` runs, for now, only the following test images:
* `openstack-tobiko <https://quay.io/openstack-s2i-containers/openstack-tobiko:master-latest>`__

* `openstack-tempest <https://quay.io/podified-antelope-centos9/openstack-tempest>`_
The default image. It installs tobiko directly from the source code downloaded
from `x/tobiko <https://opendev.org/x/tobiko.git>`_ repository.

Tobiko Image
------------
* `openstack-tobiko <https://quay.io/podified-antelope-centos9/openstack-tobiko:current-podified>`__

The TCIB variant of the same image.

AnsibleTest Image
-----------------

* `openstack-tobiko <https://quay.io/podified-antelope-centos9/openstack-tobiko:current-podified>`_
* `openstack-ansible-test <https://quay.io/openstack-s2i-containers/openstack-ansible-test:master-latest>`_

An image that installs tobiko directly from the source code downloaded from
`x/tobiko <https://opendev.org/x/tobiko.git>`_ 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 <https://quay.io/podified-antelope-centos9/openstack-ansible-tests:current-podified>`_

The TCIB variant of the same image.

HorizonTest Image
-----------------

* `openstack-horizontest <https://quay.io/repository/podified-antelope-centos9/openstack-horizontest?tab=tags&tag=current-podified>`_
* `openstack-horizontest <https://quay.io/repository/openstack-s2i-containers/openstack-horizontest?tab=tags&tag=master-latest>`__

The default image. It installs horizon directly from the source code downloaded
from `x/horizon <https://opendev.org/openstack/horizon.git>`_ repository and
prepares the environment for selenium tests to run.

* `openstack-horizontest <https://quay.io/repository/podified-antelope-centos9/openstack-horizontest?tab=tags&tag=current-podified>`__

An image that installs horizon directly from the source code downloaded from
`x/horizon <https://opendev.org/openstack/horizon.git>`_ repository and prepares
the environment for selenium tests to run
The TCIB variant of the same image.
2 changes: 1 addition & 1 deletion docs/source/samples/tempest-deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion docs/source/tempest_pod.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/openstack-k8s-operators/tcib/blob/main/container-images/tcib/base/os/tempest/run_tempest.sh>`_.
The content of the ``run_tempest.sh`` can be found in the
`s2i-openstack-containers repository <https://github.com/openstack-k8s-operators/s2i-openstack-containers/blob/main/containers/tempest/tempest/scripts/run_tempest.sh>`_
for the default S2I image and in the
`tcib repository <https://github.com/openstack-k8s-operators/tcib/blob/main/container-images/tcib/base/os/tempest/run_tempest.sh>`_
for the TCIB image.
2 changes: 1 addition & 1 deletion docs/source/tempest_podman.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading