Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

man/docker-build.1:fix --memory-swamp and --network, removing = between long-form opts and values 

Signed-off-by: Des Preston <despreston@gmail.com>
This commit is contained in:
Des Preston 2020-09-01 11:59:30 -04:00
parent ed8ce81d58
commit 8df7a9364f
1 changed files with 67 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
man/docker-build.1.md
View File

@ -54,7 +54,7 @@ the rest of the archive will get used as the context of the build. When a Git r
set as the **URL**, the repository is cloned locally and then sent as the context.
# OPTIONS
**-f**, **--file**=*PATH/Dockerfile*
**-f**, **--file** *PATH/Dockerfile*
Path to the Dockerfile to use. If the path is a relative path and you are
building from a local directory, then the path must be relative to that
directory. If you are building from a remote URL pointing to either a
@ -62,7 +62,7 @@ set as the **URL**, the repository is cloned locally and then sent as the contex
the remote context. In all cases, the file must be within the build context.
The default is *Dockerfile*.
**--squash**=*true*|*false*
**--squash** *true*|*false*
**Experimental Only**
Once the image is built, squash the new layers into a new image with a single
new layer. Squashing does not destroy any existing image, rather it creates a new
@ -78,13 +78,13 @@ set as the **URL**, the repository is cloned locally and then sent as the contex
storing two copies of the image, one for the build cache with all the cache
layers in tact, and one for the squashed version.
**--add-host**=[]
**--add-host** []
Add a custom host-to-IP mapping (host:ip)
Add a line to /etc/hosts. The format is hostname:ip. The **--add-host**
option can be set multiple times.
**--build-arg**=*variable*
**--build-arg** *variable*
name and value of a **buildarg**.
For example, if you want to pass a value for `http_proxy`, use
@ -95,67 +95,66 @@ option can be set multiple times.
or for variable expansion in other Dockerfile instructions. This is not meant
for passing secret values. [Read more about the buildargs instruction](https://docs.docker.com/engine/reference/builder/#arg)
**--cache-from**=""
**--cache-from** ""
Set image that will be used as a build cache source.
**--force-rm**=*true*|*false*
**--force-rm** *true*|*false*
Always remove intermediate containers, even after unsuccessful builds. The default is *false*.
**--isolation**="*default*"
**--isolation** "*default*"
Isolation specifies the type of isolation technology used by containers.
**--label**=*label*
**--label** *label*
Set metadata for an image
**--no-cache**=*true*|*false*
**--no-cache** *true*|*false*
Do not use cache when building the image. The default is *false*.
**--iidfile**=""
**--iidfile** ""
Write the image ID to the file
**--help**
Print usage statement
**--pull**=*true*|*false*
**--pull** *true*|*false*
Always attempt to pull a newer version of the image. The default is *false*.
**--compress**=*true*|*false*
**--compress** *true*|*false*
Compress the build context using gzip. The default is *false*.
**-q**, **--quiet**=*true*|*false*
**-q**, **--quiet** *true*|*false*
Suppress the build output and print image ID on success. The default is *false*.
**--rm**=*true*|*false*
**--rm** *true*|*false*
Remove intermediate containers after a successful build. The default is *true*.
**-t**, **--tag**=""
**-t**, **--tag** ""
Repository names (and optionally with tags) to be applied to the resulting
image in case of success. Refer to **docker-tag(1)** for more information
about valid tag names.
**-m**, **--memory**=*MEMORY*
**-m**, **--memory** *MEMORY*
Memory limit
**--memory-swap**=*LIMIT*
A limit value equal to memory plus swap. Must be used with the **-m**
(**--memory**) flag. The swap `LIMIT` should always be larger than **-m**
(**--memory**) value.
**--memory-swap** *number*[*S*]
Combined memory plus swap limit; *S* is an optional suffix which can be one
of **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes).
The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes),
`k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a
unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
This option can only be used together with **--memory**. The argument should always be larger than that of **--memory**. Default is double the value of **--memory**. Set to **-1** to enable unlimited swap.
**--network**=*bridge*
**--network** *type*
Set the networking mode for the RUN instructions during build. Supported standard
values are: `bridge`, `host`, `none` and `container:<name|id>`. Any other value
values are: **none**, **bridge**, **host** and **container:**<_name_|_id_>. Any other value
is taken as a custom network's name or ID which this container should connect to.
**--shm-size**=*SHM-SIZE*
In Linux, default is **bridge**.
**--shm-size** *SHM-SIZE*
Size of `/dev/shm`. The format is `<number><unit>`. `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** *0*
CPU shares (relative weight).
By default, all containers get the same proportion of CPU cycles.
@ -172,27 +171,27 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
flag to set the weighting to 2 or higher.
Container CPU share Flag
{C0} 60% of CPU --cpu-shares=614 (614 is 60% of 1024)
{C1} 40% of CPU --cpu-shares=410 (410 is 40% of 1024)
{C0} 60% of CPU --cpu-shares 614 (614 is 60% of 1024)
{C1} 40% of CPU --cpu-shares 410 (410 is 40% of 1024)
The proportion is only applied when CPU-intensive processes are running.
When tasks in one container are idle, the other containers can use the
left-over CPU time. The actual amount of CPU time used varies depending on
the number of containers running on the system.
For example, consider three containers, where one has **--cpu-shares=1024** and
two others have **--cpu-shares=512**. When processes in all three
For example, consider three containers, where one has **--cpu-shares 1024** and
two others have **--cpu-shares 512**. When processes in all three
containers attempt to use 100% of CPU, the first container would receive
50% of the total CPU time. If you add a fourth container with **--cpu-shares=1024**,
50% of the total CPU time. If you add a fourth container with **--cpu-shares 1024**,
the first container only gets 33% of the CPU. The remaining containers
receive 16.5%, 16.5% and 33% of the CPU.
Container CPU share Flag CPU time
{C0} 100% --cpu-shares=1024 33%
{C1} 50% --cpu-shares=512 16.5%
{C2} 50% --cpu-shares=512 16.5%
{C4} 100% --cpu-shares=1024 33%
{C0} 100% --cpu-shares 1024 33%
{C1} 50% --cpu-shares 512 16.5%
{C2} 50% --cpu-shares 512 16.5%
{C4} 100% --cpu-shares 1024 33%
On a multi-core system, the shares of CPU time are distributed across the CPU
@ -200,8 +199,8 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
use 100% of each individual CPU core.
For example, consider a system with more than three cores. If you start one
container **{C0}** with **--cpu-shares=512** running one process, and another container
**{C1}** with **--cpu-shares=1024** running two processes, this can result in the following
container **{C0}** with **--cpu-shares 512** running one process, and another container
**{C1}** with **--cpu-shares 1024** running two processes, this can result in the following
division of CPU shares:
PID container CPU CPU share
@ -209,39 +208,39 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
101 {C1} 1 100% of CPU1
102 {C1} 2 100% of CPU2
**--cpu-period**=*0*
**--cpu-period** *0*
Limit the CPU CFS (Completely Fair Scheduler) period.
Limit the container's CPU usage. This flag causes the kernel to restrict the
container's CPU usage to the period you specify.
**--cpu-quota**=*0*
**--cpu-quota** *0*
Limit the CPU CFS (Completely Fair Scheduler) quota.
By default, containers run with the full CPU resource. This flag causes the
kernel to restrict the container's CPU usage to the quota you specify.
**--cpuset-cpus**=*CPUSET-CPUS*
**--cpuset-cpus** *CPUSET-CPUS*
CPUs in which to allow execution (0-3, 0,1).
**--cpuset-mems**=*CPUSET-MEMS*
**--cpuset-mems** *CPUSET-MEMS*
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on
NUMA systems.
For example, if you have four memory nodes on your system (0-3), use `--cpuset-mems=0,1`
For example, if you have four memory nodes on your system (0-3), use `--cpuset-mems 0,1`
to ensure the processes in your Docker container only use memory from the first
two memory nodes.
**--cgroup-parent**=*CGROUP-PARENT*
**--cgroup-parent** *CGROUP-PARENT*
Path to `cgroups` under which the container's `cgroup` are created.
If the path is not absolute, the path is considered relative to the `cgroups` path of the init process.
Cgroups are created if they do not already exist.
**--target**=""
**--target** ""
Set the target build stage name.
**--ulimit**=[]
**--ulimit** []
Ulimit options
For more information about `ulimit` see [Setting ulimits in a
@ -256,9 +255,9 @@ Docker images can be built using the build command and a Dockerfile:
docker build .
During the build process Docker creates intermediate images. In order to
keep them, you must explicitly set `--rm=false`.
keep them, you must explicitly set `--rm false`.
docker build --rm=false .
docker build --rm false .
A good practice is to make a sub-directory with a related name and create
the Dockerfile in that directory. For example, a directory called mongo may
@ -342,7 +341,7 @@ Note: supported compression formats are 'xz', 'bzip2', 'gzip' and 'identity' (no
## Specify isolation technology for container (--isolation)
This option is useful in situations where you are running Docker containers on
Windows. The `--isolation=<value>` option sets a container's isolation
Windows. The `--isolation <value>` option sets a container's isolation
technology. On Linux, the only supported is the `default` option which uses
Linux namespaces. On Microsoft Windows, you can specify these values:
@ -350,10 +349,11 @@ Linux namespaces. On Microsoft Windows, you can specify these values:
* `process`: Namespace isolation only.
* `hyperv`: Hyper-V hypervisor partition-based isolation.
Specifying the `--isolation` flag without a value is the same as setting `--isolation="default"`.
Specifying the `--isolation` flag without a value is the same as setting `--isolation "default"`.
# HISTORY
March 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.com source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
June 2015, updated by Sally O'Malley <somalley@redhat.com>
August 2020, Updated by Des Preston <despreston@gmail.com>