Merge pull request #87432 from bhardesty/osdocs-12565-service-mesh

OSDOCS-12565: Add Service Mesh to ROSA HCP

Author: xenolinux

_topic_maps/_topic_map_rosa.yml

@@ -1729,6 +1729,12 @@ Name: Service Mesh
 Dir: service_mesh
 Distros: openshift-rosa
 Topics:
+# Tech Preview
+# - Name: Service Mesh 3.x
+#  Dir: v3x
+#  Topics:
+#  - Name: OpenShift Service Mesh 3.0 TP1 overview
+#    File: ossm-service-mesh-3-0-overview
 - Name: Service Mesh 2.x
   Dir: v2x
   Topics:

_topic_maps/_topic_map_rosa_hcp.yml

@@ -904,6 +904,100 @@ Topics:
 #  - Name: Adding worker nodes to single-node OpenShift clusters
 #    File: nodes-sno-worker-nodes
 ---
+Name: Service Mesh
+Dir: service_mesh
+Distros: openshift-rosa-hcp
+Topics:
+# Tech Preview
+# - Name: Service Mesh 3.x
+#   Dir: v3x
+#   Topics:
+#   - Name: OpenShift Service Mesh 3.0 TP1 overview
+#     File: ossm-service-mesh-3-0-overview
+- Name: Service Mesh 2.x
+  Dir: v2x
+  Topics:
+  - Name: About OpenShift Service Mesh
+    File: ossm-about
+  - Name: Service Mesh 2.x release notes
+    File: servicemesh-release-notes
+  - Name: Service Mesh architecture
+    File: ossm-architecture
+  - Name: Service Mesh deployment models
+    File: ossm-deployment-models
+  - Name: Service Mesh and Istio differences
+    File: ossm-vs-community
+  - Name: Preparing to install Service Mesh
+    File: preparing-ossm-installation
+  - Name: Installing the Operators
+    File: installing-ossm
+  - Name: Creating the ServiceMeshControlPlane
+    File: ossm-create-smcp
+  - Name: Adding workloads to a service mesh
+    File: ossm-create-mesh
+  - Name: Enabling sidecar injection
+    File: prepare-to-deploy-applications-ossm
+  - Name: Upgrading Service Mesh
+    File: upgrading-ossm
+  - Name: Managing users and profiles
+    File: ossm-profiles-users
+  - Name: Security
+    File: ossm-security
+  - Name: Traffic management
+    File: ossm-traffic-manage
+  - Name: Metrics, logs, and traces
+    File: ossm-observability
+  - Name: Performance and scalability
+    File: ossm-performance-scalability
+  - Name: Deploying to production
+    File: ossm-deploy-production
+  - Name: Federation
+    File: ossm-federation
+  - Name: Extensions
+    File: ossm-extensions
+  - Name: 3scale WebAssembly for 2.1
+    File: ossm-threescale-webassembly-module
+  - Name: 3scale Istio adapter for 2.0
+    File: threescale-adapter
+  - Name: Troubleshooting Service Mesh
+    File: ossm-troubleshooting-istio
+  - Name: Control plane configuration reference
+    File: ossm-reference-smcp
+  - Name: Kiali configuration reference
+    File: ossm-reference-kiali
+  - Name: Jaeger configuration reference
+    File: ossm-reference-jaeger
+  - Name: Uninstalling Service Mesh
+    File: removing-ossm
+# Service Mesh 1.x is tech preview
+# - Name: Service Mesh 1.x
+#  Dir: v1x
+#  Topics:
+#  - Name: Service Mesh 1.x release notes
+#    File: servicemesh-release-notes
+#  - Name: Service Mesh architecture
+#    File: ossm-architecture
+#  - Name: Service Mesh and Istio differences
+#    File: ossm-vs-community
+#  - Name: Preparing to install Service Mesh
+#    File: preparing-ossm-installation
+#  - Name: Installing Service Mesh
+#    File: installing-ossm
+#  - Name: Security
+#    File: ossm-security
+#  - Name: Traffic management
+#    File: ossm-traffic-manage
+#  - Name: Deploying applications on Service Mesh
+#    File: prepare-to-deploy-applications-ossm
+#  - Name: Data visualization and observability
+#    File: ossm-observability
+#  - Name: Custom resources
+#    File: ossm-custom-resources
+#  - Name: 3scale Istio adapter for 1.x
+#    File: threescale-adapter
+#  - Name: Removing Service Mesh
+#    File: removing-ossm
+---
 Name: Serverless
 Dir: serverless
 Distros: openshift-rosa-hcp

modules/distr-tracing-config-storage.adoc

@@ -645,7 +645,7 @@ spec:
 <3> Secret which defines environment variables ES_PASSWORD and ES_USERNAME. Created by kubectl create secret generic tracing-secret --from-literal=ES_PASSWORD=changeme --from-literal=ES_USERNAME=elastic
 <4> Volume mounts and volumes which are mounted into all storage components.
 
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 [id="distr-tracing-manage-es-certificates_{context}"]
 = Managing certificates with Elasticsearch
 
@@ -722,4 +722,4 @@ spec:
 The {JaegerName} Operator sets the Elasticsearch custom resource `name` to the value of `spec.storage.elasticsearch.name` from the Jaeger custom resource when provisioning Elasticsearch.
 
 The certificates are provisioned by the {es-op} and the {JaegerName} Operator injects the certificates.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]

modules/ossm-about-smcp.adoc

@@ -12,16 +12,16 @@ The control plane includes Istiod, Ingress and Egress Gateways, and other compon
 This basic installation is configured based on the default {product-title} settings and is not designed for production use. Use this default installation to verify your installation, and then configure your `ServiceMeshControlPlane` settings for your environment.
 ====
 
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 [NOTE]
 ====
 The {SMProductShortName} documentation uses `istio-system` as the example project, but you can deploy the service mesh to any project.
 ====
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
-ifdef::openshift-rosa[]
+ifdef::openshift-rosa,openshift-rosa-hcp[]
 If you are deploying the control plane for use on {product-rosa}, see the Red Hat Knowledgebase article link:https://access.redhat.com/solutions/6529231[OpenShift service mesh operator Istio basic not starting due to authentication errors], which discusses adding a new project and starting pods.
-endif::openshift-rosa[]
+endif::openshift-rosa,openshift-rosa-hcp[]
 ifdef::openshift-dedicated[]
 If you are deploying the control plane for use on {product-dedicated}, see the Red Hat Knowledgebase article link:https://access.redhat.com/solutions/6529231[OpenShift service mesh operator Istio basic not starting due to authentication errors], which discusses adding a new project and starting pods.
 endif::openshift-dedicated[]

modules/ossm-add-project-using-label-selectors-cli.adoc

@@ -11,12 +11,12 @@ You can use label selectors to add a project to the {SMProductShortName} with th
 .Prerequisites
 * You have installed the {SMProductName} Operator.
 * The deployment has an existing `ServiceMeshMemberRoll` resource.
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to {product-title} as`cluster-admin`.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to {product-title} as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
 .Procedure
 

modules/ossm-add-project-using-label-selectors-console.adoc

@@ -11,12 +11,12 @@ You can use labels selectors to add a project to the {SMProductShortName} with t
 .Prerequisites
 * You have installed the {SMProductName} Operator.
 * The deployment has an existing `ServiceMeshMemberRoll` resource.
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to the {product-title} web console as `cluster-admin`.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to the {product-title} web console as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
 .Procedure
 

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

@@ -25,9 +25,9 @@ Configuring the WebAssembly extension is currently a manual process. Support for
 
 * Identify a Kubernetes workload and namespace on your {SMProductShortName} deployment that you will apply this module.
 * You must have a 3scale tenant account. See link:https://www.3scale.net/signup[SaaS] or link:https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.11/html-single/installing_3scale/index#install-threescale-on-openshift-guide[3scale 2.11 On-Premises] with a matching service and relevant applications and metrics defined.
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * If you apply the module to the `<product_page>` microservice in the `bookinfo` namespace, see the xref:../../service_mesh/v1x/prepare-to-deploy-applications-ossm.adoc#ossm-tutorial-bookinfo-overview_deploying-applications-ossm-v1x[Bookinfo sample application].
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 ** The following example is the YAML format for the custom resource for `threescale-wasm-auth` module.
 This example refers to the upstream Maistra version of {SMProductShortName}, `WasmPlugin` API. You must declare the namespace where the `threescale-wasm-auth` module is deployed, alongside a `selector` to identify the set of applications the module will apply to:
 +

modules/ossm-control-plane-cli.adoc

@@ -13,12 +13,12 @@ You can deploy a basic `ServiceMeshControlPlane` from the command line.
 
 * The {SMProductName} Operator must be installed.
 * Access to the OpenShift CLI (`oc`).
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to {product-title} as`cluster-admin`.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to {product-title} as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
 .Procedure
 
@@ -29,11 +29,11 @@ endif::openshift-rosa,openshift-dedicated[]
 $ oc new-project istio-system
 ----
 +
-ifdef::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 The `ServiceMeshControlPlane` resource must be installed in the `istio-system` project, separate from your microservices and Operators.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 . Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example. The version of the {SMProductShortName} control plane determines the features available regardless of the version of the Operator.
 +
 .Example version {MaistraVersion} istio-installation.yaml
@@ -56,8 +56,8 @@ spec:
     grafana:
       enabled: true
 ----
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 . Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example. The version of the {SMProductShortName} control plane determines the features available regardless of the version of the Operator.
 +
 .Example `ServiceMeshControlPlane` resource
@@ -88,13 +88,13 @@ spec:
   telemetry:
     type: Istiod
 ----
-ifdef::openshift-rosa[]
+ifdef::openshift-rosa,openshift-rosa-hcp[]
 <1> Specifies a required setting for {product-rosa}.
-endif::openshift-rosa[]
+endif::openshift-rosa,openshift-rosa-hcp[]
 ifdef::openshift-dedicated[]
 <1> Specifies a required setting for {product-dedicated}.
 endif::openshift-dedicated[]
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 +
 . Run the following command to deploy the {SMProductShortName} control plane, where `<istio_installation.yaml>` includes the full path to your file.
 +

modules/ossm-control-plane-web.adoc

@@ -11,12 +11,12 @@ You can deploy a basic `ServiceMeshControlPlane` by using the web console.  In t
 .Prerequisites
 
 * The {SMProductName} Operator must be installed.
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to the {product-title} web console as `cluster-admin`.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to the {product-title} web console as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
 .Procedure
 
@@ -27,16 +27,16 @@ endif::openshift-rosa,openshift-dedicated[]
 .. Navigate to *Home* -> *Projects*.
 +
 .. Click *Create Project*.
-ifndef::openshift-rosa,openshift-dedcated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedcated[]
 +
 .. In the *Name* field, enter `istio-system`. The `ServiceMeshControlPlane` resource must be installed in a project that is separate from your microservices and Operators.
 +
 These steps use `istio-system` as an example, but you can deploy your {SMProductShortName} control plane in any project as long as it is separate from the project that contains your services.
-endif::openshift-rosa,openshift-dedcated[]
-ifdef::openshift-rosa,openshift-dedcated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedcated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedcated[]
 +
 .. In the *Name* field, enter `istio-system`. The `ServiceMeshControlPlane` resource must be installed in the `istio-system` project, separate from your microservices and Operators.
-endif::openshift-rosa,openshift-dedcated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedcated[]
 +
 .. Click *Create*.
 
@@ -49,9 +49,9 @@ endif::openshift-rosa,openshift-dedcated[]
 --
 .. Accept the default {SMProductShortName} control plane version to take advantage of the features available in the most current version of the product. The version of the control plane determines the features available regardless of the version of the Operator.
 
-ifdef::openshift-rosa[]
+ifdef::openshift-rosa,openshift-rosa-hcp[]
 .. Add the `spec.security.identity.type.ThirdParty` field, required by {product-rosa}.
-endif::openshift-rosa[]
+endif::openshift-rosa,openshift-rosa-hcp[]
 ifdef::openshift-dedicated[]
 .. Add the `spec.security.identity.type.ThirdParty` field, required by {product-dedicated}.
 endif::openshift-dedicated[]

modules/ossm-deploy-cluster-wide-control-plane-cli.adoc

@@ -13,12 +13,12 @@ You can configure the `ServiceMeshControlPlane` resource for cluster-wide deploy
 
 * The {SMProductName} Operator is installed.
 * You have access to the OpenShift CLI (`oc`).
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to {product-title} as`cluster-admin`.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 * You are logged in to {product-title} as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
 .Procedure
 
@@ -31,7 +31,7 @@ $ oc new-project istio-system
 
 . Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example:
 +
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 .Example version {MaistraVersion} istio-installation.yaml
 [source,yaml, subs="attributes,verbatim"]
 ----
@@ -44,8 +44,8 @@ spec:
   version: v{MaistraVersion}
   mode: ClusterWide
 ----
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 .Example `ServiceMeshControlPlane` resource
 [source,yaml, subs="attributes,verbatim"]
 ----
@@ -62,13 +62,13 @@ spec:
       type: ThirdParty <2>
 ----
 <1> Specifies that the resource is for a cluster-wide deployment.
-ifdef::openshift-rosa[]
+ifdef::openshift-rosa,openshift-rosa-hcp[]
 <2> Specifies a required setting for {product-rosa}. 
-endif::openshift-rosa[]
+endif::openshift-rosa,openshift-rosa-hcp[]
 ifdef::openshift-dedicated[]
 <2> Specifies a required setting for {product-dedicated}. 
 endif::openshift-dedicated[]
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
 . Run the following command to deploy the {SMProductShortName} control plane:
 +