Add examples, more documentation around health checks
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 4.7k
- Forks
- 8.5k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 108
Description
Problem description
Healthchecks are a powerful feature, but the documentation is currently sparse. There is some basic information on its usage in the builder documentation, and the flags are included in the docker container run and docker service create command line reference, but no practical examples are included in the documentation.
Suggestions for a fix
Docker 17.05 and up adds additional options for health checks (start period), and I wrote a comment on that pull request to illustrate the functionality which may be useful as a starting point https://github.com/moby/moby/pull/28938#issuecomment-301736698, https://github.com/moby/moby/issues/35881#issuecomment-356619230, and I saw @tomwillfixit has a demo repository to show health checks (https://github.com/tomwillfixit/healthcheck).
Those examples are very basic, but can be useful in itself (possibly we may want to add a "real" example as well).
/cc @mstanleyjones
also /cc @dongluochen @tianon who may be able to provide more information on this subject 👍
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/reference/builder.md, docs/reference/commandline/run.md, and docs/reference/commandline/service_create.md, then review the linked health-check examples and demo repository. Document practical health-check usage, including the newer start-period option, and consider whether a more realistic example is needed. Done means the relevant references contain useful examples beyond the existing flag descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100