healthcheck: do not interpret exit code 2 as "starting"

Instead reserve exit code 2 to be future proof, document that it should
not be used. Implementation-wise, it is considered as unhealthy, but
users should not rely on this as it may change in the future.

Signed-off-by: Tibor Vass <tibor@docker.com>
This commit is contained in:
Tibor Vass 2016-07-20 10:50:04 -07:00
parent b41c3dd208
commit fa9465f093
1 changed files with 1 additions and 4 deletions

View File

@ -1524,10 +1524,7 @@ The possible values are:
- 0: success - the container is healthy and ready for use
- 1: unhealthy - the container is not working correctly
- 2: starting - the container is not ready for use yet, but is working correctly
If the probe returns 2 ("starting") when the container has already moved out of the
"starting" state then it is treated as "unhealthy" instead.
- 2: reserved - do not use this exit code
For example, to check every five minutes or so that a web-server is able to
serve the site's main page within three seconds: