Skip to content

Commit b1e8e6e

Browse files
authored
Merge pull request #48340 from pneedle-rh/osdocs-2920-updating-uwm-content
OSDOCS-2920 - Updating statement about monitoring for user-defined projects
2 parents a54a9d1 + 4d96421 commit b1e8e6e

9 files changed

+29
-18
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,10 @@ Topics:
130130
Topics:
131131
- Name: Understanding the monitoring stack
132132
File: osd-understanding-the-monitoring-stack
133-
- Name: Configuring the monitoring stack
134-
File: osd-configuring-the-monitoring-stack
135133
- Name: Accessing monitoring for user-defined projects
136134
File: osd-accessing-monitoring-for-user-defined-projects
135+
- Name: Configuring the monitoring stack
136+
File: osd-configuring-the-monitoring-stack
137137
- Name: Managing metrics
138138
File: osd-managing-metrics
139139
- Name: Managing alerts

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,10 +219,10 @@ Topics:
219219
Topics:
220220
- Name: Understanding the monitoring stack
221221
File: rosa-understanding-the-monitoring-stack
222-
- Name: Configuring the monitoring stack
223-
File: rosa-configuring-the-monitoring-stack
224222
- Name: Accessing monitoring for user-defined projects
225223
File: rosa-accessing-monitoring-for-user-defined-projects
224+
- Name: Configuring the monitoring stack
225+
File: rosa-configuring-the-monitoring-stack
226226
- Name: Managing metrics
227227
File: rosa-managing-metrics
228228
- Name: Managing alerts

modules/osd-monitoring-understanding-the-monitoring-stack.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,20 @@
66
[id="understanding-the-monitoring-stack_{context}"]
77
= Understanding the monitoring stack
88

9-
The {product-title} monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem. The monitoring stack includes the following:
9+
The {product-title}
10+
ifdef::openshift-rosa[]
11+
(ROSA)
12+
endif::openshift-rosa[]
13+
monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem. The monitoring stack includes the following:
1014

11-
* *Default platform monitoring components*. A set of platform monitoring components are installed in the `openshift-monitoring` project by default during an {product-title} installation. This provides monitoring for core {product-title}. The default monitoring stack also enables remote health monitoring for clusters. Critical metrics, such as CPU and memory, are collected from all of the workloads in every namespace and are made available for your use.
15+
* *Default platform monitoring components*. A set of platform monitoring components are installed in the `openshift-monitoring` project and enabled by default during
16+
ifdef::openshift-dedicated[]
17+
an {product-title}
18+
endif::openshift-dedicated[]
19+
ifdef::openshift-rosa[]
20+
a ROSA
21+
endif::openshift-rosa[]
22+
installation. This provides monitoring for core cluster components. The default monitoring stack also enables remote health monitoring for clusters. Critical metrics, such as CPU and memory, are collected from all of the workloads in every namespace and are made available for your use.
1223
+
1324
These components are illustrated in the *Installed by default* section in the following diagram.
1425

osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
66

77
toc::[]
88

9-
By default, centralized monitoring for user-defined projects and platform monitoring are enabled. You can monitor your own projects in {product-title} without the need for an additional monitoring solution.
10-
11-
The monitoring of user-defined projects cannot be disabled.
9+
When you install an {product-title} cluster, monitoring for user-defined projects is enabled by default. With monitoring for user-defined projects enabled, you can monitor your own {product-title} projects without the need for an additional monitoring solution.
1210

1311
The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.
1412

@@ -17,7 +15,9 @@ The `dedicated-admin` user has default permissions to configure and access monit
1715
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.
1816
====
1917

18+
Optionally, you can disable monitoring for user-defined projects during or after a cluster installation.
19+
2020
[id="accessing-user-defined-monitoring-next-steps"]
2121
== Next steps
2222

23-
* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]
23+
* xref:../../osd_cluster_admin/osd_monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]

osd_cluster_admin/osd_monitoring/osd-configuring-the-monitoring-stack.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,4 @@ include::modules/osd-monitoring-setting-log-levels-for-monitoring-components.ado
7979
[id="configuring-the-monitoring-stack-next-steps"]
8080
== Next steps
8181

82-
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
82+
* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]

osd_cluster_admin/osd_monitoring/osd-understanding-the-monitoring-stack.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffs
3030
[id="understanding-the-monitoring-stack-next-steps"]
3131
== Next steps
3232

33-
* xref:../../osd_cluster_admin/osd_monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
33+
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]

rosa_cluster_admin/rosa_monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
66

77
toc::[]
88

9-
By default, centralized monitoring for user-defined projects and platform monitoring are enabled. You can monitor your own projects in {product-title} without the need for an additional monitoring solution.
10-
11-
The monitoring of user-defined projects cannot be disabled.
9+
When you install a {product-title} (ROSA) cluster, monitoring for user-defined projects is enabled by default. With monitoring for user-defined projects enabled, you can monitor your own ROSA projects without the need for an additional monitoring solution.
1210

1311
The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.
1412

@@ -17,7 +15,9 @@ The `dedicated-admin` user has default permissions to configure and access monit
1715
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.
1816
====
1917

18+
Optionally, you can disable monitoring for user-defined projects during or after a cluster installation.
19+
2020
[id="accessing-user-defined-monitoring-next-steps"]
2121
== Next steps
2222

23-
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-managing-metrics.adoc#rosa-managing-metrics[Managing metrics]
23+
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]

rosa_cluster_admin/rosa_monitoring/rosa-configuring-the-monitoring-stack.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ include::modules/osd-monitoring-setting-log-levels-for-monitoring-components.ado
8080
[id="configuring-the-monitoring-stack-next-steps"]
8181
== Next steps
8282

83-
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
83+
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-managing-metrics.adoc#rosa-managing-metrics[Managing metrics]

rosa_cluster_admin/rosa_monitoring/rosa-understanding-the-monitoring-stack.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffs
3131
[id="understanding-the-monitoring-stack-next-steps"]
3232
== Next steps
3333

34-
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]
34+
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]

0 commit comments

Comments
 (0)