Add HEALTHCHECK instruction to Dockerfile
#407
Conversation
This file contains 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
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 [`PING`](https://redis.io/docs/latest/commands/ping/) command via the [Redis CLI](https://redis.io/docs/latest/develop/connect/cli/), which is already part of the image. The command “is useful for […] verifying the server's ability to serve data”. 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
Dockerfilecurrently does not have aHEALTHCHECKinstruction. Users of the Docker image currently need to add it manually (e.g. via Docker Compose). Instead, theDockerfileitself should include the instruction.To determine whether the service is healthy, one can use the
PINGcommand via the Redis CLI, which is already part of the image. The command “is useful for […] verifying the server's ability to serve data”.Most of the default
HEALTHCHECKoptions seem reasonable:I set
--start-period=1sbecause the default of0sis too quick for this program.Users of the image can still override the
HEALTHCHECKinstruction if they want to customize the command or the options.