|
@@ -10,109 +10,120 @@ parent = "smn_cli"
|
|
|
|
|
|
# run
|
|
|
|
|
|
- Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
|
|
|
-
|
|
|
- Run a command in a new container
|
|
|
-
|
|
|
- -a, --attach=[] Attach to STDIN, STDOUT or STDERR
|
|
|
- --add-host=[] Add a custom host-to-IP mapping (host:ip)
|
|
|
- --blkio-weight=0 Block IO weight (relative weight)
|
|
|
- --blkio-weight-device=[] Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`)
|
|
|
- --cpu-shares=0 CPU shares (relative weight)
|
|
|
- --cap-add=[] Add Linux capabilities
|
|
|
- --cap-drop=[] Drop Linux capabilities
|
|
|
- --cgroup-parent="" Optional parent cgroup for the container
|
|
|
- --cidfile="" Write the container ID to the file
|
|
|
- --cpu-percent=0 Limit percentage of CPU available for execution by the container. Windows daemon only.
|
|
|
- --cpu-period=0 Limit CPU CFS (Completely Fair Scheduler) period
|
|
|
- --cpu-quota=0 Limit CPU CFS (Completely Fair Scheduler) quota
|
|
|
- --cpuset-cpus="" CPUs in which to allow execution (0-3, 0,1)
|
|
|
- --cpuset-mems="" Memory nodes (MEMs) in which to allow execution (0-3, 0,1)
|
|
|
- -d, --detach Run container in background and print container ID
|
|
|
- --detach-keys Specify the escape key sequence used to detach a container
|
|
|
- --device=[] Add a host device to the container
|
|
|
- --device-read-bps=[] Limit read rate (bytes per second) from a device (e.g., --device-read-bps=/dev/sda:1mb)
|
|
|
- --device-read-iops=[] Limit read rate (IO per second) from a device (e.g., --device-read-iops=/dev/sda:1000)
|
|
|
- --device-write-bps=[] Limit write rate (bytes per second) to a device (e.g., --device-write-bps=/dev/sda:1mb)
|
|
|
- --device-write-iops=[] Limit write rate (IO per second) to a device (e.g., --device-write-bps=/dev/sda:1000)
|
|
|
- --disable-content-trust=true Skip image verification
|
|
|
- --dns=[] Set custom DNS servers
|
|
|
- --dns-opt=[] Set custom DNS options
|
|
|
- --dns-search=[] Set custom DNS search domains
|
|
|
- -e, --env=[] Set environment variables
|
|
|
- --entrypoint="" Overwrite the default ENTRYPOINT of the image
|
|
|
- --env-file=[] Read in a file of environment variables
|
|
|
- --expose=[] Expose a port or a range of ports
|
|
|
- --group-add=[] Add additional groups to run as
|
|
|
- -h, --hostname="" Container host name
|
|
|
+```markdown
|
|
|
+Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
|
|
|
+
|
|
|
+Run a command in a new container
|
|
|
+
|
|
|
+Options:
|
|
|
+ --add-host value Add a custom host-to-IP mapping (host:ip) (default [])
|
|
|
+ -a, --attach value Attach to STDIN, STDOUT or STDERR (default [])
|
|
|
+ --blkio-weight value Block IO (relative weight), between 10 and 1000
|
|
|
+ --blkio-weight-device value Block IO weight (relative device weight) (default [])
|
|
|
+ --cap-add value Add Linux capabilities (default [])
|
|
|
+ --cap-drop value Drop Linux capabilities (default [])
|
|
|
+ --cgroup-parent string Optional parent cgroup for the container
|
|
|
+ --cidfile string Write the container ID to the file
|
|
|
+ --cpu-percent int CPU percent (Windows only)
|
|
|
+ --cpu-period int Limit CPU CFS (Completely Fair Scheduler) period
|
|
|
+ --cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota
|
|
|
+ -c, --cpu-shares int CPU shares (relative weight)
|
|
|
+ --cpuset-cpus string CPUs in which to allow execution (0-3, 0,1)
|
|
|
+ --cpuset-mems string MEMs in which to allow execution (0-3, 0,1)
|
|
|
+ -d, --detach Run container in background and print container ID
|
|
|
+ --detach-keys string Override the key sequence for detaching a container
|
|
|
+ --device value Add a host device to the container (default [])
|
|
|
+ --device-read-bps value Limit read rate (bytes per second) from a device (default [])
|
|
|
+ --device-read-iops value Limit read rate (IO per second) from a device (default [])
|
|
|
+ --device-write-bps value Limit write rate (bytes per second) to a device (default [])
|
|
|
+ --device-write-iops value Limit write rate (IO per second) to a device (default [])
|
|
|
+ --disable-content-trust Skip image verification (default true)
|
|
|
+ --dns value Set custom DNS servers (default [])
|
|
|
+ --dns-opt value Set DNS options (default [])
|
|
|
+ --dns-search value Set custom DNS search domains (default [])
|
|
|
+ --entrypoint string Overwrite the default ENTRYPOINT of the image
|
|
|
+ -e, --env value Set environment variables (default [])
|
|
|
+ --env-file value Read in a file of environment variables (default [])
|
|
|
+ --expose value Expose a port or a range of ports (default [])
|
|
|
+ --group-add value Add additional groups to join (default [])
|
|
|
+ --health-cmd string Command to run to check health
|
|
|
+ --health-interval duration Time between running the check
|
|
|
+ --health-retries int Consecutive failures needed to report unhealthy
|
|
|
+ --health-timeout duration Maximum time to allow one check to run
|
|
|
--help Print usage
|
|
|
- -i, --interactive Keep STDIN open even if not attached
|
|
|
- --ip="" Container IPv4 address (e.g. 172.30.100.104)
|
|
|
- --ip6="" Container IPv6 address (e.g. 2001:db8::33)
|
|
|
- --ipc="" IPC namespace to use
|
|
|
- --isolation="" Container isolation technology
|
|
|
- --kernel-memory="" Kernel memory limit
|
|
|
- -l, --label=[] Set metadata on the container (e.g., --label=com.example.key=value)
|
|
|
- --label-file=[] Read in a file of labels (EOL delimited)
|
|
|
- --link=[] Add link to another container
|
|
|
- --link-local-ip=[] Container IPv4/IPv6 link-local addresses (e.g. 169.254.0.77, fe80::77)
|
|
|
- --log-driver="" Logging driver for container
|
|
|
- --log-opt=[] Log driver specific options
|
|
|
- -m, --memory="" Memory limit
|
|
|
- --mac-address="" Container MAC address (e.g. 92:d0:c6:0a:29:33)
|
|
|
- --io-maxbandwidth="" Maximum IO bandwidth limit for the system drive
|
|
|
+ -h, --hostname string Container host name
|
|
|
+ -i, --interactive Keep STDIN open even if not attached
|
|
|
+ --io-maxbandwidth string Maximum IO bandwidth limit for the system drive (Windows only)
|
|
|
(Windows only). The format is `<number><unit>`.
|
|
|
Unit is optional and can be `b` (bytes per second),
|
|
|
`k` (kilobytes per second), `m` (megabytes per second),
|
|
|
or `g` (gigabytes per second). If you omit the unit,
|
|
|
the system uses bytes per second.
|
|
|
--io-maxbandwidth and --io-maxiops are mutually exclusive options.
|
|
|
- --io-maxiops=0 Maximum IO per second limit for the system drive (Windows only).
|
|
|
- --io-maxbandwidth and --io-maxiops are mutually exclusive options.
|
|
|
- --memory-reservation="" Memory soft limit
|
|
|
- --memory-swap="" A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap.
|
|
|
- --memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
|
|
|
- --name="" Assign a name to the container
|
|
|
- --net="bridge" Connect a container to a network
|
|
|
+ --io-maxiops uint Maximum IOps limit for the system drive (Windows only)
|
|
|
+ --ip string Container IPv4 address (e.g. 172.30.100.104)
|
|
|
+ --ip6 string Container IPv6 address (e.g. 2001:db8::33)
|
|
|
+ --ipc string IPC namespace to use
|
|
|
+ --isolation string Container isolation technology
|
|
|
+ --kernel-memory string Kernel memory limit
|
|
|
+ -l, --label value Set meta data on a container (default [])
|
|
|
+ --label-file value Read in a line delimited file of labels (default [])
|
|
|
+ --link value Add link to another container (default [])
|
|
|
+ --link-local-ip value Container IPv4/IPv6 link-local addresses (default [])
|
|
|
+ --log-driver string Logging driver for container
|
|
|
+ --log-opt value Log driver options (default [])
|
|
|
+ --mac-address string Container MAC address (e.g. 92:d0:c6:0a:29:33)
|
|
|
+ -m, --memory string Memory limit
|
|
|
+ --memory-reservation string Memory soft limit
|
|
|
+ --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap
|
|
|
+ --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1).
|
|
|
+ --name string Assign a name to the container
|
|
|
+ --net string Connect a container to a network (default "default")
|
|
|
'bridge': create a network stack on the default Docker bridge
|
|
|
'none': no networking
|
|
|
'container:<name|id>': reuse another container's network stack
|
|
|
'host': use the Docker host network stack
|
|
|
'<network-name>|<network-id>': connect to a user-defined network
|
|
|
- --net-alias=[] Add network-scoped alias for the container
|
|
|
- --oom-kill-disable Whether to disable OOM Killer for the container or not
|
|
|
- --oom-score-adj=0 Tune the host's OOM preferences for containers (accepts -1000 to 1000)
|
|
|
- -P, --publish-all Publish all exposed ports to random ports
|
|
|
- -p, --publish=[] Publish a container's port(s) to the host
|
|
|
- --pid="" PID namespace to use
|
|
|
- --pids-limit=-1 Tune container pids limit (set -1 for unlimited), kernel >= 4.3
|
|
|
+ --net-alias value Add network-scoped alias for the container (default [])
|
|
|
+ --no-healthcheck Disable any container-specified HEALTHCHECK
|
|
|
+ --oom-kill-disable Disable OOM Killer
|
|
|
+ --oom-score-adj int Tune host's OOM preferences (-1000 to 1000)
|
|
|
+ --pid string PID namespace to use
|
|
|
+ --pids-limit int Tune container pids limit (set -1 for unlimited)
|
|
|
--privileged Give extended privileges to this container
|
|
|
+ -p, --publish value Publish a container's port(s) to the host (default [])
|
|
|
+ -P, --publish-all Publish all exposed ports to random ports
|
|
|
--read-only Mount the container's root filesystem as read only
|
|
|
- --restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped)
|
|
|
+ --restart string Restart policy to apply when a container exits (default "no")
|
|
|
+ Possible values are : no, on-failuer[:max-retry], always, unless-stopped
|
|
|
--rm Automatically remove the container when it exits
|
|
|
- --runtime="" Name of the runtime to be used for that container
|
|
|
- --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`.
|
|
|
- --security-opt=[] Security Options
|
|
|
- --sig-proxy=true Proxy received signals to the process
|
|
|
- --stop-signal="SIGTERM" Signal to stop a container
|
|
|
- --storage-opt=[] Set storage driver options per container
|
|
|
- --sysctl[=*[]*]] Configure namespaced kernel parameters at runtime
|
|
|
- -t, --tty Allocate a pseudo-TTY
|
|
|
- -u, --user="" Username or UID (format: <name|uid>[:<group|gid>])
|
|
|
- --userns="" Container user namespace
|
|
|
+ --runtime string Runtime to use for this container
|
|
|
+ --security-opt value Security Options (default [])
|
|
|
+ --shm-size string Size of /dev/shm, default value is 64MB.
|
|
|
+ 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.
|
|
|
+ --sig-proxy Proxy received signals to the process (default true)
|
|
|
+ --stop-signal string Signal to stop a container, SIGTERM by default (default "SIGTERM")
|
|
|
+ --storage-opt value Set storage driver options per container (default [])
|
|
|
+ --sysctl value Sysctl options (default map[])
|
|
|
+ --tmpfs value Mount a tmpfs directory (default [])
|
|
|
+ -t, --tty Allocate a pseudo-TTY
|
|
|
+ --ulimit value Ulimit options (default [])
|
|
|
+ -u, --user string Username or UID (format: <name|uid>[:<group|gid>])
|
|
|
+ --userns string User namespace to use
|
|
|
'host': Use the Docker host user namespace
|
|
|
'': Use the Docker daemon user namespace specified by `--userns-remap` option.
|
|
|
- --ulimit=[] Ulimit options
|
|
|
- --uts="" UTS namespace to use
|
|
|
- -v, --volume=[host-src:]container-dest[:<options>]
|
|
|
- Bind mount a volume. The comma-delimited
|
|
|
+ --uts string UTS namespace to use
|
|
|
+ -v, --volume value Bind mount a volume (default []). The comma-delimited
|
|
|
`options` are [rw|ro], [z|Z],
|
|
|
[[r]shared|[r]slave|[r]private], and
|
|
|
[nocopy]. The 'host-src' is an absolute path
|
|
|
or a name value.
|
|
|
- --volume-driver="" Container's volume driver
|
|
|
- --volumes-from=[] Mount volumes from the specified container(s)
|
|
|
- -w, --workdir="" Working directory inside the container
|
|
|
+ --volume-driver string Optional volume driver for the container
|
|
|
+ --volumes-from value Mount volumes from the specified container(s) (default [])
|
|
|
+ -w, --workdir string Working directory inside the container
|
|
|
+```
|
|
|
|
|
|
The `docker run` command first `creates` a writeable container layer over the
|
|
|
specified image, and then `starts` it using the specified command. That is,
|