Skip to content

Commit f9089cb

Browse files
authored
Merge pull request #28109 from brian-avery/fixesOSSMDocs
Some fixes to the OSSM docs
2 parents a72b49d + c068758 commit f9089cb

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

modules/ossm-jaeger-service-mesh.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Installing Jaeger with the Service Mesh on {product-title} differs from communit
1111

1212
* Jaeger has been enabled by default for {ProductShortName}.
1313
* Ingress has been enabled by default for {ProductShortName}.
14-
* The name for the Zipkin port name has changed to jaeger-collector-zipkin (from http)
14+
* The name for the Zipkin port name has changed to `jaeger-collector-zipkin` (from `http`)
1515
* Jaeger uses Elasticsearch for storage by default.
1616
* The community version of Istio provides a generic "tracing" route. {ProductName} uses a "jaeger" route that is installed by the Jaeger operator and is already protected by OAuth.
1717
* {ProductName} uses a sidecar for the Envoy proxy, and Jaeger also uses a sidecar, for the Jaeger agent.

modules/ossm-kiali-architecture.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In addition, Kiali depends on external services and components provided by the c
1717

1818
* *Red Hat Service Mesh* (Istio) - Istio is a Kiali requirement. Istio is the component that provides and controls the service mesh. Although Kiali and Istio can be installed separately, Kiali depends on Istio and will not work if it is not present. Kiali needs to retrieve Istio data and configurations, which are exposed through Prometheus and the cluster API.
1919

20-
* *Prometheus* - A dedicated Prometheus instance is included as part of the {ProductName} installation. When Istio telemetry is enabled, metrics data is stored in Prometheus. Kiali uses this Prometheus data to determine the mesh topology, display metrics, calculate health, show possible problems, and so on. Kiali communicates directly with Prometheus and assumes the data schema used by Istio Telemetery. Prometheus is an Istio dependency and a hard dependency for Kiali, and many of Kiali’s features will not work without Prometheus.
20+
* *Prometheus* - A dedicated Prometheus instance is included as part of the {ProductName} installation. When Istio telemetry is enabled, metrics data is stored in Prometheus. Kiali uses this Prometheus data to determine the mesh topology, display metrics, calculate health, show possible problems, and so on. Kiali communicates directly with Prometheus and assumes the data schema used by Istio Telemetry. Prometheus is an Istio dependency and a hard dependency for Kiali, and many of Kiali’s features will not work without Prometheus.
2121

2222
* *Cluster API* - Kiali uses the API of the {product-title} (cluster API) in order to fetch and resolve service mesh configurations. Kiali queries the cluster API to retrieve, for example, definitions for namespaces, services, deployments, pods, and other entities. Kiali also makes queries to resolve relationships between the different cluster entities. The cluster API is also queried to retrieve Istio configurations like virtual services, destination rules, route rules, gateways, quotas, and so on.
2323

modules/ossm-routing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ A service entry adds an entry to the service registry that {ProductName} maintai
218218
* Define retry, timeout, and fault injection policies for external destinations.
219219
* Run a mesh service in a Virtual Machine (VM) by adding VMs to your mesh.
220220
* Logically add services from a different cluster to the mesh to configure a multicluster {ProductName} mesh on Kubernetes.
221-
* You don’t need to add a service entry for every external service that you want your mesh services to use. By default, {ProductName} configures the Envoy proxies to passthrough requests to unknown services. However, you can’t use {ProductName} features to control the traffic to destinations that aren’t registered in the mesh.
221+
* You don’t need to add a service entry for every external service that you want your mesh services to use. By default, {ProductName} configures the Envoy proxies to pass requests through to unknown services. However, you can’t use {ProductName} features to control the traffic to destinations that aren’t registered in the mesh.
222222

223223
.Service entry examples
224224
The following example mesh-external service entry adds the `ext-resource` external dependency to the {ProductName} service registry:

modules/ossm-security-cert-manage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ By default, {ProductName} generates self-signed root certificate and key, and us
1818

1919
To use an existing signing (CA) certificate and key, you must create a chain of trust file that includes the CA certificate, key, and root certificate. You must use the following exact file names for each of the corresponding certificates. The CA certificate is called `ca-cert.pem`, the key is `ca-key.pem`, and the root certificate, which signs `ca-cert.pem`, is called `root-cert.pem`. If your workload uses intermediate certificates, you must specify them in a `cert-chain.pem` file.
2020

21-
Add the certificates to {ProductShortName} by following these steps. Save the example certificates from the link:https://github.com/maistra/istio/tree/maistra-2.0/samples/certs[Maistra repo] locally and replace `<path>` with the path to your certificates.
21+
Add the certificates to {ProductShortName} by following these steps. Save the example certificates from the link:https://github.com/maistra/istio/tree/maistra-2.0/samples/certs[Maistra repository] locally and replace `<path>` with the path to your certificates.
2222

2323
. Create a secret `cacert` that includes the input files `ca-cert.pem`, `ca-key.pem`, `root-cert.pem` and `cert-chain.pem`.
2424
+

modules/ossm-tutorial-jaeger-generating-traces.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This tutorial uses {ProductShortName} and the Bookinfo tutorial to demonstrate h
2828
* Bookinfo example application installed.
2929

3030
.Procedure
31-
. After you have deployed the Bookinfo application you will need to generate calls to the Bookinfo application so that you have some trace data to analyze. Access http://<GATEWAY_URL>/productpage and refresh the page a few times to generate some trace data.
31+
. After you have deployed the Bookinfo application you will need to generate calls to the Bookinfo application so that you have some trace data to analyze. Access `http://<GATEWAY_URL>/productpage` and refresh the page a few times to generate some trace data.
3232
. The installation process creates a route to access the Jaeger console.
3333
.. In the {product-title} console, navigate to *Networking* -> *Routes* and search for the Jaeger route, which is the URL listed under *Location*.
3434
.. Use the CLI to query for details of the route:

modules/ossm-vs-istio.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ An installation of {ProductName} differs from an installation of Istio in multip
1111
[id="ossm-cli-tool_{context}"]
1212
== Command line tool
1313

14-
The command line tool for {ProductName} is oc.  {ProductName} does not support istioctl.
14+
The command line tool for {ProductName} is `oc`.  {ProductName} does not support `istioctl`.
1515

1616

1717
[id="ossm-installation-upgrade_{context}"]

0 commit comments

Comments
 (0)