From 64088495493d0a0774ccf6d87bd2229d3fc4bfff Mon Sep 17 00:00:00 2001 From: Jonas Date: Fri, 10 Jan 2025 14:27:17 +0100 Subject: [PATCH 1/2] Create health.md --- docs/health.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/health.md diff --git a/docs/health.md b/docs/health.md new file mode 100644 index 00000000..091e7b9e --- /dev/null +++ b/docs/health.md @@ -0,0 +1,5 @@ +# Health checks and liveness probes + +All services in eoAPI have endpoints for basic health checks. +The deployment template includes instructions for these checks to get pinged on a regular basis - look for `livenessProbe` +in https://github.com/developmentseed/eoapi-k8s/blob/main/helm-chart/eoapi/templates/services/deployment.yaml From e7aed2ff173670e8abe9d88592276b08238b4351 Mon Sep 17 00:00:00 2001 From: Jonas Date: Fri, 10 Jan 2025 14:41:43 +0100 Subject: [PATCH 2/2] List endpoints per service --- docs/health.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/health.md b/docs/health.md index 091e7b9e..71ddb3d2 100644 --- a/docs/health.md +++ b/docs/health.md @@ -3,3 +3,9 @@ All services in eoAPI have endpoints for basic health checks. The deployment template includes instructions for these checks to get pinged on a regular basis - look for `livenessProbe` in https://github.com/developmentseed/eoapi-k8s/blob/main/helm-chart/eoapi/templates/services/deployment.yaml + +If you are using the default ingress setup, the health endpoints are: + +* Raster API: `/raster/healthz`, success: returns status code 200, no auth +* Vector API: `/vector/healthz`, success: returns status code 200, no auth +* STAC API: `/stac/_mgmt/ping`, sucess: returns status code 200, no auth