From d56ceaaede2e4705143b747cc54cd5d8087c726e Mon Sep 17 00:00:00 2001 From: Zhang Wei Date: Tue, 9 Aug 2016 00:47:12 +0800 Subject: [PATCH] Add docs for auto-removal on daemon Docs for #20848: move "--rm" to daemon side. Add description for introduced API changes. Signed-off-by: Zhang Wei Upstream-commit: 7df815d2afe006ece9a3bc5c0642bd7643f40124 Component: engine --- components/engine/docs/reference/api/docker_remote_api.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.25.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/components/engine/docs/reference/api/docker_remote_api.md b/components/engine/docs/reference/api/docker_remote_api.md index a24823d913..986917548b 100644 --- a/components/engine/docs/reference/api/docker_remote_api.md +++ b/components/engine/docs/reference/api/docker_remote_api.md @@ -116,7 +116,7 @@ This section lists each version from latest to oldest. Each listing includes a [Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation -* `POST /containers/create` now takes `AutoRemove` in HostConfig, auto-removal will be done on daemon side. +* `POST /containers/create` now takes `AutoRemove` in HostConfig, to enable auto-removal of the container on daemon side when the container's process exits. ### v1.24 API changes diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.25.md b/components/engine/docs/reference/api/docker_remote_api_v1.25.md index eb17cb8bec..3a26d41106 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.25.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.25.md @@ -459,6 +459,8 @@ Create a container The default is not to restart. (optional) An ever increasing delay (double the previous delay, starting at 100mS) is added before each restart to prevent flooding the server. + - **AutoRemove** - Boolean value, set to `true` to automatically remove the container on daemon side + when the container's process exits. - **UsernsMode** - Sets the usernamespace mode for the container when usernamespace remapping option is enabled. supported values are: `host`. - **NetworkMode** - Sets the networking mode for the container. Supported