devops(docker): add healthchecks for db and api services (#10) - #77
Open
ghzhost wants to merge 1 commit into
Open
devops(docker): add healthchecks for db and api services (#10)#77ghzhost wants to merge 1 commit into
ghzhost wants to merge 1 commit into
Conversation
) - Add pg_isready-based healthcheck for the db (postgres:16-alpine) service so depends_on waits until Postgres is ready to accept connections, not just until the container has started. - Add curl /health-based healthcheck for the api service using the existing GET /health liveness probe. - Upgrade depends_on: [db] to depends_on: db: condition: service_healthy so the API container only starts after the DB is proven healthy. - Add curl to the Dockerfile runtime stage so the healthcheck command is available in the final image. Fixes StellarSend#10
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #10 —
docker-compose.ymlhad nohealthcheck:blocks, sodepends_on: [db]only waited for the container to start, not for Postgres to accept connections. On a cold start the API could attempt DB connections and fail.Changes
docker-compose.ymlpg_isready -U stellarsend -d stellarsendhealthcheck for thedbservice (interval 5s, retries 10, start_period 10s).curl -f http://localhost:3000/healthhealthcheck for theapiservice using the existing GET/healthliveness probe (interval 10s, retries 5, start_period 30s).depends_on: [db]todepends_on: db: condition: service_healthyso the API only starts after Postgres is proven ready.Dockerfilecurlto the runtime stage install (ca-certificates libssl3 curl) so the healthcheck command is available inside the final image.Testing
docker compose upnow waits fordbto passpg_isreadybefore startingapi.docker compose pswill show both services healthy./healthendpoint (liveness probe) is used as the API healthcheck target — no new code needed.Closes #10