Skip to content

Commit 5f750ba

Browse files
gibson042gibson042
committed
Update reference docs
```sh for cmd in create run; do doc="docs/reference/commandline/$cmd.md" tmp="$(mktemp)" awk -v cmd="$cmd" ' # Replace the contents of the first markdown block # with output from docker help (omitting leading blank lines). /^```markdown/ && !replaced { # Print the block start. print; # Insert `docker help` output. while(("./build/docker help " cmd | getline)>0) { if(NF>0) trimmed=1; if(trimmed) print; } # Advance to the block end. while(getline>0 && $0!="```"); replaced++; } { print } ' "$doc" >"$tmp" && \ mv "$tmp" "$doc" done ``` Signed-off-by: Richard Gibson <richard.gibson@gmail.com>
1 parent 917ad65 commit 5f750ba

2 files changed

Lines changed: 217 additions & 245 deletions

File tree

‎docs/reference/commandline/create.md‎

Lines changed: 107 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -14,122 +14,113 @@ Usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...]
1414
Create a new container
1515

1616
Options:
17-
--add-host value Add a custom host-to-IP mapping (host:ip) (default [])
18-
-a, --attach value Attach to STDIN, STDOUT or STDERR (default [])
19-
--blkio-weight value Block IO (relative weight), between 10 and 1000
20-
--blkio-weight-device value Block IO weight (relative device weight) (default [])
21-
--cap-add value Add Linux capabilities (default [])
22-
--cap-drop value Drop Linux capabilities (default [])
23-
--cgroupns string Cgroup namespace to use
24-
'host': Run the container in the Docker host's cgroup namespace
25-
'private': Run the container in its own private cgroup namespace
26-
'': Use the default Docker daemon cgroup namespace specified by the `--default-cgroupns-mode` option
27-
--cgroup-parent string Optional parent cgroup for the container
28-
--cidfile string Write the container ID to the file
29-
--cpu-count int The number of CPUs available for execution by the container.
30-
Windows daemon only. On Windows Server containers, this is
31-
approximated as a percentage of total CPU usage.
32-
--cpu-percent int CPU percent (Windows only)
33-
--cpu-period int Limit CPU CFS (Completely Fair Scheduler) period
34-
--cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota
35-
-c, --cpu-shares int CPU shares (relative weight)
36-
--cpus NanoCPUs Number of CPUs (default 0.000)
37-
--cpu-rt-period int Limit the CPU real-time period in microseconds
38-
--cpu-rt-runtime int Limit the CPU real-time runtime in microseconds
39-
--cpuset-cpus string CPUs in which to allow execution (0-3, 0,1)
40-
--cpuset-mems string MEMs in which to allow execution (0-3, 0,1)
41-
--device value Add a host device to the container (default [])
42-
--device-cgroup-rule value Add a rule to the cgroup allowed devices list
43-
--device-read-bps value Limit read rate (bytes per second) from a device (default [])
44-
--device-read-iops value Limit read rate (IO per second) from a device (default [])
45-
--device-write-bps value Limit write rate (bytes per second) to a device (default [])
46-
--device-write-iops value Limit write rate (IO per second) to a device (default [])
47-
--disable-content-trust Skip image verification (default true)
48-
--dns value Set custom DNS servers (default [])
49-
--dns-option value Set DNS options (default [])
50-
--dns-search value Set custom DNS search domains (default [])
51-
--domainname string Container NIS domain name
52-
--entrypoint string Overwrite the default ENTRYPOINT of the image
53-
-e, --env value Set environment variables (default [])
54-
--env-file value Read in a file of environment variables (default [])
55-
--expose value Expose a port or a range of ports (default [])
56-
--group-add value Add additional groups to join (default [])
57-
--health-cmd string Command to run to check health
58-
--health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s)
59-
--health-retries int Consecutive failures needed to report unhealthy
60-
--health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s)
61-
--health-start-period duration Start period for the container to initialize before counting retries towards unstable (ns|us|ms|s|m|h) (default 0s)
62-
--help Print usage
63-
-h, --hostname string Container host name
64-
--init Run an init inside the container that forwards signals and reaps processes
65-
-i, --interactive Keep STDIN open even if not attached
66-
--io-maxbandwidth string Maximum IO bandwidth limit for the system drive (Windows only)
67-
--io-maxiops uint Maximum IOps limit for the system drive (Windows only)
68-
--ip string IPv4 address (e.g., 172.30.100.104)
69-
--ip6 string IPv6 address (e.g., 2001:db8::33)
70-
--ipc string IPC namespace to use
71-
--isolation string Container isolation technology
72-
--kernel-memory string Kernel memory limit
73-
-l, --label value Set meta data on a container (default [])
74-
--label-file value Read in a line delimited file of labels (default [])
75-
--link value Add link to another container (default [])
76-
--link-local-ip value Container IPv4/IPv6 link-local addresses (default [])
77-
--log-driver string Logging driver for the container
78-
--log-opt value Log driver options (default [])
79-
--mac-address string Container MAC address (e.g., 92:d0:c6:0a:29:33)
80-
-m, --memory string Memory limit
81-
--memory-reservation string Memory soft limit
82-
--memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap
83-
--memory-swappiness int Tune container memory swappiness (0 to 100) (default -1)
84-
--mount value Attach a filesystem mount to the container (default [])
85-
--name string Assign a name to the container
86-
--network-alias value Add network-scoped alias for the container (default [])
87-
--network string Connect a container to a network (default "default")
88-
'bridge': create a network stack on the default Docker bridge
89-
'none': no networking
90-
'container:<name|id>': reuse another container's network stack
91-
'host': use the Docker host network stack
92-
'<network-name>|<network-id>': connect to a user-defined network
93-
--no-healthcheck Disable any container-specified HEALTHCHECK
94-
--oom-kill-disable Disable OOM Killer
95-
--oom-score-adj int Tune host's OOM preferences (-1000 to 1000)
96-
--pid string PID namespace to use
97-
--pids-limit int Tune container pids limit (set -1 for unlimited), kernel >= 4.3
98-
--privileged Give extended privileges to this container
99-
-p, --publish value Publish a container's port(s) to the host (default [])
100-
-P, --publish-all Publish all exposed ports to random ports
101-
--read-only Mount the container's root filesystem as read only
102-
--restart string Restart policy to apply when a container exits (default "no")
103-
Possible values are: no, on-failure[:max-retry], always, unless-stopped
104-
--rm Automatically remove the container when it exits
105-
--runtime string Runtime to use for this container
106-
--security-opt value Security Options (default [])
107-
--shm-size bytes Size of /dev/shm
108-
The format is `<number><unit>`. `number` must be greater than `0`.
109-
Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes),
110-
or `g` (gigabytes). If you omit the unit, the system uses bytes.
111-
--stop-signal string Signal to stop the container
112-
--stop-timeout int Timeout (in seconds) to stop a container
113-
--storage-opt value Storage driver options for the container (default [])
114-
--sysctl value Sysctl options (default map[])
115-
--tmpfs value Mount a tmpfs directory (default [])
116-
-t, --tty Allocate a pseudo-TTY
117-
--ulimit value Ulimit options (default [])
118-
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
119-
--userns string User namespace to use
120-
'host': Use the Docker host user namespace
121-
'': Use the Docker daemon user namespace specified by `--userns-remap` option.
122-
--uts string UTS namespace to use
123-
-v, --volume value Bind mount a volume (default []). The format
124-
is `[host-src:]container-dest[:<options>]`.
125-
The comma-delimited `options` are [rw|ro],
126-
[z|Z], [[r]shared|[r]slave|[r]private],
127-
[delegated|cached|consistent], and
128-
[nocopy]. The 'host-src' is an absolute path
129-
or a name value.
130-
--volume-driver string Optional volume driver for the container
131-
--volumes-from value Mount volumes from the specified container(s) (default [])
132-
-w, --workdir string Working directory inside the container
17+
--add-host list Add a custom host-to-IP mapping (host:ip)
18+
-a, --attach list Attach to STDIN, STDOUT or STDERR
19+
--blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0
20+
to disable (default 0)
21+
--blkio-weight-device list Block IO weight (relative device weight) (default [])
22+
--cap-add list Add Linux capabilities
23+
--cap-drop list Drop Linux capabilities
24+
--cgroup-parent string Optional parent cgroup for the container
25+
--cidfile string Write the container ID to the file
26+
--cpu-period int Limit CPU CFS (Completely Fair Scheduler) period
27+
--cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota
28+
--cpu-rt-period int Limit CPU real-time period in microseconds
29+
--cpu-rt-runtime int Limit CPU real-time runtime in microseconds
30+
-c, --cpu-shares int CPU shares (relative weight)
31+
--cpus decimal Number of CPUs
32+
--cpuset-cpus string CPUs in which to allow execution (0-3, 0,1)
33+
--cpuset-mems string MEMs in which to allow execution (0-3, 0,1)
34+
--device list Add a host device to the container
35+
--device-cgroup-rule list Add a rule to the cgroup allowed devices list
36+
--device-read-bps list Limit read rate (bytes per second) from a device
37+
(default [])
38+
--device-read-iops list Limit read rate (IO per second) from a device (default [])
39+
--device-write-bps list Limit write rate (bytes per second) to a device
40+
(default [])
41+
--device-write-iops list Limit write rate (IO per second) to a device (default [])
42+
--disable-content-trust Skip image verification (default true)
43+
--dns list Set custom DNS servers
44+
--dns-option list Set DNS options
45+
--dns-search list Set custom DNS search domains
46+
--domainname string Container NIS domain name
47+
--entrypoint string Overwrite the default ENTRYPOINT of the image
48+
-e, --env list Set environment variables
49+
--env-file list Read in a file of environment variables
50+
--expose list Expose a port or a range of ports
51+
--gpus gpu-request GPU devices to add to the container ('all' to pass all
52+
GPUs)
53+
--group-add list Add additional groups to join
54+
--health-cmd string Command to run to check health
55+
--health-interval duration Time between running the check (ms|s|m|h) (default 0s)
56+
--health-retries int Consecutive failures needed to report unhealthy
57+
--health-start-period duration Start period for the container to initialize before
58+
starting health-retries countdown (ms|s|m|h) (default 0s)
59+
--health-timeout duration Maximum time to allow one check to run (ms|s|m|h)
60+
(default 0s)
61+
--help Print usage
62+
-h, --hostname string Container host name
63+
--init Run an init inside the container that forwards signals
64+
and reaps processes
65+
-i, --interactive Keep STDIN open even if not attached
66+
--ip string IPv4 address (e.g., 172.30.100.104)
67+
--ip6 string IPv6 address (e.g., 2001:db8::33)
68+
--ipc string IPC mode to use
69+
--isolation string Container isolation technology
70+
--kernel-memory bytes Kernel memory limit
71+
-l, --label list Set meta data on a container
72+
--label-file list Read in a line delimited file of labels
73+
--link list Add link to another container
74+
--link-local-ip list Container IPv4/IPv6 link-local addresses
75+
--log-driver string Logging driver for the container
76+
--log-opt list Log driver options
77+
--mac-address string Container MAC address (e.g., 92:d0:c6:0a:29:33)
78+
-m, --memory bytes Memory limit
79+
--memory-reservation bytes Memory soft limit
80+
--memory-swap bytes Swap limit equal to memory plus swap: '-1' to enable
81+
unlimited swap
82+
--memory-swappiness int Tune container memory swappiness (0 to 100) (default -1)
83+
--mount mount Attach a filesystem mount to the container (e.g.,
84+
"type=volume,target=/mnt/persistent" or
85+
"type=bind,ro,src=/var/run/docker.sock,dst=/run/host-docker.sock")
86+
--name string Assign a name to the container
87+
--network network Connect a container to a network
88+
--network-alias list Add network-scoped alias for the container
89+
--no-healthcheck Disable any container-specified HEALTHCHECK
90+
--oom-kill-disable Disable OOM Killer
91+
--oom-score-adj int Tune host's OOM preferences (-1000 to 1000)
92+
--pid string PID namespace to use
93+
--pids-limit int Tune container pids limit (set -1 for unlimited)
94+
--platform string Set platform if server is multi-platform capable
95+
--privileged Give extended privileges to this container
96+
-p, --publish list Publish a container's port(s) to the host (format:
97+
<host address>:[<host port>]:<container port> or
98+
[<host port>:]<container port>)
99+
-P, --publish-all Publish all exposed ports to random ports
100+
--pull string Pull image before creating
101+
("always"|"missing"|"never") (default "missing")
102+
--read-only Mount the container's root filesystem as read only
103+
--restart string Restart policy to apply when a container exits
104+
(default "no")
105+
--rm Automatically remove the container when it exits
106+
--runtime string Runtime to use for this container
107+
--security-opt list Security Options
108+
--shm-size bytes Size of /dev/shm
109+
--stop-signal string Signal to stop the container
110+
--stop-timeout int Timeout (in seconds) to stop a container
111+
--storage-opt list Storage driver options for the container
112+
--sysctl map Sysctl options (default map[])
113+
--tmpfs list Mount a tmpfs directory
114+
-t, --tty Allocate a pseudo-TTY
115+
--ulimit ulimit Ulimit options (default [])
116+
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
117+
--userns string User namespace to use
118+
--uts string UTS namespace to use
119+
-v, --volume list Bind mount a volume (format: [<volume name|absolute
120+
host path>:]<absolute container path>[:<options>])
121+
--volume-driver string Optional volume driver for the container
122+
--volumes-from list Mount volumes from the specified container(s)
123+
-w, --workdir string Working directory inside the container
133124
```
134125

135126
## Description

0 commit comments

Comments
 (0)