summaryrefslogtreecommitdiff
path: root/api/server/router/container/exec.go
diff options
context:
space:
mode:
authorThomas Leonard <thomas.leonard@docker.com>2016-04-18 10:48:13 +0100
committerSebastiaan van Stijn <github@gone.nl>2016-06-02 23:58:34 +0200
commitb6c7becbfe1d76b1250f6d8e991e645e13808a9c (patch)
treecc458a621b71a850a74706a9953b9aaaacf663de /api/server/router/container/exec.go
parentd1b1b6a98ef5381d2f3702d2c11856f692a0a412 (diff)
downloaddocker-b6c7becbfe1d76b1250f6d8e991e645e13808a9c.tar.gz
Add support for user-defined healthchecks
This PR adds support for user-defined health-check probes for Docker containers. It adds a `HEALTHCHECK` instruction to the Dockerfile syntax plus some corresponding "docker run" options. It can be used with a restart policy to automatically restart a container if the check fails. The `HEALTHCHECK` instruction has two forms: * `HEALTHCHECK [OPTIONS] CMD command` (check container health by running a command inside the container) * `HEALTHCHECK NONE` (disable any healthcheck inherited from the base image) The `HEALTHCHECK` instruction tells Docker how to test a container to check that it is still working. This can detect cases such as a web server that is stuck in an infinite loop and unable to handle new connections, even though the server process is still running. When a container has a healthcheck specified, it has a _health status_ in addition to its normal status. This status is initially `starting`. Whenever a health check passes, it becomes `healthy` (whatever state it was previously in). After a certain number of consecutive failures, it becomes `unhealthy`. The options that can appear before `CMD` are: * `--interval=DURATION` (default: `30s`) * `--timeout=DURATION` (default: `30s`) * `--retries=N` (default: `1`) The health check will first run **interval** seconds after the container is started, and then again **interval** seconds after each previous check completes. If a single run of the check takes longer than **timeout** seconds then the check is considered to have failed. It takes **retries** consecutive failures of the health check for the container to be considered `unhealthy`. There can only be one `HEALTHCHECK` instruction in a Dockerfile. If you list more than one then only the last `HEALTHCHECK` will take effect. The command after the `CMD` keyword can be either a shell command (e.g. `HEALTHCHECK CMD /bin/check-running`) or an _exec_ array (as with other Dockerfile commands; see e.g. `ENTRYPOINT` for details). The command's exit status indicates the health status of the container. 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. 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: HEALTHCHECK --interval=5m --timeout=3s \ CMD curl -f http://localhost/ || exit 1 To help debug failing probes, any output text (UTF-8 encoded) that the command writes on stdout or stderr will be stored in the health status and can be queried with `docker inspect`. Such output should be kept short (only the first 4096 bytes are stored currently). When the health status of a container changes, a `health_status` event is generated with the new status. The health status is also displayed in the `docker ps` output. Signed-off-by: Thomas Leonard <thomas.leonard@docker.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Diffstat (limited to 'api/server/router/container/exec.go')
-rw-r--r--api/server/router/container/exec.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/api/server/router/container/exec.go b/api/server/router/container/exec.go
index fb88ac824a..21f5dc8300 100644
--- a/api/server/router/container/exec.go
+++ b/api/server/router/container/exec.go
@@ -106,7 +106,8 @@ func (s *containerRouter) postContainerExecStart(ctx context.Context, w http.Res
}
// Now run the user process in container.
- if err := s.backend.ContainerExecStart(execName, stdin, stdout, stderr); err != nil {
+ // Maybe we should we pass ctx here if we're not detaching?
+ if err := s.backend.ContainerExecStart(context.Background(), execName, stdin, stdout, stderr); err != nil {
if execStartCheck.Detach {
return err
}