Skip to content

Commit e53110a

Browse files
authored
Merge pull request #74074 from gwynnemonahan/OSSM-6248
OSSM-6248 Kiali doc updates for OSSMC plugin
2 parents 3548784 + db0e2d9 commit e53110a

6 files changed

+21
-16
lines changed

modules/ossm-kiali-ossmc-plugin-install-cli.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
[id="ossm-kiali-ossmc-plugin-install-cli_{context}"]
77
= Installing OpenShift Service Mesh Console plugin using the CLI
88

9-
You can install the {SMProductName} (OSSMC) plugin using the CLI, instead of the {product-title} web console.
9+
You can install the {SMPlugin} using the CLI, instead of the {product-title} web console.
1010

1111
.Prerequisites
1212

13-
* OpenShift 4.12+ is installed.
14-
* Kiali Operator provided by Red Hat 1.73 is installed.
15-
* {SMProductName} (OSSMC) is installed.
16-
* Kiali Server is installed.
13+
* {product-title} is installed.
14+
* {KialiProduct} 1.73 is installed.
15+
* {SMProductName} (OSSM) is installed.
16+
* `ServiceMeshControlPlane` (SMCP) 2.5 or later is installed.
1717
1818
.Procedure
1919

modules/ossm-kiali-ossmc-plugin-install-web-console.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
[id="ossm-kiali-ossmc-plugin-install-web-console_{context}"]
77
= Installing OpenShift Service Mesh Console plugin using the {product-title} web console
88

9-
You can install the OpenShift Service Mesh Console (OSSMC) plugin using the {product-title} web console.
9+
You can install the {SMPlugin} using the {product-title} web console.
1010

1111
.Prerequisites
1212

13-
* OpenShift 4.12+ is installed.
14-
* Kiali Operator provided by Red Hat 1.73 is installed.
13+
* {product-title} is installed.
14+
* {KialiProduct} 1.73 is installed.
1515
* {SMProductName} (OSSM) is installed.
16-
* Kiali Server is installed.
16+
* `ServiceMeshControlPlane` 2.5 or later is installed.
1717
1818
.Procedure
1919

modules/ossm-kiali-ossmc-plugin-uninstall-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="ossm-kiali-ossmc-plugin-uninstall-cli_{context}"]
77
= Uninstalling OpenShift Service Mesh Console plugin using the CLI
88

9-
You can uninstall the {SMProductName} (OSSMC) plugin by using the {oc-first}.
9+
You can uninstall the {SMPlugin} by using the {oc-first}.
1010

1111
.Procedure
1212

modules/ossm-kiali-ossmc-plugin-uninstall-web-console.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="ossm-kiali-ossmc-plugin-uninstall-web-console_{context}"]
77
= Uninstalling OpenShift Service Mesh Console plugin using the {product-title} web console
88

9-
You can uninstall the {SMProductName} (OSSMC) plugin by using the {product-title} web console.
9+
You can uninstall the {SMPlugin} by using the {product-title} web console.
1010

1111
.Procedure
1212

modules/ossm-kiali-ossmc-plugin-user-guide.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,21 @@
99
//In the title include nouns or noun phrases that are used in the body text.
1010
//Do not start the title of concept modules with a verb.
1111

12-
The {SMProductName} Console (OSSMC) plugin is an extension to the {product-title} web console that provides visibility into your Service Mesh.
12+
The {SMPlugin} is an extension to the {product-title} web console that provides visibility into your Service Mesh.
1313

1414
[WARNING]
1515
====
16-
The {SMPRoductName} Console (OSSMC) plugin only supports a single Kiali instance. Whether that Kiali instance is configured to access only a subset of OpenShift projects or has access cluster-wide to all projects does not matter. However, only a single Kiali instance can be accessed.
16+
The {SMPluginShort} only supports a single Kiali instance. Whether that Kiali instance is configured to access only a subset of OpenShift projects or has access cluster-wide to all projects does not matter. However, only a single Kiali instance can be accessed.
1717
====
1818

1919
You can install the OSSMC plugin in only one of two ways: using the {product-title} web console, or through the CLI.
2020

21-
Installing the OSSMC plugin creates a new category, *Service Mesh*, in the main {product-title} web console navigation. Click *Service Mesh* to see:
21+
[NOTE]
22+
====
23+
The {SMPluginShort} is only supported on {SMProductShortName} 2.5 or later. Specifically, the `ServiceMeshControlPlane` version must be set to 2.5 or later.
24+
====
25+
26+
Installing the {SMPluginShort} creates a new category, *Service Mesh*, in the main {product-title} web console navigation. Click *Service Mesh* to see:
2227

2328
* *Overview* for a summary of your mesh displayed as cards that represent the namespaces in the mesh
2429
* *Graph* for a full topology view of your mesh represented by nodes and edges, each node representing a component of the mesh and each edge representing traffic flowing through the mesh between components

service_mesh/v2x/ossm-kiali-ossmc-plugin.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
The {SMProductName} (OSSMC) plugin is an extension to the {product-title} web console that provides visibility into your Service Mesh. With the OSSMC plugin installed, a new *Service Mesh* menu option is available in the navigation menu on the left side of the web console, as well as new *Service Mesh* tabs that enhance the existing *Workloads* and *Services* console pages.
9+
The {SMPlugin} is an extension to the {product-title} web console that provides visibility into your Service Mesh. With the OSSMC plugin installed, a new *Service Mesh* menu option is available in the navigation menu on the left side of the web console, as well as new *Service Mesh* tabs that enhance the existing *Workloads* and *Services* console pages.
1010

1111
[IMPORTANT]
1212
====
13-
If you are using a certificate that your browser does not initially trust, you must tell your browser to trust the certificate first before you are able to access the OSSMC plugin. To do this, go to the Kiali standalone user interface (UI) and tell the browser to accept its certificate.
13+
If you are using a certificate that your browser does not initially trust, you must tell your browser to trust the certificate first before you are able to access the {SMPluginShort}. To do this, go to the Kiali standalone user interface (UI) and tell the browser to accept its certificate.
1414
====
1515

1616
include::modules/ossm-kiali-ossmc-plugin-user-guide.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)