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