mirror of https://github.com/docker/docs.git
1109 lines
30 KiB
YAML
1109 lines
30 KiB
YAML
command: docker container create
|
|
aliases: docker container create, docker create
|
|
short: Create a new container
|
|
long: |-
|
|
The `docker container create` (or shorthand: `docker create`) command creates a
|
|
new container from the specified image, without starting it.
|
|
|
|
When creating a container, the Docker daemon creates a writeable container layer
|
|
over the specified image and prepares it for running the specified command. The
|
|
container ID is then printed to `STDOUT`. This is similar to `docker run -d`
|
|
except the container is never started. You can then use the `docker container start`
|
|
(or shorthand: `docker start`) command to start the container at any point.
|
|
|
|
This is useful when you want to set up a container configuration ahead of time
|
|
so that it's ready to start when you need it. The initial status of the
|
|
new container is `created`.
|
|
|
|
The `docker create` command shares most of its options with the `docker run`
|
|
command (which performs a `docker create` before starting it).
|
|
Refer to the [`docker run` CLI reference](/reference/cli/docker/container/run/)
|
|
for details on the available flags and options.
|
|
usage: docker container create [OPTIONS] IMAGE [COMMAND] [ARG...]
|
|
pname: docker container
|
|
plink: docker_container.yaml
|
|
options:
|
|
- option: add-host
|
|
value_type: list
|
|
description: Add a custom host-to-IP mapping (host:ip)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: annotation
|
|
value_type: map
|
|
default_value: map[]
|
|
description: |
|
|
Add an annotation to the container (passed through to the OCI runtime)
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.43"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: attach
|
|
shorthand: a
|
|
value_type: list
|
|
description: Attach to STDIN, STDOUT or STDERR
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: blkio-weight
|
|
value_type: uint16
|
|
default_value: "0"
|
|
description: |
|
|
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: blkio-weight-device
|
|
value_type: list
|
|
default_value: '[]'
|
|
description: Block IO weight (relative device weight)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cap-add
|
|
value_type: list
|
|
description: Add Linux capabilities
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cap-drop
|
|
value_type: list
|
|
description: Drop Linux capabilities
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cgroup-parent
|
|
value_type: string
|
|
description: Optional parent cgroup for the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cgroupns
|
|
value_type: string
|
|
description: |-
|
|
Cgroup namespace to use (host|private)
|
|
'host': Run the container in the Docker host's cgroup namespace
|
|
'private': Run the container in its own private cgroup namespace
|
|
'': Use the cgroup namespace as configured by the
|
|
default-cgroupns-mode option on the daemon (default)
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.41"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cidfile
|
|
value_type: string
|
|
description: Write the container ID to the file
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpu-count
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: CPU count (Windows only)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
os_type: windows
|
|
- option: cpu-percent
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: CPU percent (Windows only)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
os_type: windows
|
|
- option: cpu-period
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: Limit CPU CFS (Completely Fair Scheduler) period
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpu-quota
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: Limit CPU CFS (Completely Fair Scheduler) quota
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpu-rt-period
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: Limit CPU real-time period in microseconds
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.25"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpu-rt-runtime
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: Limit CPU real-time runtime in microseconds
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.25"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpu-shares
|
|
shorthand: c
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: CPU shares (relative weight)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpus
|
|
value_type: decimal
|
|
description: Number of CPUs
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.25"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpuset-cpus
|
|
value_type: string
|
|
description: CPUs in which to allow execution (0-3, 0,1)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpuset-mems
|
|
value_type: string
|
|
description: MEMs in which to allow execution (0-3, 0,1)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: device
|
|
value_type: list
|
|
description: Add a host device to the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: device-cgroup-rule
|
|
value_type: list
|
|
description: Add a rule to the cgroup allowed devices list
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: device-read-bps
|
|
value_type: list
|
|
default_value: '[]'
|
|
description: Limit read rate (bytes per second) from a device
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: device-read-iops
|
|
value_type: list
|
|
default_value: '[]'
|
|
description: Limit read rate (IO per second) from a device
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: device-write-bps
|
|
value_type: list
|
|
default_value: '[]'
|
|
description: Limit write rate (bytes per second) to a device
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: device-write-iops
|
|
value_type: list
|
|
default_value: '[]'
|
|
description: Limit write rate (IO per second) to a device
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: disable-content-trust
|
|
value_type: bool
|
|
default_value: "true"
|
|
description: Skip image verification
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: dns
|
|
value_type: list
|
|
description: Set custom DNS servers
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: dns-opt
|
|
value_type: list
|
|
description: Set DNS options
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: dns-option
|
|
value_type: list
|
|
description: Set DNS options
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: dns-search
|
|
value_type: list
|
|
description: Set custom DNS search domains
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: domainname
|
|
value_type: string
|
|
description: Container NIS domain name
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: entrypoint
|
|
value_type: string
|
|
description: Overwrite the default ENTRYPOINT of the image
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: env
|
|
shorthand: e
|
|
value_type: list
|
|
description: Set environment variables
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: env-file
|
|
value_type: list
|
|
description: Read in a file of environment variables
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: expose
|
|
value_type: list
|
|
description: Expose a port or a range of ports
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: gpus
|
|
value_type: gpu-request
|
|
description: GPU devices to add to the container ('all' to pass all GPUs)
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.40"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: group-add
|
|
value_type: list
|
|
description: Add additional groups to join
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: health-cmd
|
|
value_type: string
|
|
description: Command to run to check health
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: health-interval
|
|
value_type: duration
|
|
default_value: 0s
|
|
description: Time between running the check (ms|s|m|h) (default 0s)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: health-retries
|
|
value_type: int
|
|
default_value: "0"
|
|
description: Consecutive failures needed to report unhealthy
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: health-start-interval
|
|
value_type: duration
|
|
default_value: 0s
|
|
description: |
|
|
Time between running the check during the start period (ms|s|m|h) (default 0s)
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.44"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: health-start-period
|
|
value_type: duration
|
|
default_value: 0s
|
|
description: |
|
|
Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.29"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: health-timeout
|
|
value_type: duration
|
|
default_value: 0s
|
|
description: Maximum time to allow one check to run (ms|s|m|h) (default 0s)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: help
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Print usage
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: hostname
|
|
shorthand: h
|
|
value_type: string
|
|
description: Container host name
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: init
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: |
|
|
Run an init inside the container that forwards signals and reaps processes
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.25"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: interactive
|
|
shorthand: i
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Keep STDIN open even if not attached
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: io-maxbandwidth
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Maximum IO bandwidth limit for the system drive (Windows only)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
os_type: windows
|
|
- option: io-maxiops
|
|
value_type: uint64
|
|
default_value: "0"
|
|
description: Maximum IOps limit for the system drive (Windows only)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
os_type: windows
|
|
- option: ip
|
|
value_type: string
|
|
description: IPv4 address (e.g., 172.30.100.104)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: ip6
|
|
value_type: string
|
|
description: IPv6 address (e.g., 2001:db8::33)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: ipc
|
|
value_type: string
|
|
description: IPC mode to use
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: isolation
|
|
value_type: string
|
|
description: Container isolation technology
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: kernel-memory
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Kernel memory limit
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: label
|
|
shorthand: l
|
|
value_type: list
|
|
description: Set meta data on a container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: label-file
|
|
value_type: list
|
|
description: Read in a line delimited file of labels
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: link
|
|
value_type: list
|
|
description: Add link to another container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: link-local-ip
|
|
value_type: list
|
|
description: Container IPv4/IPv6 link-local addresses
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: log-driver
|
|
value_type: string
|
|
description: Logging driver for the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: log-opt
|
|
value_type: list
|
|
description: Log driver options
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: mac-address
|
|
value_type: string
|
|
description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: memory
|
|
shorthand: m
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Memory limit
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: memory-reservation
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Memory soft limit
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: memory-swap
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: |
|
|
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: memory-swappiness
|
|
value_type: int64
|
|
default_value: "-1"
|
|
description: Tune container memory swappiness (0 to 100)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: mount
|
|
value_type: mount
|
|
description: Attach a filesystem mount to the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: name
|
|
value_type: string
|
|
description: Assign a name to the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: net
|
|
value_type: network
|
|
description: Connect a container to a network
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: net-alias
|
|
value_type: list
|
|
description: Add network-scoped alias for the container
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: network
|
|
value_type: network
|
|
description: Connect a container to a network
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: network-alias
|
|
value_type: list
|
|
description: Add network-scoped alias for the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: no-healthcheck
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Disable any container-specified HEALTHCHECK
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: oom-kill-disable
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Disable OOM Killer
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: oom-score-adj
|
|
value_type: int
|
|
default_value: "0"
|
|
description: Tune host's OOM preferences (-1000 to 1000)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: pid
|
|
value_type: string
|
|
description: PID namespace to use
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: pids-limit
|
|
value_type: int64
|
|
default_value: "0"
|
|
description: Tune container pids limit (set -1 for unlimited)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: platform
|
|
value_type: string
|
|
description: Set platform if server is multi-platform capable
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.32"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: privileged
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Give extended privileges to this container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: publish
|
|
shorthand: p
|
|
value_type: list
|
|
description: Publish a container's port(s) to the host
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: publish-all
|
|
shorthand: P
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Publish all exposed ports to random ports
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: pull
|
|
value_type: string
|
|
default_value: missing
|
|
description: Pull image before creating (`always`, `|missing`, `never`)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: quiet
|
|
shorthand: q
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Suppress the pull output
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: read-only
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Mount the container's root filesystem as read only
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: restart
|
|
value_type: string
|
|
default_value: "no"
|
|
description: Restart policy to apply when a container exits
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: rm
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: |
|
|
Automatically remove the container and its associated anonymous volumes when it exits
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: runtime
|
|
value_type: string
|
|
description: Runtime to use for this container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: security-opt
|
|
value_type: list
|
|
description: Security Options
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: shm-size
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Size of /dev/shm
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: stop-signal
|
|
value_type: string
|
|
description: Signal to stop the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: stop-timeout
|
|
value_type: int
|
|
default_value: "0"
|
|
description: Timeout (in seconds) to stop a container
|
|
deprecated: false
|
|
hidden: false
|
|
min_api_version: "1.25"
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: storage-opt
|
|
value_type: list
|
|
description: Storage driver options for the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: sysctl
|
|
value_type: map
|
|
default_value: map[]
|
|
description: Sysctl options
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: tmpfs
|
|
value_type: list
|
|
description: Mount a tmpfs directory
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: tty
|
|
shorthand: t
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Allocate a pseudo-TTY
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: ulimit
|
|
value_type: ulimit
|
|
default_value: '[]'
|
|
description: Ulimit options
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: user
|
|
shorthand: u
|
|
value_type: string
|
|
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: userns
|
|
value_type: string
|
|
description: User namespace to use
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: uts
|
|
value_type: string
|
|
description: UTS namespace to use
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: volume
|
|
shorthand: v
|
|
value_type: list
|
|
description: Bind mount a volume
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: volume-driver
|
|
value_type: string
|
|
description: Optional volume driver for the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: volumes-from
|
|
value_type: list
|
|
description: Mount volumes from the specified container(s)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: workdir
|
|
shorthand: w
|
|
value_type: string
|
|
description: Working directory inside the container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
examples: |-
|
|
### Create and start a container
|
|
|
|
The following example creates an interactive container with a pseudo-TTY attached,
|
|
then starts the container and attaches to it:
|
|
|
|
```console
|
|
$ docker container create -i -t --name mycontainer alpine
|
|
6d8af538ec541dd581ebc2a24153a28329acb5268abe5ef868c1f1a261221752
|
|
|
|
$ docker container start --attach -i mycontainer
|
|
/ # echo hello world
|
|
hello world
|
|
```
|
|
|
|
The above is the equivalent of a `docker run`:
|
|
|
|
```console
|
|
$ docker run -it --name mycontainer2 alpine
|
|
/ # echo hello world
|
|
hello world
|
|
```
|
|
|
|
### Initialize volumes
|
|
|
|
Container volumes are initialized during the `docker create` phase
|
|
(i.e., `docker run` too). For example, this allows you to `create` the `data`
|
|
volume container, and then use it from another container:
|
|
|
|
```console
|
|
$ docker create -v /data --name data ubuntu
|
|
|
|
240633dfbb98128fa77473d3d9018f6123b99c454b3251427ae190a7d951ad57
|
|
|
|
$ docker run --rm --volumes-from data ubuntu ls -la /data
|
|
|
|
total 8
|
|
drwxr-xr-x 2 root root 4096 Dec 5 04:10 .
|
|
drwxr-xr-x 48 root root 4096 Dec 5 04:11 ..
|
|
```
|
|
|
|
Similarly, `create` a host directory bind mounted volume container, which can
|
|
then be used from the subsequent container:
|
|
|
|
```console
|
|
$ docker create -v /home/docker:/docker --name docker ubuntu
|
|
|
|
9aa88c08f319cd1e4515c3c46b0de7cc9aa75e878357b1e96f91e2c773029f03
|
|
|
|
$ docker run --rm --volumes-from docker ubuntu ls -la /docker
|
|
|
|
total 20
|
|
drwxr-sr-x 5 1000 staff 180 Dec 5 04:00 .
|
|
drwxr-xr-x 48 root root 4096 Dec 5 04:13 ..
|
|
-rw-rw-r-- 1 1000 staff 3833 Dec 5 04:01 .ash_history
|
|
-rw-r--r-- 1 1000 staff 446 Nov 28 11:51 .ashrc
|
|
-rw-r--r-- 1 1000 staff 25 Dec 5 04:00 .gitconfig
|
|
drwxr-sr-x 3 1000 staff 60 Dec 1 03:28 .local
|
|
-rw-r--r-- 1 1000 staff 920 Nov 28 11:51 .profile
|
|
drwx--S--- 2 1000 staff 460 Dec 5 00:51 .ssh
|
|
drwxr-xr-x 32 1000 staff 1140 Dec 5 04:01 docker
|
|
```
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|