Skip to content

Commit 74e1a92

Browse files
committed
OSSMDOC-553: merge service mesh attributes files.
1 parent c81901c commit 74e1a92

File tree

169 files changed

+554
-647
lines changed

Some content is hidden

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

169 files changed

+554
-647
lines changed

_attributes/common-attributes.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,3 @@ endif::[]
9494
:MaistraVersion: 2.1
9595
//Service Mesh v1
9696
:SMProductVersion1x: 1.1.17
97-
:MaistraVersionv1: 1.1

_attributes/ossm-document-attributes-1x.adoc

Lines changed: 0 additions & 37 deletions
This file was deleted.

_attributes/ossm-document-attributes.adoc

Lines changed: 0 additions & 47 deletions
This file was deleted.

machine_management/creating-infrastructure-machinesets.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
[id="creating-infrastructure-machinesets"]
33
= Creating infrastructure machine sets
44
include::_attributes/common-attributes.adoc[]
5-
include::_attributes/ossm-document-attributes.adoc[]
65
:context: creating-infrastructure-machinesets
76

87
toc::[]

modules/distr-tracing-accessing-jaeger-console.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The *Location* column displays the linked address for each route.
3737

3838
.Procedure from the CLI
3939

40-
. Log in to the {product-title} CLI as a user with the `cluster-admin` role. If you use Red Hat OpenShift Dedicated, you must have an account with the `dedicated-admin` role.
40+
. Log in to the {product-title} CLI as a user with the `cluster-admin` role. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.
4141
+
4242
[source,terminal]
4343
----

modules/distr-tracing-change-operator-20.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ As part of the update to version 2.0, you must update your OpenShift Elasticsear
1919
* The {product-title} version is 4.6 or later.
2020
* You have updated the OpenShift Elasticsearch Operator.
2121
* You have backed up the Jaeger custom resource file.
22-
* An account with the `cluster-admin` role. If you use Red Hat OpenShift Dedicated, you must have an account with the `dedicated-admin` role.
22+
* An account with the `cluster-admin` role. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.

modules/ossm-about-collecting-ossm-data.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[id="ossm-about-collecting-ossm-data_{context}"]
99
= About collecting service mesh data
1010

11-
You can use the `oc adm must-gather` CLI command to collect information about your cluster, including features and objects associated with {ProductName}.
11+
You can use the `oc adm must-gather` CLI command to collect information about your cluster, including features and objects associated with {SMProductName}.
1212

1313
.Prerequisites
1414

@@ -18,14 +18,14 @@ You can use the `oc adm must-gather` CLI command to collect information about yo
1818
1919
.Precedure
2020

21-
. To collect {ProductName} data with `must-gather`, you must specify the {ProductName} image.
21+
. To collect {SMProductName} data with `must-gather`, you must specify the {SMProductName} image.
2222
+
2323
[source,terminal]
2424
----
2525
$ oc adm must-gather --image=registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel8
2626
----
2727
+
28-
. To collect {ProductName} data for a specific control plane namespace with `must-gather`, you must specify the {ProductName} image and namespace. In this example, replace `<namespace>` with your control plane namespace, such as `istio-system`.
28+
. To collect {SMProductName} data for a specific control plane namespace with `must-gather`, you must specify the {SMProductName} image and namespace. In this example, replace `<namespace>` with your control plane namespace, such as `istio-system`.
2929
+
3030
[source,terminal]
3131
----

modules/ossm-architecture-1x.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
// -service_mesh/v1x/ossm-architecture.adoc
44

55
[id="ossm-architecture-1x_{context}"]
6-
= {ProductName} Architecture
6+
= {SMProductName} Architecture
77

8-
{ProductName} is logically split into a data plane and a control plane:
8+
{SMProductName} is logically split into a data plane and a control plane:
99

1010
The *data plane* is a set of intelligent proxies deployed as sidecars. These proxies intercept and control all inbound and outbound network communication between microservices in the service mesh. Sidecar proxies also communicate with Mixer, the general-purpose policy and telemetry hub.
1111

@@ -18,4 +18,4 @@ The *control plane* manages and configures proxies to route traffic, and configu
1818
* *Citadel* issues and rotates certificates. Citadel provides strong service-to-service and end-user authentication with built-in identity and credential management. You can use Citadel to upgrade unencrypted traffic in the service mesh. Operators can enforce policies based on service identity rather than on network controls using Citadel.
1919
* *Galley* ingests the service mesh configuration, then validates, processes, and distributes the configuration. Galley protects the other service mesh components from obtaining user configuration details from {product-title}.
2020

21-
{ProductName} also uses the *istio-operator* to manage the installation of the control plane. An _Operator_ is a piece of software that enables you to implement and automate common activities in your {product-title} cluster. It acts as a controller, allowing you to set or change the desired state of objects in your cluster.
21+
{SMProductName} also uses the *istio-operator* to manage the installation of the control plane. An _Operator_ is a piece of software that enables you to implement and automate common activities in your {product-title} cluster. It acts as a controller, allowing you to set or change the desired state of objects in your cluster.

modules/ossm-architecture.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Service mesh technology operates at the network communication level. That is, se
99

1010
image::ossm-architecture.png[Service Mesh architecture image]
1111

12-
At a high level, {ProductName} consists of a data plane and a control plane
12+
At a high level, {SMProductName} consists of a data plane and a control plane
1313

1414
The *data plane* is a set of intelligent proxies, running alongside application containers in a pod, that intercept and control all inbound and outbound network communication between microservices in the service mesh.
1515
The data plane is implemented in such a way that it intercepts all inbound (ingress) and outbound (egress) network traffic. The Istio data plane is composed of Envoy containers running along side application containers in a pod. The Envoy container acts as a proxy, controlling all network communication into and out of the pod.
@@ -32,20 +32,20 @@ The *control plane* manages and configures the proxies that make up the data pla
3232

3333
** Istiod is responsible for injecting sidecar proxy containers into workloads deployed to an OpenShift cluster.
3434

35-
{ProductName} uses the *istio-operator* to manage the installation of the control plane. An _Operator_ is a piece of software that enables you to implement and automate common activities in your OpenShift cluster. It acts as a controller, allowing you to set or change the desired state of objects in your cluster, in this case, a {ProductName} installation.
35+
{SMProductName} uses the *istio-operator* to manage the installation of the control plane. An _Operator_ is a piece of software that enables you to implement and automate common activities in your OpenShift cluster. It acts as a controller, allowing you to set or change the desired state of objects in your cluster, in this case, a {SMProductName} installation.
3636

37-
{ProductName} also bundles the following Istio add-ons as part of the product:
37+
{SMProductName} also bundles the following Istio add-ons as part of the product:
3838

39-
* *Kiali* - Kiali is the management console for {ProductName}. It provides dashboards, observability, and robust configuration and validation capabilities. It shows the structure of your service mesh by inferring traffic topology and displays the health of your mesh. Kiali provides detailed metrics, powerful validation, access to Grafana, and strong integration with the {JaegerShortName}.
39+
* *Kiali* - Kiali is the management console for {SMProductName}. It provides dashboards, observability, and robust configuration and validation capabilities. It shows the structure of your service mesh by inferring traffic topology and displays the health of your mesh. Kiali provides detailed metrics, powerful validation, access to Grafana, and strong integration with the {JaegerShortName}.
4040

41-
* *Prometheus* - {ProductName} uses Prometheus to store telemetry information from services. Kiali depends on Prometheus to obtain metrics, health status, and mesh topology.
41+
* *Prometheus* - {SMProductName} uses Prometheus to store telemetry information from services. Kiali depends on Prometheus to obtain metrics, health status, and mesh topology.
4242

43-
* *Jaeger* - {ProductName} supports the {JaegerShortName}. Jaeger is an open source traceability server that centralizes and displays traces associated with a single request between multiple services. Using the {JaegerShortName} you can monitor and troubleshoot your microservices-based distributed systems.
43+
* *Jaeger* - {SMProductName} supports the {JaegerShortName}. Jaeger is an open source traceability server that centralizes and displays traces associated with a single request between multiple services. Using the {JaegerShortName} you can monitor and troubleshoot your microservices-based distributed systems.
4444

4545
* *Elasticsearch* - Elasticsearch is an open source, distributed, JSON-based search and analytics engine. The {JaegerShortName} uses Elasticsearch for persistent storage.
4646

4747
* *Grafana* - Grafana provides mesh administrators with advanced query and metrics analysis and dashboards for Istio data. Optionally, Grafana can be used to analyze service mesh metrics.
4848

49-
The following Istio integrations are supported with {ProductName}:
49+
The following Istio integrations are supported with {SMProductName}:
5050

5151
* *3scale* - Istio provides an optional integration with Red Hat 3scale API Management solutions. For versions prior to 2.1, this integration was achieved via the 3scale Istio adapter. For version 2.1 and later, the 3scale integration is achieved via a WebAssembly module.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ This TASK module included in the following assemblies:
66
[id="ossm-auto-route-1x_{context}"]
77
= Automatic route creation
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.
9+
OpenShift routes for Istio Gateways are automatically managed in {SMProductName}. Every time an Istio Gateway is created, updated or deleted inside the service mesh, an OpenShift route is created, updated or deleted.
1010

1111
[id="ossm-auto-route-enable_{context}"]
1212
== Enabling Automatic Route Creation
13-
A {ProductName} control plane component called Istio OpenShift Routing (IOR) synchronizes the gateway route. Enable IOR as part of the control plane deployment.
13+
A {SMProductName} control plane component called Istio OpenShift Routing (IOR) synchronizes the gateway route. Enable IOR as part of the control plane deployment.
1414

1515
If the Gateway contains a TLS section, the OpenShift Route will be configured to support TLS.
1616

@@ -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. Configure an {product-title} wildcard policy before configuring a wildcard host Gateway. For more information, see the "Links" section.
39+
{SMProductName} 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

@@ -74,4 +74,4 @@ gateway1-lvlfn bookinfo.example.com istio-ingressgateway <all>
7474
gateway1-scqhv www.bookinfo.com istio-ingressgateway <all> None
7575
----
7676

77-
If the gateway is deleted, {ProductName} deletes the routes. However, routes created manually are never modified by {ProductName}.
77+
If the gateway is deleted, {SMProductName} deletes the routes. However, routes created manually are never modified by {SMProductName}.

0 commit comments

Comments
 (0)