Merge pull request #36517 from openshift-cherrypick-robot/cherry-pick-34983-to-enterprise-4.9

[enterprise-4.9] OSSMDOC-198: Update configuration reference section.

_topic_map.yml

@@ -2696,7 +2696,7 @@ Topics:
     File: threescale-adapter
   - Name: Troubleshooting Service Mesh
     File: ossm-troubleshooting-istio
-  - Name: SMCP configuration reference
+  - Name: Service Mesh configuration reference
     File: ossm-reference-smcp
   - Name: Jaeger configuration reference
     File: ossm-reference-jaeger

modules/ossm-cr-example.adoc

@@ -146,13 +146,15 @@ metadata:
   name: basic
 spec:
   proxy:
-    resources:
-      requests:
-        cpu: 100m
-        memory: 128Mi
-      limits:
-        cpu: 500m
-        memory: 128Mi
+    runtime:
+      container:
+        resources:
+          requests:
+            cpu: 100m
+            memory: 128Mi
+          limits:
+            cpu: 500m
+            memory: 128Mi
   tracing:
     type: Jaeger
   gateways:
@@ -211,6 +213,13 @@ spec:
         config:
           env: {}
           envSecrets: {}
+        persistence:
+          enabled: true
+          storageClassName: ""
+          accessMode: ReadWriteOnce
+          capacity:
+            requests:
+              storage: 5Gi
         service:
           ingress:
             contextPath: /grafana

modules/ossm-cr-general.adoc

@@ -0,0 +1,60 @@
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-reference-smcp.adoc
+
+[id="ossm-cr-general_{context}"]
+= general parameters
+
+Here is an example that illustrates the `spec.general` parameters for the `ServiceMeshControlPlane` object and a description of the available parameters with appropriate values.
+
+.Example general parameters
+[source,yaml]
+----
+apiVersion: maistra.io/v2
+kind: ServiceMeshControlPlane
+metadata:
+  name: basic
+spec
+  general:
+    logging:
+      componentLevels: {}
+          # misc: error
+      logAsJSON: false
+    validationMessages: true
+----
+
+
+.Istio general parameters
+[options="header"]
+[cols="l, a, a, a"]
+|===
+|Parameter |Description |Values |Default value
+
+|logging:
+|Use to configure logging for the control plane components.
+|
+|N/A
+
+|logging:
+ componentLevels:
+|Use to specify the component logging level.
+|Possible values: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
+|N/A
+
+|logging:
+ logLevels:
+|Possible values: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
+|
+|N/A
+
+|logging:
+ logAsJSON:
+|Use to enable or disable JSON logging.
+|`true`/`false`
+|N/A
+
+|validationMessages:
+|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.
+|`true`/`false`
+|N/A
+|===

modules/ossm-cr-profiles.adoc

@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-reference-smcp.adoc
+
+[id="ossm-cr-profiles_{context}"]
+= profiles parameters
+
+You can create reusable configurations with `ServiceMeshControlPlane` object profiles. If you do not configure the `profile` setting, {ProductName} uses the default profile.
+
+Here is an example that illustrates the `spec.profiles` parameter for the `ServiceMeshControlPlane` object:
+
+.Example profiles parameters
+[source,yaml]
+----
+apiVersion: maistra.io/v2
+kind: ServiceMeshControlPlane
+metadata:
+  name: basic
+spec:
+  profiles:
+  - YourProfileName
+----

modules/ossm-cr-status.adoc

@@ -0,0 +1,49 @@
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-reference-smcp.adoc
+
+[id="ossm-cr-status_{context}"]
+= status parameter
+
+The `status` parameter describes the current state of your service mesh. This information is generated by the Operator and is read-only.
+
+.Istio status parameters
+|===
+|Name |Description |Type
+
+|`observedGeneration`
+|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`.
+|integer
+
+|`annotations`
+|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.
+|Not configurable
+
+|`readiness`
+|The readiness status of components and owned resources.
+|string
+
+|`operatorVersion`
+|The version of the Operator that last processed this resource.
+|string
+
+|`components`
+|Shows the status of each deployed control plane component.
+|string
+
+|`appliedSpec`
+|The resulting specification of the configuration options after all profiles have been applied.
+|`ControlPlaneSpec`
+
+|`conditions`
+|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.
+|string
+
+|`chartVersion`
+|The version of the charts that were last processed for this resource.
+|string
+
+|`appliedValues`
+|The resulting `values.yaml` file that was used to generate the charts.
+|`ControlPlaneSpec`
+|===

modules/ossm-cr-techPreview.adoc

@@ -0,0 +1,14 @@
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-reference-smcp.adoc
+
+[id="ossm-cr-techPreview_{context}"]
+= techPreview parameters
+
+The `spec.techPreview` parameter enables early access to features that are in Technology Preview.
+
+[IMPORTANT]
+====
+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.
+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].
+====

modules/ossm-cr-tracing.adoc

@@ -0,0 +1,42 @@
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-reference-smcp.adoc
+
+[id="ossm-cr-tracing_{context}"]
+= tracing parameters
+
+The following example illustrates the `spec.tracing` parameters for the `ServiceMeshControlPlane` object, and a description of the available parameters with appropriate values.
+
+.Example tracing parameters
+[source,yaml]
+----
+apiVersion: maistra.io/v2
+kind: ServiceMeshControlPlane
+metadata:
+  name: basic
+spec:
+  version: v2.0
+  tracing:
+    sampling: 100
+    type: Jaeger
+----
+
+.Istio tracing parameters
+[options="header"]
+[cols="l, a, a, a"]
+|===
+|Parameter |Description |Values |Default value
+
+|tracing:
+ sampling:
+
+|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.
+|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.
+|`10000` (100% of traces)
+
+|tracing:
+ type:
+|Currently the only tracing type that is supported is `Jaeger`. Jaeger is enabled by default. To disable tracing, set the `type` parameter to `None`.
+|`None`, `Jaeger`
+|`Jaeger`
+|===

modules/ossm-cr-version.adoc

@@ -0,0 +1,8 @@
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-reference-smcp.adoc
+
+[id="ossm-cr-version_{context}"]
+= version parameter
+
+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

@@ -1,7 +1,7 @@
 [id="jaeger-config-ref"]
 = Jaeger configuration reference
 include::modules/ossm-document-attributes.adoc[]
-:context: jaeger-config-ref
+:context: jaeger-config-reference
 
 toc::[]
 
@@ -25,7 +25,7 @@ include::modules/jaeger-config-sampling.adoc[leveloffset=+2]
 
 include::modules/jaeger-config-storage.adoc[leveloffset=+2]
 
-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].
+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].
 
 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].
 

service_mesh/v2x/ossm-reference-smcp.adoc

@@ -1,16 +1,36 @@
 [id="ossm-reference"]
-= SMCP configuration reference
+= Service Mesh control plane configuration reference
 include::modules/ossm-document-attributes.adoc[]
 :context: ossm-reference
 
+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.
+
 include::modules/ossm-cr-example.adoc[leveloffset=+1]
 
-include::modules/ossm-cr-threescale.adoc[leveloffset=+1]
+== spec parameters
+
+include::modules/ossm-cr-general.adoc[leveloffset=+2]
+
+include::modules/ossm-cr-profiles.adoc[leveloffset=+2]
+
+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].
+
+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)].
+
+include::modules/ossm-cr-techPreview.adoc[leveloffset=+2]
+
+include::modules/ossm-cr-tracing.adoc[leveloffset=+2]
+
+include::modules/ossm-cr-version.adoc[leveloffset=+2]
+
+include::modules/ossm-cr-threescale.adoc[leveloffset=+2]
+
+include::modules/ossm-cr-status.adoc[leveloffset=+1]
 
 [id="additional-resources_ossm-reference"]
 == Additional resources
 
-* For more information about how to configure the features in the `ServiceMeshControlPlane`, see the following links:
+* For more information about how to configure the features in the `ServiceMeshControlPlane` resource, see the following links:
 
 ** xref:../../service_mesh/v2x/ossm-security.adoc#ossm-security-mtls_ossm-security[Security]