Skip to content

Commit

Permalink
Merge pull request openshift#30703 from neal-timpe/ossmdoc-246
Browse files Browse the repository at this point in the history
OSSMDOC-246: Deploying to production
  • Loading branch information
Preeticp authored Jun 21, 2021
2 parents c739056 + d6fa60c commit 01ffe28
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 1 deletion.
2 changes: 2 additions & 0 deletions _topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2584,6 +2584,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
Expand Down
2 changes: 1 addition & 1 deletion modules/ossm-deploying-jaeger.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
52 changes: 52 additions & 0 deletions modules/ossm-smcp-prod.adoc
Original file line number Diff line number Diff line change
@@ -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
----
14 changes: 14 additions & 0 deletions service_mesh/v2x/ossm-deploy-production.adoc
Original file line number Diff line number Diff line change
@@ -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]

0 comments on commit 01ffe28

Please sign in to comment.