IGNITE-20440 Add docs for REST probe (#10939)

apache · Sep 19, 2023 · 0d26229 · 0d26229
1 parent abbf613
commit 0d26229
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/docs/_docs/installation/kubernetes/generic-configuration.adoc b/docs/_docs/installation/kubernetes/generic-configuration.adoc
@@ -285,6 +285,16 @@ $ {command} logs ignite-cluster-5b69557db6-lcglw -n ignite
 
 The string `servers=2` in the last line indicates that the two nodes joined into a single cluster.
 
+=== Readiness Probe Setup
+
+To set up a readiness probe uncomment the relevant section inside the yaml definitions
+below. A special REST command (link:restapi#probe[PROBE]) is used to determine when an Ignite Kernal has started.
+
+=== Liveness Probe
+
+To set up a liveness probe uncomment the relevant section inside the yaml definitions
+below. The REST command (link:restapi#version[VERSION]) is used to verify that Ignite is running properly.
+
 == Activating the Cluster
 
 If you deployed a stateless cluster, skip this step: a cluster without persistence does not require activation.

diff --git a/docs/_docs/restapi.adoc b/docs/_docs/restapi.adoc
@@ -2936,3 +2936,26 @@ The command returns 'true' if the query was closed successfully.
 ----
 
 
+=== Probe
+
+Returns whether Ignite kernal as started.
+
+
+*Request:*::
++
+[source,shell]
+----
+http://host:port/ignite?cmd=probe
+----
+
+*Response:*::
+Returns HTTP Status code 200 if kernal has started, and 503 otherwise
++
+[source,json]
+----
+{
+  "error": "",
+  "response": "grid has started",
+  "successStatus": 0
+}
+----