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