Skip to content

Commit 6860fdc

Browse files
authored
Merge pull request #72590 from eromanova97/OBSDOCS-365
OBSDOCS-365: menu is different with UI for 4.11 and above version docs
2 parents 8d056ab + db1958f commit 6860fdc

6 files changed

+62
-72
lines changed

modules/monitoring-accessing-the-alerting-ui.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
[id="monitoring-accessing-the-alerting-ui_{context}"]
88
= Accessing the Alerting UI in the Administrator and Developer perspectives
99

10-
The Alerting UI is accessible through the Administrator perspective and the Developer perspective in the {product-title} web console.
10+
The Alerting UI is accessible through the *Administrator* perspective and the *Developer* perspective of the {product-title} web console.
1111

12-
* In the *Administrator* perspective, select *Observe* -> *Alerting*. The three main pages in the Alerting UI in this perspective are the *Alerts*, *Silences*, and *Alerting Rules* pages.
12+
* In the *Administrator* perspective, go to *Observe* -> *Alerting*. The three main pages in the Alerting UI in this perspective are the *Alerts*, *Silences*, and *Alerting rules* pages.
1313
1414
//Next to the title of each of these pages is a link to the Alertmanager interface.
1515

16-
* In the *Developer* perspective, select *Observe* -> *<project_name>* -> *Alerts*. In this perspective, alerts, silences, and alerting rules are all managed from the *Alerts* page. The results shown in the *Alerts* page are specific to the selected project.
16+
* In the *Developer* perspective, go to *Observe* -> *<project_name>* -> *Alerts*. In this perspective, alerts, silences, and alerting rules are all managed from the *Alerts* page. The results shown in the *Alerts* page are specific to the selected project.
1717
1818
[NOTE]
1919
====
20-
In the *Developer* perspective, you can select from core {product-title} and user-defined projects that you have access to in the *Project:* list. However, alerts, silences, and alerting rules relating to core {product-title} projects are not displayed if you are not logged in as a cluster administrator.
20+
In the *Developer* perspective, you can select from core {product-title} and user-defined projects that you have access to in the *Project: <project_name>* list. However, alerts, silences, and alerting rules relating to core {product-title} projects are not displayed if you are not logged in as a cluster administrator.
2121
====

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ $ oc -n openshift-monitoring create secret generic alertmanager-main --from-file
111111

112112
To change the Alertmanager configuration from the {product-title} web console:
113113

114-
. Navigate to the *Administration* -> *Cluster Settings* -> *Configuration* -> *Alertmanager* -> *YAML* page of the web console.
114+
. Go to the *Administration* -> *Cluster Settings* -> *Configuration* -> *Alertmanager* -> *YAML* page of the web console.
115115

116116
. Modify the YAML configuration file.
117117

118-
. Select *Save*.
118+
. Click *Save*.

modules/monitoring-configuring-alert-receivers.adoc

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ You can configure alert receivers to ensure that you learn about important issue
1515
1616
.Procedure
1717

18-
. In the *Administrator* perspective, navigate to *Administration* -> *Cluster Settings* -> *Configuration* -> *Alertmanager*.
18+
. In the *Administrator* perspective, go to *Administration* -> *Cluster Settings* -> *Configuration* -> *Alertmanager*.
1919
+
2020
[NOTE]
2121
====
22-
Alternatively, you can navigate to the same page through the notification drawer. Select the bell icon at the top right of the {product-title} web console and choose *Configure* in the *AlertmanagerReceiverNotConfigured* alert.
22+
Alternatively, you can go to the same page through the notification drawer. Select the bell icon at the top right of the {product-title} web console and choose *Configure* in the *AlertmanagerReceiverNotConfigured* alert.
2323
====
2424

25-
. Select *Create Receiver* in the *Receivers* section of the page.
25+
. Click *Create Receiver* in the *Receivers* section of the page.
2626

27-
. In the *Create Receiver* form, add a *Receiver Name* and choose a *Receiver Type* from the list.
27+
. In the *Create Receiver* form, add a *Receiver name* and choose a *Receiver type* from the list.
2828

2929
. Edit the receiver configuration:
3030
+
@@ -34,23 +34,23 @@ Alternatively, you can navigate to the same page through the notification drawer
3434
+
3535
.. Add the URL of your PagerDuty installation.
3636
+
37-
.. Select *Show advanced configuration* if you want to edit the client and incident details or the severity specification.
37+
.. Click *Show advanced configuration* if you want to edit the client and incident details or the severity specification.
3838
+
3939
* For webhook receivers:
4040
+
4141
.. Add the endpoint to send HTTP POST requests to.
4242
+
43-
.. Select *Show advanced configuration* if you want to edit the default option to send resolved alerts to the receiver.
43+
.. Click *Show advanced configuration* if you want to edit the default option to send resolved alerts to the receiver.
4444
+
4545
* For email receivers:
4646
+
4747
.. Add the email address to send notifications to.
4848
+
4949
.. Add SMTP configuration details, including the address to send notifications from, the smarthost and port number used for sending emails, the hostname of the SMTP server, and authentication details.
5050
+
51-
.. Choose whether TLS is required.
51+
.. Select whether TLS is required.
5252
+
53-
.. Select *Show advanced configuration* if you want to edit the default option not to send resolved alerts to the receiver or edit the body of email notifications configuration.
53+
.. Click *Show advanced configuration* if you want to edit the default option not to send resolved alerts to the receiver or edit the body of email notifications configuration.
5454
+
5555
* For Slack receivers:
5656
+
@@ -60,11 +60,9 @@ Alternatively, you can navigate to the same page through the notification drawer
6060
+
6161
.. Select *Show advanced configuration* if you want to edit the default option not to send resolved alerts to the receiver or edit the icon and username configuration. You can also choose whether to find and link channel names and usernames.
6262

63-
. By default, firing alerts with labels that match all of the selectors will be sent to the receiver. If you want label values for firing alerts to be matched exactly before they are sent to the receiver:
64-
.. Add routing label names and values in the *Routing Labels* section of the form.
65-
+
66-
.. Select *Regular Expression* if want to use a regular expression.
67-
+
68-
.. Select *Add Label* to add further routing labels.
63+
. By default, firing alerts with labels that match all of the selectors are sent to the receiver. If you want label values for firing alerts to be matched exactly before they are sent to the receiver, perform the following steps:
64+
.. Add routing label names and values in the *Routing labels* section of the form.
65+
66+
.. Click *Add label* to add further routing labels.
6967

70-
. Select *Create* to create the receiver.
68+
. Click *Create* to create the receiver.

modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc

Lines changed: 33 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,87 +10,79 @@ The Alerting UI provides detailed information about alerts and their governing a
1010

1111
.Prerequisites
1212

13-
* You have access to the cluster as a developer or as a user with view permissions for the project that you are viewing metrics for.
13+
* You have access to the cluster as a developer or as a user with view permissions for the project that you are viewing alerts for.
1414
1515
.Procedure
1616

1717
*To obtain information about alerts in the Administrator perspective*:
1818

19-
. Open the {product-title} web console and navigate to the *Observe* -> *Alerting* -> *Alerts* page.
19+
. Open the {product-title} web console and go to the *Observe* -> *Alerting* -> *Alerts* page.
2020

21-
. Optional: Search for alerts by name using the *Name* field in the search list.
21+
. Optional: Search for alerts by name by using the *Name* field in the search list.
2222

2323
. Optional: Filter alerts by state, severity, and source by selecting filters in the *Filter* list.
2424

2525
. Optional: Sort the alerts by clicking one or more of the *Name*, *Severity*, *State*, and *Source* column headers.
2626

27-
. Select the name of an alert to navigate to its *Alert Details* page. The page includes a graph that illustrates alert time series data. It also provides information about the alert, including:
28-
+
29-
--
30-
** A description of the alert
31-
** Messages associated with the alerts
32-
** Labels attached to the alert
33-
** A link to its governing alerting rule
34-
** Silences for the alert, if any exist
35-
--
27+
. Click the name of an alert to view its *Alert details* page. The page includes a graph that illustrates alert time series data. It also provides the following information about the alert:
28+
29+
* A description of the alert
30+
* Messages associated with the alert
31+
* Labels attached to the alert
32+
* A link to its governing alerting rule
33+
* Silences for the alert, if any exist
3634
3735
*To obtain information about silences in the Administrator perspective*:
3836

39-
. Navigate to the *Observe* -> *Alerting* -> *Silences* page.
37+
. Go to the *Observe* -> *Alerting* -> *Silences* page.
4038

4139
. Optional: Filter the silences by name using the *Search by name* field.
4240

4341
. Optional: Filter silences by state by selecting filters in the *Filter* list. By default, *Active* and *Pending* filters are applied.
4442

45-
. Optional: Sort the silences by clicking one or more of the *Name*, *Firing Alerts*, and *State* column headers.
43+
. Optional: Sort the silences by clicking one or more of the *Name*, *Firing alerts*, *State*, and *Creator* column headers.
44+
45+
. Select the name of a silence to view its *Silence details* page. The page includes the following details:
4646

47-
. Select the name of a silence to navigate to its *Silence Details* page. The page includes the following details:
48-
+
49-
--
5047
* Alert specification
5148
* Start time
5249
* End time
5350
* Silence state
5451
* Number and list of firing alerts
55-
--
5652
5753
*To obtain information about alerting rules in the Administrator perspective*:
5854

59-
. Navigate to the *Observe* -> *Alerting* -> *Alerting Rules* page.
55+
. Go to the *Observe* -> *Alerting* -> *Alerting rules* page.
6056

6157
. Optional: Filter alerting rules by state, severity, and source by selecting filters in the *Filter* list.
6258

63-
. Optional: Sort the alerting rules by clicking one or more of the *Name*, *Severity*, *Alert State*, and *Source* column headers.
59+
. Optional: Sort the alerting rules by clicking one or more of the *Name*, *Severity*, *Alert state*, and *Source* column headers.
60+
61+
. Select the name of an alerting rule to view its *Alerting rule details* page. The page provides the following details about the alerting rule:
6462

65-
. Select the name of an alerting rule to navigate to its *Alerting Rule Details* page. The page provides the following details about the alerting rule:
66-
+
67-
--
68-
** Alerting rule name, severity, and description
69-
** The expression that defines the condition for firing the alert
70-
** The time for which the condition should be true for an alert to fire
71-
** A graph for each alert governed by the alerting rule, showing the value with which the alert is firing
72-
** A table of all alerts governed by the alerting rule
73-
--
63+
* Alerting rule name, severity, and description.
64+
* The expression that defines the condition for firing the alert.
65+
* The time for which the condition should be true for an alert to fire.
66+
* A graph for each alert governed by the alerting rule, showing the value with which the alert is firing.
67+
* A table of all alerts governed by the alerting rule.
7468
7569
*To obtain information about alerts, silences, and alerting rules in the Developer perspective*:
7670

77-
. Navigate to the *Observe* -> *<project_name>* -> *Alerts* page.
71+
. Go to the *Observe* -> *<project_name>* -> *Alerts* page.
7872

7973
. View details for an alert, silence, or an alerting rule:
8074

81-
* *Alert Details* can be viewed by selecting *>* to the left of an alert name and then selecting the alert in the list.
75+
* *Alert details* can be viewed by clicking a greater than symbol (*>*) next to an alert name and then selecting the alert from the list.
8276
83-
* *Silence Details* can be viewed by selecting a silence in the *Silenced By* section of the *Alert Details* page. The *Silence Details* page includes the following information:
84-
+
85-
--
86-
* Alert specification
87-
* Start time
88-
* End time
89-
* Silence state
90-
* Number and list of firing alerts
91-
--
77+
* *Silence details* can be viewed by clicking a silence in the *Silenced by* section of the *Alert details* page. The *Silence details* page includes the following information:
78+
79+
** Alert specification
80+
** Start time
81+
** End time
82+
** Silence state
83+
** Number and list of firing alerts
9284

93-
* *Alerting Rule Details* can be viewed by selecting *View Alerting Rule* in the {kebab} menu on the right of an alert in the *Alerts* page.
85+
* *Alerting rule details* can be viewed by clicking the {kebab} menu next to an alert in the *Alerts* page and then clicking *View Alerting Rule*.
9486
9587
[NOTE]
9688
====

modules/monitoring-searching-alerts-silences-and-alerting-rules.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ In the *Administrator* perspective, the *Alerts* page in the Alerting UI provide
1515

1616
You can filter by alert state, severity, and source. By default, only *Platform* alerts that are *Firing* are displayed. The following describes each alert filtering option:
1717

18-
* *Alert State* filters:
19-
** *Firing*. The alert is firing because the alert condition is true and the optional `for` duration has passed. The alert will continue to fire as long as the condition remains true.
18+
* *State* filters:
19+
** *Firing*. The alert is firing because the alert condition is true and the optional `for` duration has passed. The alert continues to fire while the condition remains true.
2020
** *Pending*. The alert is active but is waiting for the duration that is specified in the alerting rule before it fires.
21-
** *Silenced*. The alert is now silenced for a defined time period. Silences temporarily mute alerts based on a set of label selectors that you define. Notifications will not be sent for alerts that match all the listed values or regular expressions.
21+
** *Silenced*. The alert is now silenced for a defined time period. Silences temporarily mute alerts based on a set of label selectors that you define. Notifications are not sent for alerts that match all the listed values or regular expressions.
2222

2323
* *Severity* filters:
2424
** *Critical*. The condition that triggered the alert could have a critical impact. The alert requires immediate attention when fired and is typically paged to an individual or to a critical response team.
@@ -38,22 +38,22 @@ In the *Administrator* perspective, the *Silences* page in the Alerting UI provi
3838

3939
You can filter by silence state. By default, only *Active* and *Pending* silences are displayed. The following describes each silence state filter option:
4040

41-
* *Silence State* filters:
41+
* *State* filters:
4242
** *Active*. The silence is active and the alert will be muted until the silence is expired.
4343
** *Pending*. The silence has been scheduled and it is not yet active.
4444
** *Expired*. The silence has expired and notifications will be sent if the conditions for an alert are true.
4545

4646
[discrete]
4747
== Understanding alerting rule filters
4848

49-
In the *Administrator* perspective, the *Alerting Rules* page in the Alerting UI provides details about alerting rules relating to default {product-title} and user-defined projects. The page includes a summary of the state, severity, and source for each alerting rule.
49+
In the *Administrator* perspective, the *Alerting rules* page in the Alerting UI provides details about alerting rules relating to default {product-title} and user-defined projects. The page includes a summary of the state, severity, and source for each alerting rule.
5050

5151
You can filter alerting rules by alert state, severity, and source. By default, only *Platform* alerting rules are displayed. The following describes each alerting rule filtering option:
5252

53-
* *Alert State* filters:
54-
** *Firing*. The alert is firing because the alert condition is true and the optional `for` duration has passed. The alert will continue to fire as long as the condition remains true.
53+
* *Alert state* filters:
54+
** *Firing*. The alert is firing because the alert condition is true and the optional `for` duration has passed. The alert continues to fire while the condition remains true.
5555
** *Pending*. The alert is active but is waiting for the duration that is specified in the alerting rule before it fires.
56-
** *Silenced*. The alert is now silenced for a defined time period. Silences temporarily mute alerts based on a set of label selectors that you define. Notifications will not be sent for alerts that match all the listed values or regular expressions.
56+
** *Silenced*. The alert is now silenced for a defined time period. Silences temporarily mute alerts based on a set of label selectors that you define. Notifications are not sent for alerts that match all the listed values or regular expressions.
5757
** *Not Firing*. The alert is not firing.
5858

5959
* *Severity* filters:
@@ -70,6 +70,6 @@ You can filter alerting rules by alert state, severity, and source. By default,
7070
[discrete]
7171
== Searching and filtering alerts, silences, and alerting rules in the Developer perspective
7272

73-
In the *Developer* perspective, the Alerts page in the Alerting UI provides a combined view of alerts and silences relating to the selected project. A link to the governing alerting rule is provided for each displayed alert.
73+
In the *Developer* perspective, the *Alerts* page in the Alerting UI provides a combined view of alerts and silences relating to the selected project. A link to the governing alerting rule is provided for each displayed alert.
7474

7575
In this view, you can filter by alert state and severity. By default, all alerts in the selected project are displayed if you have permission to access the project. These filters are the same as those described for the *Administrator* perspective.

modules/monitoring-silencing-alerts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To silence a specific alert in the *Developer* perspective:
4242

4343
. Go to *Observe* -> *<project_name>* -> *Alerts* in the {product-title} web console.
4444

45-
. If necessary, expand the details for the alert by selecting *>* next to the alert name.
45+
. If necessary, expand the details for the alert by selecting a greater than symbol (*>*) next to the alert name.
4646

4747
. Click the alert message in the expanded view to open the *Alert details* page for the alert.
4848

0 commit comments

Comments
 (0)