From 1ab1fe9664f989a6144eafaac4aabe9dde7732d8 Mon Sep 17 00:00:00 2001 From: Gabriel McGoldrick Date: Mon, 1 Sep 2025 14:27:07 +0100 Subject: [PATCH] OBSDOCS-2366 migrate admin, developer perspective changes --- ...uster-observability-operator-overview.adoc | 2 +- ...ng-the-cluster-observability-operator.adoc | 2 +- modules/coo-advantages.adoc | 4 ++-- .../coo-dashboard-ui-plugin-configure.adoc | 8 +++---- modules/coo-dashboard-ui-plugin-install.adoc | 4 ++-- ...distributed-tracing-ui-plugin-install.adoc | 4 ++-- ...o-distributed-tracing-ui-plugin-using.adoc | 6 ++--- modules/coo-incident-detection-using.adoc | 2 +- modules/coo-logging-ui-plugin-install.adoc | 6 ++--- modules/coo-monitoring-ui-plugin-install.adoc | 12 +++++----- modules/coo-target-users.adoc | 2 +- ...coo-troubleshooting-ui-plugin-install.adoc | 4 ++-- .../coo-troubleshooting-ui-plugin-using.adoc | 24 ++++++++++--------- .../coo-versus-default-ocp-monitoring.adoc | 12 +++++----- ...bility-operator-using-the-web-console.adoc | 6 ++--- ...bility-operator-using-the-web-console.adoc | 4 ++-- ...-observability-operator-release-notes.adoc | 24 ++++++++++--------- snippets/unified-perspective-web-console.adoc | 10 ++++++++ ui_plugins/dashboard-ui-plugin.adoc | 4 ++-- ui_plugins/distributed-tracing-ui-plugin.adoc | 2 +- ui_plugins/logging-ui-plugin.adoc | 10 ++++---- ui_plugins/monitoring-ui-plugin.adoc | 8 ++++--- .../observability-ui-plugins-overview.adoc | 12 +++++----- ui_plugins/troubleshooting-ui-plugin.adoc | 8 +++---- 24 files changed, 98 insertions(+), 82 deletions(-) create mode 100644 snippets/unified-perspective-web-console.adoc diff --git a/about/cluster-observability-operator-overview.adoc b/about/cluster-observability-operator-overview.adoc index 0819e10924dd..96b4697d48d7 100644 --- a/about/cluster-observability-operator-overview.adoc +++ b/about/cluster-observability-operator-overview.adoc @@ -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: diff --git a/installing/installing-the-cluster-observability-operator.adoc b/installing/installing-the-cluster-observability-operator.adoc index 9c1cb0b61c2d..4055182aaaad 100644 --- a/installing/installing-the-cluster-observability-operator.adoc +++ b/installing/installing-the-cluster-observability-operator.adoc @@ -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 diff --git a/modules/coo-advantages.adoc b/modules/coo-advantages.adoc index 603694e2eef5..acbc206ec04b 100644 --- a/modules/coo-advantages.adoc +++ b/modules/coo-advantages.adoc @@ -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 @@ -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. \ No newline at end of file diff --git a/modules/coo-dashboard-ui-plugin-configure.adoc b/modules/coo-dashboard-ui-plugin-configure.adoc index 4814956740ae..f8f177838874 100644 --- a/modules/coo-dashboard-ui-plugin-configure.adoc +++ b/modules/coo-dashboard-ui-plugin-configure.adoc @@ -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. @@ -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] @@ -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[] + diff --git a/modules/coo-dashboard-ui-plugin-install.adoc b/modules/coo-dashboard-ui-plugin-install.adoc index 5280f691a8ac..274caded7923 100644 --- a/modules/coo-dashboard-ui-plugin-install.adoc +++ b/modules/coo-dashboard-ui-plugin-install.adoc @@ -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*: + diff --git a/modules/coo-distributed-tracing-ui-plugin-install.adoc b/modules/coo-distributed-tracing-ui-plugin-install.adoc index 1a7cfb613785..a10a502f480e 100644 --- a/modules/coo-distributed-tracing-ui-plugin-install.adoc +++ b/modules/coo-distributed-tracing-ui-plugin-install.adoc @@ -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*: + diff --git a/modules/coo-distributed-tracing-ui-plugin-using.adoc b/modules/coo-distributed-tracing-ui-plugin-using.adoc index 2a7e3b982220..52d6768d3e39 100644 --- a/modules/coo-distributed-tracing-ui-plugin-using.adoc +++ b/modules/coo-distributed-tracing-ui-plugin-using.adoc @@ -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. diff --git a/modules/coo-incident-detection-using.adoc b/modules/coo-incident-detection-using.adoc index 16a15249c303..cf34dbd0c37f 100644 --- a/modules/coo-incident-detection-using.adoc +++ b/modules/coo-incident-detection-using.adoc @@ -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. diff --git a/modules/coo-logging-ui-plugin-install.adoc b/modules/coo-logging-ui-plugin-install.adoc index 96dfefa4a6f5..2ead45991cdc 100644 --- a/modules/coo-logging-ui-plugin-install.adoc +++ b/modules/coo-logging-ui-plugin-install.adoc @@ -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*: + @@ -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]) diff --git a/modules/coo-monitoring-ui-plugin-install.adoc b/modules/coo-monitoring-ui-plugin-install.adoc index 8ab8cd1d71bc..af6136f2f950 100644 --- a/modules/coo-monitoring-ui-plugin-install.adoc +++ b/modules/coo-monitoring-ui-plugin-install.adoc @@ -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*: + @@ -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. \ No newline at end of file +<2> Enable incident detection features. \ No newline at end of file diff --git a/modules/coo-target-users.adoc b/modules/coo-target-users.adoc index dbd27e5fdc94..156e48e71617 100644 --- a/modules/coo-target-users.adoc +++ b/modules/coo-target-users.adoc @@ -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 diff --git a/modules/coo-troubleshooting-ui-plugin-install.adoc b/modules/coo-troubleshooting-ui-plugin-install.adoc index 0d379738b5bc..10944ec92985 100644 --- a/modules/coo-troubleshooting-ui-plugin-install.adoc +++ b/modules/coo-troubleshooting-ui-plugin-install.adoc @@ -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*: + diff --git a/modules/coo-troubleshooting-ui-plugin-using.adoc b/modules/coo-troubleshooting-ui-plugin-using.adoc index cb6f5940e85b..a93f38fe91c2 100644 --- a/modules/coo-troubleshooting-ui-plugin-using.adoc +++ b/modules/coo-troubleshooting-ui-plugin-using.adoc @@ -6,18 +6,20 @@ [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) @@ -25,12 +27,12 @@ Other signal types require optional components to be installed: ==== .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. @@ -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] ==== diff --git a/modules/coo-versus-default-ocp-monitoring.adoc b/modules/coo-versus-default-ocp-monitoring.adoc index 618ff8413c19..2b5b268a2804 100644 --- a/modules/coo-versus-default-ocp-monitoring.adoc +++ b/modules/coo-versus-default-ocp-monitoring.adoc @@ -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 diff --git a/modules/monitoring-installing-cluster-observability-operator-using-the-web-console.adoc b/modules/monitoring-installing-cluster-observability-operator-using-the-web-console.adoc index 362a575cead7..fd4765f69e1d 100644 --- a/modules/monitoring-installing-cluster-observability-operator-using-the-web-console.adoc +++ b/modules/monitoring-installing-cluster-observability-operator-using-the-web-console.adoc @@ -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: diff --git a/modules/monitoring-uninstalling-cluster-observability-operator-using-the-web-console.adoc b/modules/monitoring-uninstalling-cluster-observability-operator-using-the-web-console.adoc index 840fcc6ac727..f763da282ace 100644 --- a/modules/monitoring-uninstalling-cluster-observability-operator-using-the-web-console.adoc +++ b/modules/monitoring-uninstalling-cluster-observability-operator-using-the-web-console.adoc @@ -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 diff --git a/release-notes/cluster-observability-operator-release-notes.adoc b/release-notes/cluster-observability-operator-release-notes.adoc index 2a5a500afe53..7f3288bd98d2 100644 --- a/release-notes/cluster-observability-operator-release-notes.adoc +++ b/release-notes/cluster-observability-operator-release-notes.adoc @@ -7,13 +7,13 @@ include::_attributes/common-attributes.adoc[] toc::[] -The {coo-first} is an optional {product-title} Operator that enables administrators to create standalone monitoring stacks that are independently configurable for use by different services and users. +The {coo-first} is an optional {ocp-product-title} Operator that enables administrators to create standalone monitoring stacks that are independently configurable for use by different services and users. -The {coo-short} complements the built-in monitoring capabilities of {product-title}. You can deploy it in parallel with the default platform and user workload monitoring stacks managed by the {cmo-first}. +The {coo-short} complements the built-in monitoring capabilities of {ocp-product-title}. You can deploy it in parallel with the default platform and user workload monitoring stacks managed by the {cmo-first}. -These release notes track the development of the {coo-full} in {product-title}. +These release notes track the development of the {coo-full} in {ocp-product-title}. -The following table provides information about which features are available depending on the version of {coo-full} and {product-title}: +The following table provides information about which features are available depending on the version of {coo-full} and {ocp-product-title}: [cols="1,1,1,1,1,1,1", options="header"] |=== @@ -24,6 +24,8 @@ The following table provides information about which features are available depe | 1.2+ | 4.19+ | ✔ | ✔ | ✔ | ✔ | ✔ |=== +include::snippets/unified-perspective-web-console.adoc[] + [id="cluster-observability-operator-release-notes-1-2-2_{context}"] == {coo-full} 1.2.2 @@ -171,7 +173,7 @@ This issue is being tracked in link:https://issues.redhat.com/browse/COO-784[*CO [id="cluster-observability-operator-1-0-new-features-enhancements_{context}"] === New features and enhancements -* {coo-short} is now enabled for {product-title} platform monitoring. (link:https://issues.redhat.com/browse/COO-476[*COO-476*]) +* {coo-short} is now enabled for {ocp-product-title} platform monitoring. (link:https://issues.redhat.com/browse/COO-476[*COO-476*]) ** Implements HTTPS support for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-480[*COO-480*]) ** Implements authn/authz for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-481[*COO-481*]) ** Configures ServiceMonitor resource to collect metrics from {coo-short}. (link:https://issues.redhat.com/browse/COO-482[*COO-482*]) @@ -193,7 +195,7 @@ This issue is being tracked in link:https://issues.redhat.com/browse/COO-784[*CO ** You can select a Tempo instance and tenant when you navigate to the tracing page by clicking *Observe -> Tracing* in the web console. The preview troubleshooting panel only works with the `openshift-tracing / platform` instance and the `platform` tenant. ** The troubleshooting panel works best in the *Administrator* perspective. It has limited functionality in the Developer perspective due to authorization issues with some back ends, most notably Prometheus for metrics and alerts. This will be addressed in a future release. -The following table provides information about which features are available depending on the version of {coo-full} and {product-title}: +The following table provides information about which features are available depending on the version of {coo-full} and {ocp-product-title}: [cols="1,1,1,1,1", options="header"] |=== @@ -221,7 +223,7 @@ The following table provides information about which features are available depe == Features available on older, Technology Preview releases -The following table provides information about which features are available depending on older version of {coo-full} and {product-title}: +The following table provides information about which features are available depending on older version of {coo-full} and {ocp-product-title}: [cols="1,1,1,1,1,1", options="header"] |=== @@ -278,7 +280,7 @@ The following advisory is available for {coo-full} 0.4.0: * The troubleshooting UI panel has been improved so you can now select and focus on a specific starting signal. * There is more visibility into Korrel8r queries, with the option of selecting the depth. -* Users of {product-title} version 4.17+ can access the troubleshooting UI panel from the Application Launcher {launch}. Alternatively, on versions 4.16+, you can access it in the web console by clicking on **Observe** -> **Alerting**. +* Users of {ocp-product-title} version 4.17+ can access the troubleshooting UI panel from the Application Launcher {launch}. Alternatively, on versions 4.16+, you can access it in the web console by clicking on **Observe** -> **Alerting**. For more information, see xref:../ui_plugins/troubleshooting-ui-plugin.adoc#troubleshooting-ui-plugin[troubleshooting UI plugin]. @@ -321,7 +323,7 @@ The following advisory is available for {coo-full} 0.3.2: [id="cluster-observability-operator-0-3-2-bug-fixes_{context}"] === Bug fixes -* Previously, the logging UIPlugin was not in the `Available` state and the logging pod was not created, when installed on a specific version of {product-title}. +* Previously, the logging UIPlugin was not in the `Available` state and the logging pod was not created, when installed on a specific version of {ocp-product-title}. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-260[*COO-260*]) [id="cluster-observability-operator-release-notes-0-3-0"] @@ -332,7 +334,7 @@ The following advisory is available for {coo-full} 0.3.0: [id="cluster-observability-operator-0-3-0-new-features-enhancements"] === New features and enhancements -* With this release, the {coo-full} adds backend support for future {product-title} observability web console UI plugins and observability components. +* With this release, the {coo-full} adds backend support for future {ocp-product-title} observability web console UI plugins and observability components. [id="cluster-observability-operator-release-notes-0-2-0"] == {coo-full} 0.2.0 @@ -342,7 +344,7 @@ The following advisory is available for {coo-full} 0.2.0: [id="cluster-observability-operator-0-2-0-new-features-enhancements"] === New features and enhancements -* With this release, the {coo-full} supports installing and managing observability-related plugins for the {product-title} web console user interface (UI). (link:https://issues.redhat.com/browse/COO-58[*COO-58*]) +* With this release, the {coo-full} supports installing and managing observability-related plugins for the {ocp-product-title} web console user interface (UI). (link:https://issues.redhat.com/browse/COO-58[*COO-58*]) [id="cluster-observability-operator-release-notes-0-1-3"] == {coo-full} 0.1.3 diff --git a/snippets/unified-perspective-web-console.adoc b/snippets/unified-perspective-web-console.adoc new file mode 100644 index 000000000000..9707811b78b6 --- /dev/null +++ b/snippets/unified-perspective-web-console.adoc @@ -0,0 +1,10 @@ +:_mod-docs-content-type: SNIPPET + +[IMPORTANT] +==== +Starting with {ocp-product-title} 4.19, the perspectives in the web console have unified. The *Developer* perspective is no longer enabled by default. + +All users can interact with all {ocp-product-title} web console features. However, if you are not the cluster owner, you might need to request permission to certain features from the cluster owner. + +You can still enable the *Developer* perspective. On the *Getting Started* pane in the web console, you can take a tour of the console, find information on setting up your cluster, view a quick start for enabling the *Developer* perspective, and follow links to explore new features and capabilities. +==== \ No newline at end of file diff --git a/ui_plugins/dashboard-ui-plugin.adoc b/ui_plugins/dashboard-ui-plugin.adoc index 6a6144982867..160304291334 100644 --- a/ui_plugins/dashboard-ui-plugin.adoc +++ b/ui_plugins/dashboard-ui-plugin.adoc @@ -6,9 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] -The dashboard UI plugin supports enhanced dashboards in the OpenShift web console at *Observe* -> *Dashboards* . You can add other Prometheus datasources from the cluster to the default dashboards, in addition to the in-cluster datasource. This results in a unified observability experience across different data sources. +The dashboard UI plugin supports enhanced dashboards in the {ocp-product-title} web console at *Observe* -> *Dashboards* . You can add other Prometheus datasources from the cluster to the default dashboards, in addition to the in-cluster datasource. This results in a unified observability experience across different data sources. -The plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`. +The plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`. include::modules/coo-dashboard-ui-plugin-install.adoc[leveloffset=+1] diff --git a/ui_plugins/distributed-tracing-ui-plugin.adoc b/ui_plugins/distributed-tracing-ui-plugin.adoc index dd57008021ad..733586c4f1d2 100644 --- a/ui_plugins/distributed-tracing-ui-plugin.adoc +++ b/ui_plugins/distributed-tracing-ui-plugin.adoc @@ -9,7 +9,7 @@ toc::[] :FeatureName: The {coo-full} distributed tracing UI plugin include::snippets/technology-preview.adoc[leveloffset=+2] -The distributed tracing UI plugin adds tracing-related features to the Administrator perspective of the OpenShift web console at **Observe** → **Traces**. You can follow requests through the front end and into the backend of microservices, helping you identify code errors and performance bottlenecks in distributed systems. +The distributed tracing UI plugin adds tracing-related features to the {ocp-product-title} web console at **Observe** → **Traces**. You can follow requests through the front end and into the backend of microservices, helping you identify code errors and performance bottlenecks in distributed systems. include::modules/coo-distributed-tracing-ui-plugin-install.adoc[leveloffset=+1] diff --git a/ui_plugins/logging-ui-plugin.adoc b/ui_plugins/logging-ui-plugin.adoc index 5e169c3dc702..430c385ecd1c 100644 --- a/ui_plugins/logging-ui-plugin.adoc +++ b/ui_plugins/logging-ui-plugin.adoc @@ -6,19 +6,19 @@ include::_attributes/common-attributes.adoc[] toc::[] -The logging UI plugin surfaces logging data in the {product-title} web console on the *Observe* -> *Logs* page. +The logging UI plugin surfaces logging data in the {ocp-product-title} web console on the *Observe* -> *Logs* page. You can specify filters, queries, time ranges and refresh rates, with the results displayed as a list of collapsed logs, which can then be expanded to show more detailed information for each log. -When you have also deployed the Troubleshooting UI plugin on {product-title} version 4.16+, it connects to the Korrel8r service and adds direct links from the Administration perspective, from the **Observe** -> **Logs** page, to the **Observe** -> **Metrics** page with a correlated PromQL query. It also adds a **See Related Logs** link from the Administration perspective alerting detail page, at **Observe** -> **Alerting**, to the **Observe** -> **Logs** page with a correlated filter set selected. +If you also deploy the Troubleshooting UI plugin on {ocp-product-title} version 4.16+, it connects to the Korrel8r service and adds direct links to the web console, from the **Observe** -> **Logs** page, to the **Observe** -> **Metrics** page with a correlated PromQL query. The plugin also adds a **See Related Logs** link from the web console alerting detail page, at **Observe** -> **Alerting**, to the **Observe** -> **Logs** page with a correlated filter set selected. The features of the plugin are categorized as: -dev-console:: Adds the logging view to the Developer perspective. +dev-console:: Adds the logging view to web console. alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view. -dev-alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view for the Developer perspective. +dev-alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view for the web console. -For {coo-first} versions, the support for these features in {product-title} versions is shown in the following table: +For {coo-first} versions, the support for these features in {ocp-product-title} versions is shown in the following table: [cols="1,1,3", options="header"] |=== diff --git a/ui_plugins/monitoring-ui-plugin.adoc b/ui_plugins/monitoring-ui-plugin.adoc index 414affa4726f..a5880f93d735 100644 --- a/ui_plugins/monitoring-ui-plugin.adoc +++ b/ui_plugins/monitoring-ui-plugin.adoc @@ -9,13 +9,15 @@ toc::[] :FeatureName: The {coo-full} monitoring UI plugin include::snippets/technology-preview.adoc[leveloffset=+2] -The monitoring UI plugin adds monitoring features to the Administrator perspective of the OpenShift web console. +The monitoring UI plugin adds monitoring features to the Administrator perspective of the {ocp-product-title} web console. -* **{rh-rhacm}:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing {rh-rhacm} with the same alerting capabilities as {product-title}. You can configure the plugin to fetch alerts from the {rh-rhacm} Alertmanager backend. This enables seamless integration and user experience by aligning {rh-rhacm} and {product-title} monitoring workflows. +include::snippets/unified-perspective-web-console.adoc[] + +* **{rh-rhacm}:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing {rh-rhacm} with the same alerting capabilities as {ocp-product-title}. You can configure the plugin to fetch alerts from the {rh-rhacm} Alertmanager backend. This enables seamless integration and user experience by aligning {rh-rhacm} and {ocp-product-title} monitoring workflows. * **Incident detection:** The incident detection feature groups related alerts into incidents, to help you identify the root causes of alert bursts, instead of being overwhelmed by individual alerts. It presents a timeline of incidents, color-coded by severity, and you can drill down into the individual alerts within an incident. The system also categorizes alerts by affected component, grouped by severity. This helps you focus on the most critical areas first. + -The incident detection feature is available in the Administrator perspective of the OpenShift web console at **Observe** → **Incidents**. +The incident detection feature is available in the {ocp-product-title} web console at **Observe** -> **Incidents**. include::modules/coo-monitoring-ui-plugin-install.adoc[leveloffset=+1] diff --git a/ui_plugins/observability-ui-plugins-overview.adoc b/ui_plugins/observability-ui-plugins-overview.adoc index c59d9876608a..2ae71f0a62ad 100644 --- a/ui_plugins/observability-ui-plugins-overview.adoc +++ b/ui_plugins/observability-ui-plugins-overview.adoc @@ -6,15 +6,15 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can use the {coo-first} to install and manage UI plugins to enhance the observability capabilities of the {product-title} web console. +You can use the {coo-first} to install and manage UI plugins to enhance the observability capabilities of the {ocp-product-title} web console. The plugins extend the default functionality, providing new UI features for troubleshooting, distributed tracing, and cluster logging. [id="monitoring_{context}"] == Monitoring -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. -* **ACM:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing ACM with the same monitoring capabilities as {product-title}. +* **ACM:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing ACM with the same monitoring capabilities as {ocp-product-title}. * **Incident Detection:** The incident detection feature groups alerts into incidents to help you identify the root causes of alert bursts instead of being overwhelmed by individual alerts. It presents a timeline of incidents, color-coded by severity, and you can drill down into the individual alerts within an incident. The system also categorizes alerts by affected component to help you focus on the most critical areas first. @@ -34,9 +34,9 @@ For more information, see the xref:../ui_plugins/logging-ui-plugin.adoc#logging- :FeatureName: The {coo-full} troubleshooting panel UI plugin include::snippets/technology-preview.adoc[leveloffset=+2] -The troubleshooting panel UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project. +The troubleshooting panel UI plugin for {ocp-product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project. You can use the troubleshooting panel available from the *Observe* -> *Alerting* page to easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores. -Users of {product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}. +Users of {ocp-product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}. The output of Korrel8r is displayed as an interactive node graph. When you click on a node, you are automatically redirected to the corresponding web console page with the specific information for that node, for example, metric, log, or pod. @@ -58,7 +58,7 @@ For more information, see the xref:../ui_plugins/distributed-tracing-ui-plugin.a [id="dashboards_{context}"] == Dashboards -The dashboard UI plugin supports enhanced dashboards in the {product-title} web console at *Observe* -> *Dashboards*. +The dashboard UI plugin supports enhanced dashboards in the {ocp-product-title} web console at *Observe* -> *Dashboards*. You can add other Prometheus data sources from the cluster to the default dashboards, in addition to the in-cluster data source. This results in a unified observability experience across different data sources. diff --git a/ui_plugins/troubleshooting-ui-plugin.adoc b/ui_plugins/troubleshooting-ui-plugin.adoc index 12706dbc78a7..eefb4380ac1f 100644 --- a/ui_plugins/troubleshooting-ui-plugin.adoc +++ b/ui_plugins/troubleshooting-ui-plugin.adoc @@ -9,13 +9,13 @@ toc::[] :FeatureName: The {coo-full} troubleshooting panel UI plugin include::snippets/technology-preview.adoc[leveloffset=+2] -The troubleshooting UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project. -With the troubleshooting panel that is available under *Observe* -> *Alerting*, you can easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores. -Users of {product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}. +The troubleshooting UI plugin for {ocp-product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project. +With the troubleshooting panel that is available under *Observe* -> *Alerting*, you can easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores. +Users of {ocp-product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}. When you install the troubleshooting UI plugin, a link:https://github.com/korrel8r/korrel8r[Korrel8r] service named `korrel8r` is deployed in the same namespace, and it is able to locate related observability signals and Kubernetes resources from its correlation engine. -The output of Korrel8r is displayed in the form of an interactive node graph in the {product-title} web console. +The output of Korrel8r is displayed in the form of an interactive node graph in the {ocp-product-title} web console. Nodes in the graph represent a type of resource or signal, while edges represent relationships. When you click on a node, you are automatically redirected to the corresponding web console page with the specific information for that node, for example, metric, log, pod.