Skip to content

Commit e2e30d9

Browse files
JSticklerJStickler
authored
Merge pull request #34983 from JStickler/OSSMDOC-198
OSSMDOC-198: Update configuration reference section.
2 parents f97c1e3 + 36af34a commit e2e30d9

File tree

10 files changed

+237
-13
lines changed

10 files changed

+237
-13
lines changed

‎_topic_map.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2707,7 +2707,7 @@ Topics:
27072707
File: threescale-adapter
27082708
- Name: Troubleshooting Service Mesh
27092709
File: ossm-troubleshooting-istio
2710-
- Name: SMCP configuration reference
2710+
- Name: Service Mesh configuration reference
27112711
File: ossm-reference-smcp
27122712
- Name: Jaeger configuration reference
27132713
File: ossm-reference-jaeger

‎modules/ossm-cr-example.adoc‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -146,13 +146,15 @@ metadata:
146146
name: basic
147147
spec:
148148
proxy:
149-
resources:
150-
requests:
151-
cpu: 100m
152-
memory: 128Mi
153-
limits:
154-
cpu: 500m
155-
memory: 128Mi
149+
runtime:
150+
container:
151+
resources:
152+
requests:
153+
cpu: 100m
154+
memory: 128Mi
155+
limits:
156+
cpu: 500m
157+
memory: 128Mi
156158
tracing:
157159
type: Jaeger
158160
gateways:
@@ -211,6 +213,13 @@ spec:
211213
config:
212214
env: {}
213215
envSecrets: {}
216+
persistence:
217+
enabled: true
218+
storageClassName: ""
219+
accessMode: ReadWriteOnce
220+
capacity:
221+
requests:
222+
storage: 5Gi
214223
service:
215224
ingress:
216225
contextPath: /grafana

‎modules/ossm-cr-general.adoc‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-reference-smcp.adoc
4+
5+
[id="ossm-cr-general_{context}"]
6+
= general parameters
7+
8+
Here is an example that illustrates the `spec.general` parameters for the `ServiceMeshControlPlane` object and a description of the available parameters with appropriate values.
9+
10+
.Example general parameters
11+
[source,yaml]
12+
----
13+
apiVersion: maistra.io/v2
14+
kind: ServiceMeshControlPlane
15+
metadata:
16+
name: basic
17+
spec
18+
general:
19+
logging:
20+
componentLevels: {}
21+
# misc: error
22+
logAsJSON: false
23+
validationMessages: true
24+
----
25+
26+
27+
.Istio general parameters
28+
[options="header"]
29+
[cols="l, a, a, a"]
30+
|===
31+
|Parameter |Description |Values |Default value
32+
33+
|logging:
34+
|Use to configure logging for the control plane components.
35+
|
36+
|N/A
37+
38+
|logging:
39+
componentLevels:
40+
|Use to specify the component logging level.
41+
|Possible values: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
42+
|N/A
43+
44+
|logging:
45+
logLevels:
46+
|Possible values: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
47+
|
48+
|N/A
49+
50+
|logging:
51+
logAsJSON:
52+
|Use to enable or disable JSON logging.
53+
|`true`/`false`
54+
|N/A
55+
56+
|validationMessages:
57+
|Use to enable or disable validation messages to the status fields of istio.io resources. This can be useful for detecting configuration errors in resources.
58+
|`true`/`false`
59+
|N/A
60+
|===

‎modules/ossm-cr-profiles.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-reference-smcp.adoc
4+
5+
[id="ossm-cr-profiles_{context}"]
6+
= profiles parameters
7+
8+
You can create reusable configurations with `ServiceMeshControlPlane` object profiles. If you do not configure the `profile` setting, {ProductName} uses the default profile.
9+
10+
Here is an example that illustrates the `spec.profiles` parameter for the `ServiceMeshControlPlane` object:
11+
12+
.Example profiles parameters
13+
[source,yaml]
14+
----
15+
apiVersion: maistra.io/v2
16+
kind: ServiceMeshControlPlane
17+
metadata:
18+
name: basic
19+
spec:
20+
profiles:
21+
- YourProfileName
22+
----

‎modules/ossm-cr-status.adoc‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-reference-smcp.adoc
4+
5+
[id="ossm-cr-status_{context}"]
6+
= status parameter
7+
8+
The `status` parameter describes the current state of your service mesh. This information is generated by the Operator and is read-only.
9+
10+
.Istio status parameters
11+
|===
12+
|Name |Description |Type
13+
14+
|`observedGeneration`
15+
|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`.
16+
|integer
17+
18+
|`annotations`
19+
|The `annotations` parameter stores additional, usually redundant status information, such as the number of components deployed by the `ServiceMeshControlPlane` object. These statuses are used by the command line tool, `oc`, which does not yet allow counting objects in JSONPath expressions.
20+
|Not configurable
21+
22+
|`readiness`
23+
|The readiness status of components and owned resources.
24+
|string
25+
26+
|`operatorVersion`
27+
|The version of the Operator that last processed this resource.
28+
|string
29+
30+
|`components`
31+
|Shows the status of each deployed control plane component.
32+
|string
33+
34+
|`appliedSpec`
35+
|The resulting specification of the configuration options after all profiles have been applied.
36+
|`ControlPlaneSpec`
37+
38+
|`conditions`
39+
|Represents the latest available observations of the object's current state. `Reconciled` indicates that the Operator has finished reconciling the actual state of deployed components with the configuration in the `ServiceMeshControlPlane` resource. `Installed` indicates that the control plane has been installed. `Ready` indicates that all control plane components are ready.
40+
|string
41+
42+
|`chartVersion`
43+
|The version of the charts that were last processed for this resource.
44+
|string
45+
46+
|`appliedValues`
47+
|The resulting `values.yaml` file that was used to generate the charts.
48+
|`ControlPlaneSpec`
49+
|===

‎modules/ossm-cr-techPreview.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-reference-smcp.adoc
4+
5+
[id="ossm-cr-techPreview_{context}"]
6+
= techPreview parameters
7+
8+
The `spec.techPreview` parameter enables early access to features that are in Technology Preview.
9+
10+
[IMPORTANT]
11+
====
12+
Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production.
13+
These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see the link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Support Scope].
14+
====

‎modules/ossm-cr-tracing.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-reference-smcp.adoc
4+
5+
[id="ossm-cr-tracing_{context}"]
6+
= tracing parameters
7+
8+
The following example illustrates the `spec.tracing` parameters for the `ServiceMeshControlPlane` object, and a description of the available parameters with appropriate values.
9+
10+
.Example tracing parameters
11+
[source,yaml]
12+
----
13+
apiVersion: maistra.io/v2
14+
kind: ServiceMeshControlPlane
15+
metadata:
16+
name: basic
17+
spec:
18+
version: v2.0
19+
tracing:
20+
sampling: 100
21+
type: Jaeger
22+
----
23+
24+
.Istio tracing parameters
25+
[options="header"]
26+
[cols="l, a, a, a"]
27+
|===
28+
|Parameter |Description |Values |Default value
29+
30+
|tracing:
31+
sampling:
32+
33+
|The sampling rate determines how often the Envoy proxy generates a trace. You use the sampling rate to control what percentage of requests get reported to your tracing system.
34+
|Integer values between 0 and 10000 representing increments of 0.01% (0 to 100%). For example, setting the value to `10` samples 0.1% of requests, setting the value to `100` will sample 1% of requests setting the value to `500` samples 5% of requests, and a setting of `10000` samples 100% of requests.
35+
|`10000` (100% of traces)
36+
37+
|tracing:
38+
type:
39+
|Currently the only tracing type that is supported is `Jaeger`. Jaeger is enabled by default. To disable tracing, set the `type` parameter to `None`.
40+
|`None`, `Jaeger`
41+
|`Jaeger`
42+
|===

‎modules/ossm-cr-version.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-reference-smcp.adoc
4+
5+
[id="ossm-cr-version_{context}"]
6+
= version parameter
7+
8+
You use the `version` parameter to specify what version of the control plane to install. When you create a `ServiceMeshControlPlane` object with an empty `version` parameter, the admission webhook sets the version to the current version. New `ServiceMeshControlPlanes` objects with an empty `version` parameter are set to `v2.0`. Existing `ServiceMeshControlPlanes` objects with an empty `version` parameter keep their setting.

‎service_mesh/v2x/ossm-reference-jaeger.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[id="jaeger-config-ref"]
22
= Jaeger configuration reference
33
include::modules/ossm-document-attributes.adoc[]
4-
:context: jaeger-config-ref
4+
:context: jaeger-config-reference
55

66
toc::[]
77

@@ -25,7 +25,7 @@ include::modules/jaeger-config-sampling.adoc[leveloffset=+2]
2525

2626
include::modules/jaeger-config-storage.adoc[leveloffset=+2]
2727

28-
For more information about configuring Elasticsearch with {product-title}, see xref:../../logging/config/cluster-logging-log-store.adoc[Configuring the log store] or xref:../../jaeger/jaeger_install/rhbjaeger-deploying.adoc[Configuring and deploying Jaeger].
28+
For more information about configuring Elasticsearch with {product-title}, see xref:../../logging/config/cluster-logging-log-store.adoc[Configuring the log store] or xref:../../jaeger/jaeger_install/rhbjaeger-deploying.adoc[Configuring and deploying Jaeger].
2929

3030
For information about connecting to an external Elasticsearch instance, see xref:../../jaeger/jaeger_install/rhbjaeger-deploying.adoc#jaeger-config-external-es_jaeger-deploying[Connecting to an existing Elasticsearch instance].
3131

‎service_mesh/v2x/ossm-reference-smcp.adoc‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
11
[id="ossm-reference"]
2-
= SMCP configuration reference
2+
= Service Mesh control plane configuration reference
33
include::modules/ossm-document-attributes.adoc[]
44
:context: ossm-reference
55

6+
You can customize your {ProductName} by modifying the default `ServiceMeshControlPlane` (SMCP) resource or by creating a completely custom SMCP resource. This reference section documents the configuration options available for the SMCP resource.
7+
68
include::modules/ossm-cr-example.adoc[leveloffset=+1]
79

8-
include::modules/ossm-cr-threescale.adoc[leveloffset=+1]
10+
== spec parameters
11+
12+
include::modules/ossm-cr-general.adoc[leveloffset=+2]
13+
14+
include::modules/ossm-cr-profiles.adoc[leveloffset=+2]
15+
16+
For information about creating profiles, see the xref:../../service_mesh/v2x/ossm-profiles-users.adoc#ossm-control-plane-profiles_ossm-profiles-users[Creating control plane profiles].
17+
18+
For more detailed examples of security configuration, see xref:../../service_mesh/v2x/ossm-security.adoc#ossm-security-mtls_ossm-security[Mutual Transport Layer Security (mTLS)].
19+
20+
include::modules/ossm-cr-techPreview.adoc[leveloffset=+2]
21+
22+
include::modules/ossm-cr-tracing.adoc[leveloffset=+2]
23+
24+
include::modules/ossm-cr-version.adoc[leveloffset=+2]
25+
26+
include::modules/ossm-cr-threescale.adoc[leveloffset=+2]
27+
28+
include::modules/ossm-cr-status.adoc[leveloffset=+1]
929

1030
[id="additional-resources_ossm-reference"]
1131
== Additional resources
1232

13-
* For more information about how to configure the features in the `ServiceMeshControlPlane`, see the following links:
33+
* For more information about how to configure the features in the `ServiceMeshControlPlane` resource, see the following links:
1434

1535
** xref:../../service_mesh/v2x/ossm-security.adoc#ossm-security-mtls_ossm-security[Security]
1636

0 commit comments

Comments
 (0)