Skip to content

Commit 857be4d

Browse files
authored
Merge pull request #28345 from brian-avery/ossmdoc-197
Fix spelling errors reported in OSSM-197
2 parents 454d015 + fbe001c commit 857be4d

File tree

2 files changed

+39
-39
lines changed

2 files changed

+39
-39
lines changed

modules/ossm-architecture.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The *data plane* is a set of intelligent proxies deployed as sidecars. These pro
1313

1414
The *control plane* manages and configures Istiod to enforce proxies to route traffic.
1515

16-
Istiod provides service discovery, configuration and certificate management. It converts high-level routing rules to Envoy configurations and propogates them to the sidcars at runtime.
16+
Istiod provides service discovery, configuration and certificate management. It converts high-level routing rules to Envoy configurations and propagates them to the sidecars at runtime.
1717

1818
Security Discovery Service (SDS) distributes certificates and keys to sidecars directly from Istiod.
1919

modules/ossm-cr-example.adoc

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -182,98 +182,98 @@ The following table lists the specifications for the `ServiceMeshControlPlane` r
182182
|===
183183
|Name |Description |Configurable parameters
184184

185-
|addons
186-
|Addon is used to configure additional features beyond core control plane components, such as visualization, or metric storage.
185+
|`addons`
186+
| You use the `addons` parameter to configure additional features beyond core control plane components, such as visualization, or metric storage.
187187
|`3scale`, `grafana`, `jaeger`, `kiali`, and `prometheus`.
188188

189-
|cluster
190-
|Cluster is the general configuration of the cluster (cluster name, network name, multi-cluster, mesh expansion, etc.)
189+
|`cluster`
190+
|The `cluster` parameter sets the general configuration of the cluster (cluster name, network name, multi-cluster, mesh expansion, etc.)
191191
|`meshExpansion`, `multiCluster`, `name`, and `network`
192192

193-
|gateways
194-
|Gateways configures ingress and egress gateways for the mesh.
193+
|`gateways`
194+
| You use the `gateways` parameter to configure ingress and egress gateways for the mesh.
195195
|`enabled`, `additionalEgress`, `additionalIngress`, `egress`, `ingress`, and `openshiftRoute`
196196

197-
|general
198-
|General represents general control plane configuration that does not fit anywhere else.
197+
|`general`
198+
|The `general` parameter represents general control plane configuration that does not fit anywhere else.
199199
|`logging` and `validationMessages`
200200

201-
|policy
202-
|Policy configures policy checking for the control plane. If `spec.policy.enabled` is set to `true`, policy checking is enabled.
201+
|`policy`
202+
|You use the `policy` parameter to configure policy checking for the control plane. Policy checking can be enabled by setting `spec.policy.enabled` to `true`.
203203
|`mixer` `remote`, or `type`. `type` can be set to `Istiod`, `Mixer` or `None`.
204204

205-
|profiles
206-
|Profiles selects the `ServiceMeshControlPlane` profile to use for default values.
205+
|`profiles`
206+
|You select the `ServiceMeshControlPlane` profile to use for default values using the `profiles` parameter.
207207
|`default`
208208

209-
|proxy
210-
|Proxy configures the default behavior for sidecars.
209+
|`proxy`
210+
| You use the `proxy` parameter to configure the default behavior for sidecars.
211211
|`accessLogging`, `adminPort`, `concurrency`, and `envoyMetricsService`
212212

213-
|runtime
214-
|Runtime configuration for the control plane components.
213+
|`runtime`
214+
| You use the `runtime` parameter to configure the control plane components.
215215
|`components`, and `defaults`
216216

217-
|security
218-
|Security configures aspects of security for the control plane.
217+
|`security`
218+
| The `security` parameter allows you to configure aspects of security for the control plane.
219219
|`certificateAuthority`, `controlPlane`, `identity`, `dataPlane` and `trust`
220220

221-
|techPreview
222-
|TechPreview is used to enable early access to features that are technology previews.
221+
|`techPreview`
222+
|The `techPreview` parameter enables early access to features that are in technology techPreview.
223223
|N/A
224224

225-
|telemetry
226-
|If spec.mixer.telemetry.enabled is set to true, telemetry is enabled.
225+
|`telemetry`
226+
|If `spec.mixer.telemetry.enabled` is set to `true`, telemetry is enabled.
227227
|`mixer`, `remote`, and `type`. `type` can be set to `Istiod`, `Mixer` or `None`.
228228

229-
|tracing
230-
|Tracing enables distributed tracing for the mesh.
229+
|`tracing`
230+
|You use the `tracing` parameter to enables distributed tracing for the mesh.
231231
|`sampling`, `type`. `type` can be set to `Jaeger` or `None`.
232232

233-
|version
234-
|Version specifies what Maistra version of the control plane to install. When creating a `ServiceMeshControlPlane` with an empty version, the admission webhook sets the version to the current version. New `ServiceMeshControlPlanes` with an empty version are set to v2.0. Existing `ServiceMeshControlPlanes` with an empty version keep their setting.
233+
|`version`
234+
|You use the `version` parameter to specify what Maistra version of the control plane to install. When creating a `ServiceMeshControlPlane` with an empty version, the admission webhook sets the version to the current version. New `ServiceMeshControlPlanes` with an empty version are set to `v2.0`. Existing `ServiceMeshControlPlanes` with an empty version keep their setting.
235235
|string
236236
|===
237237

238-
ControlPlaneStatus represents the current state of your service mesh.
238+
`ControlPlaneStatus` represents the current state of your service mesh.
239239

240240
.`ServiceMeshControlPlane` resource `ControlPlaneStatus`
241241
|===
242242
|Name |Description |Type
243243

244-
|annotations
245-
|Annotations is an unstructured key value map used to store additional, usually redundant status information, such as the number of components deployed by the `ServiceMeshControlPlane`. These statuses are used by the command line tool, `oc`, which does not yet allow counting objects in JSONPath expressions.
244+
|`annotations`
245+
|The `annotations` parameter stores additional, usually redundant status information, such as the number of components deployed by the `ServiceMeshControlPlane`. These statuses are used by the command line tool, `oc`, which does not yet allow counting objects in JSONPath expressions.
246246
|Not configurable
247247

248-
|conditions
248+
|`conditions`
249249
|Represents the latest available observations of the object’s current state. `Reconciled` indicates whether the operator has finished reconciling the actual state of deployed components with the configuration in the `ServiceMeshControlPlane` resource. `Installed` indicates whether the control plane has been installed. `Ready` indicates whether all control plane components are ready
250250
|string
251251

252-
|components
252+
|`components`
253253
|Shows the status of each deployed control plane component.
254254
|string
255255

256-
|appliedSpec
256+
|`appliedSpec`
257257
|The resulting specification of the configuration options after all profiles have been applied.
258258
|`ControlPlaneSpec`
259259

260-
|appliedValues
260+
|`appliedValues`
261261
|The resulting values.yaml used to generate the charts.
262262
|`ControlPlaneSpec`
263263

264-
|chartVersion
264+
|`chartVersion`
265265
|The version of the charts that were last processed for this resource.
266266
|string
267267

268-
|observedGeneration
268+
|`observedGeneration`
269269
|The generation observed by the controller during the most recent reconciliation. The information in the status pertains to this particular generation of the object. The `status.conditions` are not up-to-date if the `status.observedGeneration` field doesn't match `metadata.generation`.
270270
|integer
271271

272-
|operatorVersion
272+
|`operatorVersion`
273273
|The version of the operator that last processed this resource.
274274
|string
275275

276-
|readiness
276+
|`readiness`
277277
|The readiness status of components & owned resources
278278
|string
279-
|===
279+
|===

0 commit comments

Comments
 (0)