Clarify that healthcheck retries must be > 0
Open
@dvdksn is already working on this.
Since Aug 24, 2023.
lifecycle/frozen
status/upstream
- Dominant language
- Markdown
- Stars
- 4.7k
- Forks
- 8.5k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 108
Description
In the HEALTHCHECK section the docs say:
--retries=N (default: 3)
What isn't clear is if you want to disable retries, should you set this to 0 or 1. i.e. does the first attempt count as a "try" or a "retry"? 😄
Looks like per our observations and this code that anything less than 1 is ignored and triggers the default. Would be great to have this documented.
Here is a suggestion of how it could look:
Note: This value must be 1 or higher. Any value of 0 or lower will be ignored. To fail the health check on the first attempt, set it to 1.
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.
Assessment
This issue has not been assessed yet.