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