From 69e968206ba25a17665d9c0481e827d33f29b70c 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 --- ...ing-a-secret-to-the-alertmanager-configuration.adoc | 2 +- ...assigning-tolerations-to-monitoring-components.adoc | 2 +- ...ditional-labels-to-your-time-series-and-alerts.adoc | 2 +- ...ng-configuring-a-local-persistent-volume-claim.adoc | 2 +- .../monitoring-configuring-remote-write-storage.adoc | 2 +- .../monitoring-configuring-the-monitoring-stack.adoc | 2 +- ...itoring-creating-cluster-id-labels-for-metrics.adoc | 9 ++++++++- modules/monitoring-creating-scrape-sample-alerts.adoc | 10 ++++++++-- ...ing-user-defined-workload-monitoring-configmap.adoc | 4 +++- ...-enabling-monitoring-for-user-defined-projects.adoc | 9 +++++++-- ...ating-why-user-defined-metrics-are-unavailable.adoc | 3 +-- ...tion-time-and-size-for-prometheus-metrics-data.adoc | 10 ++++++++-- ...e-retention-time-for-thanos-ruler-metrics-data.adoc | 10 ++++++++-- ...oving-monitoring-components-to-different-nodes.adoc | 2 +- ...onitoring-resizing-a-persistent-storage-volume.adoc | 9 ++++++++- ...g-setting-log-levels-for-monitoring-components.adoc | 2 +- ...nitoring-setting-query-log-file-for-prometheus.adoc | 2 +- ...ple-and-label-limits-for-user-defined-projects.adoc | 2 +- 18 files changed, 61 insertions(+), 23 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..915afa837b90 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-assigning-tolerations-to-monitoring-components.adoc b/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc index f4b0a60cd103..6fcb53256ece 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-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..559a924b2505 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-a-local-persistent-volume-claim.adoc b/modules/monitoring-configuring-a-local-persistent-volume-claim.adoc index 02c55702663c..756733bc9b5a 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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..17de74b2f746 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-the-monitoring-stack.adoc b/modules/monitoring-configuring-the-monitoring-stack.adoc index c573e4f008be..b236d287a7e0 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-cluster-id-labels-for-metrics.adoc b/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc index a291c921eb79..ac992cdf6dc1 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -159,6 +159,13 @@ data: . Save the file to apply the changes to the `ConfigMap` object. The pods affected by the updated configuration automatically restart. +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-scrape-sample-alerts.adoc b/modules/monitoring-creating-scrape-sample-alerts.adoc index f0c8c20acca6..39fbed8a47e3 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. +* The `user-workload-monitoring-config` `ConfigMap` object exists. * 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`). @@ -72,3 +71,10 @@ spec: ---- $ oc apply -f monitoring-stack-alerts.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-creating-user-defined-workload-monitoring-configmap.adoc b/modules/monitoring-creating-user-defined-workload-monitoring-configmap.adoc index 4c89b48e1953..5490be665ab5 100644 --- a/modules/monitoring-creating-user-defined-workload-monitoring-configmap.adoc +++ b/modules/monitoring-creating-user-defined-workload-monitoring-configmap.adoc @@ -8,7 +8,7 @@ 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. -[NOTE] +[TIP] ==== 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. ==== @@ -47,8 +47,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-monitoring-for-user-defined-projects.adoc b/modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc index 63dfd3107021..1ad3d43cf6ae 100644 --- a/modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc +++ b/modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc @@ -25,7 +25,7 @@ You must have access to the cluster as a user with the `cluster-admin` cluster r * You have created the `cluster-monitoring-config` `ConfigMap` object. * You have optionally created and configured the `user-workload-monitoring-config` `ConfigMap` object in the `openshift-user-workload-monitoring` project. You can add configuration options to this `ConfigMap` object for the components that monitor user-defined projects. + -[NOTE] +[IP] ==== 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. ==== @@ -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 before creating the `user-workload-monitoring-config` `ConfigMap`, the config map 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-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..36609eaa9c8e 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. +**The `user-workload-monitoring-config` `ConfigMap` object exists. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -148,6 +147,13 @@ data: ---- . 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-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..4ce72598aa53 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 @@ -12,8 +12,7 @@ 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. +* The `user-workload-monitoring-config` `ConfigMap` object exists. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role. @@ -65,6 +64,13 @@ data: ---- . Save the file to apply the changes. The pods affected by the new configuration automatically restart. +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-moving-monitoring-components-to-different-nodes.adoc b/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc index 2d1a7dbc1435..4a9f58c81172 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-resizing-a-persistent-storage-volume.adoc b/modules/monitoring-resizing-a-persistent-storage-volume.adoc index dd63a9f10179..88916e87e91a 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. ** You have configured at least one PVC for components that monitor user-defined projects. .Procedure @@ -182,6 +182,13 @@ 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 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-setting-log-levels-for-monitoring-components.adoc b/modules/monitoring-setting-log-levels-for-monitoring-components.adoc index a4f05419cd9f..01db748ec81b 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-setting-query-log-file-for-prometheus.adoc b/modules/monitoring-setting-query-log-file-for-prometheus.adoc index 6192086cdccf..0a3671fda3aa 100644 --- a/modules/monitoring-setting-query-log-file-for-prometheus.adoc +++ b/modules/monitoring-setting-query-log-file-for-prometheus.adoc @@ -25,7 +25,7 @@ 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. +** The `user-workload-monitoring-config` `ConfigMap` object exists. 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-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..d2be33da4242 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. +* The `user-workload-monitoring-config` `ConfigMap` object exists. endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] * You have access to the cluster as a user with the `dedicated-admin` role.