From fa2f024bc6e23cd34e132ffa66c523430d58eb44 Mon Sep 17 00:00:00 2001 From: NIWA Hideyuki Date: Wed, 9 Sep 2015 15:30:56 +0900 Subject: [PATCH] Addition of "--shm-size" to which size of /dev/shm is changed. - Optional "--shm-size=" was added to the sub-command(run, create,and build). - The size of /dev/shm in the container can be changed when container is made. - Being able to specify is a numerical value that applies number, b, k, m, and g. - The default value is 64MB, when this option is not set. - It deals with both native and lxc drivers. Signed-off-by: NIWA Hideyuki --- docs/reference/commandline/build.md | 1 + docs/reference/commandline/create.md | 1 + docs/reference/commandline/run.md | 1 + docs/reference/run.md | 4 ++++ man/docker-build.1.md | 6 ++++++ man/docker-create.1.md | 6 ++++++ man/docker-run.1.md | 6 ++++++ 7 files changed, 25 insertions(+) diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index 32a51ceb8b..72da56d80e 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -31,6 +31,7 @@ parent = "smn_cli" --pull=false Always attempt to pull a newer version of the image -q, --quiet=false Suppress the verbose output generated by the containers --rm=true Remove intermediate containers after a successful build + --shm-size=[] Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. -t, --tag=[] Name and optionally a tag in the 'name:tag' format --ulimit=[] Ulimit options diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index 9c4b19bd8c..a7ed5dda17 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -65,6 +65,7 @@ Creates a new container. --restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped) --security-opt=[] Security options --stop-signal="SIGTERM" Signal to stop a container + --shm-size=[] Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. -t, --tty=false Allocate a pseudo-TTY -u, --user="" Username or UID --ulimit=[] Ulimit options diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 3ad93f2fa3..5d6ad1877f 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -68,6 +68,7 @@ parent = "smn_cli" --read-only=false Mount the container's root filesystem as read only --restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped) --rm=false Automatically remove the container when it exits + --shm-size=[] Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. --security-opt=[] Security Options --sig-proxy=true Proxy received signals to the process --stop-signal="SIGTERM" Signal to stop a container diff --git a/docs/reference/run.md b/docs/reference/run.md index 5ea79d4b28..a14429651e 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -626,6 +626,10 @@ container: | `--blkio-weight-device=""` | Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`) | | `--oom-kill-disable=false` | Whether to disable OOM Killer for the container or not. | | `--memory-swappiness="" ` | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | +| `--shm-size="" ` | Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. | +| | Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or | +| | `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size | +| | entirely, the system uses `64m`. | ### User memory constraints diff --git a/man/docker-build.1.md b/man/docker-build.1.md index 4bf4deea59..01889f76d2 100644 --- a/man/docker-build.1.md +++ b/man/docker-build.1.md @@ -19,6 +19,7 @@ docker-build - Build a new image from the source code at PATH [**-t**|**--tag**[=*[]*]] [**-m**|**--memory**[=*MEMORY*]] [**--memory-swap**[=*MEMORY-SWAP*]] +[**--shm-size**[=*SHM-SIZE*]] [**--cpu-period**[=*0*]] [**--cpu-quota**[=*0*]] [**--cpuset-cpus**[=*CPUSET-CPUS*]] @@ -90,6 +91,11 @@ set as the **URL**, the repository is cloned locally and then sent as the contex **--memory-swap**=*MEMORY-SWAP* Total memory (memory + swap), '-1' to disable swap. +**--shm-size**=*SHM-SIZE* + Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. + Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. + If you omit the size entirely, the system uses `64m`. + **--cpu-shares**=*0* CPU shares (relative weight). diff --git a/man/docker-create.1.md b/man/docker-create.1.md index b919234073..fed6278afe 100644 --- a/man/docker-create.1.md +++ b/man/docker-create.1.md @@ -54,6 +54,7 @@ docker-create - Create a new container [**--restart**[=*RESTART*]] [**--security-opt**[=*[]*]] [**--stop-signal**[=*SIGNAL*]] +[**--shm-size**[=*[]*]] [**-t**|**--tty**[=*false*]] [**-u**|**--user**[=*USER*]] [**--ulimit**[=*[]*]] @@ -252,6 +253,11 @@ This value should always larger than **-m**, so you should always use this with **--restart**="*no*" Restart policy to apply when a container exits (no, on-failure[:max-retry], always, unless-stopped). +**--shm-size**="" + Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. + Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. + If you omit the size entirely, the system uses `64m`. + **--security-opt**=[] Security Options diff --git a/man/docker-run.1.md b/man/docker-run.1.md index 72475b098a..2be6b1b5c0 100644 --- a/man/docker-run.1.md +++ b/man/docker-run.1.md @@ -56,6 +56,7 @@ docker-run - Run a command in a new container [**--rm**[=*false*]] [**--security-opt**[=*[]*]] [**--stop-signal**[=*SIGNAL*]] +[**--shm-size**[=*[]*]] [**--sig-proxy**[=*true*]] [**-t**|**--tty**[=*false*]] [**-u**|**--user**[=*USER*]] @@ -410,6 +411,11 @@ its root filesystem mounted as read only prohibiting any writes. **--stop-signal**=*SIGTERM* Signal to stop a container. Default is SIGTERM. +**--shm-size**="" + Size of `/dev/shm`. The format is ``. + `number` must be greater than `0`. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m`(megabytes), or `g` (gigabytes). + If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. + **--sig-proxy**=*true*|*false* Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.