Merge pull request #62152 from bburt-rh/OBSDOCS-316-role-versus-clusterrole-for-monitoring-docs

OBSDOCS-316: distinguish between role vs cluster role in monitoring docs

Author: bburt-rh

modules/monitoring-accessing-alerting-rules-for-your-project.adoc

@@ -6,12 +6,12 @@
 [id="accessing-alerting-rules-for-your-project_{context}"]
 = Accessing alerting rules for user-defined projects
 
-To list alerting rules for a user-defined project, you must have been assigned the `monitoring-rules-view` role for the project.
+To list alerting rules for a user-defined project, you must have been assigned the `monitoring-rules-view` cluster role for the project.
 
 .Prerequisites
 
 * You have enabled monitoring for user-defined projects.
-* You are logged in as a user that has the `monitoring-rules-view` role for your project.
+* You are logged in as a user that has the `monitoring-rules-view` cluster role for your project.
 * You have installed the OpenShift CLI (`oc`).
 
 .Procedure

modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc

@@ -19,12 +19,12 @@ After you add a secret to the config map, the secret is mounted as a volume at `
 
 ifndef::openshift-dedicated,openshift-rosa[]
 * *If you are configuring core {product-title} monitoring components in the `openshift-monitoring` project*:
-** You have access to the cluster as a user with the `cluster-admin` role.
+** You have access to the cluster as a user with the `cluster-admin` cluster role.
 ** 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` role, or as a user with the `user-workload-monitoring-config-edit` role 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 secret to be configured in Alertmanager in the `openshift-user-workload-monitoring` project.
 endif::openshift-dedicated,openshift-rosa[]
 ifdef::openshift-dedicated,openshift-rosa[]

modules/monitoring-applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing.adoc

@@ -4,7 +4,7 @@
 
 :_content-type: PROCEDURE
 [id="applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing_{context}"]
-= Applying a custom configuration to Alertmanager for user-defined alert routing 
+= Applying a custom configuration to Alertmanager for user-defined alert routing
 
 If you have enabled a separate instance of Alertmanager dedicated to user-defined alert routing, you can overwrite the configuration for this instance of Alertmanager by editing the `alertmanager-user-workload` secret in the `openshift-user-workload-monitoring` namespace.
 
@@ -14,7 +14,7 @@ ifdef::openshift-rosa,openshift-dedicated[]
 * You have access to the cluster as a user with the `dedicated-admin` role.
 endif::[]
 ifndef::openshift-rosa,openshift-dedicated[]
-* You have access to the cluster as a user with the `cluster-admin` role.
+* You have access to the cluster as a user with the `cluster-admin` cluster role.
 endif::[]
 * You have installed the OpenShift CLI (`oc`).
 
@@ -36,7 +36,7 @@ route:
   group_by:
   - name: Default
   routes:
-  - matchers: 
+  - matchers:
     - "service = prometheus-example-monitor" <1>
     receiver: <receiver> <2>
 receivers:

modules/monitoring-applying-custom-alertmanager-configuration.adoc

@@ -10,7 +10,7 @@ You can overwrite the default Alertmanager configuration by editing the `alertma
 
 .Prerequisites
 
-* You have access to the cluster as a user with the `cluster-admin` role.
+* You have access to the cluster as a user with the `cluster-admin` cluster role.
 
 .Procedure
 

modules/monitoring-assigning-tolerations-to-monitoring-components.adoc

@@ -18,10 +18,10 @@ endif::openshift-dedicated,openshift-rosa[]
 
 ifndef::openshift-dedicated,openshift-rosa[]
 * *If you are configuring core {product-title} monitoring components*:
-** You have access to the cluster as a user with the `cluster-admin` role.
+** 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*:
-** You have access to the cluster as a user with the `cluster-admin` role, or as a user with the `user-workload-monitoring-config-edit` role 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.
 endif::openshift-dedicated,openshift-rosa[]
 ifdef::openshift-dedicated,openshift-rosa[]

modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc

@@ -12,10 +12,10 @@ Using the external labels feature of Prometheus, you can attach custom labels to
 
 ifndef::openshift-dedicated,openshift-rosa[]
 * *If you are configuring core {product-title} monitoring components*:
-** You have access to the cluster as a user with the `cluster-admin` role.
+** 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*:
-** You have access to the cluster as a user with the `cluster-admin` role, or as a user with the `user-workload-monitoring-config-edit` role 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.
 endif::openshift-dedicated,openshift-rosa[]
 ifdef::openshift-dedicated,openshift-rosa[]

modules/monitoring-choosing-a-metrics-collection-profile.adoc

@@ -13,7 +13,7 @@ To choose a metrics collection profile for core {product-title} monitoring compo
 * You have installed the OpenShift CLI (`oc`).
 * You have enabled Technology Preview features by using the `FeatureGate` custom resource (CR).
 * You have created the `cluster-monitoring-config` `ConfigMap` object.
-* You have access to the cluster as a user with the `cluster-admin` role.
+* You have access to the cluster as a user with the `cluster-admin` cluster role.
 
 [WARNING]
 ====
@@ -46,7 +46,7 @@ data:
 ----
 +
 <1> The name of the metrics collection profile.
-The available values are `full` or `minimal`. 
+The available values are `full` or `minimal`.
 If you do not specify a value or if the `collectionProfile` key name does not exist in the config map, the default setting of `full` is used.
 +
 The following example sets the metrics collection profile to `minimal` for the core platform instance of Prometheus:

modules/monitoring-configuring-a-local-persistent-volume-claim.adoc

@@ -17,10 +17,10 @@ For monitoring components to use a persistent volume (PV), you must configure a
 
 ifndef::openshift-dedicated,openshift-rosa[]
 * *If you are configuring core {product-title} monitoring components*:
-** You have access to the cluster as a user with the `cluster-admin` role.
+** 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*:
-** You have access to the cluster as a user with the `cluster-admin` role, or as a user with the `user-workload-monitoring-config-edit` role 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.
 endif::openshift-dedicated,openshift-rosa[]
 ifdef::openshift-dedicated,openshift-rosa[]

modules/monitoring-configuring-alert-receivers.adoc

@@ -11,7 +11,7 @@ You can configure alert receivers to ensure that you learn about important issue
 
 .Prerequisites
 
-* You have access to the cluster as a user with the `cluster-admin` role.
+* You have access to the cluster as a user with the `cluster-admin` cluster role.
 
 .Procedure
 

modules/monitoring-configuring-external-alertmanagers.adoc

@@ -20,10 +20,10 @@ If you add the same external Alertmanager configuration for multiple clusters an
 
 ifndef::openshift-dedicated,openshift-rosa[]
 * *If you are configuring core {product-title} monitoring components in the `openshift-monitoring` project*:
-** You have access to the cluster as a user with the `cluster-admin` role.
+** You have access to the cluster as a user with the `cluster-admin` cluster role.
 ** 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` role, or as a user with the `user-workload-monitoring-config-edit` role 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` config map.
 endif::openshift-dedicated,openshift-rosa[]
 ifdef::openshift-dedicated,openshift-rosa[]
@@ -63,7 +63,7 @@ data:
 ----
 +
 For `<alertmanager_specification>`, substitute authentication and other configuration details for additional Alertmanager instances.
-Currently supported authentication methods are bearer token (`bearerToken`) and client TLS (`tlsConfig`). 
+Currently supported authentication methods are bearer token (`bearerToken`) and client TLS (`tlsConfig`).
 The following sample config map configures an additional Alertmanager using a bearer token with client TLS authentication:
 +
 [source,yaml]
@@ -85,13 +85,13 @@ data:
           name: alertmanager-bearer-token
           key: token
         tlsConfig:
-          key: 
+          key:
             name: alertmanager-tls
             key: tls.key
-          cert: 
+          cert:
             name: alertmanager-tls
             key: tls.crt
-          ca: 
+          ca:
             name: alertmanager-tls
             key: tls.ca
         staticConfigs:
@@ -150,13 +150,13 @@ data:
           name: alertmanager-bearer-token
           key: token
         tlsConfig:
-          key: 
+          key:
             name: alertmanager-tls
             key: tls.key
-          cert: 
+          cert:
             name: alertmanager-tls
             key: tls.crt
-          ca: 
+          ca:
             name: alertmanager-tls
             key: tls.ca
         staticConfigs:
@@ -172,3 +172,7 @@ ifndef::openshift-dedicated,openshift-rosa[]
 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.
+
+