diff --git a/_topic_map.yml b/_topic_map.yml index f25f2d06c26a..7d4afdb016f7 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -2572,6 +2572,8 @@ Topics: File: ossm-performance-scalability - Name: Extensions File: ossm-extensions + - Name: Deploying to production + File: ossm-deploy-production - Name: Using the 3scale Istio adapter File: threescale-adapter - Name: Removing Service Mesh diff --git a/modules/ossm-deploying-jaeger.adoc b/modules/ossm-deploying-jaeger.adoc index c244e4555da3..a11e68dd4302 100644 --- a/modules/ossm-deploying-jaeger.adoc +++ b/modules/ossm-deploying-jaeger.adoc @@ -59,7 +59,7 @@ To use the `production` deployment strategy, set `spec.addons.jaeger.install.st apiVersion: maistra.io/v2 kind: ServiceMeshControlPlane metadata: - name: production + name: basic spec: version: v2.0 tracing: diff --git a/modules/ossm-smcp-prod.adoc b/modules/ossm-smcp-prod.adoc new file mode 100644 index 000000000000..c7b4fed72755 --- /dev/null +++ b/modules/ossm-smcp-prod.adoc @@ -0,0 +1,52 @@ +// Module included in the following assemblies: +// +// * service_mesh/v2x/ossm-deploy-production.adoc + +[id="ossm-smcp-prod_{context}"] += Configuring your ServiceMeshControlPlane resource for production + +If you have installed a basic `ServiceMeshControlPlane` resource to test {ProductShortName}, you must configure it to production specification before you use {ProductName} in production. + +You cannot change the `metadata.name` field of an existing `ServiceMeshControlPlane` resource. For production deployments, you must customize the default template. + +.Procedure + +. Configure Jaeger for production. ++ +.. Edit the `ServiceMeshControlPlane` resource to use the `production` deployment strategy, by setting `spec.addons.jaeger.install.storage.type` to `Elasticsearch` and specify additional configuration options under `install`. You can create and configure your Jaeger instance and set `spec.addons.jaeger.name` to the name of the Jaeger instance, for example, `jaeger-production`. ++ +.Default Jaeger parameters including Elasticsearch +[source,yaml] +---- +apiVersion: maistra.io/v2 +kind: ServiceMeshControlPlane +metadata: + name: basic +spec: + version: v2.0 + tracing: + sampling: 100 + type: Jaeger + addons: + jaeger: + name: jaeger-production + install: + storage: + type: Elasticsearch + ingress: + enabled: true + runtime: + components: + tracing.jaeger.elasticsearch: # only supports resources and image name + container: + resources: {} +---- + +. Ensure your security certificates are production ready by installing security certificates from an external certificate authority. For more information, see the Security section. + +. Verify the results. Enter the following command to verify that the `ServiceMeshControlPlane` resource updated properly. In this example, `basic` is the name of the `ServiceMeshControlPlane` resource. + +[source,terminal] +---- +$ oc get smcp basic -o yaml +---- diff --git a/service_mesh/v2x/ossm-deploy-production.adoc b/service_mesh/v2x/ossm-deploy-production.adoc new file mode 100644 index 000000000000..9f812f809332 --- /dev/null +++ b/service_mesh/v2x/ossm-deploy-production.adoc @@ -0,0 +1,14 @@ +[id="ossm-production"] +include::modules/ossm-document-attributes.adoc[] += Configuring Service Mesh for production +:context: ossm-architecture +toc::[] + +When you are ready to move from a basic installation to production, you must configure your control plane, tracing, and security certificates to meet production requirements. + +.Prerequisites + +* Install and configure {ProductName}. +* Test your configuration in a staging environment. + +include::modules/ossm-smcp-prod.adoc[leveloffset=+1]