From 63c02d8f03e4dc146acbdc9204ea8446f2f43197 Mon Sep 17 00:00:00 2001 From: Eliska Romanova Date: Fri, 26 Apr 2024 12:29:25 +0200 Subject: [PATCH] OBSDOCS-1011: Fix information about the user-workload-monitoring-config ConfigMap --- ...ng-a-secret-to-the-alertmanager-configuration.adoc | 9 +-------- ...ssigning-tolerations-to-monitoring-components.adoc | 9 +-------- ...itional-labels-to-your-time-series-and-alerts.adoc | 9 +-------- ...g-configuring-a-local-persistent-volume-claim.adoc | 9 +-------- ...monitoring-configuring-external-alertmanagers.adoc | 11 +---------- ...g-configuring-pod-topology-spread-constraints.adoc | 2 +- .../monitoring-configuring-remote-write-storage.adoc | 9 +-------- .../monitoring-configuring-the-monitoring-stack.adoc | 9 +-------- ...toring-creating-cluster-id-labels-for-metrics.adoc | 2 +- modules/monitoring-creating-scrape-sample-alerts.adoc | 3 +-- ...ng-user-defined-workload-monitoring-configmap.adoc | 8 ++++++-- ...nager-instance-for-user-defined-alert-routing.adoc | 2 +- ...enabling-monitoring-for-user-defined-projects.adoc | 9 +++++++-- ...igure-alert-routing-for-user-defined-projects.adoc | 2 +- ...ting-why-user-defined-metrics-are-unavailable.adoc | 3 +-- ...ion-time-and-size-for-prometheus-metrics-data.adoc | 3 +-- ...-retention-time-for-thanos-ruler-metrics-data.adoc | 1 - ...ving-monitoring-components-to-different-nodes.adoc | 9 +-------- ...nitoring-resizing-a-persistent-storage-volume.adoc | 2 +- ...-setting-log-levels-for-monitoring-components.adoc | 9 +-------- ...itoring-setting-query-log-file-for-prometheus.adoc | 11 ++--------- ...le-and-label-limits-for-user-defined-projects.adoc | 9 +-------- 22 files changed, 33 insertions(+), 107 deletions(-) diff --git a/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc b/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc index caff23c2d1cb..d38e271868bc 100644 --- a/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc +++ b/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc @@ -23,9 +23,9 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` config map. ** You have created the secret to be configured in Alertmanager in the `openshift-monitoring` project. * *If you are configuring components that monitor user-defined projects*: -** A cluster administrator has enabled monitoring for user-defined projects. ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. ** You have created the secret to be configured in Alertmanager in the `openshift-user-workload-monitoring` project. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -128,13 +128,6 @@ data: - test-secret - test-api-receiver-token ---- -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] . Save the file to apply the changes to the `ConfigMap` object. The new configuration is applied automatically. diff --git a/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc b/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc index f4b0a60cd103..df3aceb00c9f 100644 --- a/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc +++ b/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc @@ -22,7 +22,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -126,13 +126,6 @@ data: ---- . Save the file to apply the changes. The new component placement configuration is applied automatically. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ==== diff --git a/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc b/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc index 3c73af40ede9..6f95381bd42d 100644 --- a/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc +++ b/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc @@ -16,7 +16,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -135,13 +135,6 @@ data: ---- . Save the file to apply the changes. The new configuration is applied automatically. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ==== diff --git a/modules/monitoring-configuring-a-local-persistent-volume-claim.adoc b/modules/monitoring-configuring-a-local-persistent-volume-claim.adoc index 02c55702663c..0fc74f448d87 100644 --- a/modules/monitoring-configuring-a-local-persistent-volume-claim.adoc +++ b/modules/monitoring-configuring-a-local-persistent-volume-claim.adoc @@ -21,7 +21,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -207,13 +207,6 @@ Storage requirements for the `thanosRuler` component depend on the number of rul ==== . Save the file to apply the changes. The pods affected by the new configuration are restarted automatically and the new storage configuration is applied. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] + [WARNING] diff --git a/modules/monitoring-configuring-external-alertmanagers.adoc b/modules/monitoring-configuring-external-alertmanagers.adoc index 72df94644ac2..ff6aba3c4950 100644 --- a/modules/monitoring-configuring-external-alertmanagers.adoc +++ b/modules/monitoring-configuring-external-alertmanagers.adoc @@ -24,7 +24,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` config map. * *If you are configuring components that monitor user-defined projects*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` config map. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -165,14 +165,5 @@ data: ---- . Save the file to apply the changes to the `ConfigMap` object. The new component placement configuration is applied automatically. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] . Save the file to apply the changes to the `ConfigMap` object. The new component placement configuration is applied automatically. - - diff --git a/modules/monitoring-configuring-pod-topology-spread-constraints.adoc b/modules/monitoring-configuring-pod-topology-spread-constraints.adoc index d2c8f57a0d22..6105f8b96918 100644 --- a/modules/monitoring-configuring-pod-topology-spread-constraints.adoc +++ b/modules/monitoring-configuring-pod-topology-spread-constraints.adoc @@ -29,8 +29,8 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have access to the cluster as a user with the `cluster-admin` cluster role. ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring pods for user-defined monitoring:* -** A cluster administrator has enabled monitoring for user-defined projects. ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. diff --git a/modules/monitoring-configuring-remote-write-storage.adoc b/modules/monitoring-configuring-remote-write-storage.adoc index c7b0ae7b470d..b749ca114c22 100644 --- a/modules/monitoring-configuring-remote-write-storage.adoc +++ b/modules/monitoring-configuring-remote-write-storage.adoc @@ -17,7 +17,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects:* ** You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -202,13 +202,6 @@ data: See the link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[Prometheus relabel_config documentation] for information about write relabel configuration options. . Save the file to apply the changes. The pods affected by the new configuration restart automatically. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ==== diff --git a/modules/monitoring-configuring-the-monitoring-stack.adoc b/modules/monitoring-configuring-the-monitoring-stack.adoc index c573e4f008be..7ffff011901d 100644 --- a/modules/monitoring-configuring-the-monitoring-stack.adoc +++ b/modules/monitoring-configuring-the-monitoring-stack.adoc @@ -21,7 +21,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -137,13 +137,6 @@ The Prometheus config map component is called `prometheusK8s` in the `cluster-mo endif::openshift-dedicated,openshift-rosa[] . Save the file to apply the changes to the `ConfigMap` object. The pods affected by the new configuration are restarted automatically. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ==== diff --git a/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc b/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc index a291c921eb79..b94ed4535743 100644 --- a/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc +++ b/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc @@ -34,7 +34,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects:* ** You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. diff --git a/modules/monitoring-creating-scrape-sample-alerts.adoc b/modules/monitoring-creating-scrape-sample-alerts.adoc index f0c8c20acca6..f8343d22ba90 100644 --- a/modules/monitoring-creating-scrape-sample-alerts.adoc +++ b/modules/monitoring-creating-scrape-sample-alerts.adoc @@ -14,8 +14,7 @@ You can create alerts that notify you when: .Prerequisites * You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -* You have enabled monitoring for user-defined projects. -* You have created the `user-workload-monitoring-config` `ConfigMap` object. +* A cluster administrator has enabled monitoring for user-defined projects. * You have limited the number of samples that can be accepted per target scrape in user-defined projects, by using `enforcedSampleLimit`. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/monitoring-creating-user-defined-workload-monitoring-configmap.adoc b/modules/monitoring-creating-user-defined-workload-monitoring-configmap.adoc index 4c89b48e1953..8b25118be3a9 100644 --- a/modules/monitoring-creating-user-defined-workload-monitoring-configmap.adoc +++ b/modules/monitoring-creating-user-defined-workload-monitoring-configmap.adoc @@ -6,11 +6,13 @@ [id="creating-user-defined-workload-monitoring-configmap_{context}"] = Creating a user-defined workload monitoring config map -You can configure the user workload monitoring components by creating the `user-workload-monitoring-config` `ConfigMap` object in the `openshift-user-workload-monitoring` project. The Cluster Monitoring Operator (CMO) then configures the components that monitor user-defined projects. +You can configure the user workload monitoring components with the `user-workload-monitoring-config` `ConfigMap` object in the `openshift-user-workload-monitoring` project. The Cluster Monitoring Operator (CMO) then configures the components that monitor user-defined projects. [NOTE] ==== -When you save your changes to the `user-workload-monitoring-config` `ConfigMap` object, some or all of the pods in the `openshift-user-workload-monitoring` project might be redeployed. It can sometimes take a while for these components to redeploy. You can create and configure the config map before you first enable monitoring for user-defined projects, to prevent having to redeploy the pods often. +* If you enable monitoring for user-defined projects, the `user-workload-monitoring-config` `ConfigMap` object is created by default. + +* When you save your changes to the `user-workload-monitoring-config` `ConfigMap` object, some or all of the pods in the `openshift-user-workload-monitoring` project might be redeployed. It can sometimes take a while for these components to redeploy. ==== .Prerequisites @@ -47,8 +49,10 @@ data: ---- $ oc apply -f user-workload-monitoring-config.yaml ---- +ifndef::openshift-dedicated,openshift-rosa[] + [NOTE] ==== Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. ==== +endif::openshift-dedicated,openshift-rosa[] diff --git a/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc b/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc index 194a2b4264db..1aeb7175b5d2 100644 --- a/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc +++ b/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc @@ -22,7 +22,7 @@ ifdef::openshift-rosa,openshift-dedicated[] endif::[] ifndef::openshift-rosa,openshift-dedicated[] * You have access to the cluster as a user with the `cluster-admin` cluster role. -* You have enabled monitoring for user-defined projects in the `cluster-monitoring-config` config map for the `openshift-monitoring` namespace. +* You have enabled monitoring for user-defined projects. endif::[] * You have installed the OpenShift CLI (`oc`). diff --git a/modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc b/modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc index 63dfd3107021..e10f130d634c 100644 --- a/modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc +++ b/modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc @@ -27,7 +27,7 @@ You must have access to the cluster as a user with the `cluster-admin` cluster r + [NOTE] ==== -Every time you save configuration changes to the `user-workload-monitoring-config` `ConfigMap` object, the pods in the `openshift-user-workload-monitoring` project are redeployed. It can sometimes take a while for these components to redeploy. You can create and configure the `ConfigMap` object before you first enable monitoring for user-defined projects, to prevent having to redeploy the pods often. +Every time you save configuration changes to the `user-workload-monitoring-config` `ConfigMap` object, the pods in the `openshift-user-workload-monitoring` project are redeployed. It can sometimes take a while for these components to redeploy. ==== .Procedure @@ -56,12 +56,17 @@ data: . Save the file to apply the changes. Monitoring for user-defined projects is then enabled automatically. + +[NOTE] +==== +If you enable monitoring for user-defined projects, the `user-workload-monitoring-config` `ConfigMap` object is created by default. +==== ++ [WARNING] ==== When changes are saved to the `cluster-monitoring-config` `ConfigMap` object, the pods and other resources in the `openshift-monitoring` project might be redeployed. The running monitoring processes in that project might also be restarted. ==== -. Check that the `prometheus-operator`, `prometheus-user-workload` and `thanos-ruler-user-workload` pods are running in the `openshift-user-workload-monitoring` project. It might take a short while for the pods to start: +. Verify that the `prometheus-operator`, `prometheus-user-workload` and `thanos-ruler-user-workload` pods are running in the `openshift-user-workload-monitoring` project. It might take a short while for the pods to start: + [source,terminal] ---- diff --git a/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc b/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc index bf72a9a7dacc..c1d2e71a62c8 100644 --- a/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc +++ b/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc @@ -17,7 +17,7 @@ ifdef::openshift-rosa,openshift-dedicated[] endif::[] ifndef::openshift-rosa,openshift-dedicated[] * You have access to the cluster as a user with the `cluster-admin` cluster role. -* You have enabled monitoring for user-defined projects in the `cluster-monitoring-config` config map for the `openshift-monitoring` namespace. +* You have enabled monitoring for user-defined projects. endif::[] * The user account that you are assigning the role to already exists. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc b/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc index d36dd1724863..fefd1106a708 100644 --- a/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc +++ b/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc @@ -18,8 +18,7 @@ ifdef::openshift-rosa,openshift-dedicated[] * You have access to the cluster as a user with the `dedicated-admin` role. endif::openshift-rosa,openshift-dedicated[] * You have installed the OpenShift CLI (`oc`). -* You have enabled and configured monitoring for user-defined workloads. -* You have created the `user-workload-monitoring-config` `ConfigMap` object. +* You have enabled and configured monitoring for user-defined projects. * You have created a `ServiceMonitor` resource. .Procedure diff --git a/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc b/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc index b653a9fe3596..8cb79a5c6a3b 100644 --- a/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc +++ b/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc @@ -45,9 +45,8 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have access to the cluster as a user with the `cluster-admin` cluster role. ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects*: -** A cluster administrator has enabled monitoring for user-defined projects. ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. diff --git a/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc b/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc index 1eb403a321c6..84c94e6d7154 100644 --- a/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc +++ b/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc @@ -13,7 +13,6 @@ By default, for user-defined projects, Thanos Ruler automatically retains metric ifndef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -* You have created the `user-workload-monitoring-config` `ConfigMap` object. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. diff --git a/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc b/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc index 2d1a7dbc1435..f9b5a889883a 100644 --- a/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc +++ b/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc @@ -26,7 +26,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are configuring components that monitor user-defined projects*: ** You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -119,13 +119,6 @@ If monitoring components remain in a `Pending` state after configuring the `node . Save the file to apply the changes. The components specified in the new configuration are moved to the new nodes automatically. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ==== diff --git a/modules/monitoring-resizing-a-persistent-storage-volume.adoc b/modules/monitoring-resizing-a-persistent-storage-volume.adoc index dd63a9f10179..e18c19485862 100644 --- a/modules/monitoring-resizing-a-persistent-storage-volume.adoc +++ b/modules/monitoring-resizing-a-persistent-storage-volume.adoc @@ -22,7 +22,7 @@ No service disruption occurs during this process. ** You have configured at least one PVC for core {product-title} monitoring components. * *If you are configuring components that monitor user-defined projects*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. ** You have configured at least one PVC for components that monitor user-defined projects. .Procedure diff --git a/modules/monitoring-setting-log-levels-for-monitoring-components.adoc b/modules/monitoring-setting-log-levels-for-monitoring-components.adoc index a4f05419cd9f..263a27b583b0 100644 --- a/modules/monitoring-setting-log-levels-for-monitoring-components.adoc +++ b/modules/monitoring-setting-log-levels-for-monitoring-components.adoc @@ -35,7 +35,7 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are setting a log level for Prometheus Operator, Prometheus, or Thanos Ruler in the `openshift-user-workload-monitoring` project*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -104,13 +104,6 @@ For user workload monitoring, available component values are `alertmanager`, `pr <2> The log level to apply to the component. The available values are `error`, `warn`, `info`, and `debug`. The default value is `info`. . Save the file to apply the changes. The pods for the component restart automatically when you apply the log-level change. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ==== diff --git a/modules/monitoring-setting-query-log-file-for-prometheus.adoc b/modules/monitoring-setting-query-log-file-for-prometheus.adoc index 6192086cdccf..632e952c3288 100644 --- a/modules/monitoring-setting-query-log-file-for-prometheus.adoc +++ b/modules/monitoring-setting-query-log-file-for-prometheus.adoc @@ -25,11 +25,11 @@ ifndef::openshift-dedicated,openshift-rosa[] ** You have created the `cluster-monitoring-config` `ConfigMap` object. * *If you are enabling the query log file feature for Prometheus in the `openshift-user-workload-monitoring` project*: ** You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -** You have created the `user-workload-monitoring-config` `ConfigMap` object. +** A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. -* The `user-workload-monitoring-config` ConfigMap object exists. This object is created by default when the cluster is created. +* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. endif::openshift-dedicated,openshift-rosa[] * You have installed the OpenShift CLI (`oc`). @@ -112,13 +112,6 @@ data: <1> The full path to the file in which queries will be logged. + . Save the file to apply the changes. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ==== diff --git a/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc b/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc index e2019fdbf37a..9a1ef40bc678 100644 --- a/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc +++ b/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc @@ -17,7 +17,7 @@ If you set sample or label limits, no further sample data is ingested for that t ifndef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. -* You have enabled monitoring for user-defined projects. +* A cluster administrator has enabled monitoring for user-defined projects. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -74,13 +74,6 @@ The default value is `0`, which specifies no limit. The default value is `0`, which specifies no limit. . Save the file to apply the changes. The limits are applied automatically. -ifndef::openshift-dedicated,openshift-rosa[] -+ -[NOTE] -==== -Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects. -==== -endif::openshift-dedicated,openshift-rosa[] + [WARNING] ====