This is an automated email from the ASF dual-hosted git repository.
ashapkin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 0d262299686 IGNITE-20440 Add docs for REST probe (#10939)
0d262299686 is described below
commit 0d2622996869dbe864502ba9c26bcfbd7f9272c3
Author: IgGusev <[email protected]>
AuthorDate: Tue Sep 19 17:26:31 2023 +0400
IGNITE-20440 Add docs for REST probe (#10939)
---
.../kubernetes/generic-configuration.adoc | 10 ++++++++++
docs/_docs/restapi.adoc | 23 ++++++++++++++++++++++
2 files changed, 33 insertions(+)
diff --git a/docs/_docs/installation/kubernetes/generic-configuration.adoc
b/docs/_docs/installation/kubernetes/generic-configuration.adoc
index 67a557c30f9..4595a83f4e7 100644
--- 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
index a206e9be617..83270dafca5 100644
--- 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
+}
+----
\ No newline at end of file
