From 0d2622996869dbe864502ba9c26bcfbd7f9272c3 Mon Sep 17 00:00:00 2001 From: IgGusev Date: Tue, 19 Sep 2023 17:26:31 +0400 Subject: [PATCH] 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 67a557c30f96e..4595a83f4e706 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 a206e9be6175e..83270dafca564 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