docker.github.io/_data/engine-cli-edge/docker_create.yaml at newlabs · feheze/docker.github.io

674 lines (641 loc) · 19.3 KB
command: docker create
short: Create a new container
  The `docker create` command creates a writeable container layer over the
  specified image and prepares it for running the specified command.  The
  container ID is then printed to `STDOUT`.  This is similar to `docker run -d`
  except the container is never started.  You can then use the
  `docker start <container_id>` command to start the container at any point.
  This is useful when you want to set up a container configuration ahead of time
  so that it is ready to start when you need it. The initial status of the
  new container is `created`.
  Please see the [run command](run.md) section and the [Docker run reference](../run.md) for more details.
usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...]
pname: docker
plink: docker.yaml
- option: add-host
  value_type: list
  description: Add a custom host-to-IP mapping (host:ip)
  deprecated: false
  experimental: false
- option: attach
  shorthand: a
  value_type: list
  description: Attach to STDIN, STDOUT or STDERR
  deprecated: false
  experimental: false
- option: blkio-weight
  value_type: uint16
  default_value: "0"
  description: |
    Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
  deprecated: false
  experimental: false
- option: blkio-weight-device
  value_type: list
  default_value: '[]'
  description: Block IO weight (relative device weight)
  deprecated: false
  experimental: false
- option: cap-add
  value_type: list
  description: Add Linux capabilities
  deprecated: false
  experimental: false
- option: cap-drop
  value_type: list
  description: Drop Linux capabilities
  deprecated: false
  experimental: false
- option: cgroup-parent
  value_type: string
  description: Optional parent cgroup for the container
  deprecated: false
  experimental: false
- option: cidfile
  value_type: string
  description: Write the container ID to the file
  deprecated: false
  experimental: false
- option: cpu-count
  value_type: int64
  default_value: "0"
  description: CPU count (Windows only)
  deprecated: false
  experimental: false
- option: cpu-percent
  value_type: int64
  default_value: "0"
  description: CPU percent (Windows only)
  deprecated: false
  experimental: false
- option: cpu-period
  value_type: int64
  default_value: "0"
  description: Limit CPU CFS (Completely Fair Scheduler) period
  deprecated: false
  experimental: false
- option: cpu-quota
  value_type: int64
  default_value: "0"
  description: Limit CPU CFS (Completely Fair Scheduler) quota
  deprecated: false
  experimental: false
- option: cpu-rt-period
  value_type: int64
  default_value: "0"
  description: Limit CPU real-time period in microseconds
  deprecated: false
  min_api_version: "1.25"
  experimental: false
- option: cpu-rt-runtime
  value_type: int64
  default_value: "0"
  description: Limit CPU real-time runtime in microseconds
  deprecated: false
  min_api_version: "1.25"
  experimental: false
- option: cpu-shares
  shorthand: c
  value_type: int64
  default_value: "0"
  description: CPU shares (relative weight)
  deprecated: false
  experimental: false
- option: cpus
  value_type: decimal
  description: Number of CPUs
  deprecated: false
  min_api_version: "1.25"
  experimental: false
- option: cpuset-cpus
  value_type: string
  description: CPUs in which to allow execution (0-3, 0,1)
  deprecated: false
  experimental: false
- option: cpuset-mems
  value_type: string
  description: MEMs in which to allow execution (0-3, 0,1)
  deprecated: false
  experimental: false
- option: device
  value_type: list
  description: Add a host device to the container
  deprecated: false
  experimental: false
- option: device-cgroup-rule
  value_type: list
  description: Add a rule to the cgroup allowed devices list
  deprecated: false
  experimental: false
- option: device-read-bps
  value_type: list
  default_value: '[]'
  description: Limit read rate (bytes per second) from a device
  deprecated: false
  experimental: false
- option: device-read-iops
  value_type: list
  default_value: '[]'
  description: Limit read rate (IO per second) from a device
  deprecated: false
  experimental: false
- option: device-write-bps
  value_type: list
  default_value: '[]'
  description: Limit write rate (bytes per second) to a device
  deprecated: false
  experimental: false
- option: device-write-iops
  value_type: list
  default_value: '[]'
  description: Limit write rate (IO per second) to a device
  deprecated: false
  experimental: false
- option: disable-content-trust
  value_type: bool
  default_value: "true"
  description: Skip image verification
  deprecated: false
  experimental: false
- option: dns
  value_type: list
  description: Set custom DNS servers
  deprecated: false
  experimental: false
- option: dns-opt
  value_type: list
  description: Set DNS options
  deprecated: false
  experimental: false
- option: dns-option
  value_type: list
  description: Set DNS options
  deprecated: false
  experimental: false
- option: dns-search
  value_type: list
  description: Set custom DNS search domains
  deprecated: false
  experimental: false
- option: entrypoint
  value_type: string
  description: Overwrite the default ENTRYPOINT of the image
  deprecated: false
  experimental: false
- option: env
  shorthand: e
  value_type: list
  description: Set environment variables
  deprecated: false
  experimental: false
- option: env-file
  value_type: list
  description: Read in a file of environment variables
  deprecated: false
  experimental: false
- option: expose
  value_type: list
  description: Expose a port or a range of ports
  deprecated: false
  experimental: false
- option: group-add
  value_type: list
  description: Add additional groups to join
  deprecated: false
  experimental: false
- option: health-cmd
  value_type: string
  description: Command to run to check health
  deprecated: false
  experimental: false
- option: health-interval
  value_type: duration
  default_value: 0s
  description: Time between running the check (ms|s|m|h) (default 0s)
  deprecated: false
  experimental: false
- option: health-retries
  value_type: int
  default_value: "0"
  description: Consecutive failures needed to report unhealthy
  deprecated: false
  experimental: false
- option: health-start-period
  value_type: duration
  default_value: 0s
  description: |
    Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)
  deprecated: false
  min_api_version: "1.29"
  experimental: false
- option: health-timeout
  value_type: duration
  default_value: 0s
  description: |
    Maximum time to allow one check to run (ms|s|m|h) (default 0s)
  deprecated: false
  experimental: false
- option: help
  value_type: bool
  default_value: "false"
  description: Print usage
  deprecated: false
  experimental: false
- option: hostname
  shorthand: h
  value_type: string
  description: Container host name
  deprecated: false
  experimental: false
- option: init
  value_type: bool
  default_value: "false"
  description: |
    Run an init inside the container that forwards signals and reaps processes
  deprecated: false
  min_api_version: "1.25"
  experimental: false
- option: interactive
  shorthand: i
  value_type: bool
  default_value: "false"
  description: Keep STDIN open even if not attached
  deprecated: false
  experimental: false
- option: io-maxbandwidth
  value_type: bytes
  default_value: "0"
  description: |
    Maximum IO bandwidth limit for the system drive (Windows only)
  deprecated: false
  experimental: false
- option: io-maxiops
  value_type: uint64
  default_value: "0"
  description: Maximum IOps limit for the system drive (Windows only)
  deprecated: false
  experimental: false
- option: ip
  value_type: string
  description: IPv4 address (e.g., 172.30.100.104)
  deprecated: false
  experimental: false
- option: ip6
  value_type: string
  description: IPv6 address (e.g., 2001:db8::33)
  deprecated: false
  experimental: false
- option: ipc
  value_type: string
  description: IPC mode to use
  deprecated: false
  experimental: false
- option: isolation
  value_type: string
  description: Container isolation technology
  deprecated: false
  experimental: false
- option: kernel-memory
  value_type: bytes
  default_value: "0"
  description: Kernel memory limit
  deprecated: false
  experimental: false
- option: label
  shorthand: l
  value_type: list
  description: Set meta data on a container
  deprecated: false
  experimental: false
- option: label-file
  value_type: list
  description: Read in a line delimited file of labels
  deprecated: false
  experimental: false
- option: link
  value_type: list
  description: Add link to another container
  deprecated: false
  experimental: false
- option: link-local-ip
  value_type: list
  description: Container IPv4/IPv6 link-local addresses
  deprecated: false
  experimental: false
- option: log-driver
  value_type: string
  description: Logging driver for the container
  deprecated: false
  experimental: false
- option: log-opt
  value_type: list
  description: Log driver options
  deprecated: false
  experimental: false
- option: mac-address
  value_type: string
  description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
  deprecated: false
  experimental: false
- option: memory
  shorthand: m
  value_type: bytes
  default_value: "0"
  description: Memory limit
  deprecated: false
  experimental: false
- option: memory-reservation
  value_type: bytes
  default_value: "0"
  description: Memory soft limit
  deprecated: false
  experimental: false
- option: memory-swap
  value_type: bytes
  default_value: "0"
  description: |
    Swap limit equal to memory plus swap: '-1' to enable unlimited swap
  deprecated: false
  experimental: false
- option: memory-swappiness
  value_type: int64
  default_value: "-1"
  description: Tune container memory swappiness (0 to 100)
  deprecated: false
  experimental: false
- option: mount
  value_type: mount
  description: Attach a filesystem mount to the container
  deprecated: false
  experimental: false
- option: name
  value_type: string
  description: Assign a name to the container
  deprecated: false
  experimental: false
- option: net
  value_type: string
  default_value: default
  description: Connect a container to a network
  deprecated: false
  experimental: false
- option: net-alias
  value_type: list
  description: Add network-scoped alias for the container
  deprecated: false
  experimental: false
- option: network
  value_type: string
  default_value: default
  description: Connect a container to a network
  deprecated: false
  experimental: false
- option: network-alias
  value_type: list
  description: Add network-scoped alias for the container
  deprecated: false
  experimental: false
- option: no-healthcheck
  value_type: bool
  default_value: "false"
  description: Disable any container-specified HEALTHCHECK
  deprecated: false
  experimental: false
- option: oom-kill-disable
  value_type: bool
  default_value: "false"
  description: Disable OOM Killer
  deprecated: false
  experimental: false
- option: oom-score-adj
  value_type: int
  default_value: "0"
  description: Tune host's OOM preferences (-1000 to 1000)
  deprecated: false
  experimental: false
- option: pid
  value_type: string
  description: PID namespace to use
  deprecated: false
  experimental: false
- option: pids-limit
  value_type: int64
  default_value: "0"
  description: Tune container pids limit (set -1 for unlimited)
  deprecated: false
  experimental: false
- option: privileged
  value_type: bool
  default_value: "false"
  description: Give extended privileges to this container
  deprecated: false
  experimental: false
- option: publish
  shorthand: p
  value_type: list
  description: Publish a container's port(s) to the host
  deprecated: false
  experimental: false
- option: publish-all
  shorthand: P
  value_type: bool
  default_value: "false"
  description: Publish all exposed ports to random ports
  deprecated: false
  experimental: false
- option: read-only
  value_type: bool
  default_value: "false"
  description: Mount the container's root filesystem as read only
  deprecated: false
  experimental: false
- option: restart
  value_type: string
  default_value: "no"
  description: Restart policy to apply when a container exits
  deprecated: false
  experimental: false
- option: rm
  value_type: bool
  default_value: "false"
  description: Automatically remove the container when it exits
  deprecated: false
  experimental: false
- option: runtime
  value_type: string
  description: Runtime to use for this container
  deprecated: false
  experimental: false
- option: security-opt
  value_type: list
  description: Security Options
  deprecated: false
  experimental: false
- option: shm-size
  value_type: bytes
  default_value: "0"
  description: Size of /dev/shm
  deprecated: false
  experimental: false
- option: stop-signal
  value_type: string
  default_value: SIGTERM
  description: Signal to stop a container
  deprecated: false
  experimental: false
- option: stop-timeout
  value_type: int
  default_value: "0"
  description: Timeout (in seconds) to stop a container
  deprecated: false
  min_api_version: "1.25"
  experimental: false
- option: storage-opt
  value_type: list
  description: Storage driver options for the container
  deprecated: false
  experimental: false
- option: sysctl
  value_type: map
  default_value: map[]
  description: Sysctl options
  deprecated: false
  experimental: false
- option: tmpfs
  value_type: list
  description: Mount a tmpfs directory
  deprecated: false
  experimental: false
- option: tty
  shorthand: t
  value_type: bool
  default_value: "false"
  description: Allocate a pseudo-TTY
  deprecated: false
  experimental: false
- option: ulimit
  value_type: ulimit
  default_value: '[]'
  description: Ulimit options
  deprecated: false
  experimental: false
- option: user
  shorthand: u
  value_type: string
  description: 'Username or UID (format: <name|uid>[:<group|gid>])'
  deprecated: false
  experimental: false
- option: userns
  value_type: string
  description: User namespace to use
  deprecated: false
  experimental: false
- option: uts
  value_type: string
  description: UTS namespace to use
  deprecated: false
  experimental: false
- option: volume
  shorthand: v
  value_type: list
  description: Bind mount a volume
  deprecated: false
  experimental: false
- option: volume-driver
  value_type: string
  description: Optional volume driver for the container
  deprecated: false
  experimental: false
- option: volumes-from
  value_type: list
  description: Mount volumes from the specified container(s)
  deprecated: false
  experimental: false
- option: workdir
  shorthand: w
  value_type: string
  description: Working directory inside the container
  deprecated: false
  experimental: false
examples: |-
  ### Create and start a container
  $ docker create -t -i fedora bash
  6d8af538ec541dd581ebc2a24153a28329acb5268abe5ef868c1f1a261221752
  $ docker start -a -i 6d8af538ec5
  bash-4.2#
  ### Initialize volumes
  As of v1.4.0 container volumes are initialized during the `docker create` phase
  (i.e., `docker run` too). For example, this allows you to `create` the `data`
  volume container, and then use it from another container:
  $ docker create -v /data --name data ubuntu
  240633dfbb98128fa77473d3d9018f6123b99c454b3251427ae190a7d951ad57
  $ docker run --rm --volumes-from data ubuntu ls -la /data
  drwxr-xr-x  2 root root 4096 Dec  5 04:10 .
  drwxr-xr-x 48 root root 4096 Dec  5 04:11 ..
  Similarly, `create` a host directory bind mounted volume container, which can
  then be used from the subsequent container:
  $ docker create -v /home/docker:/docker --name docker ubuntu
  9aa88c08f319cd1e4515c3c46b0de7cc9aa75e878357b1e96f91e2c773029f03
  $ docker run --rm --volumes-from docker ubuntu ls -la /docker
  drwxr-sr-x  5 1000 staff  180 Dec  5 04:00 .
  drwxr-xr-x 48 root root  4096 Dec  5 04:13 ..
  -rw-rw-r--  1 1000 staff 3833 Dec  5 04:01 .ash_history
  -rw-r--r--  1 1000 staff  446 Nov 28 11:51 .ashrc
  -rw-r--r--  1 1000 staff   25 Dec  5 04:00 .gitconfig
  drwxr-sr-x  3 1000 staff   60 Dec  1 03:28 .local
  -rw-r--r--  1 1000 staff  920 Nov 28 11:51 .profile
  drwx--S---  2 1000 staff  460 Dec  5 00:51 .ssh
  drwxr-xr-x 32 1000 staff 1140 Dec  5 04:01 docker
  Set storage driver options per container.
  $ docker create -it --storage-opt size=120G fedora /bin/bash
  This (size) will allow to set the container rootfs size to 120G at creation time.
  This option is only available for the `devicemapper`, `btrfs`, `overlay2`,
  `windowsfilter` and `zfs` graph drivers.
  For the `devicemapper`, `btrfs`, `windowsfilter` and `zfs` graph drivers,
  user cannot pass a size less than the Default BaseFS Size.
  For the `overlay2` storage driver, the size option is only available if the
  backing fs is `xfs` and mounted with the `pquota` mount option.
  Under these conditions, user can pass any size less then the backing fs size.
  ### Specify isolation technology for container (--isolation)
  This option is useful in situations where you are running Docker containers on
  Windows. The `--isolation=<value>` option sets a container's isolation
  technology. On Linux, the only supported is the `default` option which uses
  Linux namespaces. On Microsoft Windows, you can specify these values:
  |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
  | `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
  daemon is running on Windows server, or `hyperv` if running on Windows client.  |
  | `hyperv`   | Hyper-V hypervisor partition-based isolation.                                                                                                                  |
  Specifying the `--isolation` flag without a value is the same as setting `--isolation="default"`.
  ### Dealing with dynamically created devices (--device-cgroup-rule)
  Devices available to a container are assigned at creation time. The
  assigned devices will both be added to the cgroup.allow file and
  created into the container once it is run. This poses a problem when
  a new device needs to be added to running container.
  One of the solution is to add a more permissive rule to a container
  allowing it access to a wider range of devices. For example, supposing
  our container needs access to a character device with major `42` and
  any number of minor number (added as new devices appear), the
  following rule would be added:
  docker create --device-cgroup-rule='c 42:* rmw' -name my-container my-image
  Then, a user could ask `udev` to execute a script that would `docker exec my-container mknod newDevX c 42 <minor>`
  the required device when it is added.
  NOTE: initially present devices still need to be explicitely added to
  the create/run command
deprecated: false
experimental: false
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

docker_create.yaml

Latest commit

History

docker_create.yaml

File metadata and controls
