|
| 1 | +// Module included in the following assemblies: |
| 2 | +// |
| 3 | +//* *service_mesh/v2x/ossm-kiali-ossmc-plugin.adoc |
| 4 | + |
| 5 | + |
| 6 | +:_mod-docs-content-type: CONCEPT |
| 7 | +[id="ossm-kiali-ossmc-plugin-user-guide_{context}"] |
| 8 | += About the OpenShift Service Mesh Console plugin |
| 9 | +//In the title include nouns or noun phrases that are used in the body text. |
| 10 | +//Do not start the title of concept modules with a verb. |
| 11 | + |
| 12 | +The {SMProductName} Console (OSSMC) plugin is an extension to the {product-title} web console that provides visibility into your Service Mesh. |
| 13 | + |
| 14 | +[WARNING] |
| 15 | +==== |
| 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. |
| 17 | +==== |
| 18 | + |
| 19 | +You can install the OSSMC plugin in only one of two ways: using the {product-title} web console, or through the CLI. |
| 20 | + |
| 21 | +Installing the OSSMC plugin creates a new category, *Service Mesh*, in the main {product-title} web console navigation. Click *Service Mesh* to see: |
| 22 | + |
| 23 | +* *Overview* for a summary of your mesh displayed as cards that represent the namespaces in the mesh |
| 24 | +* *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 |
| 25 | +* *Istio config* for a list of all Istio configuration files in your mesh with a column that provides a quick way to know if the configuration for each resource is valid |
| 26 | +
|
| 27 | +Under *Workloads*, the OSSMC plugin adds a *Service Mesh* tab that contains the following subtabs: |
| 28 | + |
| 29 | +* *Overview* subtab provides a summary of the selected workload including a localized topology graph showing the workload with all inbound and outbound edges and nodes |
| 30 | +* *Traffic* subtab displays information about all inbound and outbound traffic to the workload. |
| 31 | +* *Logs* subtab shows the logs for the workload's containers |
| 32 | ++ |
| 33 | +-- |
| 34 | +** You can view container logs individually or in a unified fashion, ordered by log time. This is especially helpful to see how the Envoy sidecar proxy logs relate to your workload's application logs. |
| 35 | +** You can enable the tracing span integration which then allows you to see which logs correspond to trace spans. |
| 36 | +-- |
| 37 | ++ |
| 38 | +* *Metrics* subtab shows both inbound and outbound metric graphs in the corresponding subtabs. All the workload metrics can be displayed here, providing you with a detail view of the performance of your workload. |
| 39 | ++ |
| 40 | +-- |
| 41 | +** You can enable the tracing span integration which allows you to see which spans occurred at the same time as the metrics. Click a span marker in the graph to view the specific spans associated with that timeframe. |
| 42 | +-- |
| 43 | ++ |
| 44 | +* *Traces* provides a chart showing the trace spans collected over the given timeframe. |
| 45 | ++ |
| 46 | +-- |
| 47 | +** Click a bubble to drill down into those trace spans; the trace spans can provide you the most low-level detail within your workload application, down to the individual request level. The trace details view gives further details, including heatmaps that provide you with a comparison of one span in relation to other requests and spans in the same timeframe. |
| 48 | +** If you hover over a cell in a heatmap, a tooltip gives some details on the cell data. |
| 49 | +-- |
| 50 | ++ |
| 51 | +* *Envoy* subtab provides information about the Envoy sidecar configuration. This is useful when you need to dig down deep into the sidecar configuration when debugging things such as connectivity issues. |
| 52 | +
|
| 53 | +Under *Networking*, the OSSMC plugin adds a *Service Mesh* tab to Services and contains the *Overview*, *Traffic*, *Inbound Metrics*, and *Traces* subtabs that are similar to the same subtabs found in *Workloads*. |
0 commit comments