Skip to content

Commit 91bef10

Browse files
authored
Update index for the test-operator (#79)
With this change [1] we moved the test-operator to openstack-operator-index. Let's update the documentation to reflect this. [1] openstack-k8s-operators/openstack-operator#752 Depends-On: openstack-k8s-operators/openstack-operator#752
1 parent ffec86c commit 91bef10

File tree

2 files changed

+16
-58
lines changed

2 files changed

+16
-58
lines changed

docs/source/guide.rst

Lines changed: 15 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -30,59 +30,13 @@ Running Test Operator Using the Operator Lifecycle Manager (OLM)
3030
----------------------------------------------------------------
3131

3232
The first option of how to start the operator is by running the pre-built operator image
33-
stored on
34-
`quay.io <https://quay.io/repository/openstack-k8s-operators/test-operator>`_
33+
stored in the `openstack-operator-index <https://quay.io/repository/openstack-k8s-operators/openstack-operator-index>`_
3534
using the OLM.
3635

37-
.. note::
38-
39-
Currently, the `test-operator <https://quay.io/openstack-k8s-operators/test-operator>`_ is not
40-
part of the `openstack-operator-index <https://quay.io/openstack-k8s-operators/
41-
openstack-operator-index>`_; therefore, a new catalog source which uses `test-operator-index
42-
<https://quay.io/openstack-k8s-operators/test-operator-index>`_ image needs to be created
43-
in advance.
44-
45-
Follow these steps to install the operator in the OpenStack project.
46-
47-
1. Create :code:`OperatorGroup`
48-
49-
.. code-block:: yaml
50-
51-
cat operator-group.yaml
52-
---
53-
apiVersion: operators.coreos.com/v1
54-
kind: OperatorGroup
55-
metadata:
56-
name: openstack-operatorgroup
57-
namespace: openstack
58-
spec:
59-
targetNamespaces:
60-
- openstack
61-
62-
.. code-block:: bash
63-
64-
oc apply -f operator-group.yaml
36+
Follow these steps to install the operator in the :code:`openstack-operators`
37+
project.
6538

66-
2. Create :code:`CatalogSource`
67-
68-
.. code-block:: yaml
69-
70-
cat catalog-source.yaml
71-
---
72-
apiVersion: operators.coreos.com/v1alpha1
73-
kind: CatalogSource
74-
metadata:
75-
name: test-operator-catalog
76-
namespace: openstack
77-
spec:
78-
sourceType: grpc
79-
image: quay.io/openstack-k8s-operators/test-operator-index:latest
80-
81-
.. code-block:: bash
82-
83-
oc apply -f catalog-source.yaml
84-
85-
3. Create :code:`Subscription`
39+
1. Create :code:`Subscription`
8640

8741
.. code-block:: yaml
8842
@@ -92,24 +46,28 @@ Follow these steps to install the operator in the OpenStack project.
9246
kind: Subscription
9347
metadata:
9448
name: test-operator
95-
namespace: openstack
49+
namespace: openstack-operators
9650
spec:
9751
name: test-operator
98-
source: test-operator-catalog
99-
sourceNamespace: openstack
52+
source: openstack-operator-index
53+
sourceNamespace: openstack-operators
54+
55+
2. Apply :code:`subscription.yaml`
10056

10157
.. code-block:: bash
10258
10359
oc apply -f subscription.yaml
10460
105-
4. Wait for the :code:`test-operator-controller-manager` pod to successfully
61+
3. Wait for the :code:`test-operator-controller-manager` pod to successfully
10662
spawn. Once you see the pod running, you can start communicating with the
107-
operator using the :code:`Tempest` resource defined in the
108-
:ref:`executing-tests` section.
63+
operator using the CRs understood by the test-operator (see
64+
:ref:`custom-resources-used-by-the-test-operator`). For more information
65+
about how to run tests via the test-operator, refer to the :ref:`executing-tests`
66+
section.
10967

11068
.. code-block:: bash
11169
112-
oc get pods
70+
oc get pods -n openstack-operators
11371
...
11472
test-operator-controller-manager-6c9994847c-6jwn5 2/2 Running 0 20s
11573
...

docs/source/images.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Currently, there are the following tempest images:
3636
* `openstack-tempest-extras <https://quay.io/podified-antelope-centos9/openstack-tempest-extras>`_
3737

3838
An image that installs `openstack-tempest-all` RPM package. On top of the all the plugins that are part of the RPM,
39-
this image contains a few extras. The list of the extra projects (mainly tempest pluginsg) that are installed there has
39+
this image contains a few extras. The list of the extra projects (mainly tempest plugins) that are installed there has
4040
a tendency to change. Therefore for the up to date list check the
4141
`TCIB definition <https://github.com/openstack-k8s-operators/tcib/blob/main/container-images/tcib/base/os/tempest/tempest-extras/tempest-extras.yaml>`_
4242
of the image.

0 commit comments

Comments
 (0)