From 7bcc3d081e2fd67525312f53555f2fef0e475b3f Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Thu, 3 Jan 2019 15:56:53 +0100 Subject: [PATCH] adding liveness section in documentation --- build/docs/content/08-liveness.md | 11 ++++++++ .../docs/content/{08-links.md => 09-links.md} | 0 docs/index.html | 26 ++++++++++++++++--- internal/app/api/api_test.go | 2 -- 4 files changed, 34 insertions(+), 5 deletions(-) create mode 100644 build/docs/content/08-liveness.md rename build/docs/content/{08-links.md => 09-links.md} (100%) diff --git a/build/docs/content/08-liveness.md b/build/docs/content/08-liveness.md new file mode 100644 index 00000000..5da45771 --- /dev/null +++ b/build/docs/content/08-liveness.md @@ -0,0 +1,11 @@ +--- +title: Liveness +--- + +Gotenberg provides the endpoint `/ping` for checking the API availability with +a simple `GET` request. + +This feature is especially useful for liveness/readiness probes in Kubernetes: + +* [Pod lifecycle](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) +* [Configure Liveness and Readiness Probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/) \ No newline at end of file diff --git a/build/docs/content/08-links.md b/build/docs/content/09-links.md similarity index 100% rename from build/docs/content/08-links.md rename to build/docs/content/09-links.md diff --git a/docs/index.html b/docs/index.html index adc5874b..5c51a69a 100755 --- a/docs/index.html +++ b/docs/index.html @@ -54,6 +54,10 @@ Scalability +
+ Liveness +
+
Links
@@ -105,7 +109,7 @@ gotenberg: image: thecodingmachine/gotenberg:3 - +

The API will be available under gotenberg:3000 in your Docker Compose network.

@@ -695,7 +699,7 @@ $filename = $client->store($request, $dirPath); 
FROM thecodingmachine/gotenberg:3
 
 RUN apt-get -y install yourfonts
-
+ @@ -834,7 +838,7 @@ $resp = $client->post($request); gotenberg: image: thecodingmachine/gotenberg:3 - +

You may now launch your services using:

@@ -846,6 +850,22 @@ redirect a request to a Gotenberg container according to the round-robin strateg +
+

Liveness

+

Gotenberg provides the endpoint /ping for checking the API availability with +a simple GET request.

+ +

This feature is especially useful for liveness/readiness probes in Kubernetes:

+ + + +
+