From 2ccc48adc6eaf2623311366ab7748475c277f443 Mon Sep 17 00:00:00 2001
From: Marco Pracucci <marco.pracucci@spreaker.com>
Date: Fri, 5 Jul 2019 11:50:48 +0200
Subject: [PATCH] Documented /healthy, /ready and lifecycle API (#5737)

Signed-off-by: Marco Pracucci <marco.pracucci@spreaker.com>
---
 docs/management_api.md | 50 ++++++++++++++++++++++++++++++++++++++++++
 docs/migration.md      |  2 +-
 docs/stability.md      |  2 +-
 3 files changed, 52 insertions(+), 2 deletions(-)
 create mode 100644 docs/management_api.md

diff --git a/docs/management_api.md b/docs/management_api.md
new file mode 100644
index 000000000..584aa40a4
--- /dev/null
+++ b/docs/management_api.md
@@ -0,0 +1,50 @@
+---
+title: Management API
+sort_rank: 7
+---
+
+# Management API
+
+Prometheus provides a set of management API to ease automation and integrations.
+
+
+### Health check
+
+```
+GET /-/healthy
+```
+
+This endpoint always returns 200 and should be used to check Prometheus health.
+
+
+### Readiness check
+
+```
+GET /-/ready
+```
+
+This endpoint returns 200 when Prometheus is ready to serve traffic (i.e. respond to queries).
+
+
+### Reload
+
+```
+PUT  /-/reload
+POST /-/reload
+```
+
+This endpoint triggers a reload of the Prometheus configuration and rule files. It's disabled by default and can be enabled via the `--web.enable-lifecycle` flag.
+
+An alternative way trigger a configuration reload is by sending a `SIGHUP` to the Prometheus process.
+
+
+### Quit
+
+```
+PUT  /-/quit
+POST /-/quit
+```
+
+This endpoint triggers a graceful shutdown of Prometheus. It's disabled by default and can be enabled via the `--web.enable-lifecycle` flag.
+
+An alternative way trigger a graceful shutdown is by sending a `SIGTERM` to the Prometheus process.
diff --git a/docs/migration.md b/docs/migration.md
index 9ddce39ca..199e916ed 100644
--- a/docs/migration.md
+++ b/docs/migration.md
@@ -1,6 +1,6 @@
 ---
 title: Migration
-sort_rank: 7
+sort_rank: 8
 ---
 
 # Prometheus 2.0 migration guide
diff --git a/docs/stability.md b/docs/stability.md
index 6753e90d7..1e10c0b5f 100644
--- a/docs/stability.md
+++ b/docs/stability.md
@@ -1,6 +1,6 @@
 ---
 title: API Stability
-sort_rank: 8
+sort_rank: 9
 ---
 
 # API Stability Guarantees