From fa9465f093b743b00c35208527a17494a2fa55f0 Mon Sep 17 00:00:00 2001 From: Tibor Vass Date: Wed, 20 Jul 2016 10:50:04 -0700 Subject: [PATCH] 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 --- docs/reference/builder.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/reference/builder.md b/docs/reference/builder.md index d677d63b8b..5975110fe4 100644 --- a/docs/reference/builder.md +++ b/docs/reference/builder.md @@ -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: