Skip to content

Commit 1989e4c

Browse files
committed
OSSMDOC-341: Standardize references to istio-system.
1 parent d151cbc commit 1989e4c

33 files changed

+63
-59
lines changed

modules/jaeger-upgrading-es.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ When updating from Elasticsearch 5 to Elasticsearch 6, you must delete your Jaeg
1010

1111
.Procedure if Jaeger is installed as part of Red Hat Service Mesh
1212

13-
. Determine the name of your Jaeger custom resource file:
13+
. Determine the name of your Jaeger custom resource file. In this example, `istio-system` is the control plane namespace.
1414
+
1515
[source,terminal]
1616
----
17-
$ oc get jaeger -n istio-system
17+
$ oc get jaeger -n <istio-system>
1818
----
1919
+
2020
You should see something like the following:
@@ -29,21 +29,21 @@ jaeger 3d21h
2929
+
3030
[source,terminal]
3131
----
32-
$ oc get jaeger jaeger -oyaml -n istio-system > /tmp/jaeger-cr.yaml
32+
$ oc get jaeger jaeger -oyaml -n <istio-system> > /tmp/jaeger-cr.yaml
3333
----
3434
+
3535
. Delete the Jaeger instance:
3636
+
3737
[source,terminal]
3838
----
39-
$ oc delete jaeger jaeger -n istio-system
39+
$ oc delete jaeger jaeger -n <istio-system>
4040
----
4141
+
4242
. Recreate the Jaeger instance from your copy of the custom resource file:
4343
+
4444
[source,terminal]
4545
----
46-
$ oc create -f /tmp/jaeger-cr.yaml -n istio-system
46+
$ oc create -f /tmp/jaeger-cr.yaml -n <istio-system>
4747
----
4848
+
4949
. Delete the copy of the generated custom resource file:
@@ -83,6 +83,6 @@ $ oc create -f <jaeger-cr-file>
8383
+
8484
[source,terminal]
8585
----
86-
$ oc get pods -n jaeger-system -w
86+
$ oc get pods -n <jaeger-system> -w
8787
----
8888
+

modules/ossm-about-collecting-ossm-data.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ To collect {ProductName} data for a specific control plane namespace with `must-
2020

2121
[source,terminal]
2222
----
23-
$ oc adm must-gather --image=registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel8 gather <namespace>
23+
$ oc adm must-gather --image=registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel8 gather <namespace>
2424
----

modules/ossm-access-grafana.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
[id="ossm-access-grafana_{context}"]
66
= Accessing Grafana
77

8-
Grafana is an analytics tool that you can use to view, query, and analyze your service mesh metrics. To access Grafana, do the following:
8+
Grafana is an analytics tool that you can use to view, query, and analyze your service mesh metrics. In this example, `istio-system` is the control plane namespace. To access Grafana, do the following:
99

1010
.Procedure
1111

1212
. Log in to the {product-title} web console.
1313

14-
. Click the *Project* menu and choose the `istio-system` project from the list.
14+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
1515

1616
. Click *Routes*.
1717

modules/ossm-access-prometheus.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
[id="ossm-access-prometheus_{context}"]
66
= Accessing Prometheus
77

8-
Prometheus is a monitoring and alerting tool that you can use to collect multi-dimensional data about your microservices.
8+
Prometheus is a monitoring and alerting tool that you can use to collect multi-dimensional data about your microservices. In this example, `istio-system` is the control plane namespace.
99

1010
.Procedure
1111

1212
. Log in to the {product-title} web console.
1313

14-
. Click the *Project* menu and choose the `istio-system` project from the list.
14+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
1515

1616
. Click *Routes*.
1717

modules/ossm-config-enabling-controlplane.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ spec:
1818
mtls: true
1919
----
2020

21-
You can also enable mTLS for the control plane by using the {product-title} web console.
21+
You can also enable mTLS for the control plane by using the {product-title} web console. In this example, `istio-system` is the control plane namespace.
2222

2323
.Procedure
2424

2525
. Log in to the web console.
2626

27-
. Click the *Project* menu and choose the `istio-system` project from the list.
27+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
2828

2929
. Click *Operators* -> *Installed Operators*.
3030

modules/ossm-config-external-jaeger.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you already use standalone Jaeger for distributed tracing in {product-title},
1515

1616
. In the {product-title} web console, click *Operators* -> *Installed Operators*.
1717

18-
. From the *Project* menu, select the project where you installed the control plane, for example `istio-system`.
18+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
1919

2020
. Click the {ProductName} Operator. In the *Istio Service Mesh Control Plane* column, click the name of your `ServiceMeshControlPlane` resource, for example `basic`.
2121

modules/ossm-config-mtls-min-max.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The default is `TLS_AUTO` and does not specify a version of TLS.
2929

3030
. Log in to the web console.
3131

32-
. Click the *Project* menu and choose the `istio-system` project from the list.
32+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
3333

3434
. Click *Operators* -> *Installed Operators*.
3535

modules/ossm-config-sampling.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ The distributed tracing sampling rate is set to sample 100% of traces in your se
99

1010
A trace is an execution path between services in the service mesh. A trace is comprised of one or more spans. A span is a logical unit of work that has a name, start time, and duration.
1111

12-
The sampling rate determines how often a trace is generated. Configure sampling as a scaled integer representing 0.01% increments.
12+
The sampling rate determines how often a trace is generated. Configure sampling as a scaled integer representing 0.01% increments.
1313

1414
In a basic installation, `spec.tracing.sampling` is set to `10000`, which samples 100% of traces. For example:
1515

16-
* Setting the value to 10 samples 0.1% of traces.
17-
* Setting the value to 500 samples 5% of traces.
16+
* Setting the value to 10 samples 0.1% of traces.
17+
* Setting the value to 500 samples 5% of traces.
1818

1919
Setting the value to `10000` is useful for debugging, but can affect performance. For production, set `spec.tracing.sampling` to `100.`
2020

2121
.Procedure
2222

2323
. In the {product-title} web console, click *Operators* -> *Installed Operators*.
2424

25-
. From the *Project* menu, select the project where you installed the control plane, for example `istio-system`.
25+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
2626

2727
. Click the {ProductName} Operator. In the *Istio Service Mesh Control Plane* column, click the name of your `ServiceMeshControlPlane` resource, for example `basic`.
2828

modules/ossm-config-sec-mtls-mesh.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can also enable mTLS by using the {product-title} web console.
2424

2525
. Log in to the web console.
2626

27-
. Click the *Project* menu and choose the `istio-system` project from the list.
27+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
2828

2929
. Click *Operators* -> *Installed Operators*.
3030

modules/ossm-config-web-console.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can configure the `ServiceMeshControlPlane` by using the {product-title} web
1212

1313
. In the {product-title} web console, click *Operators* -> *Installed Operators*.
1414

15-
. Select the project where you installed the control plane, for example `istio-system`, from the Project menu.
15+
. Click the *Project* menu and select the project where you installed the control plane, for example *istio-system*.
1616

1717
. Click the {ProductName} Operator. In the *Istio Service Mesh Control Plane* column, click the name of your `ServiceMeshControlPlane` resource, for example `basic`.
1818

0 commit comments

Comments
 (0)