github.com/itscaro/cli@v0.0.0-20190705081621-c9db0fe93829/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/cli GitHub 8 repository at https://github.com/docker/cli/. 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-cgroup-rule value Add a rule to the cgroup allowed devices list 48 --device-read-bps value Limit read rate (bytes per second) from a device (default []) 49 --device-read-iops value Limit read rate (IO per second) from a device (default []) 50 --device-write-bps value Limit write rate (bytes per second) to a device (default []) 51 --device-write-iops value Limit write rate (IO per second) to a device (default []) 52 --disable-content-trust Skip image verification (default true) 53 --dns value Set custom DNS servers (default []) 54 --dns-option value Set DNS options (default []) 55 --dns-search value Set custom DNS search domains (default []) 56 --domainname string Container NIS domain name 57 --entrypoint string Overwrite the default ENTRYPOINT of the image 58 -e, --env value Set environment variables (default []) 59 --env-file value Read in a file of environment variables (default []) 60 --expose value Expose a port or a range of ports (default []) 61 --group-add value Add additional groups to join (default []) 62 --health-cmd string Command to run to check health 63 --health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) 64 --health-retries int Consecutive failures needed to report unhealthy 65 --health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) 66 --health-start-period duration Start period for the container to initialize before counting retries towards unstable (ns|us|ms|s|m|h) (default 0s) 67 --help Print usage 68 -h, --hostname string Container host name 69 --init Run an init inside the container that forwards signals and reaps processes 70 -i, --interactive Keep STDIN open even if not attached 71 --io-maxbandwidth string Maximum IO bandwidth limit for the system drive (Windows only) 72 --io-maxiops uint Maximum IOps limit for the system drive (Windows only) 73 --ip string IPv4 address (e.g., 172.30.100.104) 74 --ip6 string IPv6 address (e.g., 2001:db8::33) 75 --ipc string IPC namespace to use 76 --isolation string Container isolation technology 77 --kernel-memory string Kernel memory limit 78 -l, --label value Set meta data on a container (default []) 79 --label-file value Read in a line delimited file of labels (default []) 80 --link value Add link to another container (default []) 81 --link-local-ip value Container IPv4/IPv6 link-local addresses (default []) 82 --log-driver string Logging driver for the container 83 --log-opt value Log driver options (default []) 84 --mac-address string Container MAC address (e.g., 92:d0:c6:0a:29:33) 85 -m, --memory string Memory limit 86 --memory-reservation string Memory soft limit 87 --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap 88 --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) 89 --mount value Attach a filesystem mount to the container (default []) 90 --name string Assign a name to the container 91 --network-alias value Add network-scoped alias for the container (default []) 92 --network string Connect a container to a network (default "default") 93 'bridge': create a network stack on the default Docker bridge 94 'none': no networking 95 'container:<name|id>': reuse another container's network stack 96 'host': use the Docker host network stack 97 '<network-name>|<network-id>': connect to a user-defined network 98 --no-healthcheck Disable any container-specified HEALTHCHECK 99 --oom-kill-disable Disable OOM Killer 100 --oom-score-adj int Tune host's OOM preferences (-1000 to 1000) 101 --pid string PID namespace to use 102 --pids-limit int Tune container pids limit (set -1 for unlimited), kernel >= 4.3 103 --privileged Give extended privileges to this container 104 -p, --publish value Publish a container's port(s) to the host (default []) 105 -P, --publish-all Publish all exposed ports to random ports 106 --read-only Mount the container's root filesystem as read only 107 --restart string Restart policy to apply when a container exits (default "no") 108 Possible values are: no, on-failure[:max-retry], always, unless-stopped 109 --rm Automatically remove the container when it exits 110 --runtime string Runtime to use for this container 111 --security-opt value Security Options (default []) 112 --shm-size bytes Size of /dev/shm 113 The format is `<number><unit>`. `number` must be greater than `0`. 114 Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), 115 or `g` (gigabytes). If you omit the unit, the system uses bytes. 116 --stop-signal string Signal to stop a container (default "SIGTERM") 117 --stop-timeout=10 Timeout (in seconds) to stop a container 118 --storage-opt value Storage driver options for the container (default []) 119 --sysctl value Sysctl options (default map[]) 120 --tmpfs value Mount a tmpfs directory (default []) 121 -t, --tty Allocate a pseudo-TTY 122 --ulimit value Ulimit options (default []) 123 -u, --user string Username or UID (format: <name|uid>[:<group|gid>]) 124 --userns string User namespace to use 125 'host': Use the Docker host user namespace 126 '': Use the Docker daemon user namespace specified by `--userns-remap` option. 127 --uts string UTS namespace to use 128 -v, --volume value Bind mount a volume (default []). The format 129 is `[host-src:]container-dest[:<options>]`. 130 The comma-delimited `options` are [rw|ro], 131 [z|Z], [[r]shared|[r]slave|[r]private], 132 [delegated|cached|consistent], and 133 [nocopy]. The 'host-src' is an absolute path 134 or a name value. 135 --volume-driver string Optional volume driver for the container 136 --volumes-from value Mount volumes from the specified container(s) (default []) 137 -w, --workdir string Working directory inside the container 138 ``` 139 ## Description 140 141 The `docker create` command creates a writeable container layer over the 142 specified image and prepares it for running the specified command. The 143 container ID is then printed to `STDOUT`. This is similar to `docker run -d` 144 except the container is never started. You can then use the 145 `docker start <container_id>` command to start the container at any point. 146 147 This is useful when you want to set up a container configuration ahead of time 148 so that it is ready to start when you need it. The initial status of the 149 new container is `created`. 150 151 Please see the [run command](run.md) section and the [Docker run reference](../run.md) for more details. 152 153 ## Examples 154 155 ### Create and start a container 156 157 ```bash 158 $ docker create -t -i fedora bash 159 160 6d8af538ec541dd581ebc2a24153a28329acb5268abe5ef868c1f1a261221752 161 162 $ docker start -a -i 6d8af538ec5 163 164 bash-4.2# 165 ``` 166 167 ### Initialize volumes 168 169 As of v1.4.0 container volumes are initialized during the `docker create` phase 170 (i.e., `docker run` too). For example, this allows you to `create` the `data` 171 volume container, and then use it from another container: 172 173 ```bash 174 $ docker create -v /data --name data ubuntu 175 176 240633dfbb98128fa77473d3d9018f6123b99c454b3251427ae190a7d951ad57 177 178 $ docker run --rm --volumes-from data ubuntu ls -la /data 179 180 total 8 181 drwxr-xr-x 2 root root 4096 Dec 5 04:10 . 182 drwxr-xr-x 48 root root 4096 Dec 5 04:11 .. 183 ``` 184 185 Similarly, `create` a host directory bind mounted volume container, which can 186 then be used from the subsequent container: 187 188 ```bash 189 $ docker create -v /home/docker:/docker --name docker ubuntu 190 191 9aa88c08f319cd1e4515c3c46b0de7cc9aa75e878357b1e96f91e2c773029f03 192 193 $ docker run --rm --volumes-from docker ubuntu ls -la /docker 194 195 total 20 196 drwxr-sr-x 5 1000 staff 180 Dec 5 04:00 . 197 drwxr-xr-x 48 root root 4096 Dec 5 04:13 .. 198 -rw-rw-r-- 1 1000 staff 3833 Dec 5 04:01 .ash_history 199 -rw-r--r-- 1 1000 staff 446 Nov 28 11:51 .ashrc 200 -rw-r--r-- 1 1000 staff 25 Dec 5 04:00 .gitconfig 201 drwxr-sr-x 3 1000 staff 60 Dec 1 03:28 .local 202 -rw-r--r-- 1 1000 staff 920 Nov 28 11:51 .profile 203 drwx--S--- 2 1000 staff 460 Dec 5 00:51 .ssh 204 drwxr-xr-x 32 1000 staff 1140 Dec 5 04:01 docker 205 ``` 206 207 208 Set storage driver options per container. 209 210 ```bash 211 $ docker create -it --storage-opt size=120G fedora /bin/bash 212 ``` 213 214 This (size) will allow to set the container rootfs size to 120G at creation time. 215 This option is only available for the `devicemapper`, `btrfs`, `overlay2`, 216 `windowsfilter` and `zfs` graph drivers. 217 For the `devicemapper`, `btrfs`, `windowsfilter` and `zfs` graph drivers, 218 user cannot pass a size less than the Default BaseFS Size. 219 For the `overlay2` storage driver, the size option is only available if the 220 backing fs is `xfs` and mounted with the `pquota` mount option. 221 Under these conditions, user can pass any size less than the backing fs size. 222 223 ### Specify isolation technology for container (--isolation) 224 225 This option is useful in situations where you are running Docker containers on 226 Windows. The `--isolation=<value>` option sets a container's isolation 227 technology. On Linux, the only supported is the `default` option which uses 228 Linux namespaces. On Microsoft Windows, you can specify these values: 229 230 231 | Value | Description | 232 |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| 233 | `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 234 daemon is running on Windows server, or `hyperv` if running on Windows client. | 235 | `process` | Namespace isolation only. | 236 | `hyperv` | Hyper-V hypervisor partition-based isolation. | 237 238 Specifying the `--isolation` flag without a value is the same as setting `--isolation="default"`. 239 240 ### Dealing with dynamically created devices (--device-cgroup-rule) 241 242 Devices available to a container are assigned at creation time. The 243 assigned devices will both be added to the cgroup.allow file and 244 created into the container once it is run. This poses a problem when 245 a new device needs to be added to running container. 246 247 One of the solution is to add a more permissive rule to a container 248 allowing it access to a wider range of devices. For example, supposing 249 our container needs access to a character device with major `42` and 250 any number of minor number (added as new devices appear), the 251 following rule would be added: 252 253 ``` 254 docker create --device-cgroup-rule='c 42:* rmw' -name my-container my-image 255 ``` 256 257 Then, a user could ask `udev` to execute a script that would `docker exec my-container mknod newDevX c 42 <minor>` 258 the required device when it is added. 259 260 NOTE: initially present devices still need to be explicitly added to 261 the create/run command