From e543210470fec3b71276d3ce4f1376b158fd29aa Mon Sep 17 00:00:00 2001
From: Fynn <fynn.becker@hs-hannover.de>
Date: Fri, 26 Aug 2022 15:05:58 +0200
Subject: [PATCH] Add some documentation on monitor_postgrest state

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 1b1ff6e..c15720e 100644
--- a/README.md
+++ b/README.md
@@ -108,6 +108,12 @@ Installs the [nginx_status](https://checkmk.com/cms_check_nginx_status.html) age
 
 Install the [php_fpm_pools](https://exchange.checkmk.com/p/php-fpm) agent plugin.
 
+### `checkmk.debian.monitor_postgrest`
+
+Installs the `monitor-postgrest` agent local check.
+Relies on pillar configuration for [postgrest-formula](https://lab.it.hs-hannover.de/salt/postgrest-formula).
+Specifically, if no PostgREST instance defines `admin-server-port` in its configuration the state will ensure that the local check is not present.
+
 ### `checkmk.debian.radsec`
 
 Installs the radsec plugin.
-- 
GitLab