Skip to content

Commit 24c01df

Browse files
authored
Merge pull request #48540 from rh-tokeefe/OSSMDOC-474-New
OSSMDOC-474: Publish service mesh docs to ROSA
2 parents cea942c + 8adf9ee commit 24c01df

18 files changed

+157
-12
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,93 @@ Topics:
316316
# - Name: Using the internal registry
317317
# File: rosa-using-internal-registry
318318
---
319+
Name: Service Mesh
320+
Dir: service_mesh
321+
Distros: openshift-rosa
322+
Topics:
323+
- Name: Service Mesh 2.x
324+
Dir: v2x
325+
Topics:
326+
- Name: About OpenShift Service Mesh
327+
File: ossm-about
328+
- Name: Service Mesh 2.x release notes
329+
File: servicemesh-release-notes
330+
- Name: Service Mesh architecture
331+
File: ossm-architecture
332+
- Name: Service Mesh deployment models
333+
File: ossm-deployment-models
334+
- Name: Service Mesh and Istio differences
335+
File: ossm-vs-community
336+
- Name: Preparing to install Service Mesh
337+
File: preparing-ossm-installation
338+
- Name: Installing the Operators
339+
File: installing-ossm
340+
- Name: Creating the ServiceMeshControlPlane
341+
File: ossm-create-smcp
342+
- Name: Adding workloads to a service mesh
343+
File: ossm-create-mesh
344+
- Name: Enabling sidecar injection
345+
File: prepare-to-deploy-applications-ossm
346+
- Name: Upgrading Service Mesh
347+
File: upgrading-ossm
348+
- Name: Managing users and profiles
349+
File: ossm-profiles-users
350+
- Name: Security
351+
File: ossm-security
352+
- Name: Traffic management
353+
File: ossm-traffic-manage
354+
- Name: Metrics, logs, and traces
355+
File: ossm-observability
356+
- Name: Performance and scalability
357+
File: ossm-performance-scalability
358+
- Name: Deploying to production
359+
File: ossm-deploy-production
360+
- Name: Federation
361+
File: ossm-federation
362+
- Name: Extensions
363+
File: ossm-extensions
364+
- Name: 3scale WebAssembly for 2.1
365+
File: ossm-threescale-webassembly-module
366+
- Name: 3scale Istio adapter for 2.0
367+
File: threescale-adapter
368+
- Name: Troubleshooting Service Mesh
369+
File: ossm-troubleshooting-istio
370+
- Name: Control plane configuration reference
371+
File: ossm-reference-smcp
372+
- Name: Kiali configuration reference
373+
File: ossm-reference-kiali
374+
- Name: Jaeger configuration reference
375+
File: ossm-reference-jaeger
376+
- Name: Uninstalling Service Mesh
377+
File: removing-ossm
378+
- Name: Service Mesh 1.x
379+
Dir: v1x
380+
Topics:
381+
- Name: Service Mesh 1.x release notes
382+
File: servicemesh-release-notes
383+
- Name: Service Mesh architecture
384+
File: ossm-architecture
385+
- Name: Service Mesh and Istio differences
386+
File: ossm-vs-community
387+
- Name: Preparing to install Service Mesh
388+
File: preparing-ossm-installation
389+
- Name: Installing Service Mesh
390+
File: installing-ossm
391+
- Name: Security
392+
File: ossm-security
393+
- Name: Traffic management
394+
File: ossm-traffic-manage
395+
- Name: Deploying applications on Service Mesh
396+
File: prepare-to-deploy-applications-ossm
397+
- Name: Data visualization and observability
398+
File: ossm-observability
399+
- Name: Custom resources
400+
File: ossm-custom-resources
401+
- Name: 3scale Istio adapter for 1.x
402+
File: threescale-adapter
403+
- Name: Removing Service Mesh
404+
File: removing-ossm
405+
---
319406
Name: Serverless
320407
Dir: serverless
321408
Distros: openshift-rosa

build.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,11 @@ variants:
195195
- web_console/**/*.adoc
196196
- whats_new/**/*.adoc
197197
- windows_containers/**/*.adoc
198-
- name: openshift-rosa
199-
attributes:
200-
- _attributes/rosa-attributes.adoc
201-
- _attributes/attributes-openshift-dedicated.adoc
202-
build: false
198+
- name: openshift-rosa
199+
attributes:
200+
- _attributes/rosa-attributes.adoc
201+
- _attributes/attributes-openshift-dedicated.adoc
202+
build: false
203203
files:
204204
included:
205205
- adding_service_cluster/**/*.adoc

modules/ossm-auto-route-annotations.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
[id="ossm-auto-route-annotations_{context}"]
66
= {SMProductName} route annotations
77

8-
Sometimes specific annotations are needed in an OpenShift Route. For example, some advanced features in OpenShift Routes are managed via xref:../../networking/routes/route-configuration.adoc[special annotations]. For this and other use cases, {SMProductName} will copy all annotations present in the Istio Gateway resource (with the exception of those starting with `kubectl.kubernetes.io`) into the managed OpenShift Route resource.
8+
Sometimes specific annotations are needed in an OpenShift Route.
9+
ifdef::openshift-enterprise[]
10+
For example, some advanced features in OpenShift Routes are managed via xref:../../networking/routes/route-configuration.adoc[special annotations].
11+
endif::[]
12+
13+
For this and other use cases, {SMProductName} will copy all annotations present in the Istio Gateway resource (with the exception of those starting with `kubectl.kubernetes.io`) into the managed OpenShift Route resource.
914

1015
If you need specific annotations in the OpenShift Routes created by {SMProductShortName}, create them in the Istio Gateway resource and they will be copied into the OpenShift Route resources managed by the {SMProductShortName}.

modules/ossm-config-sampling.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ In a basic installation, `spec.tracing.sampling` is set to `10000`, which sample
2121
====
2222
The Envoy proxy sampling rate applies for applications that are available to a Service Mesh, and use the Envoy proxy. This sampling rate determines how much data the Envoy proxy collects and tracks.
2323
24-
The Jaeger remote sampling rate applies to applications that are external to the Service Mesh, and do not use the Envoy proxy, such as a database. This sampling rate determines how much data the distributed tracing system collects and stores. For more information, see xref:../../distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc#distr-tracing-config-sampling_deploying-distributed-tracing-platform[Distributed tracing configuration options].
24+
The Jaeger remote sampling rate applies to applications that are external to the Service Mesh, and do not use the Envoy proxy, such as a database. This sampling rate determines how much data the distributed tracing system collects and stores.
25+
ifdef::openshift-enterprise[]
26+
For more information, see xref:../../distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc#distr-tracing-config-sampling_deploying-distributed-tracing-platform[Distributed tracing configuration options].
27+
endif::[]
2528
====
2629

2730
.Procedure

modules/ossm-configuring-the-threescale-wasm-auth-module.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ Cluster administrators on {product-title} can configure the `threescale-wasm-aut
1010
[id="the-service-mesh-extension_{context}"]
1111
== The Service Mesh extension
1212

13-
{SMProductShortName} provides a xref:../../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[custom resource definition] to specify and apply Proxy-WASM extensions to sidecar proxies, known as xref:../../service_mesh/v2x/ossm-extensions.adoc#ossm-extensions[`ServiceMeshExtension`]. {SMProductShortName} applies this custom resource to the set of workloads that require HTTP API management with 3scale.
13+
14+
{SMProductShortName} provides a custom resource definition to specify and apply Proxy-WASM extensions to sidecar proxies, known as xref:../../service_mesh/v2x/ossm-extensions.adoc#ossm-extensions[`ServiceMeshExtension`]. {SMProductShortName} applies this custom resource to the set of workloads that require HTTP API management with 3scale.
15+
16+
ifdef::openshift-enterprise[]
17+
See xref:../../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[custom resource definition] for more information.
18+
endif::[]
1419

1520
[NOTE]
1621
====

modules/ossm-routing-ingress.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ That command returns the `NAME`, `TYPE`, `CLUSTER-IP`, `EXTERNAL-IP`, `PORT(S
2323

2424
If the `EXTERNAL-IP` value is set, your environment has an external load balancer that you can use for the ingress gateway.
2525

26-
If the `EXTERNAL-IP` value is `<none>`, or perpetually `<pending>`, your environment does not provide an external load balancer for the ingress gateway. You can access the gateway using the service's xref:../../networking/configuring-node-port-service-range.adoc[node port].
26+
If the `EXTERNAL-IP` value is `<none>`, or perpetually `<pending>`, your environment does not provide an external load balancer for the ingress gateway.
27+
ifdef::openshift-enterprise[]
28+
You can access the gateway using the service's xref:../../networking/configuring-node-port-service-range.adoc[node port].
29+
endif::[]
2730

2831
Determine the ingress according to your environment. For an environment with load balancer support, xref:../../service_mesh/v2x/ossm-traffic-manage.adoc#ossm-routing-config-ig-lb_routing-traffic[Determining ingress ports with a load balancer]. For an environment without load balancer support, xref:../../service_mesh/v2x/ossm-traffic-manage.adoc#ossm-routing-config-ig-no-lb_routing-traffic[Determining ingress ports without a load balancer]. After you have determined the ingress ports, see xref:../../service_mesh/v2x/ossm-traffic-manage.adoc#ossm-routing-gateways_routing-traffic[Configuring ingress using a gateway] to complete your configuration.
2932

service_mesh/v1x/installing-ossm.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ include::modules/ossm-member-roll-modify.adoc[leveloffset=+1]
5454
If you choose to update manually, the Operator Lifecycle Manager (OLM) controls the installation, upgrade, and role-based access control (RBAC) of Operators in a cluster. OLM runs by default in {product-title}.
5555
OLM uses CatalogSources, which use the Operator Registry API, to query for available Operators as well as upgrades for installed Operators.
5656

57+
ifdef::openshift-enterprise[]
5758
* For more information about how {product-title} handled upgrades, refer to the xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-overview_olm-understanding-olm[Operator Lifecycle Manager] documentation.
59+
endif::[]
5860

5961
include::modules/ossm-update-app-sidecar.adoc[leveloffset=+2]
6062

service_mesh/v1x/ossm-custom-resources.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ include::modules/ossm-cr-istio-global.adoc[leveloffset=+2]
2323

2424
include::modules/ossm-cr-gateway.adoc[leveloffset=+2]
2525

26+
ifdef::openshift-enterprise[]
2627
Cluster administrators can refer to xref:../../networking/ingress-operator.html#using-wildcard-routes_configuring-ingress[Using wildcard routes] for instructions on how to enable subdomains.
28+
endif::[]
2729

2830
include::modules/ossm-cr-mixer.adoc[leveloffset=+2]
2931

@@ -39,6 +41,8 @@ include::modules/ossm-jaeger-config-elasticsearch-v1x.adoc[leveloffset=+2]
3941

4042
include::modules/ossm-jaeger-config-es-cleaner-v1x.adoc[leveloffset=+2]
4143

44+
ifdef::openshift-enterprise[]
4245
For more information about configuring Elasticsearch with {product-title}, see xref:../../logging/config/cluster-logging-log-store.adoc[Configuring the log store].
46+
endif::[]
4347

4448
include::modules/ossm-cr-threescale.adoc[leveloffset=+1]

service_mesh/v1x/ossm-traffic-manage.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ include::modules/ossm-routing-ingress.adoc[leveloffset=+1]
2222

2323
include::modules/ossm-auto-route-1x.adoc[leveloffset=+1]
2424

25+
ifdef::openshift-enterprise[]
2526
== Links
2627

2728
For more information about configuring an {product-title} wildcard policy, see xref:../../networking/ingress-operator.adoc#using-wildcard-routes_configuring-ingress[Using wildcard routes].
29+
endif::[]

service_mesh/v1x/preparing-ossm-installation.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Before you can install {SMProductName}, review the installation activities, ensu
1313
== Prerequisites
1414

1515
* Possess an active {product-title} subscription on your Red Hat account. If you do not have a subscription, contact your sales representative for more information.
16+
17+
ifdef::openshift-enterprise[]
1618
* Review the xref:../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[{product-title} {product-version} overview].
1719
* Install {product-title} {product-version}.
1820
** xref:../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Install {product-title} {product-version} on AWS]
@@ -25,13 +27,19 @@ Before you can install {SMProductName}, review the installation activities, ensu
2527
If you are installing {SMProductName} on a xref:../../installing/installing-preparing.adoc#supported-installation-methods-for-different-platforms[restricted network], follow the instructions for your chosen {product-title} infrastructure.
2628
====
2729
+
30+
endif::[]
31+
2832
* Install the version of the {product-title} command line utility (the `oc` client tool) that matches your {product-title} version and add it to your path.
33+
34+
ifdef::openshift-enterprise[]
2935
** If you are using {product-title} {product-version}, see xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-about-cli_cli-developer-commands[About the OpenShift CLI].
36+
endif::[]
3037

3138
include::modules/ossm-supported-configurations-v1x.adoc[leveloffset=+1]
3239

3340
include::modules/ossm-installation-activities.adoc[leveloffset=+1]
3441

42+
ifdef::openshift-enterprise[]
3543
[WARNING]
3644
====
3745
See xref:../../logging/config/cluster-logging-log-store.adoc[Configuring the log store] for details on configuring the default Jaeger parameters for Elasticsearch in a production environment.
@@ -40,3 +48,4 @@ See xref:../../logging/config/cluster-logging-log-store.adoc[Configuring the log
4048
== Next steps
4149

4250
* xref:../../service_mesh/v1x/installing-ossm.adoc#installing-ossm-v1x[Install {SMProductName}] in your {product-title} environment.
51+
endif::[]

0 commit comments

Comments
 (0)