This synchronizes changes between API versions, and:
- applies e0a552504e64192946c86d3bdd517ae7b3af348f to
older versions of the documentation
- applies a2a0a03e2b801545b2e3fb9e8476c76370da9175 to
API version 1.25
- syncs some minor differences
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 53b1dcb25ca937c61bd47a29ba7be6e68abc25a5
Component: engine
This was added in fc7b904dced4d18d49c8a6c47ae3f415d16d0c43,
but some parts of the documentation ended up in the
wrong API version, and was overlooked during
review :)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: cd73ceffd84d6d3af695a70485ca0d7899d0475a
Component: engine
The documentation contained some outdated information
on these endpoints.
This change fixes those parts of the documentation
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: d69409fd43e73829209315de79abf79000c4c720
Component: engine
This adds a direct link to the event chart image
so that the full-resolution image can be "zoomed"
in to.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 86de72fef244b3fe209e5793deb40fb26f5b318e
Component: engine
`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>
Upstream-commit: fc7b904dced4d18d49c8a6c47ae3f415d16d0c43
Component: engine
The "Stream details" sections are currently a part of the Status codes list.
This change moves them out to the same level as other surrounding sections.
Use () for a paramaters
Remove query param from end point heading
Signed-off-by: Matt Hoyle <matt@deployable.co>
Upstream-commit: e0a552504e64192946c86d3bdd517ae7b3af348f
Component: engine
This was missing from the docs for 1.12.0.
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: fb8b6438f265532ec47e001b2739ed614b47f3a0
Component: engine
This fix tries to address the issue in raised #23367 where an out-of-band
volume driver deletion leaves some data in docker. This prevent the
reuse of deleted volume names (by out-of-band volume driver like flocker).
This fix adds a `--force` field in `docker volume rm` to forcefully purge
the data of the volume that has already been deleted.
Related documentations have been updated.
This fix is tested manually with flocker, as is specified in #23367.
An integration test has also been added for the scenario described.
This fix fixes#23367.
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 6c5c34d50d377d1c5318a255240fb2dc9c23cf92
Component: engine
This feature was added in docker 1.8, through
7491f9a9c11ad3fd3b587fa6f7e53b297b3b88c7.
However, the API docs ended up in the wrong
API version (1.19 instead of 1.20), so were
never included in future API docs.
Also, the CLI docs got lost during splitting
up the cli.md docs into separate files;
561bfb268de3c674b04d48895b7e46ae890ef795
This moves the API docs to the correct
versions, and restores the CLI documentation.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: a5ba032c7421ef7a429e780d12d0f604a045258a
Component: engine
Synchronize formatting between versions, and
update wording to be consistent.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: eb24e9bbd312b0d7392e8012b757e7c9022c9add
Component: engine
"--restart" and "--rm" are conflict options, if a container is started
with AutoRemove flag, we should forbid the update action for its Restart
Policy.
Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
Upstream-commit: 4754c64ab5b5bf5ae6f8a3040606296910e6cb19
Component: engine
Commit 067b510dfc5b90a1d7712c89e857b6dafb184f24 move the
sysctls feature to the right API version, but
missed this one.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 7cdd693d5d2094f73383145eb74d81c6b9bb9b24
Component: engine
The service create/update endpoints support
passing registry-authentication information,
but this was not documented.
This adds the missing information about passing
a X-Registry-Auth header.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: bde35ef18a408a297b960c439dc029cfb5e15464
Component: engine
Commit 353af0b3ecfe483568fd88754e432c92b0ec088b updated
the `/image/load` endpoint to consistendly return
JSON, but did not update the associated documentation.
This updates the example response in the documentation
to match the actual response.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 419d2ad0f8adc687bb25831d62f462353557a706
Component: engine
The "since" query parameter can be *useful*
for polling (in combination with "until"), but
doesn't actualy stop the endpoint from streaming
events.
This patch updates the description to better
clarify that "since" does not make the endpoint
non-streaming.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: ceed39b530838451b5b9c64b372307a0cc8492ab
Component: engine
This parameter was documented for 1.24, but we
forgot to add it to the 1.25 docs as well.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 06fa5c12e8a0a4a6ed5766ff123fff06343c603c
Component: engine
Progress reporting during image load was added
in 415dd8688618ac2b3872c6a5b5af3afcef2c3e10, but
the corresponding query-parameter was not documented
in the API docs.
This updates the API docs, and adds a response example
both with quiet enabled and disabled.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: d13ed38471decb332e9a0872854a97730d548583
Component: engine
