Skip to content

Commit 051ca09

Browse files
authored
Merge pull request #85586 from gabriel-rh/OBSDOCS-1523
OBSDOCS-1523 remove TP notice for COO, but keep for troubleshooting korrel8r
2 parents c6004ed + d1c3be0 commit 051ca09

8 files changed

+30
-32
lines changed

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3237,14 +3237,14 @@ Topics:
32373237
Topics:
32383238
- Name: Observability UI plugins overview
32393239
File: observability-ui-plugins-overview
3240-
- Name: Dashboard UI plugin
3241-
File: dashboard-ui-plugin
3240+
- Name: Logging UI plugin
3241+
File: logging-ui-plugin
32423242
- Name: Distributed tracing UI plugin
32433243
File: distributed-tracing-ui-plugin
32443244
- Name: Troubleshooting UI plugin
32453245
File: troubleshooting-ui-plugin
3246-
- Name: Logging UI plugin
3247-
File: logging-ui-plugin
3246+
# - Name: Dashboard UI plugin
3247+
# File: dashboard-ui-plugin
32483248
---
32493249
Name: Scalability and performance
32503250
Dir: scalability_and_performance

observability/cluster_observability_operator/cluster-observability-operator-overview.adoc

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

77
toc::[]
88

9-
:FeatureName: The Cluster Observability Operator
10-
include::snippets/technology-preview.adoc[leveloffset=+2]
119

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

observability/cluster_observability_operator/configuring-the-cluster-observability-operator-to-monitor-a-service.adoc

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

77
toc::[]
88

9-
:FeatureName: The Cluster Observability Operator
10-
include::snippets/technology-preview.adoc[leveloffset=+2]
11-
129
You can monitor metrics for a service by configuring monitoring stacks managed by the {coo-first}.
1310

1411
To test monitoring a service, follow these steps:

observability/cluster_observability_operator/installing-the-cluster-observability-operator.adoc

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

77
toc::[]
88

9-
:FeatureName: The Cluster Observability Operator
10-
include::snippets/technology-preview.adoc[leveloffset=+2]
11-
129
As a cluster administrator, you can install or remove the {coo-first} from OperatorHub by using the {product-title} web console.
1310
OperatorHub is a user interface that works in conjunction with Operator Lifecycle Manager (OLM), which installs and manages Operators on a cluster.
1411

observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc

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

77
toc::[]
88

9-
:FeatureName: The Cluster Observability Operator
10-
include::snippets/technology-preview.adoc[leveloffset=+2]
11-
129
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.
1310

1411
The plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`.

observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
:FeatureName: The Cluster Observability Operator
9+
:FeatureName: The {coo-full} distributed tracing UI plugin
1010
include::snippets/technology-preview.adoc[leveloffset=+2]
1111

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

observability/cluster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc

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

77
toc::[]
88

9-
:FeatureName: The {coo-full}
10-
include::snippets/technology-preview.adoc[leveloffset=+2]
11-
129
You can use the {coo-first} to install and manage UI plugins to enhance the observability capabilities of the {product-title} web console.
13-
The plugins extend the default functionality, providing new UI features for monitoring, troubleshooting, distributed tracing, and cluster logging.
10+
The plugins extend the default functionality, providing new UI features for troubleshooting, distributed tracing, and cluster logging.
1411

15-
[id="dashboards_{context}"]
16-
== Dashboards
1712

18-
The dashboard UI plugin supports enhanced dashboards in the {product-title} web console at *Observe* -> *Dashboards*.
19-
You can add other Prometheus data sources from the cluster to the default dashboards, in addition to the in-cluster data source.
20-
This results in a unified observability experience across different data sources.
2113

22-
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc#dashboard-ui-plugin[dashboard UI plugin] page.
14+
[id="cluster-logging_{context}"]
15+
== Cluster logging
16+
17+
The logging UI plugin surfaces logging data in the web console on the *Observe* -> *Logs* page.
18+
You can specify filters, queries, time ranges and refresh rates. The results displayed a list of collapsed logs, which can then be expanded to show more detailed information for each log.
19+
20+
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[logging UI plugin] page.
21+
2322

2423
[id="troubleshooting_{context}"]
2524
== Troubleshooting
2625

26+
:FeatureName: The {coo-full} troubleshooting panel UI plugin
27+
include::snippets/technology-preview.adoc[leveloffset=+2]
28+
2729
The troubleshooting panel UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project.
2830
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.
2931
Users of {product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}.
@@ -35,17 +37,24 @@ For more information, see the xref:../../../observability/cluster_observability_
3537
[id="distributed-tracing_{context}"]
3638
== Distributed tracing
3739

40+
:FeatureName: The {coo-full} distributed tracing UI plugin
41+
include::snippets/technology-preview.adoc[leveloffset=+2]
42+
3843
The distributed tracing UI plugin adds tracing-related features to the web console on the *Observe* -> *Traces* page.
3944
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.
4045
You can select a supported `TempoStack` or `TempoMonolithic` multi-tenant instance running in the cluster and set a time range and query to view the trace data.
4146

4247
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[distributed tracing UI plugin] page.
4348

4449

45-
[id="cluster-logging_{context}"]
46-
== Cluster logging
50+
////
51+
[id="dashboards_{context}"]
52+
== Dashboards
4753
48-
The logging UI plugin surfaces logging data in the web console on the *Observe* -> *Logs* page.
49-
You can specify filters, queries, time ranges and refresh rates. The results displayed a list of collapsed logs, which can then be expanded to show more detailed information for each log.
54+
The dashboard UI plugin supports enhanced dashboards in the {product-title} web console at *Observe* -> *Dashboards*.
55+
You can add other Prometheus data sources from the cluster to the default dashboards, in addition to the in-cluster data source.
56+
This results in a unified observability experience across different data sources.
5057
51-
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[logging UI plugin] page.
58+
For more information, see the xref :../../../observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc#dashboard-ui-plugin[dashboard UI plugin] page.
59+
60+
////

observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
:FeatureName: The Cluster Observability Operator
9+
:FeatureName: The {coo-full} troubleshooting panel UI plugin
1010
include::snippets/technology-preview.adoc[leveloffset=+2]
1111

1212
The troubleshooting UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project.

0 commit comments

Comments
 (0)