Skip to content

Commit

Permalink
Merge pull request openshift#32981 from neal-timpe/ossmdoc-329
Browse files Browse the repository at this point in the history
OSSMDOC-329: Performance scalability review
  • Loading branch information
mburke5678 authored Jun 30, 2021
2 parents 7087da2 + d4c42e6 commit 25c181c
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 5 deletions.
25 changes: 22 additions & 3 deletions modules/ossm-recommended-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,26 @@ This module included in the following assemblies:
////

[id="ossm-recommended-resources_{context}"]
= Recommended compute resources
= Setting limits on compute resources

By default, `spec.proxy` has the settings `cpu:10m` and `memory:128M`. If you are using Pilot, `spec.runtime.components.pilot` has the same default values.
The settings in the following example are based on 1,000 services and 1,000 requests per second. You can change the values for `cpu` and `memory` as necessary based on your environment.
By default, `spec.proxy` has the settings `cpu: 10m` and `memory: 128M`. If you are using Pilot, `spec.runtime.components.pilot` has the same default values.

The settings in the following example are based on 1,000 services and 1,000 requests per second. You can change the values for `cpu` and `memory` in the `ServiceMeshControlPlane`.

.Procedure

. In the {product-title} web console, click *Operators* -> *Installed Operators*.

. From the Project menu, select the project where you installed the `ServiceMeshControlPlane` resource, for example `istio-system`.

. Click the {ProductName} Operator. In the *Istio Service Mesh Control Plane* column, click the name of your `ServiceMeshControlPlane`, for example `basic`.

. Add the name of your standalone Jaeger instance to the `ServiceMeshControlPlane`.
+
.. Click the *YAML* tab.
+
.. Set the values for `spec.proxy.runtime.container.resources.requests.cpu` and `spec.proxy.runtime.container.resources.requests.memory` in your `ServiceMeshControlPlane` resource.
+
.Example version 2.0 ServiceMeshControlPlane
[source,yaml]
----
Expand Down Expand Up @@ -38,3 +53,7 @@ spec:
memory: 1.6Gi
limits: {}
----
+
.. Click *Save*.

. Click *Reload* to verify the `ServiceMeshControlPlane` resource was configured correctly.
4 changes: 3 additions & 1 deletion modules/ossm-smcp-prod.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,12 @@ spec:
resources: {}
----

.. Configure the sampling rate for production. For more information, see the Performance and scalability section.

. 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
Expand Down
4 changes: 4 additions & 0 deletions service_mesh/v2x/ossm-deploy-production.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,7 @@ When you are ready to move from a basic installation to production, you must con
* Test your configuration in a staging environment.
include::modules/ossm-smcp-prod.adoc[leveloffset=+1]

= Additional resources

For more information about tuning {ProductShortName} for performance, see xref:../../service_mesh/v2x/ossm-performance-scalability.adoc#ossm-performance-scalability[Perforance and Scalability].
4 changes: 3 additions & 1 deletion service_mesh/v2x/ossm-performance-scalability.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
[id="ossm-performance-scalability"]
= Performance and scalability
include::modules/ossm-document-attributes.adoc[]
:context: performance-scalability

toc::[]

The default `ServiceMeshControlPlane` settings are not intended for production use; they are designed to install successfully on a default OpenShift installation, which is an extremely resource limited environment. After you have verified a successful SMCP installation, you should modify the settings defined within the SMCP to suit your environment. This section provides guidance for configuring {ProductName} for production use.
The default `ServiceMeshControlPlane` settings are not intended for production use; they are designed to install successfully on a default {product-title} installation, which is a resource-limited environment. After you have verified a successful SMCP installation, you should modify the settings defined within the SMCP to suit your environment.

// The following include statements pull in the module files that comprise the assembly.

include::modules/ossm-recommended-resources.adoc[leveloffset=+1]

include::modules/ossm-load-test-results.adoc[leveloffset=+1]

0 comments on commit 25c181c

Please sign in to comment.