From a5efa03a6af7e42855828e39faa1c0b8f1fdfd29 Mon Sep 17 00:00:00 2001 From: Dean Kelly <dekelly@redhat.com> Date: Thu, 6 Jun 2024 08:29:18 +0000 Subject: [PATCH] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 12a58be..a2ab1d7 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,9 @@ If you need to customize the deployment process (for example, deploy your own co - `post_undeploy.sh` is executed after the CODECO operator was removes and is a good place for last minutes cleanups. >**Note:** This script is executed after the namespace `codecoapp-operator-system` is removed +## Prometheus Rules Aspect +To add a prometheus rule you wish to deploy reference the 'acm/config/rules' file. You will add your rules.yaml (it may be a good idea to reference your component in this file name e.g acm-rules.yaml, swm-rules.yaml, etc) file to this directory, which our monitoring code will then read and pass to prometheus. Coupled with the prometheus-operator you should then be able to access these rules and see the metrics on the Grafana UI through port forwarding the pod. + ## Contributing // TODO(user): Add detailed information on how you would like others to contribute to this project -- GitLab