Skip to content

Commit d3c8f94

Browse files
committed
OSDOCS-3797: Apply changes from 4.13
1 parent 7c5f739 commit d3c8f94

File tree

118 files changed

+1441
-2443
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+1441
-2443
lines changed

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2598,10 +2598,6 @@ Topics:
25982598
File: enabling-alert-routing-for-user-defined-projects
25992599
- Name: Managing metrics
26002600
File: managing-metrics
2601-
- Name: Querying metrics
2602-
File: querying-metrics
2603-
- Name: Managing metrics targets
2604-
File: managing-metrics-targets
26052601
- Name: Managing alerts
26062602
File: managing-alerts
26072603
- Name: Reviewing monitoring dashboards

_topic_maps/_topic_map_osd.yml

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -352,26 +352,32 @@ Topics:
352352
- Name: Exported fields
353353
File: cluster-logging-exported-fields
354354
---
355-
Name: Monitoring user-defined projects
355+
Name: Monitoring
356356
Dir: monitoring
357357
Distros: openshift-dedicated
358358
Topics:
359-
- Name: Understanding the monitoring stack
360-
File: osd-understanding-the-monitoring-stack
359+
- Name: Monitoring overview
360+
File: monitoring-overview
361361
- Name: Accessing monitoring for user-defined projects
362-
File: osd-accessing-monitoring-for-user-defined-projects
362+
File: sd-accessing-monitoring-for-user-defined-projects
363363
- Name: Configuring the monitoring stack
364-
File: osd-configuring-the-monitoring-stack
364+
File: configuring-the-monitoring-stack
365+
- Name: Disabling monitoring for user-defined projects
366+
File: sd-disabling-monitoring-for-user-defined-projects
365367
- Name: Enabling alert routing for user-defined projects
366-
File: osd-enabling-alert-routing-for-user-defined-projects
368+
File: enabling-alert-routing-for-user-defined-projects
367369
- Name: Managing metrics
368-
File: osd-managing-metrics
370+
File: managing-metrics
369371
- Name: Managing alerts
370372
File: managing-alerts
371373
- Name: Reviewing monitoring dashboards
372-
File: osd-reviewing-monitoring-dashboards
374+
File: reviewing-monitoring-dashboards
375+
- Name: Accessing third-party monitoring APIs
376+
File: accessing-third-party-monitoring-apis
373377
- Name: Troubleshooting monitoring issues
374-
File: osd-troubleshooting-monitoring-issues
378+
File: troubleshooting-monitoring-issues
379+
- Name: Config map reference for the Cluster Monitoring Operator
380+
File: config-map-reference-for-the-cluster-monitoring-operator
375381
---
376382
Name: Serverless
377383
Dir: serverless

_topic_maps/_topic_map_rosa.yml

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -468,26 +468,32 @@ Topics:
468468
- Name: Exported fields
469469
File: cluster-logging-exported-fields
470470
---
471-
Name: Monitoring user-defined projects
471+
Name: Monitoring
472472
Dir: monitoring
473473
Distros: openshift-rosa
474474
Topics:
475-
- Name: Understanding the monitoring stack
476-
File: rosa-understanding-the-monitoring-stack
475+
- Name: Monitoring overview
476+
File: monitoring-overview
477477
- Name: Accessing monitoring for user-defined projects
478-
File: rosa-accessing-monitoring-for-user-defined-projects
478+
File: sd-accessing-monitoring-for-user-defined-projects
479479
- Name: Configuring the monitoring stack
480-
File: rosa-configuring-the-monitoring-stack
480+
File: configuring-the-monitoring-stack
481+
- Name: Disabling monitoring for user-defined projects
482+
File: sd-disabling-monitoring-for-user-defined-projects
481483
- Name: Enabling alert routing for user-defined projects
482-
File: rosa-enabling-alert-routing-for-user-defined-projects
484+
File: enabling-alert-routing-for-user-defined-projects
483485
- Name: Managing metrics
484-
File: rosa-managing-metrics
486+
File: managing-metrics
485487
- Name: Managing alerts
486488
File: managing-alerts
487489
- Name: Reviewing monitoring dashboards
488-
File: rosa-reviewing-monitoring-dashboards
490+
File: reviewing-monitoring-dashboards
491+
- Name: Accessing third-party monitoring APIs
492+
File: accessing-third-party-monitoring-apis
489493
- Name: Troubleshooting monitoring issues
490-
File: rosa-troubleshooting-monitoring-issues
494+
File: troubleshooting-monitoring-issues
495+
- Name: Config map reference for the Cluster Monitoring Operator
496+
File: config-map-reference-for-the-cluster-monitoring-operator
491497
---
492498
Name: Service Mesh
493499
Dir: service_mesh
Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
// Module included in the following assemblies:
22
//
3-
// * monitoring/querying-metrics.adoc
3+
// * monitoring/managing-metrics.adoc
44
// * virt/support/virt-prometheus-queries.adoc
55

66
:_content-type: CONCEPT
77
[id="about-querying-metrics_{context}"]
8-
= About querying metrics
8+
= Querying metrics
99

1010
The {product-title} monitoring dashboard enables you to run Prometheus Query Language (PromQL) queries to examine metrics visualized on a plot. This functionality provides information about the state of a cluster and any user-defined workloads that you are monitoring.
1111

12-
As a *cluster administrator*, you can query metrics for all core {product-title} and user-defined projects.
12+
ifndef::openshift-dedicated,openshift-rosa[]
13+
As a cluster administrator, you can query metrics for all core {product-title} and user-defined projects.
14+
endif::openshift-dedicated,openshift-rosa[]
15+
ifdef::openshift-dedicated,openshift-rosa[]
16+
As a `dedicated-admin`, you can query one or more namespaces at a time for metrics about user-defined projects.
17+
endif::openshift-dedicated,openshift-rosa[]
1318

14-
As a *developer*, you must specify a project name when querying metrics. You must have the required privileges to view metrics for the selected project.
19+
As a developer, you must specify a project name when querying metrics. You must have the required privileges to view metrics for the selected project.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To list alerting rules for a user-defined project, you must have been assigned t
1616
1717
.Procedure
1818

19-
. You can list alerting rules in `<project>`:
19+
. To list alerting rules in `<project>`:
2020
+
2121
[source,terminal]
2222
----

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ The Alerting UI is accessible through the Administrator perspective and the Deve
1616
1717
[NOTE]
1818
====
19-
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 do not have `cluster-admin` privileges.
19+
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.
2020
====

modules/monitoring-accessing-the-metrics-targets-page.adoc

Lines changed: 0 additions & 19 deletions
This file was deleted.

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

Lines changed: 52 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,18 @@
66
[id="monitoring-adding-a-secret-to-the-alertmanager-configuration_{context}"]
77
= Adding a secret to the Alertmanager configuration
88

9+
ifndef::openshift-dedicated,openshift-rosa[]
910
You can add secrets to the Alertmanager configuration for core platform monitoring components by editing the `cluster-monitoring-config` config map in the `openshift-monitoring` project.
11+
endif::openshift-dedicated,openshift-rosa[]
12+
ifdef::openshift-dedicated,openshift-rosa[]
1013
You can add secrets to the Alertmanager configuration for user-defined projects by editing the `user-workload-monitoring-config` config map in the `openshift-user-workload-monitoring` project.
14+
endif::openshift-dedicated,openshift-rosa[]
1115

1216
After you add a secret to the config map, the secret is mounted as a volume at `/etc/alertmanager/secrets/<secret_name>` within the `alertmanager` container for the Alertmanager pods.
1317

1418
.Prerequisites
1519

16-
* You have installed the OpenShift CLI (`oc`).
20+
ifndef::openshift-dedicated,openshift-rosa[]
1721
* *If you are configuring core {product-title} monitoring components in the `openshift-monitoring` project*:
1822
** You have access to the cluster as a user with the `cluster-admin` role.
1923
** You have created the `cluster-monitoring-config` config map.
@@ -22,19 +26,27 @@ After you add a secret to the config map, the secret is mounted as a volume at `
2226
** A cluster administrator has enabled monitoring for user-defined projects.
2327
** 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.
2428
** You have created the secret to be configured in Alertmanager in the `openshift-user-workload-monitoring` project.
29+
endif::openshift-dedicated,openshift-rosa[]
30+
ifdef::openshift-dedicated,openshift-rosa[]
31+
* You have access to the cluster as a user with the `dedicated-admin` role.
32+
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
33+
* You have created the secret to be configured in Alertmanager in the `openshift-user-workload-monitoring` project.
34+
endif::openshift-dedicated,openshift-rosa[]
35+
* You have installed the OpenShift CLI (`oc`).
2536

2637
.Procedure
2738

28-
. To add a secret configuration to Alertmanager for core platform monitoring, edit the `cluster-monitoring-config` config map in the `openshift-monitoring` project:
39+
. Edit the `ConfigMap` object.
40+
ifndef::openshift-dedicated,openshift-rosa[]
41+
** *To add a secret configuration to Alertmanager for core platform monitoring*:
42+
.. Edit the `cluster-monitoring-config` config map in the `openshift-monitoring` project:
2943
+
3044
[source,terminal]
3145
----
3246
$ oc -n openshift-monitoring edit configmap cluster-monitoring-config
3347
----
3448

35-
. Add a `secrets:` section under `data/config.yaml/alertmanagerMain`.
36-
37-
. Add the configuration details for the secret in this section:
49+
.. Add a `secrets:` section under `data/config.yaml/alertmanagerMain` with the following configuration:
3850
+
3951
[source,yaml]
4052
----
@@ -50,10 +62,8 @@ data:
5062
- <secret_name_1> <2>
5163
- <secret_name_2>
5264
----
53-
<1> This section contains the secrets to be mounted into Alertmanager.
54-
The secrets must be located within the same namespace as the Alertmanager object.
55-
<2> The name of the `Secret` object that contains authentication credentials for the receiver.
56-
If you add multiple secrets, place each one on a new line.
65+
<1> This section contains the secrets to be mounted into Alertmanager. The secrets must be located within the same namespace as the Alertmanager object.
66+
<2> The name of the `Secret` object that contains authentication credentials for the receiver. If you add multiple secrets, place each one on a new line.
5767
+
5868
The following sample config map settings configure Alertmanager to use two `Secret` objects named `test-secret-basic-auth` and `test-secret-api-token`:
5969
+
@@ -72,7 +82,36 @@ data:
7282
- test-secret-api-token
7383
----
7484

75-
. Optional: To add the secrets for use by Alertmanager in user-defined projects, add the secret names under `data/config.yaml/alertmanager/secrets` in the `user-workload-monitoring-config` config map in the `openshift-user-workload-monitoring` project:
85+
** *To add a secret configuration to Alertmanager for user-defined project monitoring*:
86+
endif::openshift-dedicated,openshift-rosa[]
87+
88+
.. Edit the `user-workload-monitoring-config` config map in the `openshift-user-workload-monitoring` project:
89+
+
90+
[source,terminal]
91+
----
92+
$ oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-config
93+
----
94+
95+
.. Add a `secrets:` section under `data/config.yaml/alertmanager/secrets` with the following configuration:
96+
+
97+
[source,yaml]
98+
----
99+
apiVersion: v1
100+
kind: ConfigMap
101+
metadata:
102+
name: user-workload-monitoring-config
103+
namespace: openshift-user-workload-monitoring
104+
data:
105+
config.yaml: |
106+
alertmanager:
107+
secrets: <1>
108+
- <secret_name_1> <2>
109+
- <secret_name_2>
110+
----
111+
<1> This section contains the secrets to be mounted into Alertmanager. The secrets must be located within the same namespace as the Alertmanager object.
112+
<2> The name of the `Secret` object that contains authentication credentials for the receiver. If you add multiple secrets, place each one on a new line.
113+
+
114+
The following sample config map settings configure Alertmanager to use two `Secret` objects named `test-secret` and `test-secret-api-token`:
76115
+
77116
[source,yaml]
78117
----
@@ -89,12 +128,13 @@ data:
89128
- test-secret
90129
- test-api-receiver-token
91130
----
131+
ifndef::openshift-dedicated,openshift-rosa[]
92132
+
93133
[NOTE]
94134
====
95135
Configurations applied to the `user-workload-monitoring-config` `ConfigMap` object are not activated unless a cluster administrator has enabled monitoring for user-defined projects.
96136
====
137+
endif::openshift-dedicated,openshift-rosa[]
97138

98-
. Save the file to apply the changes to the `ConfigMap` object.
99-
The new configuration is applied automatically.
139+
. Save the file to apply the changes to the `ConfigMap` object. The new configuration is applied automatically.
100140

modules/monitoring-adding-cluster-id-labels-to-metrics.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
[id="adding-cluster-id-labels-to-metrics_{context}"]
77
= Adding cluster ID labels to metrics
88

9-
If you manage multiple {product-title} clusters and use the remote write feature to send metrics data from these clusters to an external storage location, you can add cluster ID labels to identify the metrics data coming from different clusters.
10-
You can then query these labels to identify the source cluster for a metric and distinguish that data from similar metrics data sent by other clusters.
9+
If you manage multiple {product-title} clusters and use the remote write feature to send metrics data from these clusters to an external storage location, you can add cluster ID labels to identify the metrics data coming from different clusters. You can then query these labels to identify the source cluster for a metric and distinguish that data from similar metrics data sent by other clusters.
1110

1211
This way, if you manage many clusters for multiple customers and send metrics data to a single centralized storage system, you can use cluster ID labels to query metrics for a particular cluster or customer.
1312

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ If you have enabled a separate instance of Alertmanager dedicated to user-define
1111
.Prerequisites
1212

1313
ifdef::openshift-rosa,openshift-dedicated[]
14-
* You have access to the cluster as a user with the `cluster-admin` or `dedicated-admin` role.
14+
* You have access to the cluster as a user with the `dedicated-admin` role.
1515
endif::[]
1616
ifndef::openshift-rosa,openshift-dedicated[]
1717
* You have access to the cluster as a user with the `cluster-admin` role.
1818
endif::[]
19+
* You have installed the OpenShift CLI (`oc`).
1920

2021
.Procedure
2122

0 commit comments

Comments
 (0)