Skip to content

Commit b0c4f01

Browse files
gwynnemonahanopenshift-cherrypick-robot
authored andcommitted
OSSM-9004 Typos, style things
1 parent e432b74 commit b0c4f01

7 files changed

+12
-15
lines changed

modules/ossm-about-multi-cluster-mesh-topologies.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="ossm-about-multi-cluster-mesh-topologies_{context}"]
7-
= About multi-cluster mesh topologies
7+
= About multi-cluster mesh topologies
88

99
In a multi-cluster mesh topology, you install and manage a single {istio} mesh across multiple {ocp-product-title} clusters, enabling communication and service discovery between the services. Two factors determine the multi-cluster mesh topology: control plane topology and network topology. There are two options for each topology. Therefore, there are four possible multi-cluster mesh topology configurations.
1010

11-
* Multi-Primary Single Network: Combines the multi-primary control plane topology and the single network network topology models.
11+
* Multi-Primary Single Network: Combines the multi-primary control plane topology and the single network network topology models.
1212
13-
* Multi-Primary Multi-Network: Combines the Combines the multi-primary control plane topology and the multi-network network topology models.
13+
* Multi-Primary Multi-Network: Combines the multi-primary control plane topology and the multi-network network topology models.
1414
1515
* Primary-Remote Single Network: Combines the primary-remote control plane topology and the single network network topology models.
1616
@@ -23,7 +23,7 @@ A multi-cluster mesh must use one of the following control plane topologies:
2323

2424
* Multi-Primary: In this configuration, a control plane resides on every cluster. Each control plane observes the API servers in all of the other clusters for services and endpoints.
2525

26-
* Primary-Remote: In this configuration, the control plane resides only on one cluster, called the primary cluster. No control plane runs on any of the other clusters, called remote clusters. The control plane on the primary cluster discovers services and endpoints and configures the sidecar proxies for the workloads in all clusters.
26+
* Primary-Remote: In this configuration, the control plane resides only on one cluster, called the primary cluster. No control plane runs on any of the other clusters, called remote clusters. The control plane on the primary cluster discovers services and endpoints and configures the sidecar proxies for the workloads in all clusters.
2727

2828
[id="ossm-network-topology-models_{context}"]
2929
== Network topology models

modules/ossm-accessing-bookinfo-application-using-gateway-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The {k8s} Gateway API deploys a gateway by creating a `Gateway` resource. In {oc
1010
Red{nbsp}Hat provides support for using the {k8s} Gateway API with {SMProductName}. Red{nbsp}Hat does not provide support for the {k8s} Gateway API custom resource definitions (CRDs). In this procedure, the use of community Gateway API CRDs is shown for demonstration purposes only.
1111
====
1212

13-
. Prerequisites
13+
.Prerequisites
1414

1515
* You are logged in to the {ocp-product-title} web console as `cluster-admin`.
1616

modules/ossm-attach-workloads-to-control-plane-revisionbased.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
= Attach workloads to the control plane by using RevisionBased strategy
77
:context: ossm-attach-workloads-to-control-plane-revisionbased
88

9-
To attach the workloads to a control plane deployed by using the `RevisionBased` strategy, you must set the `istio.io/rev namespace` label to the name of the `IstioRevision`. Alternatively, you can apply the label to the workload pods.
9+
To attach the workloads to a control plane deployed by using the `RevisionBased` strategy, you must set the `istio.io/rev namespace` label to the name of the `IstioRevision` resource. Alternatively, you can apply the label to the workload pods.

modules/ossm-migrating-read-me-introducing-canary-updates.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,13 @@
22
//
33
// * service-mesh-docs-main/about/ossm-migrating-assembly.adoc
44

5-
//Start of an overall Migrating section.
6-
//Section is most likely to be reworked/restructured with OSSM 2 to OSSM 3 migration guides for GA. Unknown how many migration guides there are at this time (11/11/2024). It would be beneficial to be able to link from differences to the relevent migration guide so that users A) understand the change, esp significant changes like new operator, installing tracing and Kiali separately, gateways, etc.
7-
85
:_mod-docs-content-type: CONCEPT
96
[id="ossm-migrating-read-me-introducing-canary-updatess_{context}"]
107
= Introducing canary updates
118

129
{SMProductName} 2 supported only in-place style updates, which created risk for large meshes where, after the control plane was updated, all workloads must update to the new control plane version without a simple way to roll back if something goes wrong.
1310

14-
{SMProduct} 3 retains support for simple in-place style updates, and adds support for canary-style updatess of the Istio control plane using Istio's revision feature.
11+
{SMProduct} 3 retains support for simple in-place style updates, and adds support for canary-style updates of the Istio control plane using Istio's revision feature.
1512

1613
The `Istio` resource manages Istio revision labels using the `IstioRevision` resource. When the `Istio` resource's `updateStrategy` type is set to `RevisionBased`, it creates Istio revision labels using the `Istio` resource's name combined with the Istio version, for example `mymesh-v1-21-2`.
1714

modules/ossm-performing-inplace-update.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ When updating {istio} using the `InPlace` strategy, you can only increment by on
1010

1111
.Prerequisites
1212

13-
* You are logged in to {ocp-product-title} as `cluster-admin`.
13+
* You are logged in to {ocp-product-title} as a user with the `cluster-admin` role.
1414
* You have installed the {SMProductName} Operator, and deployed {istio}.
1515
1616
.Procedure
@@ -39,5 +39,5 @@ $ oc get istio <control-plane-name>
3939
+
4040
[source,terminal]
4141
----
42-
$ oc rollout restart deployment <deployment-name>
42+
$ oc rollout restart deployment <deployment_name>
4343
----

modules/ossm-performing-revisionbased-update.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ $ oc get istiorevisions
4040
+
4141
[source,terminal]
4242
----
43-
$ oc rollout restart deployment <deployment-name>
43+
$ oc rollout restart deployment <deployment_name>
4444
----

modules/ossm-select-revisionbased-strategy.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
To deploy {istio} with the `RevisionBased` strategy, create the {istio} resource with the following `spec.updateStrategy` value:
1010

11-
.Example specification to select RevisionBased strategy
11+
.Example specification to select `RevisionBased` strategy
1212
[source,yaml, subs="attributes,verbatim"]
1313
----
1414
kind: Istio
@@ -18,4 +18,4 @@ spec:
1818
type: RevisionBased
1919
----
2020

21-
After you select the strategy for the {istio} resource, the Operator creates a new `IstioRevision` resource with the name <istio resource name>-<version>.
21+
After you select the strategy for the {istio} resource, the Operator creates a new `IstioRevision` resource with the name `<istio_resource_name>-<version>`.

0 commit comments

Comments
 (0)