Skip to content

Create health.md #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Create health.md #171

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6408849
Create health.md
j08lue Jan 10, 2025
e7aed2f
List endpoints per service
j08lue Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/health.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 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

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
Loading