Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[enterprise-4.13] OSSM-6248 Kiali doc updates for OSSMC plugin #74315

Merged
merged 1 commit into from
Apr 5, 2024
Merged

[enterprise-4.13] OSSM-6248 Kiali doc updates for OSSMC plugin #74315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions modules/ossm-kiali-ossmc-plugin-install-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
[id="ossm-kiali-ossmc-plugin-install-cli_{context}"]
= Installing OpenShift Service Mesh Console plugin using the CLI

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

.Prerequisites

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

.Procedure

Expand Down
8 changes: 4 additions & 4 deletions modules/ossm-kiali-ossmc-plugin-install-web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
[id="ossm-kiali-ossmc-plugin-install-web-console_{context}"]
= Installing OpenShift Service Mesh Console plugin using the {product-title} web console

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

.Prerequisites

* OpenShift 4.12+ is installed.
* Kiali Operator provided by Red Hat 1.73 is installed.
* {product-title} is installed.
* {KialiProduct} 1.73 is installed.
* {SMProductName} (OSSM) is installed.
* Kiali Server is installed.
* `ServiceMeshControlPlane` 2.5 or later is installed.

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/ossm-kiali-ossmc-plugin-uninstall-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[id="ossm-kiali-ossmc-plugin-uninstall-cli_{context}"]
= Uninstalling OpenShift Service Mesh Console plugin using the CLI

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

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/ossm-kiali-ossmc-plugin-uninstall-web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[id="ossm-kiali-ossmc-plugin-uninstall-web-console_{context}"]
= Uninstalling OpenShift Service Mesh Console plugin using the {product-title} web console

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

.Procedure

Expand Down
11 changes: 8 additions & 3 deletions modules/ossm-kiali-ossmc-plugin-user-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,21 @@
//In the title include nouns or noun phrases that are used in the body text.
//Do not start the title of concept modules with a verb.

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

[WARNING]
====
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.
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.
====

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

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

Installing the {SMPluginShort} creates a new category, *Service Mesh*, in the main {product-title} web console navigation. Click *Service Mesh* to see:

* *Overview* for a summary of your mesh displayed as cards that represent the namespaces in the mesh
* *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
Expand Down
4 changes: 2 additions & 2 deletions service_mesh/v2x/ossm-kiali-ossmc-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ include::_attributes/common-attributes.adoc[]

toc::[]

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.
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.

[IMPORTANT]
====
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.
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.
====

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