mirror of https://github.com/docker/docs.git
274 lines
8.5 KiB
YAML
274 lines
8.5 KiB
YAML
command: docker container run
|
|
short: Run a command in a new container
|
|
long: Run a command in a new container
|
|
usage: docker container run [OPTIONS] IMAGE [COMMAND] [ARG...]
|
|
pname: docker container
|
|
plink: docker_container.yaml
|
|
options:
|
|
- option: add-host
|
|
description: Add a custom host-to-IP mapping (host:ip)
|
|
- option: attach
|
|
shorthand: a
|
|
description: Attach to STDIN, STDOUT or STDERR
|
|
- option: blkio-weight
|
|
default_value: "0"
|
|
description: |
|
|
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
|
|
- option: blkio-weight-device
|
|
default_value: '[]'
|
|
description: Block IO weight (relative device weight)
|
|
- option: cap-add
|
|
description: Add Linux capabilities
|
|
- option: cap-drop
|
|
description: Drop Linux capabilities
|
|
- option: cgroup-parent
|
|
description: Optional parent cgroup for the container
|
|
- option: cidfile
|
|
description: Write the container ID to the file
|
|
- option: cpu-count
|
|
default_value: "0"
|
|
description: CPU count (Windows only)
|
|
- option: cpu-percent
|
|
default_value: "0"
|
|
description: CPU percent (Windows only)
|
|
- option: cpu-period
|
|
default_value: "0"
|
|
description: Limit CPU CFS (Completely Fair Scheduler) period
|
|
- option: cpu-quota
|
|
default_value: "0"
|
|
description: Limit CPU CFS (Completely Fair Scheduler) quota
|
|
- option: cpu-rt-period
|
|
default_value: "0"
|
|
description: Limit CPU real-time period in microseconds
|
|
- option: cpu-rt-runtime
|
|
default_value: "0"
|
|
description: Limit CPU real-time runtime in microseconds
|
|
- option: cpu-shares
|
|
shorthand: c
|
|
default_value: "0"
|
|
description: CPU shares (relative weight)
|
|
- option: cpus
|
|
description: Number of CPUs
|
|
- option: cpuset-cpus
|
|
description: CPUs in which to allow execution (0-3, 0,1)
|
|
- option: cpuset-mems
|
|
description: MEMs in which to allow execution (0-3, 0,1)
|
|
- option: detach
|
|
shorthand: d
|
|
default_value: "false"
|
|
description: Run container in background and print container ID
|
|
- option: detach-keys
|
|
description: Override the key sequence for detaching a container
|
|
- option: device
|
|
description: Add a host device to the container
|
|
- option: device-cgroup-rule
|
|
description: Add a rule to the cgroup allowed devices list
|
|
- option: device-read-bps
|
|
default_value: '[]'
|
|
description: Limit read rate (bytes per second) from a device
|
|
- option: device-read-iops
|
|
default_value: '[]'
|
|
description: Limit read rate (IO per second) from a device
|
|
- option: device-write-bps
|
|
default_value: '[]'
|
|
description: Limit write rate (bytes per second) to a device
|
|
- option: device-write-iops
|
|
default_value: '[]'
|
|
description: Limit write rate (IO per second) to a device
|
|
- option: disable-content-trust
|
|
default_value: "true"
|
|
description: Skip image verification
|
|
- option: dns
|
|
description: Set custom DNS servers
|
|
- option: dns-opt
|
|
description: Set DNS options
|
|
- option: dns-option
|
|
description: Set DNS options
|
|
- option: dns-search
|
|
description: Set custom DNS search domains
|
|
- option: entrypoint
|
|
description: Overwrite the default ENTRYPOINT of the image
|
|
- option: env
|
|
shorthand: e
|
|
description: Set environment variables
|
|
- option: env-file
|
|
description: Read in a file of environment variables
|
|
- option: expose
|
|
description: Expose a port or a range of ports
|
|
- option: group-add
|
|
description: Add additional groups to join
|
|
- option: health-cmd
|
|
description: Command to run to check health
|
|
- option: health-interval
|
|
default_value: 0s
|
|
description: Time between running the check (ns|us|ms|s|m|h) (default 0s)
|
|
- option: health-retries
|
|
default_value: "0"
|
|
description: Consecutive failures needed to report unhealthy
|
|
- option: health-start-period
|
|
default_value: 0s
|
|
description: |
|
|
Start period for the container to initialize before starting health-retries countdown (ns|us|ms|s|m|h) (default 0s)
|
|
- option: health-timeout
|
|
default_value: 0s
|
|
description: |
|
|
Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s)
|
|
- option: help
|
|
default_value: "false"
|
|
description: Print usage
|
|
- option: hostname
|
|
shorthand: h
|
|
description: Container host name
|
|
- option: init
|
|
default_value: "false"
|
|
description: |
|
|
Run an init inside the container that forwards signals and reaps processes
|
|
- option: init-path
|
|
description: Path to the docker-init binary
|
|
- option: interactive
|
|
shorthand: i
|
|
default_value: "false"
|
|
description: Keep STDIN open even if not attached
|
|
- option: io-maxbandwidth
|
|
default_value: "0"
|
|
description: |
|
|
Maximum IO bandwidth limit for the system drive (Windows only)
|
|
- option: io-maxiops
|
|
default_value: "0"
|
|
description: Maximum IOps limit for the system drive (Windows only)
|
|
- option: ip
|
|
description: IPv4 address (e.g., 172.30.100.104)
|
|
- option: ip6
|
|
description: IPv6 address (e.g., 2001:db8::33)
|
|
- option: ipc
|
|
description: IPC namespace to use
|
|
- option: isolation
|
|
description: Container isolation technology
|
|
- option: kernel-memory
|
|
default_value: "0"
|
|
description: Kernel memory limit
|
|
- option: label
|
|
shorthand: l
|
|
description: Set meta data on a container
|
|
- option: label-file
|
|
description: Read in a line delimited file of labels
|
|
- option: link
|
|
description: Add link to another container
|
|
- option: link-local-ip
|
|
description: Container IPv4/IPv6 link-local addresses
|
|
- option: log-driver
|
|
description: Logging driver for the container
|
|
- option: log-opt
|
|
description: Log driver options
|
|
- option: mac-address
|
|
description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
|
|
- option: memory
|
|
shorthand: m
|
|
default_value: "0"
|
|
description: Memory limit
|
|
- option: memory-reservation
|
|
default_value: "0"
|
|
description: Memory soft limit
|
|
- option: memory-swap
|
|
default_value: "0"
|
|
description: |
|
|
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
|
|
- option: memory-swappiness
|
|
default_value: "-1"
|
|
description: Tune container memory swappiness (0 to 100)
|
|
- option: mount
|
|
description: Attach a filesystem mount to the container
|
|
- option: name
|
|
description: Assign a name to the container
|
|
- option: net
|
|
default_value: default
|
|
description: Connect a container to a network
|
|
- option: net-alias
|
|
description: Add network-scoped alias for the container
|
|
- option: network
|
|
default_value: default
|
|
description: Connect a container to a network
|
|
- option: network-alias
|
|
description: Add network-scoped alias for the container
|
|
- option: no-healthcheck
|
|
default_value: "false"
|
|
description: Disable any container-specified HEALTHCHECK
|
|
- option: oom-kill-disable
|
|
default_value: "false"
|
|
description: Disable OOM Killer
|
|
- option: oom-score-adj
|
|
default_value: "0"
|
|
description: Tune host's OOM preferences (-1000 to 1000)
|
|
- option: pid
|
|
description: PID namespace to use
|
|
- option: pids-limit
|
|
default_value: "0"
|
|
description: Tune container pids limit (set -1 for unlimited)
|
|
- option: privileged
|
|
default_value: "false"
|
|
description: Give extended privileges to this container
|
|
- option: publish
|
|
shorthand: p
|
|
description: Publish a container's port(s) to the host
|
|
- option: publish-all
|
|
shorthand: P
|
|
default_value: "false"
|
|
description: Publish all exposed ports to random ports
|
|
- option: read-only
|
|
default_value: "false"
|
|
description: Mount the container's root filesystem as read only
|
|
- option: restart
|
|
default_value: "no"
|
|
description: Restart policy to apply when a container exits
|
|
- option: rm
|
|
default_value: "false"
|
|
description: Automatically remove the container when it exits
|
|
- option: runtime
|
|
description: Runtime to use for this container
|
|
- option: security-opt
|
|
description: Security Options
|
|
- option: shm-size
|
|
default_value: "0"
|
|
description: Size of /dev/shm
|
|
- option: sig-proxy
|
|
default_value: "true"
|
|
description: Proxy received signals to the process
|
|
- option: stop-signal
|
|
default_value: SIGTERM
|
|
description: Signal to stop a container
|
|
- option: stop-timeout
|
|
default_value: "0"
|
|
description: Timeout (in seconds) to stop a container
|
|
- option: storage-opt
|
|
description: Storage driver options for the container
|
|
- option: sysctl
|
|
default_value: map[]
|
|
description: Sysctl options
|
|
- option: tmpfs
|
|
description: Mount a tmpfs directory
|
|
- option: tty
|
|
shorthand: t
|
|
default_value: "false"
|
|
description: Allocate a pseudo-TTY
|
|
- option: ulimit
|
|
default_value: '[]'
|
|
description: Ulimit options
|
|
- option: user
|
|
shorthand: u
|
|
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
|
|
- option: userns
|
|
description: User namespace to use
|
|
- option: uts
|
|
description: UTS namespace to use
|
|
- option: volume
|
|
shorthand: v
|
|
description: Bind mount a volume
|
|
- option: volume-driver
|
|
description: Optional volume driver for the container
|
|
- option: volumes-from
|
|
description: Mount volumes from the specified container(s)
|
|
- option: workdir
|
|
shorthand: w
|
|
description: Working directory inside the container
|
|
|