create

Create a new container

Aliases

docker container create, docker create

Options

NameTypeDefaultDescription
--add-hostlistAdd a custom host-to-IP mapping (host:ip)
--annotationmapmap[]Add an annotation to the container (passed through to the OCI runtime)
-a, --attachlistAttach to STDIN, STDOUT or STDERR
--blkio-weightuint160Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
--blkio-weight-devicelistBlock IO weight (relative device weight)
--cap-addlistAdd Linux capabilities
--cap-droplistDrop Linux capabilities
--cgroup-parentstringOptional parent cgroup for the container
--cgroupnsstringCgroup 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)
--cidfilestringWrite the container ID to the file
--cpu-countint640CPU count (Windows only)
--cpu-percentint640CPU percent (Windows only)
--cpu-periodint640Limit CPU CFS (Completely Fair Scheduler) period
--cpu-quotaint640Limit CPU CFS (Completely Fair Scheduler) quota
--cpu-rt-periodint640Limit CPU real-time period in microseconds
--cpu-rt-runtimeint640Limit CPU real-time runtime in microseconds
-c, --cpu-sharesint640CPU shares (relative weight)
--cpusdecimalNumber of CPUs
--cpuset-cpusstringCPUs in which to allow execution (0-3, 0,1)
--cpuset-memsstringMEMs in which to allow execution (0-3, 0,1)
--devicelistAdd a host device to the container
--device-cgroup-rulelistAdd a rule to the cgroup allowed devices list
--device-read-bpslistLimit read rate (bytes per second) from a device
--device-read-iopslistLimit read rate (IO per second) from a device
--device-write-bpslistLimit write rate (bytes per second) to a device
--device-write-iopslistLimit write rate (IO per second) to a device
--disable-content-trustbooltrueSkip image verification
--dnslistSet custom DNS servers
--dns-optionlistSet DNS options
--dns-searchlistSet custom DNS search domains
--domainnamestringContainer NIS domain name
--entrypointstringOverwrite the default ENTRYPOINT of the image
-e, --envlistSet environment variables
--env-filelistRead in a file of environment variables
--exposelistExpose a port or a range of ports
--gpusgpu-requestGPU devices to add to the container (‘all’ to pass all GPUs)
--group-addlistAdd additional groups to join
--health-cmdstringCommand to run to check health
--health-intervalduration0sTime between running the check (ms|s|m|h) (default 0s)
--health-retriesint0Consecutive failures needed to report unhealthy
--health-start-intervalduration0sTime between running the check during the start period (ms|s|m|h) (default 0s)
--health-start-periodduration0sStart period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)
--health-timeoutduration0sMaximum time to allow one check to run (ms|s|m|h) (default 0s)
--helpboolPrint usage
-h, --hostnamestringContainer host name
--initboolRun an init inside the container that forwards signals and reaps processes
-i, --interactiveboolKeep STDIN open even if not attached
--io-maxbandwidthbytes0Maximum IO bandwidth limit for the system drive (Windows only)
--io-maxiopsuint640Maximum IOps limit for the system drive (Windows only)
--ipstringIPv4 address (e.g., 172.30.100.104)
--ip6stringIPv6 address (e.g., 2001:db8::33)
--ipcstringIPC mode to use
--isolationstringContainer isolation technology
--kernel-memorybytes0Kernel memory limit
-l, --labellistSet meta data on a container
--label-filelistRead in a line delimited file of labels
--linklistAdd link to another container
--link-local-iplistContainer IPv4/IPv6 link-local addresses
--log-driverstringLogging driver for the container
--log-optlistLog driver options
--mac-addressstringContainer MAC address (e.g., 92:d0:c6:0a:29:33)
-m, --memorybytes0Memory limit
--memory-reservationbytes0Memory soft limit
--memory-swapbytes0Swap limit equal to memory plus swap: ‘-1’ to enable unlimited swap
--memory-swappinessint64-1Tune container memory swappiness (0 to 100)
--mountmountAttach a filesystem mount to the container
--namestringAssign a name to the container
--networknetworkConnect a container to a network
--network-aliaslistAdd network-scoped alias for the container
--no-healthcheckboolDisable any container-specified HEALTHCHECK
--oom-kill-disableboolDisable OOM Killer
--oom-score-adjint0Tune host's OOM preferences (-1000 to 1000)
--pidstringPID namespace to use
--pids-limitint640Tune container pids limit (set -1 for unlimited)
--platformstringSet platform if server is multi-platform capable
--privilegedboolGive extended privileges to this container
-p, --publishlistPublish a container's port(s) to the host
-P, --publish-allboolPublish all exposed ports to random ports
--pullstringmissingPull image before creating (always, |missing, never)
-q, --quietboolSuppress the pull output
--read-onlyboolMount the container's root filesystem as read only
--restartstringnoRestart policy to apply when a container exits
--rmboolAutomatically remove the container and its associated anonymous volumes when it exits
--runtimestringRuntime to use for this container
--security-optlistSecurity Options
--shm-sizebytes0Size of /dev/shm
--stop-signalstringSignal to stop the container
--stop-timeoutint0Timeout (in seconds) to stop a container
--storage-optlistStorage driver options for the container
--sysctlmapmap[]Sysctl options
--tmpfslistMount a tmpfs directory
-t, --ttyboolAllocate a pseudo-TTY
--ulimitulimitUlimit options
--use-api-socketboolBind mount Docker API socket and required auth
-u, --userstringUsername or UID (format: <name|uid>[:<group|gid>])
--usernsstringUser namespace to use
--utsstringUTS namespace to use
-v, --volumelistBind mount a volume
--volume-driverstringOptional volume driver for the container
--volumes-fromlistMount volumes from the specified container(s)
-w, --workdirstringWorking directory inside the container

Description

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 for details on the available flags and options.

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:

$ 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:

$ 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:

$ 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:

$ 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