Skip to content

Commit dfad85d

Browse files
JSticklerJStickler
committed
OSSMDOC-598: Update locations of resources in install/troubleshooting.
1 parent 3fcdf9c commit dfad85d

File tree

2 files changed

+77
-28
lines changed

2 files changed

+77
-28
lines changed

‎modules/ossm-install-ossm-operator.adoc

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,30 +14,27 @@ To install {SMProductName}, install following Operators in this order. Repeat th
1414
* Kiali
1515
* {SMProductName}
1616
17+
[NOTE]
18+
====
19+
If you have already installed the OpenShift Elasticsearch Operator as part of OpenShift Logging, you do not need to install the OpenShift Elasticsearch Operator again. The {JaegerName} Operator will create the Elasticsearch instance using the installed OpenShift Elasticsearch Operator.
20+
====
21+
1722
.Procedure
1823

19-
. Log in to the {product-title} web console as a user with the `cluster-admin` role.
24+
. Log in to the {product-title} web console as a user with the `cluster-admin` role. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.
2025

2126
. In the {product-title} web console, click *Operators* -> *OperatorHub*.
2227

2328
. Type the name of the Operator into the filter box and select the Red Hat version of the Operator. Community versions of the Operators are not supported.
2429

2530
. Click *Install*.
26-
+
27-
[NOTE]
28-
====
29-
If you have already installed the OpenShift Elasticsearch Operator as part of OpenShift
30-
Logging, you do not need to install the OpenShift Elasticsearch Operator again. The
31-
{JaegerName} Operator will create the Elasticsearch instance using the installed OpenShift
32-
Elasticsearch Operator.
33-
====
3431

35-
. On the *Install Operator* page, select installation options.
36-
.. For the OpenShift Elasticsearch Operator, in the *Update Channel* section, select *stable-5.x*.
37-
.. For the {JaegerName}, Kiali, and {SMProductName} Operators, accept the defaults.
38-
+
39-
The Kiali and {SMProductName} Operators are installed in the `openshift-operators` namespace. The {JaegerName} is installed in the `openshift-distributed-tracing` namespace. The OpenShift Elasticsearch Operator is installed in the `openshift-operators-redhat` namespace.
32+
. On the *Install Operator* page for each Operator, accept the default settings.
4033

4134
. Click *Install*. Wait until the Operator has installed before repeating the steps for the next Operator in the list.
35+
+
36+
* The OpenShift Elasticsearch Operator is installed in the `openshift-operators-redhat` namespace and is available for all namespaces in the cluster.
37+
* The {JaegerName} is installed in the `openshift-distributed-tracing` namespace and is available for all namespaces in the cluster.
38+
* The Kiali and {SMProductName} Operators are installed in the `openshift-operators` namespace and are available for all namespaces in the cluster.
4239

4340
. After all you have installed all four Operators, click *Operators* -> *Installed Operators* to verify that your Operators installed.

‎modules/ossm-validating-smcp.adoc

Lines changed: 66 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ When you create the Service Mesh control plane, the {SMProductShortName} Operato
1212
** `istio-egressgateway`
1313
** `grafana`
1414
** `prometheus`
15+
** `wasm-cacher`
1516
* Calls the Kiali Operator to create Kaili deployment based on configuration in either the SMCP or the Kiali custom resource.
1617
+
1718
[NOTE]
@@ -23,7 +24,7 @@ You view the Kiali components under the Kiali Operator, not the {SMProductShortN
2324
+
2425
[NOTE]
2526
====
26-
You view the Jaeger components under the {JaegerName} Operator and the Elasticsearch components under the Elasticsearch Operator, not the {SMProductShortName} Operator.
27+
You view the Jaeger components under the {JaegerName} Operator and the Elasticsearch components under the Red Hat Elasticsearch Operator, not the {SMProductShortName} Operator.
2728
====
2829
+
2930
.From the {product-title} console
@@ -33,10 +34,31 @@ You can verify the Service Mesh control plane installation in the {product-title
3334
. Navigate to *Operators* -> *Installed Operators*.
3435
. Select the `<istio-system>` namespace.
3536
. Select the {SMProductName} Operator.
36-
. Click the *Istio Service Mesh Control Plane* tab.
37-
. Click the name of your control plane, for example `basic`.
38-
. To view the resources created by the deployment, click the *Resources* tab. You can use the filter to narrow your view, for example, to check that all the *Pods* have a status of `running`.
39-
. If the SMCP status indicates any problems, check the `status:` output in the YAML file for more information.
37+
.. Click the *Istio Service Mesh Control Plane* tab.
38+
.. Click the name of your control plane, for example `basic`.
39+
.. To view the resources created by the deployment, click the *Resources* tab. You can use the filter to narrow your view, for example, to check that all the *Pods* have a status of `running`.
40+
.. If the SMCP status indicates any problems, check the `status:` output in the YAML file for more information.
41+
.. Navigate back to *Operators* -> *Installed Operators*.
42+
43+
. Select the OpenShift Elasticsearch Operator.
44+
.. Click the *Elasticsearch* tab.
45+
.. Click the name of the deployment, for example `elasticsearch`.
46+
.. To view the resources created by the deployment, click the *Resources* tab. .
47+
.. If the `Status` column any problems, check the `status:` output on the *YAML* tab for more information.
48+
.. Navigate back to *Operators* -> *Installed Operators*.
49+
50+
. Select the {JaegerName} Operator.
51+
.. Click the *Jaeger* tab.
52+
.. Click the name of your deployment, for example `jaeger`.
53+
.. To view the resources created by the deployment, click the *Resources* tab.
54+
.. If the `Status` column indicates any problems, check the `status:` output on the *YAML* tab for more information.
55+
.. Navigate to *Operators* -> *Installed Operators*.
56+
57+
. Select the Kiali Operator.
58+
.. Click the *Istio Service Mesh Control Plane* tab.
59+
.. Click the name of your deployment, for example `kiali`.
60+
.. To view the resources created by the deployment, click the *Resources* tab.
61+
.. If the `Status` column any problems, check the `status:` output on the *YAML* tab for more information.
4062

4163
.From the command line
4264

@@ -50,13 +72,15 @@ $ oc get pods -n istio-system
5072
.Example output
5173
[source,terminal]
5274
----
53-
NAME READY STATUS RESTARTS AGE
54-
grafana-6c47888749-dsztv 2/2 Running 0 37s
55-
istio-egressgateway-85fdc5b466-dgqgt 1/1 Running 0 36s
56-
istio-ingressgateway-844f785b79-pxbvb 1/1 Running 0 37s
57-
istiod-basic-c89b5b4bb-5jh8b 1/1 Running 0 104s
58-
jaeger-6ff889f874-rz2nm 2/2 Running 0 34s
59-
prometheus-578df79589-p7p9k 3/3 Running 0 69s
75+
NAME READY STATUS RESTARTS AGE
76+
grafana-6776785cfc-6fz7t 2/2 Running 0 102s
77+
istio-egressgateway-5f49dd99-l9ppq 1/1 Running 0 103s
78+
istio-ingressgateway-6dc885c48-jjd8r 1/1 Running 0 103s
79+
istiod-basic-6c9cc55998-wg4zq 1/1 Running 0 2m14s
80+
jaeger-6865d5d8bf-zrfss 2/2 Running 0 100s
81+
kiali-579799fbb7-8mwc8 1/1 Running 0 46s
82+
prometheus-5c579dfb-6qhjk 2/2 Running 0 115s
83+
wasm-cacher-basic-5b99bfcddb-m775l 1/1 Running 0 86s
6084
----
6185
+
6286
. Check the status of the control plane deployment with the following command, where `istio-system` is the namespace where you deployed the SMCP.
@@ -72,7 +96,7 @@ The installation has finished successfully when the STATUS column is `Components
7296
[source,terminal]
7397
----
7498
NAME READY STATUS PROFILES VERSION AGE
75-
basic 9/9 ComponentsReady ["default"] 2.0.1.1 19m
99+
basic 10/10 ComponentsReady ["default"] 2.1.3 4m2s
76100
----
77101

78102
+
@@ -82,7 +106,7 @@ If you have modified and redeployed your control plane, the status should read `
82106
[source,terminal]
83107
----
84108
NAME READY STATUS TEMPLATE VERSION AGE
85-
basic-install 9/9 UpdateSuccessful default v1.1 3d16h
109+
basic-install 10/10 UpdateSuccessful default v1.1 3d16h
86110
----
87111
+
88112
. If the SMCP status indicates anything other than `ComponentsReady` check the `status:` output in the SCMP resource for more information.
@@ -98,3 +122,31 @@ $ oc describe smcp <smcp-name> -n <controlplane-namespace>
98122
----
99123
$ oc describe smcp basic -n istio-system
100124
----
125+
+
126+
. Check the status of the Jaeger deployment with the following command, where `istio-system` is the namespace where you deployed the SMCP.
127+
+
128+
[source,terminal]
129+
----
130+
$ oc get jaeger -n <istio-system>
131+
----
132+
+
133+
.Example output
134+
[source,terminal]
135+
----
136+
NAME STATUS VERSION STRATEGY STORAGE AGE
137+
jaeger Running 1.30.0 allinone memory 15m
138+
----
139+
+
140+
. Check the status of the Kiali deployment with the following command, where `istio-system` is the namespace where you deployed the SMCP.
141+
+
142+
[source,terminal]
143+
----
144+
$ oc get kiali -n <istio-system>
145+
----
146+
+
147+
.Example output
148+
[source,terminal]
149+
----
150+
NAME AGE
151+
kiali 15m
152+
----

0 commit comments

Comments
 (0)