From 62d8d608879c8fdc7a98cab427fdb87a1d875588 Mon Sep 17 00:00:00 2001 From: Francis Begyn Date: Thu, 13 Jun 2024 17:29:08 +0200 Subject: [PATCH] (fleet/alerts) remove duplicate docs in favor of top level --- fleet/lib/prometheus-alertrules/README.md | 29 ----------------------- 1 file changed, 29 deletions(-) delete mode 100644 fleet/lib/prometheus-alertrules/README.md diff --git a/fleet/lib/prometheus-alertrules/README.md b/fleet/lib/prometheus-alertrules/README.md deleted file mode 100644 index de5e48845..000000000 --- a/fleet/lib/prometheus-alertrules/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Prometheus rules GitOps - -Any Prometheus rules file defined in the `/rules` directory will be deployed to -the cluster. It's possible to define a default namespace in the `values.yaml` -file with the `rules.namespace` key. - -## Adding Prometheus rules - -1. Write the Prometheus rules in a yaml file according to the [prometheus - specification](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). -1. Add the YAML file to the `/rules` directory -1. Commit - -## Prometheus rule AURA standards - -* `summary` annotation: The `summary` annotation is used to be able to describe a - group of alerts incomming. This annotation DOES NOT contain any templated - variables and provides a simple single sentence summary of what the alert is - about. For example "Disk space full in 24h". When a cluster triggers several - alerts, it can be hany to group these alerts into a single notification, this - is when the `summary` can be used. -* `discription` annotation: This provides a detailed overview of the alert - specifically to this instance of the alert. It MAY contain templated variables - to enrich the message. -* `receiver` label: The receiver label is used by alertmanager to decide on the - routing of the notification for the alert. It exists out of `,` seperated list - of receivers, pre- and suffixed with `,` to make regex matching easier in the - alertmanager. For example: `,slack,squadcast,email,` The receivers are defined - in the alertmanager configuration.