From 5b8a6eb05f8c69670814e400f7f85ae221c8bae4 Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Sun, 22 Jun 2014 16:33:19 -0700 Subject: [PATCH 1/3] Add cli.md documentation for docker-pause and docker-unpause Docker-DCO-1.1-Signed-off-by: Sven Dowideit (github: SvenDowideit) --- docs/sources/reference/commandline/cli.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index e9d21cac47..e31e3eee45 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -760,6 +760,12 @@ log entry. Lookup the public-facing port that is NAT-ed to PRIVATE_PORT +## pause + + Usage: docker pause CONTAINER + + Pause all processes within a container + ## ps Usage: docker ps [OPTIONS] @@ -1263,6 +1269,12 @@ them to [*Share Images via Repositories*]( Display the running processes of a container +## unpause + + Usage: docker unpause CONTAINER + + Pause all processes within a container + ## version Usage: docker version From 3957d72f9cd613fa8a0eeb03517e4f78f9cc58f1 Mon Sep 17 00:00:00 2001 From: Brian Goff Date: Tue, 8 Jul 2014 21:47:55 -0400 Subject: [PATCH 2/3] Add cgroups freezer info Docker-DCO-1.1-Signed-off-by: Brian Goff (github: cpuguy83) Docker-DCO-1.1-Signed-off-by: Brian Goff (github: SvenDowideit) --- docs/sources/reference/commandline/cli.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index e31e3eee45..d75f2b1443 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -764,7 +764,14 @@ log entry. Usage: docker pause CONTAINER - Pause all processes within a container + Pause uses the cgroups freezer to suspend all processes in a container. + Traditionally when suspending a process the SIGSTOP signal is used, + which is observable by the process being suspended. With the cgroups freezer + the process is unaware, and unable to capture, that it is being suspended, + and subsequently resumed. + + For for information on the cgroups freezer see: + https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt ## ps @@ -1273,7 +1280,7 @@ them to [*Share Images via Repositories*]( Usage: docker unpause CONTAINER - Pause all processes within a container + Resumes a paused container. ## version From 58955a30ffffb8e9dafb8593f4513d6dae53abfd Mon Sep 17 00:00:00 2001 From: SvenDowideit Date: Tue, 15 Jul 2014 10:02:29 +1000 Subject: [PATCH 3/3] re-jig the info into all the places Docker-DCO-1.1-Signed-off-by: SvenDowideit (github: SvenDowideit) --- docs/man/docker-pause.1.md | 12 ++++++++++++ docs/man/docker-unpause.1.md | 9 +++++++++ docs/sources/reference/commandline/cli.md | 24 ++++++++++++++++------- 3 files changed, 38 insertions(+), 7 deletions(-) diff --git a/docs/man/docker-pause.1.md b/docs/man/docker-pause.1.md index e6c0c2455d..7b4b091a06 100644 --- a/docs/man/docker-pause.1.md +++ b/docs/man/docker-pause.1.md @@ -8,6 +8,18 @@ docker-pause - Pause all processes within a container **docker pause** CONTAINER +# DESCRIPTION + +The `docker pause` command uses the cgroups freezer to suspend all processes in +a container. Traditionally when suspending a process the `SIGSTOP` signal is +used, which is observable by the process being suspended. With the cgroups freezer +the process is unaware, and unable to capture, that it is being suspended, +and subsequently resumed. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + # OPTIONS There are no available options. diff --git a/docs/man/docker-unpause.1.md b/docs/man/docker-unpause.1.md index 8949548b67..dfce16324e 100644 --- a/docs/man/docker-unpause.1.md +++ b/docs/man/docker-unpause.1.md @@ -8,6 +8,15 @@ docker-unpause - Unpause all processes within a container **docker unpause** CONTAINER +# DESCRIPTION + +The `docker unpause` command uses the cgroups freezer to un-suspend all +processes in a container. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + # OPTIONS There are no available options. diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index d75f2b1443..dac7c1610b 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -764,14 +764,17 @@ log entry. Usage: docker pause CONTAINER - Pause uses the cgroups freezer to suspend all processes in a container. - Traditionally when suspending a process the SIGSTOP signal is used, - which is observable by the process being suspended. With the cgroups freezer - the process is unaware, and unable to capture, that it is being suspended, - and subsequently resumed. + Pause all processes within a container - For for information on the cgroups freezer see: - https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt +The `docker pause` command uses the cgroups freezer to suspend all processes in +a container. Traditionally when suspending a process the `SIGSTOP` signal is +used, which is observable by the process being suspended. With the cgroups freezer +the process is unaware, and unable to capture, that it is being suspended, +and subsequently resumed. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. ## ps @@ -1282,6 +1285,13 @@ them to [*Share Images via Repositories*]( Resumes a paused container. +The `docker unpause` command uses the cgroups freezer to un-suspend all +processes in a container. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + ## version Usage: docker version