-
Task
-
Resolution: Unresolved
-
Major
-
None
-
None
After OCP code/feature freeze, update the modules/monitoring-alert-reference-for-the-cluster-monitoring-operator.adoc file -> update the alert tables. There is a script created for that:
Description of the task:
For every release, the list of default alerts managed by the CMO can slightly differ, we therefore need to update it with every release.
1. Launch a cluster, writer can use clusterbot. Example: launch 4.22 aws
2. In the OCP web console, search for cluster-monitoring-config config map, it is under the openshift-monitoring project
- Change .telemeterClient.enabled to true (telemeter client is usually enabled by default, so we want to include those alerting rules)
- Add enableUserWorkload: true (to be able to update default UWM alerting rules){}
- Example:
-
kind: ConfigMap apiVersion: v1 metadata: name: cluster-monitoring-config namespace: openshift-monitoring # ... data: config.yaml: |- telemeterClient: enabled: true # ... enableUserWorkload: true
3. Login to your cluster locally
4. Run the script:
$ ./scripts/generate_alerts_doc.sh
The file is created at your location called: openshift_cmo_alerts.adoc
5. Copy and paste the content of the generated tables to modules/monitoring-alert-reference-for-the-cluster-monitoring-operator.adoc
6. Create a feature branch to update the alerting table and add the changes only to the monitoring-docs-main branch and the version branch monitoring-docs-4.xx.