github.com/kaisenlinux/docker.io@v0.0.0-20230510090727-ea55db55fac7/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        --pull string                   Pull image before creating ("always"|"missing"|"never") (default "missing")
   102        --read-only                     Mount the container's root filesystem as read only
   103        --restart string                Restart policy to apply when a container exits (default "no")
   104                                        Possible values are: no, on-failure[:max-retry], always, unless-stopped
   105        --rm                            Automatically remove the container when it exits
   106        --runtime string                Runtime to use for this container
   107        --security-opt value            Security Options (default [])
   108        --shm-size bytes                Size of /dev/shm
   109                                        The format is `<number><unit>`. `number` must be greater than `0`.
   110                                        Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes),
   111                                        or `g` (gigabytes). If you omit the unit, the system uses bytes.
   112        --stop-signal string            Signal to stop a container (default "SIGTERM")
   113        --stop-timeout int              Timeout (in seconds) to stop a container
   114        --storage-opt value             Storage driver options for the container (default [])
   115        --sysctl value                  Sysctl options (default map[])
   116        --tmpfs value                   Mount a tmpfs directory (default [])
   117    -t, --tty                           Allocate a pseudo-TTY
   118        --ulimit value                  Ulimit options (default [])
   119    -u, --user string                   Username or UID (format: <name|uid>[:<group|gid>])
   120        --userns string                 User namespace to use
   121                                        'host': Use the Docker host user namespace
   122                                        '': Use the Docker daemon user namespace specified by `--userns-remap` option.
   123        --uts string                    UTS namespace to use
   124    -v, --volume value                  Bind mount a volume (default []). The format
   125                                        is `[host-src:]container-dest[:<options>]`.
   126                                        The comma-delimited `options` are [rw|ro],
   127                                        [z|Z], [[r]shared|[r]slave|[r]private],
   128                                        [delegated|cached|consistent], 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  ## Description
   137  
   138  The `docker container create` (or shorthand: `docker create`) command creates a
   139  new container from the specified image, without starting it.
   140  
   141  When creating a container, the docker daemon creates a writeable container layer
   142  over the 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 `docker container start`
   145  (or shorthand: `docker start`) 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  The `docker create` command shares most of its options with the `docker run`
   152  command (which performs a `docker create` before starting it). Refer to the
   153  [`docker run` command](run.md) section and the [Docker run reference](../run.md)
   154  for details on the available flags and options.
   155  
   156  ## Examples
   157  
   158  ### Create and start a container
   159  
   160  The following example creates an interactive container with a pseudo-TTY attached,
   161  then starts the container and attaches to it:
   162  
   163  ```console
   164  $ docker container create -i -t --name mycontainer alpine
   165  6d8af538ec541dd581ebc2a24153a28329acb5268abe5ef868c1f1a261221752
   166  
   167  $ docker container start --attach -i mycontainer
   168  / # echo hello world
   169  hello world
   170  ```
   171  
   172  The above is the equivalent of a `docker run`:
   173  
   174  ```console
   175  $ docker run -it --name mycontainer2 alpine
   176  / # echo hello world
   177  hello world
   178  ```
   179  
   180  ### Initialize volumes
   181  
   182  Container volumes are initialized during the `docker create` phase
   183  (i.e., `docker run` too). For example, this allows you to `create` the `data`
   184  volume container, and then use it from another container:
   185  
   186  ```console
   187  $ docker create -v /data --name data ubuntu
   188  
   189  240633dfbb98128fa77473d3d9018f6123b99c454b3251427ae190a7d951ad57
   190  
   191  $ docker run --rm --volumes-from data ubuntu ls -la /data
   192  
   193  total 8
   194  drwxr-xr-x  2 root root 4096 Dec  5 04:10 .
   195  drwxr-xr-x 48 root root 4096 Dec  5 04:11 ..
   196  ```
   197  
   198  Similarly, `create` a host directory bind mounted volume container, which can
   199  then be used from the subsequent container:
   200  
   201  ```console
   202  $ docker create -v /home/docker:/docker --name docker ubuntu
   203  
   204  9aa88c08f319cd1e4515c3c46b0de7cc9aa75e878357b1e96f91e2c773029f03
   205  
   206  $ docker run --rm --volumes-from docker ubuntu ls -la /docker
   207  
   208  total 20
   209  drwxr-sr-x  5 1000 staff  180 Dec  5 04:00 .
   210  drwxr-xr-x 48 root root  4096 Dec  5 04:13 ..
   211  -rw-rw-r--  1 1000 staff 3833 Dec  5 04:01 .ash_history
   212  -rw-r--r--  1 1000 staff  446 Nov 28 11:51 .ashrc
   213  -rw-r--r--  1 1000 staff   25 Dec  5 04:00 .gitconfig
   214  drwxr-sr-x  3 1000 staff   60 Dec  1 03:28 .local
   215  -rw-r--r--  1 1000 staff  920 Nov 28 11:51 .profile
   216  drwx--S---  2 1000 staff  460 Dec  5 00:51 .ssh
   217  drwxr-xr-x 32 1000 staff 1140 Dec  5 04:01 docker
   218  ```