Add HEALTHCHECK instruction to Dockerfile.

The `Dockerfile` currently does not have a `HEALTHCHECK` instruction. Users of the Docker image currently need to add it manually (e.g. via Docker Compose). Instead, the `Dockerfile` itself should include the instruction. To determine whether the service is healthy, one can use the [`pg_isready`](https://www.postgresql.org/docs/current/app-pg-isready.html) program, which is already part of the image. The program “checks the connection status of a PostgreSQL database server”. Most of the default `HEALTHCHECK` [options](https://docs.docker.com/reference/dockerfile/#healthcheck) seem reasonable: ``` --interval=30s --timeout=30s --start-interval=5s --retries=3 ``` I set `--start-period=1s` because the default of `0s` is too quick for this program. Users of the image can still override the `HEALTHCHECK` instruction if they want to customize the command or the options.
docker-library · Aug 23, 2024 · a45f2aa · a45f2aa
1 parent 805329e
commit a45f2aa
Show file tree

Hide file tree

Showing 26 changed files with 52 additions and 0 deletions.
diff --git a/12/alpine3.19/Dockerfile b/12/alpine3.19/Dockerfile
diff --git a/12/alpine3.20/Dockerfile b/12/alpine3.20/Dockerfile
diff --git a/12/bookworm/Dockerfile b/12/bookworm/Dockerfile
diff --git a/12/bullseye/Dockerfile b/12/bullseye/Dockerfile
diff --git a/13/alpine3.19/Dockerfile b/13/alpine3.19/Dockerfile
diff --git a/13/alpine3.20/Dockerfile b/13/alpine3.20/Dockerfile
diff --git a/13/bookworm/Dockerfile b/13/bookworm/Dockerfile
diff --git a/13/bullseye/Dockerfile b/13/bullseye/Dockerfile
diff --git a/14/alpine3.19/Dockerfile b/14/alpine3.19/Dockerfile
diff --git a/14/alpine3.20/Dockerfile b/14/alpine3.20/Dockerfile
diff --git a/14/bookworm/Dockerfile b/14/bookworm/Dockerfile
diff --git a/14/bullseye/Dockerfile b/14/bullseye/Dockerfile
diff --git a/15/alpine3.19/Dockerfile b/15/alpine3.19/Dockerfile
diff --git a/15/alpine3.20/Dockerfile b/15/alpine3.20/Dockerfile
diff --git a/15/bookworm/Dockerfile b/15/bookworm/Dockerfile
diff --git a/15/bullseye/Dockerfile b/15/bullseye/Dockerfile
diff --git a/16/alpine3.19/Dockerfile b/16/alpine3.19/Dockerfile
diff --git a/16/alpine3.20/Dockerfile b/16/alpine3.20/Dockerfile
diff --git a/16/bookworm/Dockerfile b/16/bookworm/Dockerfile
diff --git a/16/bullseye/Dockerfile b/16/bullseye/Dockerfile
diff --git a/17/alpine3.19/Dockerfile b/17/alpine3.19/Dockerfile
diff --git a/17/alpine3.20/Dockerfile b/17/alpine3.20/Dockerfile
diff --git a/17/bookworm/Dockerfile b/17/bookworm/Dockerfile
diff --git a/17/bullseye/Dockerfile b/17/bullseye/Dockerfile
diff --git a/Dockerfile-alpine.template b/Dockerfile-alpine.template
@@ -250,3 +250,5 @@ STOPSIGNAL SIGINT
 
 EXPOSE 5432
 CMD ["postgres"]
+
+HEALTHCHECK --start-period=1s CMD pg_isready || exit 1
diff --git a/Dockerfile-debian.template b/Dockerfile-debian.template
@@ -221,3 +221,5 @@ STOPSIGNAL SIGINT
 
 EXPOSE 5432
 CMD ["postgres"]
+
+HEALTHCHECK --start-period=1s CMD pg_isready || exit 1