Skip to content

Commit 7b14cfc

Browse files
authored
Merge pull request #32055 from neal-timpe/ossmdoc-303
OSSMDOC-303: Config reorg
2 parents e9dcfe3 + a2224a1 commit 7b14cfc

File tree

55 files changed

+1029
-706
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1029
-706
lines changed

_topic_map.yml

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2551,28 +2551,26 @@ Topics:
25512551
File: ossm-create-mesh
25522552
- Name: Enabling sidecar injection
25532553
File: prepare-to-deploy-applications-ossm
2554-
- Name: Customizing the installation
2555-
File: customizing-installation-ossm
25562554
- Name: Upgrading from 1.1 to 2.0
25572555
File: upgrading-ossm
25582556
- Name: Managing users and profiles
25592557
File: ossm-profiles-users
2560-
- Name: Performance and scalability
2561-
File: ossm-performance-scalability
2562-
- Name: Data visualization and observability
2563-
File: ossm-observability
25642558
- Name: Security
25652559
File: ossm-security
25662560
- Name: Traffic management
25672561
File: ossm-traffic-manage
2568-
- Name: Custom resources
2569-
File: ossm-custom-resources
2562+
- Name: Metrics and traces
2563+
File: ossm-observability
2564+
- Name: Performance and scalability
2565+
File: ossm-performance-scalability
25702566
- Name: Extensions
25712567
File: ossm-extensions
25722568
- Name: Using the 3scale Istio adapter
25732569
File: threescale-adapter
25742570
- Name: Removing Service Mesh
25752571
File: removing-ossm
2572+
- Name: Configuration reference
2573+
File: ossm-reference
25762574
- Name: Service Mesh 1.x
25772575
Dir: v1x
25782576
Topics:
@@ -2586,18 +2584,14 @@ Topics:
25862584
File: preparing-ossm-installation
25872585
- Name: Installing Service Mesh
25882586
File: installing-ossm
2589-
- Name: Customizing the installation
2590-
File: customizing-installation-ossm
2591-
- Name: Deploying applications on Service Mesh
2592-
File: prepare-to-deploy-applications-ossm
2593-
- Name: Data visualization and observability
2594-
File: ossm-observability
25952587
- Name: Security
25962588
File: ossm-security
25972589
- Name: Traffic management
25982590
File: ossm-traffic-manage
2599-
- Name: Custom resources
2600-
File: ossm-custom-resources
2591+
- Name: Deploying applications on Service Mesh
2592+
File: prepare-to-deploy-applications-ossm
2593+
- Name: Data visualization and observability
2594+
File: ossm-observability
26012595
- Name: Using the 3scale Istio adapter
26022596
File: threescale-adapter
26032597
- Name: Removing Service Mesh

jaeger/jaeger_install/rhbjaeger-deploying.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The streaming strategy requires an additional Red Hat subscription for AMQ Strea
4040

4141
[NOTE]
4242
====
43-
There are two ways to install and use Jaeger, as part of a service mesh or as a stand alone component. If you have installed Jaeger as part of Red Hat OpenShift Service Mesh, you can configure and deploy Jaeger as part of the xref:../../service_mesh/v2x/ossm-custom-resources.adoc#ossm-custom-resources-v2x[ServiceMeshControlPlane] or configure Jaeger and then xref:../../service_mesh/v2x/ossm-custom-resources.adoc#ossm-deploying-jaeger-streaming[reference your Jaeger configuration in the SMCP].
43+
There are two ways to install and use Jaeger, as part of a service mesh or as a stand alone component. If you have installed Jaeger as part of Red Hat OpenShift Service Mesh, you can configure and deploy Jaeger as part of the xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane] or configure Jaeger and then xref:../../service_mesh/v2x/ossm-observability.html#ossm-config-external-jaeger_observability[reference your Jaeger configuration in the ServiceMeshControlPlane].
4444
4545
====
4646

modules/ossm-access-grafana.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-observability.adoc
4+
5+
[id="ossm-access-grafana_{context}"]
6+
= Accessing Grafana
7+
8+
Grafana is an analytics tool that you can use to view, query, and analyze your service mesh metrics. To access Grafana, do the following:
9+
10+
.Procedure
11+
12+
. Log in to the {product-title} web console.
13+
14+
. Click the *Project* menu and choose the `istio-system` project from the list.
15+
16+
. Click *Routes*.
17+
18+
. Click the link in the *Location* column for the *Grafana* row.
19+
20+
. Log into the Grafana console with your {product-title} credentials.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-observability.adoc
4+
5+
[id="ossm-access-prometheus_{context}"]
6+
= Accessing Prometheus
7+
8+
Prometheus is a monitoring and alerting tool that you can use to collect multi-dimensional data about your microservices.
9+
10+
.Procedure
11+
12+
. Log in to the {product-title} web console.
13+
14+
. Click the *Project* menu and choose the `istio-system` project from the list.
15+
16+
. Click *Routes*.
17+
18+
. Click the link in the *Location* column for the *Prometheus* row.
19+
20+
. Log into the Prometheus console with your {product-title} credentials.

modules/ossm-auto-route-1x.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This TASK module included in the following assemblies:
33
// * service_mesh/v1x/ossm-traffic-manage.adoc
44
////
55

6-
[id="ossm-auto-route_{context}"]
6+
[id="ossm-auto-route-1x_{context}"]
77
= Automatic route creation
88

99
OpenShift routes for Istio Gateways are automatically managed in {ProductName}. Every time an Istio Gateway is created, updated or deleted inside the service mesh, an OpenShift route is created, updated or deleted.
@@ -36,7 +36,7 @@ spec:
3636
[id="ossm-auto-route-subdomains_{context}"]
3737
== Subdomains
3838

39-
{ProductName} creates the route with the subdomain, but {product-title} must be configured to enable it. Subdomains, for example `*.domain.com`, are supported but not by default.
39+
{ProductName} creates the route with the subdomain, but {product-title} must be configured to enable it. Subdomains, for example `*.domain.com`, are supported but not by default. Configure an {product-title} wildcard policy before configuring a wildcard host Gateway. For more information, see the "Links" section.
4040

4141
If the following gateway is created:
4242

modules/ossm-auto-route.adoc

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,10 @@ This TASK module included in the following assemblies:
33
// * service_mesh/v2x/ossm-traffic-manage.adoc
44
////
55

6-
[id="ossm-auto-route_{context}"]
7-
= Automatic route creation
6+
[id="ossm-auto-route-create-subdomains_{context}"]
7+
= Creating subdomain routes
88

9-
OpenShift routes for Istio Gateways are automatically managed in {ProductName}. Every time an Istio Gateway is created, updated or deleted inside the service mesh, an OpenShift route is created, updated or deleted.
10-
11-
[id="ossm-auto-route-enable_{context}"]
12-
== Disabling Automatic Route Creation
13-
14-
By default, the `ServiceMeshControlPlane` automatically synchronizes the Gateway resources with OpenShift routes.
15-
16-
You can disable integration between Istio Gateways and OpenShift Routes by setting the `ServiceMeshControlPlane` field `gateways.openshiftRoute.enabled` to `false`. For example, see the following resource snippet.
17-
18-
[source,yaml]
19-
----
20-
spec:
21-
gateways:
22-
openshiftRoute:
23-
enabled: false
24-
----
25-
26-
[id="ossm-auto-route-subdomains_{context}"]
27-
== Subdomains
28-
29-
{ProductName} creates the route with the subdomain, but {product-title} must be configured to enable it. Subdomains, for example `*.domain.com`, are supported but not by default.
30-
31-
If the following gateway is created:
9+
The following example creates a gateway in the Bookinfo sample application, which creates subdomain routes.
3210

3311
[source,yaml]
3412
----
@@ -65,3 +43,18 @@ gateway1-scqhv www.bookinfo.com istio-ingressgateway <all>
6543
----
6644

6745
If the gateway is deleted, {ProductName} deletes the routes. However, routes created manually are never modified by {ProductName}.
46+
47+
[id="ossm-auto-route-enable_{context}"]
48+
= Disabling automatic route creation
49+
50+
By default, the `ServiceMeshControlPlane` resource automatically synchronizes the Gateway resources with OpenShift routes. Disabling the automatic route creation allows you more flexibility to control routes if you have a special case or prefer to control routes manually.
51+
52+
Disable integration between Istio Gateways and OpenShift Routes by setting the `ServiceMeshControlPlane` field `gateways.openshiftRoute.enabled` to `false`. For example, see the following resource snippet.
53+
54+
[source,yaml]
55+
----
56+
spec:
57+
gateways:
58+
openshiftRoute:
59+
enabled: false
60+
----

modules/ossm-config-dist-trac.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v1x/customizing-installation-ossm.adoc
4+
// * service_mesh/v2x/customizing-installation-ossm.adoc
5+
6+
[id="ossm-config-dist-trac_{context}"]
7+
= Distributed tracing
8+
9+
Distributed Tracing is the process of tracking the performance of individual services in an application by tracing the path of the service calls in the application. Each time a user takes action in an application, a request is executed that might require many services to interact to produce a response. The path of this request is called a distributed transaction.
10+
11+
{ProductName} uses Jaeger to allow developers to visualize call flows in a microservice application.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-config.adoc
4+
5+
[id="ossm-security-enabling-controlplane_{context}"]
6+
== Enabling strict mTLS for Mixer telemetry or policy components
7+
8+
Secure connections are always used when proxies communicate with the control plane regardless of the `spec.security.controlPlane.mtls` setting. If Mixer telemetry or policies are part of your configuration, set `spec.security.controlPlane.mtls` to `true` in your `ServiceMeshControlPlane` resource to enable strict mTLS.
9+
10+
[source,yaml]
11+
----
12+
apiVersion: maistra.io/v2
13+
kind: ServiceMeshControlPlane
14+
spec:
15+
version: v2.0
16+
security:
17+
controlPlane:
18+
mtls: true
19+
----
20+
21+
You can also enable mTLS for the control plane by using the {product-title} web console.
22+
23+
.Procedure
24+
25+
. Log in to the web console.
26+
27+
. Click the *Project* menu and choose the `istio-system` project from the list.
28+
29+
. Click *Operators* -> *Installed Operators*.
30+
31+
. Click *Service Mesh Control Plane* under *Provided APIs*.
32+
33+
. Click the name of your `ServiceMeshControlPlane` resource, for example, `production`.
34+
35+
. On the *Details* page, click the toggle in the *Security* section for *Control Plane Security*.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-config.adoc
4+
5+
[id="ossm-config-external-jaeger_{context}"]
6+
= Connecting standalone Jaeger
7+
8+
If you already use standalone Jaeger for distributed tracing in {product-title}, configure your `ServiceMeshControlPlane` resource to use that standalone Jaeger instance rather than the one installed with {ProductName}.
9+
10+
.Prerequisites
11+
12+
* Configure and deploy a standalone Jaeger instance. For more information, see the Jaeger documentation.
13+
14+
.Procedure
15+
16+
. In the {product-title} web console, click *Operators* -> *Installed Operators*.
17+
18+
. From the *Project* menu, select the project where you installed the control plane, for example `istio-system`.
19+
20+
. Click the {ProductName} Operator. In the *Istio Service Mesh Control Plane* column, click the name of your `ServiceMeshControlPlane` resource, for example `basic`.
21+
22+
. Add the name of your standalone Jaeger instance to the `ServiceMeshControlPlane`.
23+
+
24+
.. Click the *YAML* tab.
25+
+
26+
.. Add the name of your standalone Jaeger instance to `spec.addons.jaeger.name` in your `ServiceMeshControlPlane` resource. In the following example, `simple-prod` is the name of your standalone Jaeger instance.
27+
+
28+
.Standalone Jaeger example
29+
[source,yaml]
30+
----
31+
spec:
32+
addons:
33+
jaeger:
34+
name: simple-prod
35+
----
36+
+
37+
.. Click *Save*.
38+
39+
. Click *Reload* to verify the `ServiceMeshControlPlane` resource was configured correctly.
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
[id="ossm-security-min-max-tls_{context}"]
2+
== Setting the minimum and maximum protocol versions
3+
4+
If your environment has specific requirements for encrypted traffic in your service mesh, you can control the cryptographic functions that are allowed by setting the `spec.security.controlPlane.tls.minProtocolVersion` or `spec.security.controlPlane.tls.maxProtocolVersion` in your `ServiceMeshControlPlane` resource. Those values, configured in your control plane resource, define the minimum and maximum TLS version used by mesh components when communicating securely over TLS.
5+
6+
The default is `TLS_AUTO` and does not specify a version of TLS.
7+
8+
.Valid values
9+
|===
10+
|Value|Description
11+
12+
|`TLS_AUTO`
13+
| default
14+
15+
|`TLSv1_0`
16+
|TLS version 1.0
17+
18+
|`TLSv1_1`
19+
|TLS version 1.1
20+
21+
|`TLSv1_2`
22+
|TLS version 1.2
23+
24+
|`TLSv1_3`
25+
|TLS version 1.3
26+
|===
27+
28+
.Procedure
29+
30+
. Log in to the web console.
31+
32+
. Click the *Project* menu and choose the `istio-system` project from the list.
33+
34+
. Click *Operators* -> *Installed Operators*.
35+
36+
. Click *Service Mesh Control Plane* under *Provided APIs*.
37+
38+
. Click the name of your `ServiceMeshControlPlane` resource, for example, `basic`.
39+
40+
. Click the *YAML* tab.
41+
42+
. Insert the following code snippet in the YAML editor. Replace the value in the `minProtocolVersion` with the TLS version value. In this example, the minimum TLS version is set to `TLSv1_2`.
43+
+
44+
.ServiceMeshControlPlane snippet
45+
[source,yaml]
46+
----
47+
kind: ServiceMeshControlPlane
48+
spec:
49+
security:
50+
controlPlane:
51+
tls:
52+
minProtocolVersion: TLSv1_2
53+
----
54+
55+
. Click *Save*.
56+
57+
. Click *Refresh* to verify that the changes updated correctly.

0 commit comments

Comments
 (0)