update documentation

runwhen-contrib · Jul 18, 2024 · 31a617b · 31a617b
1 parent 02ed670
commit 31a617b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/codebundles/k8s-postgres-healthcheck/runbook.robot b/codebundles/k8s-postgres-healthcheck/runbook.robot
@@ -1,5 +1,5 @@
 *** Settings ***
-Documentation       Runs a series of tasks and scores the health of a postgres cluster
+Documentation       Runs a series of tasks to check the overall health of a postgres cluster and to provide detailed information useful for debugging or reviewing configurations. 
 Metadata            Author    stewartshea
 Metadata            Display Name    Kubernetes Postgres Healthcheck
 Metadata            Supports    AKS,EKS,GKE,Kubernetes,Patroni,Postgres,Crunchy,Zalando

diff --git a/codebundles/k8s-postgres-healthcheck/sli.robot b/codebundles/k8s-postgres-healthcheck/sli.robot
@@ -1,5 +1,5 @@
 *** Settings ***
-Documentation       Runs multiple Kubernetes and psql commands to report on the health of a postgres cluster. Produces a value between 0 (completely failing thet test) and 1 (fully passing the test). Looks for container restarts, events, and pods not ready.
+Documentation       Runs multiple Kubernetes and psql commands to report on the health of a postgres cluster. Produces a value between 0 (completely failing thet test) and 1 (fully passing the test). Checks for database lag & backup health. 
 Metadata            Author    stewartshea
 Metadata            Display Name    Kubernetes Postgres Healthcheck
 Metadata            Supports    AKS,EKS,GKE,Kubernetes,Patroni,Postgres,Crunchy,Zalando