Skip to content

Commit 8c16cd7

Browse files
committed
OBSDOCS-1562 improve COO overview, including article content
1 parent 1b25ad9 commit 8c16cd7

File tree

4 files changed

+107
-8
lines changed

4 files changed

+107
-8
lines changed

modules/coo-advantages.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Module included in the following assemblies:
2+
// * observability/cluster_observability_operator/cluster-observability-operator-overview.adoc
3+
4+
:_mod-docs-content-type: CONCEPT
5+
[id="coo-advantages_{context}"]
6+
= Key advantages of using {coo-short}
7+
8+
Deploying {coo-short} helps you address monitoring requirements that are hard to achieve using the default monitoring stack.
9+
10+
[id="coo-advantages-extensibility_{context}"]
11+
== Extensibility
12+
13+
- You can add more metrics to a {coo-short}-deployed monitoring stack, which is not possible with core platform monitoring without losing support.
14+
- You can receive cluster-specific metrics from core platform monitoring through federation.
15+
- {coo-short} supports advanced monitoring scenarios like trend forecasting and anomaly detection.
16+
17+
[id="coo-advantages-multi-tenancy_{context}"]
18+
== Multi-tenancy support
19+
20+
- You can create monitoring stacks per user namespace.
21+
- You can deploy multiple stacks per namespace or a single stack for multiple namespaces.
22+
- {coo-short} enables independent configuration of alerts and receivers for different teams.
23+
24+
[id="coo-advantages-scalability_{context}"]
25+
== Scalability
26+
27+
- Supports multiple monitoring stacks on a single cluster.
28+
- Enables monitoring of large clusters through manual sharding.
29+
- Addresses cases where metrics exceed the capabilities of a single Prometheus instance.
30+
31+
[id="coo-advantages-scalabilityflexibility_{context}"]
32+
== Flexibility
33+
34+
- Decoupled from {product-title} release cycles.
35+
- Faster release iterations and rapid response to changing requirements.
36+
- Independent management of alerting rules.

modules/coo-target-users.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
// * observability/cluster_observability_operator/cluster-observability-operator-overview.adoc
3+
4+
:_mod-docs-content-type: CONCEPT
5+
[id="coo-target-users_{context}"]
6+
= Target users for {coo-short}
7+
8+
{coo-short} is ideal for users who need high customizability, scalability, and long-term data retention, especially in complex, multi-tenant enterprise environments.
9+
10+
[id="coo-target-users-enterprise_{context}"]
11+
== Enterprise-level users and administrators
12+
13+
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.
14+
15+
[id="coo-target-users-multi-tenant_{context}"]
16+
== Operations teams in multi-tenant environments
17+
18+
With multi-tenancy support, {coo-short} allows different teams to configure monitoring views for their projects and applications, making it suitable for teams with flexible monitoring needs.
19+
20+
[id="coo-target-users-devops_{context}"]
21+
== Development and operations teams
22+
23+
{coo-short} provides fine-grained monitoring and customizable observability views for in-depth troubleshooting, anomaly detection, and performance tuning during development and operations.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Module included in the following assemblies:
2+
3+
// * observability/cluster_observability_operator/cluster-observability-operator-overview.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="coo-versus-default-ocp-monitoring_{context}"]
7+
= {coo-short} compared to default monitoring stack
8+
9+
The {coo-short} components function independently of the default in-cluster monitoring stack, which is deployed and managed by the {cmo-first}.
10+
Monitoring stacks deployed by the two Operators do not conflict. You can use a {coo-short} monitoring stack in addition to the default platform monitoring components deployed by the {cmo-short}.
11+
12+
The key differences between {coo-short} and the default in-cluster monitoring stack are shown in the following table:
13+
14+
[cols="1,3,3", options="header"]
15+
|===
16+
| Feature | {coo-short} | Default monitoring stack
17+
18+
| **Scope and integration**
19+
| Offers comprehensive monitoring and analytics for enterprise-level needs, covering cluster and workload performance.
20+
21+
However, it lacks direct integration with {product-title} and typically requires an external Grafana instance for dashboards.
22+
| Limited to core components within the cluster, for example, API server and etcd, and to OpenShift-specific namespaces.
23+
24+
There is deep integration into {product-title} including console dashboards and alert management in the console.
25+
26+
| **Configuration and customization**
27+
| Broader configuration options including data retention periods, storage methods, and collected data types.
28+
29+
The {coo-short} can delegate ownership of single configurable fields in custom resources to users by using Server-Side Apply (SSA), which enhances customization.
30+
| Built-in configurations with limited customization options.
31+
32+
| **Data retention and storage**
33+
| Long-term data retention, supporting historical analysis and capacity planning
34+
| Shorter data retention times, focusing on short-term monitoring and real-time detection.
35+
36+
|===

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

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,25 @@ toc::[]
99
:FeatureName: The Cluster Observability Operator
1010
include::snippets/technology-preview.adoc[leveloffset=+2]
1111

12-
The {coo-first} is an optional component of the {product-title}. You can deploy it to create standalone monitoring stacks that are independently configurable for use by different services and users.
12+
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.
1313

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

16-
* Prometheus
17-
* Thanos Querier (optional)
18-
* Alertmanager (optional)
16+
* **Prometheus** - A highly available Prometheus instance capable of sending metrics to an external endpoint by using remote write.
17+
* **Thanos Querier** (optional) - Enables querying of Prometheus instances from a central location.
18+
* **Alertmanager** (optional) - Provides alert configuration capabilities for different services.
19+
* **UI plugins** (optional) - Enhances the observability capabilities with plugins for monitoring, logging, distributed tracing and troubleshooting.
20+
* **Korrel8r** (optional) - Provides observability signal correlation, powered by the open source Korrel8r project.
1921
20-
The {coo-short} components function independently of the default in-cluster monitoring stack, which is deployed and managed by the {cmo-first}.
21-
Monitoring stacks deployed by the two Operators do not conflict. You can use a {coo-short} monitoring stack in addition to the default platform monitoring components deployed by the {cmo-short}.
22+
include::modules/coo-versus-default-ocp-monitoring.adoc[leveloffset=+1]
2223

23-
include::modules/monitoring-understanding-the-cluster-observability-operator.adoc[leveloffset=+1]
24+
include::modules/coo-advantages.adoc[leveloffset=+1]
25+
26+
include::modules/coo-target-users.adoc[leveloffset=+1]
27+
28+
//include::modules/monitoring-understanding-the-cluster-observability-operator.adoc[leveloffset=+1]
2429

2530
[role="_additional-resources"]
2631
.Additional resources
2732

2833
* link:https://kubernetes.io/docs/reference/using-api/server-side-apply/[Kubernetes documentation for Server-Side Apply (SSA)]
29-

0 commit comments

Comments
 (0)