moby--moby/docs/reference/api
Brian Goff fc7b904dce Add new `HostConfig` field, `Mounts`.
`Mounts` allows users to specify in a much safer way the volumes they
want to use in the container.
This replaces `Binds` and `Volumes`, which both still exist, but
`Mounts` and `Binds`/`Volumes` are exclussive.
The CLI will continue to use `Binds` and `Volumes` due to concerns with
parsing the volume specs on the client side and cross-platform support
(for now).

The new API follows exactly the services mount API.

Example usage of `Mounts`:

```
$ curl -XPOST localhost:2375/containers/create -d '{
  "Image": "alpine:latest",
  "HostConfig": {
    "Mounts": [{
      "Type": "Volume",
      "Target": "/foo"
      },{
      "Type": "bind",
      "Source": "/var/run/docker.sock",
      "Target": "/var/run/docker.sock",
      },{
      "Type": "volume",
      "Name": "important_data",
      "Target": "/var/data",
      "ReadOnly": true,
      "VolumeOptions": {
	"DriverConfig": {
	  Name: "awesomeStorage",
	  Options: {"size": "10m"},
	  Labels: {"some":"label"}
	}
      }]
    }
}'
```

There are currently 2 types of mounts:

  - **bind**: Paths on the host that get mounted into the
    container. Paths must exist prior to creating the container.
  - **volume**: Volumes that persist after the
    container is removed.

Not all fields are available in each type, and validation is done to
ensure these fields aren't mixed up between types.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2016-09-13 09:55:35 -04:00
..
_static
images Implemet docker update command 2015-12-28 19:19:26 +08:00
README.md Fixes found by docs validation tool 2015-11-23 11:19:38 +10:00
docker-io_api.md Creating Engine specific menu 2016-01-26 15:58:53 -08:00
docker_io_accounts_api.md Creating Engine specific menu 2016-01-26 15:58:53 -08:00
docker_remote_api.md Add new `HostConfig` field, `Mounts`. 2016-09-13 09:55:35 -04:00
docker_remote_api_v1.18.md Cleanup API docs Markdown formatting and wording 2016-08-16 13:22:47 +02:00
docker_remote_api_v1.19.md Add missing docs about binary remote contexts 2016-08-17 16:15:59 +02:00
docker_remote_api_v1.20.md Replace docker command from 'docker daemon' to 'dockerd' 2016-08-25 17:04:44 +08:00
docker_remote_api_v1.21.md Replace docker command from 'docker daemon' to 'dockerd' 2016-08-25 17:04:44 +08:00
docker_remote_api_v1.22.md Replace docker command from 'docker daemon' to 'dockerd' 2016-08-25 17:04:44 +08:00
docker_remote_api_v1.23.md Replace docker command from 'docker daemon' to 'dockerd' 2016-08-25 17:04:44 +08:00
docker_remote_api_v1.24.md Add new `HostConfig` field, `Mounts`. 2016-09-13 09:55:35 -04:00
docker_remote_api_v1.25.md Add new `HostConfig` field, `Mounts`. 2016-09-13 09:55:35 -04:00
hub_registry_spec.md Modify link for hub and registry 2016-08-30 16:37:03 +08:00
index.md Creating Engine specific menu 2016-01-26 15:58:53 -08:00
remote_api_client_libraries.md Remove status column from client libraries page 2016-05-31 16:12:14 -07:00

README.md

This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:

  • The remote API by which a docker node can be queried over HTTP
  • The registry API by which a docker node can download and upload images for storage and sharing
  • The index search API by which a docker node can search the public index for images to download
  • The docker.io OAuth and accounts API which 3rd party services can use to access account information