Merge pull request #63944 from bburt-rh/OBSDOCS-352-document-new-silences-panel-in-monitoring-dev-console

OBSDOCS-352: document-new-silences-panel-in-monitoring-dev-console

Author: bburt-rh

modules/monitoring-editing-silences.adoc

@@ -6,30 +6,40 @@
 [id="editing-silences_{context}"]
 = Editing silences
 
-You can edit a silence, which will expire the existing silence and create a new one with the changed configuration.
+You can edit a silence, which expires the existing silence and creates a new one with the changed configuration.
+
+.Prerequisites
+
+ifndef::openshift-dedicated,openshift-rosa[]
+* If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` role.
+endif::openshift-dedicated,openshift-rosa[]
+ifdef::openshift-dedicated,openshift-rosa[]
+* If you are a cluster administrator, you have access to the cluster as a user with the `dedicated-admin` role.
+endif::openshift-dedicated,openshift-rosa[]
+* If you are a non-administrator user, you have access to the cluster as a user with the following user roles:
+** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager.
+** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts in the *Administrator* perspective in the web console.
+** The `monitoring-rules-edit` cluster role, which permits you to create and silence alerts in the *Developer* perspective in the web console.
 
 .Procedure
 
 To edit a silence in the *Administrator* perspective:
 
-. Navigate to the *Observe* -> *Alerting* -> *Silences* page.
+. Go to *Observe* -> *Alerting* -> *Silences*.
 
-. For the silence you want to modify, select the {kebab} in the last column and choose *Edit silence*.
+. For the silence you want to modify, click {kebab} and select *Edit silence*.
 +
-Alternatively, you can select *Actions* -> *Edit Silence* in the *Silence Details* page for a silence.
+Alternatively, you can click *Actions* and select *Edit silence* on the *Silence details* page for a silence.
 
-. In the *Edit Silence* page, enter your changes and select *Silence*. This will expire the existing silence and create one with the chosen configuration.
+. On the *Edit silence* page, make changes and click *Silence*. Doing so expires the existing silence and creates one with the updated configuration.
 
 To edit a silence in the *Developer* perspective:
 
-. Navigate to the *Observe* -> *<project_name>* -> *Alerts* page.
-
-. Expand the details for an alert by selecting *>* to the left of the alert name. Select the name of the alert in the expanded view to open the *Alert Details* page for the alert.
+. Go to *Observe* -> *<project_name>* -> *Silences*.
 
-. Select the name of a silence in the *Silenced By* section in that page to navigate to the *Silence Details* page for the silence.
-
-. Select the name of a silence to navigate to its *Silence Details* page.
+. For the silence you want to modify, click {kebab} and select *Edit silence*.
++
+Alternatively, you can click *Actions* and select *Edit silence* on the *Silence details* page for a silence.
 
-. Select *Actions* -> *Edit Silence* in the *Silence Details* page for a silence.
+. On the *Edit silence* page, make changes and click *Silence*. Doing so expires the existing silence and creates one with the updated configuration.
 
-. In the *Edit Silence* page, enter your changes and select *Silence*. This will expire the existing silence and create one with the chosen configuration.

modules/monitoring-expiring-silences.adoc

@@ -6,32 +6,45 @@
 [id="expiring-silences_{context}"]
 = Expiring silences
 
-You can expire a silence. Expiring a silence deactivates it forever.
+You can expire a single silence or multiple silences. Expiring a silence deactivates it permanently.
 
 [NOTE]
 ====
 You cannot delete expired, silenced alerts.
 Expired silences older than 120 hours are garbage collected.
 ====
 
+.Prerequisites
+
+ifndef::openshift-dedicated,openshift-rosa[]
+* If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` role.
+endif::openshift-dedicated,openshift-rosa[]
+ifdef::openshift-dedicated,openshift-rosa[]
+* If you are a cluster administrator, you have access to the cluster as a user with the `dedicated-admin` role.
+endif::openshift-dedicated,openshift-rosa[]
+* If you are a non-administrator user, you have access to the cluster as a user with the following user roles:
+** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager.
+** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts in the *Administrator* perspective in the web console.
+** The `monitoring-rules-edit` cluster role, which permits you to create and silence alerts in the *Developer* perspective in the web console.
+
 .Procedure
 
-To expire a silence in the *Administrator* perspective:
+To expire a silence or silences in the *Administrator* perspective:
+
+. Go to *Observe* -> *Alerting* -> *Silences*.
 
-. Navigate to the *Observe* -> *Alerting* -> *Silences* page.
+. For the silence or silences you want to expire, select the checkbox in the corresponding row.
 
-. For the silence you want to modify, select the {kebab} in the last column and choose *Expire silence*.
+. Click *Expire 1 silence* to expire a single selected silence or *Expire _<n>_ silences* to expire multiple selected silences, where _<n>_ is the number of silences you selected.
 +
-Alternatively, you can select *Actions* -> *Expire Silence* in the *Silence Details* page for a silence.
+Alternatively, to expire a single silence you can click *Actions* and select *Expire silence* on the *Silence details* page for a silence.
 
 To expire a silence in the *Developer* perspective:
 
-. Navigate to the *Observe* -> *<project_name>* -> *Alerts* page.
+. Go to *Observe* -> *<project_name>* -> *Silences*.
 
-. Expand the details for an alert by selecting *>* to the left of the alert name. Select the name of the alert in the expanded view to open the *Alert Details* page for the alert.
+. For the silence or silences you want to expire, select the checkbox in the corresponding row.
 
-. Select the name of a silence in the *Silenced By* section in that page to navigate to the *Silence Details* page for the silence.
-
-. Select the name of a silence to navigate to its *Silence Details* page.
-
-. Select *Actions* -> *Expire Silence* in the *Silence Details* page for a silence.
+. Click *Expire 1 silence* to expire a single selected silence or *Expire _<n>_ silences* to expire multiple selected silences, where _<n>_ is the number of silences you selected.
++
+Alternatively, to expire a single silence you can click *Actions* and select *Expire silence* on the *Silence details* page for a silence.

modules/monitoring-managing-silences.adoc

@@ -6,8 +6,11 @@
 [id="managing-silences_{context}"]
 = Managing silences
 
-You can create a silence to stop receiving notifications about an alert when it is firing. It might be useful to silence an alert after being first notified, while you resolve the underlying issue.
+You can create a silence for an alert in the {product-title} web console in both the *Administrator* and *Developer* perspectives.
+After you create a silence, you will not receive notifications about an alert when the alert fires.
+
+Creating silences is useful in scenarios where you have received an initial alert notification, and you do not want to receive further notifications during the time in which you resolve the underlying issue causing the alert to fire.
 
 When creating a silence, you must specify whether it becomes active immediately or at a later time. You must also set a duration period after which the silence expires.
 
-You can view, edit, and expire existing silences.
+After you create silences, you can view, edit, and expire them.

modules/monitoring-silencing-alerts.adoc

@@ -6,7 +6,7 @@
 [id="silencing-alerts_{context}"]
 = Silencing alerts
 
-You can either silence a specific alert or silence alerts that match a specification that you define.
+You can silence a specific alert or silence alerts that match a specification that you define.
 
 .Prerequisites
 
@@ -23,40 +23,66 @@ endif::openshift-dedicated,openshift-rosa[]
 
 .Procedure
 
-To silence a specific alert:
+To silence a specific alert in the *Administrator* perspective:
 
-* In the *Administrator* perspective:
+. Go to *Observe* -> *Alerting* -> *Alerts* in the {product-title} web console.
 
-. Navigate to the *Observe* -> *Alerting* -> *Alerts* page of the {product-title} web console.
+. For the alert that you want to silence, click {kebab} and select *Silence alert* to open the *Silence alert* page with a default configuration for the chosen alert.
 
-. For the alert that you want to silence, select the {kebab} in the right-hand column and select *Silence Alert*. The *Silence Alert* form will appear with a pre-populated specification for the chosen alert.
+. Optional: Change the default configuration details for the silence.
++
+[NOTE]
+====
+You must add a comment before saving a silence.
+====
 
-. Optional: Modify the silence.
+. To save the silence, click *Silence*.
 
-. You must add a comment before creating the silence.
+To silence a specific alert in the *Developer* perspective:
 
-. To create the silence, select *Silence*.
+. Go to *Observe* -> *<project_name>* -> *Alerts* in the {product-title} web console.
 
-* In the *Developer* perspective:
+. If necessary, expand the details for the alert by selecting *>* next to the alert name.
 
-. Navigate to the *Observe* -> *<project_name>* -> *Alerts* page in the {product-title} web console.
+. Click the alert message in the expanded view to open the *Alert details* page for the alert.
 
-. Expand the details for an alert by selecting *>* to the left of the alert name. Select the name of the alert in the expanded view to open the *Alert Details* page for the alert.
+. Click *Silence alert* to open the *Silence alert* page with a default configuration for the alert.
 
-. Select *Silence Alert*. The *Silence Alert* form will appear with a prepopulated specification for the chosen alert.
+. Optional: Change the default configuration details for the silence.
++
+[NOTE]
+====
+You must add a comment before saving a silence.
+====
 
-. Optional: Modify the silence.
+. To save the silence, click *Silence*.
 
-. You must add a comment before creating the silence.
+To silence a set of alerts by creating a silence configuration in the *Administrator* perspective:
 
-. To create the silence, select *Silence*.
+. Go to *Observe* -> *Alerting* -> *Silences* in the {product-title} web console.
 
-To silence a set of alerts by creating an alert specification in the *Administrator* perspective:
+. Click *Create silence*.
 
-. Navigate to the *Observe* -> *Alerting* -> *Silences* page in the {product-title} web console.
+. On the *Create silence* page, set the schedule, duration, and label details for an alert.
++
+[NOTE]
+====
+You must add a comment before saving a silence.
+====
 
-. Select *Create Silence*.
+. To create silences for alerts that match the labels that you entered, click *Silence*.
 
-. Set the schedule, duration, and label details for an alert in the *Create Silence* form. You must also add a comment for the silence.
+To silence a set of alerts by creating a silence configuration in the *Developer* perspective:
 
-. To create silences for alerts that match the label sectors that you entered in the previous step, select *Silence*.
+. Go to *Observe* -> *<project_name>* -> *Silences* in the {product-title} web console.
+
+. Click *Create silence*.
+
+. On the *Create silence* page, set the duration and label details for an alert.
++
+[NOTE]
+====
+You must add a comment before saving a silence.
+====
+
+. To create silences for alerts that match the labels that you entered, click *Silence*.