Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion about/cluster-observability-operator-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]
toc::[]


The {coo-first} is an optional component of the {product-title} designed for creating and managing highly customizable monitoring stacks. It enables cluster administrators to automate configuration and management of monitoring needs extensively, offering a more tailored and detailed view of each namespace compared to the default {product-title} monitoring system.
The {coo-first} is an optional component of the {ocp-product-title} designed for creating and managing highly customizable monitoring stacks. It enables cluster administrators to automate configuration and management of monitoring needs extensively, offering a more tailored and detailed view of each namespace compared to the default {ocp-product-title} monitoring system.

The {coo-short} deploys the following monitoring components:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

As a cluster administrator, you can install or remove the {coo-first} from OperatorHub by using the {product-title} web console.
As a cluster administrator, you can install or remove the {coo-first} from OperatorHub by using the {ocp-product-title} web console.
OperatorHub is a user interface that works in conjunction with Operator Lifecycle Manager (OLM), which installs and manages Operators on a cluster.

// Installing the COO using the OCP web console
Expand Down
4 changes: 2 additions & 2 deletions modules/coo-advantages.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[id="coo-advantages_{context}"]
= Key advantages of using {coo-short}

Deploying {coo-short} helps you address monitoring requirements that are hard to achieve using the default monitoring stack.
Deploying {coo-short} helps you address monitoring requirements that are hard to achieve using the default monitoring stack.

[id="coo-advantages-extensibility_{context}"]
== Extensibility
Expand All @@ -31,6 +31,6 @@ Deploying {coo-short} helps you address monitoring requirements that are hard to
[id="coo-advantages-scalabilityflexibility_{context}"]
== Flexibility

- Decoupled from {product-title} release cycles.
- Decoupled from {ocp-product-title} release cycles.
- Faster release iterations and rapid response to changing requirements.
- Independent management of alerting rules.
8 changes: 4 additions & 4 deletions modules/coo-dashboard-ui-plugin-configure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
[id="coo-dashboard-ui-plugin-configure-_{context}"]
= Configuring a dashboard

The dashboard UI plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`. The `ConfigMap` resource must define a datasource type and an in-cluster service where the data can be fetched.
The dashboard UI plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`. The `ConfigMap` resource must define a datasource type and an in-cluster service where the data can be fetched.

The examples in the following section are taken from link:https://github.com/openshift/console-dashboards-plugin[https://github.com/openshift/console-dashboards-plugin].

.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}.
* You have installed the dashboard UI plugin.

Expand Down Expand Up @@ -45,7 +45,7 @@ data:

. Configure a custom dashboard that connects to the datasource. The YAML for a sample dashboard is available at link:https://github.com/openshift/console-dashboards-plugin/blob/main/docs/prometheus-dashboard-example.yaml[prometheus-dashboard-example.yaml]. An excerpt from that file is shown below for demonstration purposes:
+
.Extract from example dashboard, taken from prometheus-dashboard-example.yaml
.Extract from example dashboard, taken from prometheus-dashboard-example.yaml
[%collapsible]
====
[source,yaml]
Expand Down Expand Up @@ -192,7 +192,7 @@ data:
----
====

. Click *Observe* -> *Dashboards* and the custom dashboard is available with the title ++** DASHBOARD EXAMPLE **++, based on the configuration in `prometheus-dashboard-example.yaml`.
. Click *Observe* -> *Dashboards* and the custom dashboard is available with the title ++** DASHBOARD EXAMPLE **++, based on the configuration in `prometheus-dashboard-example.yaml`.
+
image::coo-custom-dashboard.png[]
+
Expand Down
4 changes: 2 additions & 2 deletions modules/coo-dashboard-ui-plugin-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}.

.Procedure

. In the {product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}.
. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}.
. Choose the *UI Plugin* tab (at the far right of the tab list) and press *Create UIPlugin*.
. Select *YAML view*, enter the following content, and then press *Create*:
+
Expand Down
4 changes: 2 additions & 2 deletions modules/coo-distributed-tracing-ui-plugin-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}

.Procedure

. In the {product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
. Choose the *UI Plugin* tab (at the far right of the tab list) and press *Create UIPlugin*
. Select *YAML view*, enter the following content, and then press *Create*:
+
Expand Down
6 changes: 3 additions & 3 deletions modules/coo-distributed-tracing-ui-plugin-using.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}.
* You have installed the {coo-full} distributed tracing UI plugin.
* You have a `TempoStack` or `TempoMonolithic` multi-tenant instance in the cluster.

.Procedure

. In the Administrator perspective of the {product-title} web console, click **Observe** → **Traces**.
. In the {ocp-product-title} web console, click **Observe** → **Traces**.
. Select a `TempoStack` or `TempoMonolithic` multi-tenant instance and set a time range and query for the traces to be loaded.
+
The traces are displayed on a scatter-plot showing the trace start time, duration, and number of spans. Underneath the scatter plot, there is a list of traces showing information such as the `Trace Name`, number of `Spans`, and `Duration`.
The traces are displayed on a scatter-plot showing the trace start time, duration, and number of spans. Underneath the scatter plot, there is a list of traces showing information such as the `Trace Name`, number of `Spans`, and `Duration`.
. Click on a trace name link.
+
The trace detail page for the selected trace contains a Gantt Chart of all of the spans within the trace. Select a span to show a breakdown of the configured attributes.
Expand Down
2 changes: 1 addition & 1 deletion modules/coo-incident-detection-using.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}.
* You have installed the {coo-full} monitoring UI plugin with incident detection enabled.

Expand Down
6 changes: 3 additions & 3 deletions modules/coo-logging-ui-plugin-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@

.Prerequisites
* You have access to the cluster as a user with the `cluster-admin` role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}.
* You have a `LokiStack` instance in your cluster.


.Procedure
. In the {product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}.
. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}.
. Choose the *UI Plugin* tab (at the far right of the tab list) and click *Create UIPlugin*.
. Select *YAML view*, enter the following content, and then click *Create*:
+
Expand All @@ -39,7 +39,7 @@ spec:
====
These are the known issues for the logging UI plugin - for more information, see link:https://issues.redhat.com/browse/OU-587[OU-587].

* The `schema` feature is only supported in {product-title} 4.15 and later. In earlier versions of {product-title}, the logging UI plugin will only use the `viaq` attribute, ignoring any other values that might be set.
* The `schema` feature is only supported in {ocp-product-title} 4.15 and later. In earlier versions of {product-title}, the logging UI plugin will only use the `viaq` attribute, ignoring any other values that might be set.

* Non-administrator users cannot query logs using the `otel` attribute with {logging} {for} versions 5.8 to 6.2. This issue will be fixed in a future {logging} release. (https://issues.redhat.com/browse/LOG-6589[LOG-6589])

Expand Down
12 changes: 6 additions & 6 deletions modules/coo-monitoring-ui-plugin-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
[id="coo-monitoring-ui-plugin-install_{context}"]
= Installing the {coo-full} monitoring UI plugin

The monitoring UI plugin adds monitoring related UI features to the OpenShift web console, for the Advance Cluster Management (ACM) perspective and for incident detection.
The monitoring UI plugin adds monitoring related UI features to the {ocp-product-title} web console, for the Advance Cluster Management (ACM) perspective and for incident detection.

.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}

.Procedure

. In the {product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
. Choose the *UI Plugin* tab (at the far right of the tab list) and press *Create UIPlugin*
. Select *YAML view*, enter the following content, and then press *Create*:
+
Expand All @@ -34,9 +34,9 @@ spec:
alertmanager:
url: 'https://alertmanager.open-cluster-management-observability.svc:9095'
thanosQuerier:
url: 'https://rbac-query-proxy.open-cluster-management-observability.svc:8443'
url: 'https://rbac-query-proxy.open-cluster-management-observability.svc:8443'
incidents: # <2>
enabled: true
enabled: true
----
<1> Enable {rh-rhacm} features. You must configure the Alertmanager and ThanosQuerier Service endpoints.
<2> Enable incident detection features.
<2> Enable incident detection features.
2 changes: 1 addition & 1 deletion modules/coo-target-users.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[id="coo-target-users-enterprise_{context}"]
== Enterprise-level users and administrators

Enterprise users require in-depth monitoring capabilities for {product-title} clusters, including advanced performance analysis, long-term data retention, trend forecasting, and historical analysis. These features help enterprises better understand resource usage, prevent performance issues, and optimize resource allocation.
Enterprise users require in-depth monitoring capabilities for {ocp-product-title} clusters, including advanced performance analysis, long-term data retention, trend forecasting, and historical analysis. These features help enterprises better understand resource usage, prevent performance issues, and optimize resource allocation.

[id="coo-target-users-multi-tenant_{context}"]
== Operations teams in multi-tenant environments
Expand Down
4 changes: 2 additions & 2 deletions modules/coo-troubleshooting-ui-plugin-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

.Prerequisites
* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.
* You have installed the {coo-full}

.Procedure
. In the {product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators* and select {coo-full}
. Choose the *UI Plugin* tab (at the far right of the tab list) and press *Create UIPlugin*
. Select *YAML view*, enter the following content, and then press *Create*:
+
Expand Down
24 changes: 13 additions & 11 deletions modules/coo-troubleshooting-ui-plugin-using.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,33 @@
[id="coo-troubleshooting-ui-plugin-using_{context}"]
= Using the {coo-full} troubleshooting UI plugin

include::snippets/unified-perspective-web-console.adoc[]

.Prerequisites
* You have access to the {product-title} cluster as a user with the `cluster-admin` cluster role. If your cluster version is 4.17+, you can access the troubleshooting UI panel from the Application Launcher {launch}.
* You have logged in to the {product-title} web console.
* You have installed {product-title} Logging, if you want to visualize correlated logs.
* You have installed {product-title} Network Observability, if you want to visualize correlated netflows.
* You have access to the {ocp-product-title} cluster as a user with the `cluster-admin` cluster role. If your cluster version is 4.17+, you can access the troubleshooting UI panel from the Application Launcher {launch}.
* You have logged in to the {ocp-product-title} web console.
* You have installed {ocp-product-title} Logging, if you want to visualize correlated logs.
* You have installed {ocp-product-title} Network Observability, if you want to visualize correlated netflows.
* You have installed the {coo-full}.
* You have installed the {coo-full} troubleshooting UI plugin.
+
[NOTE]
====
The troubleshooting panel relies on the observability signal stores installed in your cluster.
Kuberenetes resources, alerts and metrics are always available by default in an {product-title} cluster.
Kuberenetes resources, alerts and metrics are always available by default in an {ocp-product-title} cluster.
Other signal types require optional components to be installed:

* **Logs:** Red Hat Openshift Logging (collection) and Loki Operator provided by Red Hat (store)
* **Network events:** Network observability provided by Red Hat (collection) and Loki Operator provided by Red Hat (store)
====
.Procedure

. In the admin perspective of the web console, navigate to *Observe* -> *Alerting* and then select an alert. If the alert has correlated items, a **Troubleshooting Panel** link will appear above the chart on the alert detail page.
. In the web console, go to *Observe* -> *Alerting* and then select an alert. If the alert has correlated items, a **Troubleshooting Panel** link will appear above the chart on the alert detail page.
+
image::coo-troubleshooting-panel-link.png[Troubleshooting Panel link]
+
Click on the **Troubleshooting Panel** link to display the panel.
. The panel consists of query details and a topology graph of the query results. The selected alert is converted into a Korrel8r query string and sent to the `korrel8r` service.
. The panel consists of query details and a topology graph of the query results. The selected alert is converted into a Korrel8r query string and sent to the `korrel8r` service.
The results are displayed as a graph network connecting the returned signals and resources. This is a _neighbourhood_ graph, starting at the current resource and including related objects up to 3 steps away from the starting point.
Clicking on nodes in the graph takes you to the corresponding web console pages for those resouces.
. You can use the troubleshooting panel to find resources relating to the chosen alert.
Expand Down Expand Up @@ -62,11 +64,11 @@ image::coo-troubleshooting-experimental.png[Experimental features]
[arabic]
... **Hide Query** hides the experimental features.

... The query that identifies the starting point for the graph.
The query language, part of the link:https://korrel8r.github.io/korrel8r[Korrel8r] correlation engine used to create the graphs, is experimental and may change in future.
The query is updated by the **Focus** button to correspond to the resources in the main web console window.
... The query that identifies the starting point for the graph.
The query language, part of the link:https://korrel8r.github.io/korrel8r[Korrel8r] correlation engine used to create the graphs, is experimental and may change in future.
The query is updated by the **Focus** button to correspond to the resources in the main web console window.

... **Neighbourhood depth** is used to display a smaller or larger neighbourhood.
... **Neighbourhood depth** is used to display a smaller or larger neighbourhood.
+
[NOTE]
====
Expand Down
12 changes: 6 additions & 6 deletions modules/coo-versus-default-ocp-monitoring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ The key differences between {coo-short} and the default in-cluster monitoring st
| Feature | {coo-short} | Default monitoring stack

| **Scope and integration**
| Offers comprehensive monitoring and analytics for enterprise-level needs, covering cluster and workload performance.
| Offers comprehensive monitoring and analytics for enterprise-level needs, covering cluster and workload performance.

However, it lacks direct integration with {product-title} and typically requires an external Grafana instance for dashboards.
| Limited to core components within the cluster, for example, API server and etcd, and to OpenShift-specific namespaces.
However, it lacks direct integration with {ocp-product-title} and typically requires an external Grafana instance for dashboards.
| Limited to core components within the cluster, for example, API server and etcd, and to OpenShift-specific namespaces.

There is deep integration into {product-title} including console dashboards and alert management in the console.
There is deep integration into {ocp-product-title} including console dashboards and alert management in the console.

| **Configuration and customization**
| Broader configuration options including data retention periods, storage methods, and collected data types.
| Broader configuration options including data retention periods, storage methods, and collected data types.

The {coo-short} can delegate ownership of single configurable fields in custom resources to users by using Server-Side Apply (SSA), which enhances customization.
| Built-in configurations with limited customization options.
| Built-in configurations with limited customization options.

| **Data retention and storage**
| Long-term data retention, supporting historical analysis and capacity planning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
:_mod-docs-content-type: PROCEDURE
[id="installing-the-cluster-observability-operator-in-the-web-console-_{context}"]
= Installing the {coo-full} in the web console
Install the {coo-first} from OperatorHub by using the {product-title} web console.
Install the {coo-first} from OperatorHub by using the {ocp-product-title} web console.

.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.

.Procedure

. In the {product-title} web console, click *Operators* -> *OperatorHub*.
. In the {ocp-product-title} web console, click *Operators* -> *OperatorHub*.
. Type `cluster observability operator` in the *Filter by keyword* box.
. Click *{coo-full}* in the list of results.
. Read the information about the Operator, and configure the following installation settings:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
:_mod-docs-content-type: PROCEDURE
[id="uninstalling-the-cluster-observability-operator-using-the-web-console_{context}"]
= Uninstalling the {coo-full} using the web console
If you have installed the {coo-first} by using OperatorHub, you can uninstall it in the {product-title} web console.
If you have installed the {coo-first} by using OperatorHub, you can uninstall it in the {ocp-product-title} web console.

.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have logged in to the {product-title} web console.
* You have logged in to the {ocp-product-title} web console.

.Procedure

Expand Down
Loading