github.com/olljanat/moby@v1.13.1/docs/reference/commandline/create.md (about) 1 --- 2 title: "create" 3 description: "The create command description and usage" 4 keywords: "docker, create, container" 5 --- 6 7 <!-- This file is maintained within the docker/docker Github 8 repository at https://github.com/docker/docker/. Make all 9 pull requests against that repo. If you see this file in 10 another repository, consider it read-only there, as it will 11 periodically be overwritten by the definitive file. Pull 12 requests which include edits to this file in other repositories 13 will be rejected. 14 --> 15 16 # create 17 18 Creates a new container. 19 20 ```markdown 21 Usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...] 22 23 Create a new container 24 25 Options: 26 --add-host value Add a custom host-to-IP mapping (host:ip) (default []) 27 -a, --attach value Attach to STDIN, STDOUT or STDERR (default []) 28 --blkio-weight value Block IO (relative weight), between 10 and 1000 29 --blkio-weight-device value Block IO weight (relative device weight) (default []) 30 --cap-add value Add Linux capabilities (default []) 31 --cap-drop value Drop Linux capabilities (default []) 32 --cgroup-parent string Optional parent cgroup for the container 33 --cidfile string Write the container ID to the file 34 --cpu-count int The number of CPUs available for execution by the container. 35 Windows daemon only. On Windows Server containers, this is 36 approximated as a percentage of total CPU usage. 37 --cpu-percent int CPU percent (Windows only) 38 --cpu-period int Limit CPU CFS (Completely Fair Scheduler) period 39 --cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota 40 -c, --cpu-shares int CPU shares (relative weight) 41 --cpus NanoCPUs Number of CPUs (default 0.000) 42 --cpu-rt-period int Limit the CPU real-time period in microseconds 43 --cpu-rt-runtime int Limit the CPU real-time runtime in microseconds 44 --cpuset-cpus string CPUs in which to allow execution (0-3, 0,1) 45 --cpuset-mems string MEMs in which to allow execution (0-3, 0,1) 46 --device value Add a host device to the container (default []) 47 --device-read-bps value Limit read rate (bytes per second) from a device (default []) 48 --device-read-iops value Limit read rate (IO per second) from a device (default []) 49 --device-write-bps value Limit write rate (bytes per second) to a device (default []) 50 --device-write-iops value Limit write rate (IO per second) to a device (default []) 51 --disable-content-trust Skip image verification (default true) 52 --dns value Set custom DNS servers (default []) 53 --dns-option value Set DNS options (default []) 54 --dns-search value Set custom DNS search domains (default []) 55 --entrypoint string Overwrite the default ENTRYPOINT of the image 56 -e, --env value Set environment variables (default []) 57 --env-file value Read in a file of environment variables (default []) 58 --expose value Expose a port or a range of ports (default []) 59 --group-add value Add additional groups to join (default []) 60 --health-cmd string Command to run to check health 61 --health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) 62 --health-retries int Consecutive failures needed to report unhealthy 63 --health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) 64 --help Print usage 65 -h, --hostname string Container host name 66 --init Run an init inside the container that forwards signals and reaps processes 67 --init-path string Path to the docker-init binary 68 -i, --interactive Keep STDIN open even if not attached 69 --io-maxbandwidth string Maximum IO bandwidth limit for the system drive (Windows only) 70 --io-maxiops uint Maximum IOps limit for the system drive (Windows only) 71 --ip string Container IPv4 address (e.g. 172.30.100.104) 72 --ip6 string Container IPv6 address (e.g. 2001:db8::33) 73 --ipc string IPC namespace to use 74 --isolation string Container isolation technology 75 --kernel-memory string Kernel memory limit 76 -l, --label value Set meta data on a container (default []) 77 --label-file value Read in a line delimited file of labels (default []) 78 --link value Add link to another container (default []) 79 --link-local-ip value Container IPv4/IPv6 link-local addresses (default []) 80 --log-driver string Logging driver for the container 81 --log-opt value Log driver options (default []) 82 --mac-address string Container MAC address (e.g. 92:d0:c6:0a:29:33) 83 -m, --memory string Memory limit 84 --memory-reservation string Memory soft limit 85 --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap 86 --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) 87 --name string Assign a name to the container 88 --network-alias value Add network-scoped alias for the container (default []) 89 --network string Connect a container to a network (default "default") 90 'bridge': create a network stack on the default Docker bridge 91 'none': no networking 92 'container:<name|id>': reuse another container's network stack 93 'host': use the Docker host network stack 94 '<network-name>|<network-id>': connect to a user-defined network 95 --no-healthcheck Disable any container-specified HEALTHCHECK 96 --oom-kill-disable Disable OOM Killer 97 --oom-score-adj int Tune host's OOM preferences (-1000 to 1000) 98 --pid string PID namespace to use 99 --pids-limit int Tune container pids limit (set -1 for unlimited), kernel >= 4.3 100 --privileged Give extended privileges to this container 101 -p, --publish value Publish a container's port(s) to the host (default []) 102 -P, --publish-all Publish all exposed ports to random ports 103 --read-only Mount the container's root filesystem as read only 104 --restart string Restart policy to apply when a container exits (default "no") 105 Possible values are: no, on-failure[:max-retry], always, unless-stopped 106 --rm Automatically remove the container when it exits 107 --runtime string Runtime to use for this container 108 --security-opt value Security Options (default []) 109 --shm-size string Size of /dev/shm, default value is 64MB. 110 The format is `<number><unit>`. `number` must be greater than `0`. 111 Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), 112 or `g` (gigabytes). If you omit the unit, the system uses bytes. 113 --stop-signal string Signal to stop a container, SIGTERM by default (default "SIGTERM") 114 --stop-timeout=10 Timeout (in seconds) to stop a container 115 --storage-opt value Storage driver options for the container (default []) 116 --sysctl value Sysctl options (default map[]) 117 --tmpfs value Mount a tmpfs directory (default []) 118 -t, --tty Allocate a pseudo-TTY 119 --ulimit value Ulimit options (default []) 120 -u, --user string Username or UID (format: <name|uid>[:<group|gid>]) 121 --userns string User namespace to use 122 'host': Use the Docker host user namespace 123 '': Use the Docker daemon user namespace specified by `--userns-remap` option. 124 --uts string UTS namespace to use 125 -v, --volume value Bind mount a volume (default []). The format 126 is `[host-src:]container-dest[:<options>]`. 127 The comma-delimited `options` are [rw|ro], 128 [z|Z], [[r]shared|[r]slave|[r]private], and 129 [nocopy]. The 'host-src' is an absolute path 130 or a name value. 131 --volume-driver string Optional volume driver for the container 132 --volumes-from value Mount volumes from the specified container(s) (default []) 133 -w, --workdir string Working directory inside the container 134 ``` 135 136 The `docker create` command creates a writeable container layer over the 137 specified image and prepares it for running the specified command. The 138 container ID is then printed to `STDOUT`. This is similar to `docker run -d` 139 except the container is never started. You can then use the 140 `docker start <container_id>` command to start the container at any point. 141 142 This is useful when you want to set up a container configuration ahead of time 143 so that it is ready to start when you need it. The initial status of the 144 new container is `created`. 145 146 Please see the [run command](run.md) section and the [Docker run reference](../run.md) for more details. 147 148 ## Examples 149 150 $ docker create -t -i fedora bash 151 6d8af538ec541dd581ebc2a24153a28329acb5268abe5ef868c1f1a261221752 152 $ docker start -a -i 6d8af538ec5 153 bash-4.2# 154 155 As of v1.4.0 container volumes are initialized during the `docker create` phase 156 (i.e., `docker run` too). For example, this allows you to `create` the `data` 157 volume container, and then use it from another container: 158 159 $ docker create -v /data --name data ubuntu 160 240633dfbb98128fa77473d3d9018f6123b99c454b3251427ae190a7d951ad57 161 $ docker run --rm --volumes-from data ubuntu ls -la /data 162 total 8 163 drwxr-xr-x 2 root root 4096 Dec 5 04:10 . 164 drwxr-xr-x 48 root root 4096 Dec 5 04:11 .. 165 166 Similarly, `create` a host directory bind mounted volume container, which can 167 then be used from the subsequent container: 168 169 $ docker create -v /home/docker:/docker --name docker ubuntu 170 9aa88c08f319cd1e4515c3c46b0de7cc9aa75e878357b1e96f91e2c773029f03 171 $ docker run --rm --volumes-from docker ubuntu ls -la /docker 172 total 20 173 drwxr-sr-x 5 1000 staff 180 Dec 5 04:00 . 174 drwxr-xr-x 48 root root 4096 Dec 5 04:13 .. 175 -rw-rw-r-- 1 1000 staff 3833 Dec 5 04:01 .ash_history 176 -rw-r--r-- 1 1000 staff 446 Nov 28 11:51 .ashrc 177 -rw-r--r-- 1 1000 staff 25 Dec 5 04:00 .gitconfig 178 drwxr-sr-x 3 1000 staff 60 Dec 1 03:28 .local 179 -rw-r--r-- 1 1000 staff 920 Nov 28 11:51 .profile 180 drwx--S--- 2 1000 staff 460 Dec 5 00:51 .ssh 181 drwxr-xr-x 32 1000 staff 1140 Dec 5 04:01 docker 182 183 Set storage driver options per container. 184 185 $ docker create -it --storage-opt size=120G fedora /bin/bash 186 187 This (size) will allow to set the container rootfs size to 120G at creation time. 188 This option is only available for the `devicemapper`, `btrfs`, `overlay2`, 189 `windowsfilter` and `zfs` graph drivers. 190 For the `devicemapper`, `btrfs`, `windowsfilter` and `zfs` graph drivers, 191 user cannot pass a size less than the Default BaseFS Size. 192 For the `overlay2` storage driver, the size option is only available if the 193 backing fs is `xfs` and mounted with the `pquota` mount option. 194 Under these conditions, user can pass any size less then the backing fs size. 195 196 ### Specify isolation technology for container (--isolation) 197 198 This option is useful in situations where you are running Docker containers on 199 Windows. The `--isolation=<value>` option sets a container's isolation 200 technology. On Linux, the only supported is the `default` option which uses 201 Linux namespaces. On Microsoft Windows, you can specify these values: 202 203 204 | Value | Description | 205 |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| 206 | `default` | Use the value specified by the Docker daemon's `--exec-opt` . If the `daemon` does not specify an isolation technology, Microsoft Windows uses `process` as its default value if the 207 daemon is running on Windows server, or `hyperv` if running on Windows client. | 208 | `process` | Namespace isolation only. | 209 | `hyperv` | Hyper-V hypervisor partition-based isolation. | 210 211 Specifying the `--isolation` flag without a value is the same as setting `--isolation="default"`.