Commit Graph

411 Commits

Author SHA1 Message Date
f3d4887540 Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 708892c4037e9eef6f6c25b5a3551f7779fb8868
Component: engine
2016-09-20 17:41:59 +02:00
a262e6d191 Fix incorrectly named API options
This renames `MaximumIOps` to `IOMaximumBandwidth`,
and `MaximumIOBps` to `IOMaximumIOps` to match
the actual code.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 36a25bdbe4d973aef308fa11b450264dae1bc0b4
Component: engine
2016-09-20 13:51:55 +02:00
029442b3b0 Merge pull request #26634 from thaJeztah/fix-api-docs-for-services
Fix service and tasks API documentation
Upstream-commit: 788a8a3cac67b72d3c52bd3bc8b09fcc0ee438a8
Component: engine
2016-09-17 16:13:15 +02:00
613c0e8111 Merge pull request #26654 from thaJeztah/sync-api-docs
Synchronize API docs
Upstream-commit: 1fb556bb7ebed206ebacf13148f912f7347d5489
Component: engine
2016-09-17 16:11:42 +02:00
0a2b85a132 Synchronize API docs
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
2016-09-17 03:02:12 +02:00
7bce42c737 Move HostConfig.Mounts to correct API version
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
2016-09-17 02:36:07 +02:00
a3575ae5f7 Fix service and tasks API documentation
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
2016-09-17 02:29:38 +02:00
db61cfcc59 docs: reference: api: clarify pull all tags
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
Upstream-commit: 03a8b6798d030a952e85f15208aeea1215e3f801
Component: engine
2016-09-16 16:35:15 +02:00
69bead6193 Add direct link to event chart image
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
2016-09-14 23:16:32 +02:00
06b2219a87 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>
Upstream-commit: fc7b904dced4d18d49c8a6c47ae3f415d16d0c43
Component: engine
2016-09-13 09:55:35 -04:00
ec2041215e Merge pull request #26306 from deployable/patch-1
Remote API documentation consistancy
Upstream-commit: 2cce7bf33a1af566670ec0fb2deeff8056b2798d
Component: engine
2016-09-12 10:52:30 +10:00
f9b7ffdb90 Keep headings consistant in API documentation
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
2016-09-10 12:27:41 +10:00
e42ce8aa21 Merge pull request #26156 from mstanleyjones/24905_swarm_noun_usage
Sanitize uses of Swarm as a proper and improper noun (Fixes #24905)
Upstream-commit: 6f0502b89b29a7d23b02363d02104ec531a36e4a
Component: engine
2016-09-07 10:38:59 -07:00
56f38b6496 Add response to swarm/init example (fixes #25625
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: a2a0a03e2b801545b2e3fb9e8476c76370da9175
Component: engine
2016-09-06 08:39:53 -07:00
5599c8776d Add health status as action on events documentations
This was missing from the docs for 1.12.0.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: fb8b6438f265532ec47e001b2739ed614b47f3a0
Component: engine
2016-09-04 18:01:57 +02:00
cfe42ec17e Sanitize uses of Swarm as a proper and improper noun
Fixes #24905

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 82304abd800701e7e211965f5e433804881240e7
Component: engine
2016-08-30 11:04:41 -07:00
91b527444a Modify link for hub and registry
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: aedf95e640fe362bbf59516ffa77d8bc1629d507
Component: engine
2016-08-30 16:37:03 +08:00
7045275ed8 Update documentation for validation of --ip and ip6.
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 5118dd2992aef27890203b7e8eb62fc5f507d931
Component: engine
2016-08-25 22:11:56 -07:00
2056c2799d Merge pull request #26016 from vdemeester/docs-restart-policy-api-changes
Update docker remote api to mention restart policy validation
Upstream-commit: 48ff20c79527096ab8ca9c4be6773e4133afc617
Component: engine
2016-08-26 07:57:53 +02:00
d13d215017 Update docker remote api to mention restart policy validation
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: a011a94be7448ee86e28396246de73f646af3a93
Component: engine
2016-08-25 17:03:18 +02:00
c65cef03da Replace docker command from 'docker daemon' to 'dockerd'
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: 530668cb2262fc89e60a23d9a0f6555498b0171b
Component: engine
2016-08-25 17:04:44 +08:00
36f79775aa Merge pull request #25719 from eskaaren/master
You can force leave swarm
Upstream-commit: daf454d8cd6146ef2cb644614301806ef59c58cc
Component: engine
2016-08-22 09:15:37 +02:00
a603b90d7f Add --force in docker volume rm to fix out-of-band volume driver deletion
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
2016-08-18 18:01:25 -07:00
9ab2ca7546 Merge pull request #25708 from timfeirg/master
expose RemovalInProgress in StateString #25652
Upstream-commit: 426046db3a5c3c056f02bf3ad5efd1342ff79533
Component: engine
2016-08-18 21:54:48 +02:00
c8732c07e1 expose RemovalInProgress in StateString #25652
Signed-off-by: timfeirg <kkcocogogo@gmail.com>
Upstream-commit: 37466cc8c85ccbdade57463ae2aacac638002f8a
Component: engine
2016-08-18 11:25:27 +08:00
703353742f Add missing docs about binary remote contexts
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
2016-08-17 16:15:59 +02:00
e997af8b70 Merge pull request #25704 from thaJeztah/cleanup-api-markdown
Cleanup API docs Markdown formatting and wording
Upstream-commit: 45cb33e65ca5bb247e2e9f425b4441ad6a08aa51
Component: engine
2016-08-17 10:39:45 +02:00
a413b2d6cd Merge pull request #25701 from WeiZhang555/update-conflict-rm-restart
Forbid update restart policy of container with AutoRemove flag
Upstream-commit: 9a3e7d9e343938218aac8217c4b8ba4c21b841c4
Component: engine
2016-08-16 10:37:45 -07:00
3e85f88396 Merge pull request #25757 from eskaaren/create_service_id
Capital D in "ID" returned when creating service
Upstream-commit: 641e1564cfeb3f94f68f3c43a353df10331afecf
Component: engine
2016-08-16 17:01:22 +02:00
eefe7f0f5d "Annotations" not a parameter
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
Upstream-commit: 69e481af4e1fec65629c6ea4eb74fc58f5abc932
Component: engine
2016-08-16 15:17:26 +02:00
cf3d39b364 Capital D in "ID" returned when creating service
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
Upstream-commit: 9eb2ec799eb37210dee5183ace375e480bbfd8aa
Component: engine
2016-08-16 13:43:23 +02:00
3b1b49d31b Cleanup API docs Markdown formatting and wording
Synchronize formatting between versions, and
update wording to be consistent.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: eb24e9bbd312b0d7392e8012b757e7c9022c9add
Component: engine
2016-08-16 13:22:47 +02:00
20d4e38a31 Add doc for inspect swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
Upstream-commit: c59bc537274aa7f4dc9702ea08c349c71a024b39
Component: engine
2016-08-16 12:49:33 +02:00
d1bde01a82 Forbid update restart policy of container with AutoRemove flag
"--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
2016-08-16 15:36:13 +08:00
273f3379ab You can force leave swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
Upstream-commit: 033482d9ffba69732a9895386dbe8d5c7b1a944a
Component: engine
2016-08-16 09:32:45 +02:00
fe5ecb2397 Merge pull request #25706 from thaJeztah/add-authorization-header-to-api-docs
Add X-Registry-Auth header to service API docs
Upstream-commit: 9079d5ccbb040363a89c87d87eac693575848c80
Component: engine
2016-08-15 21:54:06 +02:00
6cf3b48c91 Move sysctls to correct API version
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
2016-08-15 12:02:54 +02:00
83afa41419 Add X-Registry-Auth header to service API docs
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
2016-08-15 11:53:12 +02:00
f039ea6e5b Update API docs example for image load response
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
2016-08-12 11:57:34 +02:00
720eb363bf Merge pull request #25564 from coolljt0725/fix_inspect_network
Fix inspect network show gateway with mask
Upstream-commit: d8240c8e27b625c6c2b7982e2473cce46e2a9ddc
Component: engine
2016-08-12 11:11:09 +02:00
8eacfa50f9 Fix inspect network show gateway with mask
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: 096bb5fb0740656b91b3e35f8df23c79270f7f90
Component: engine
2016-08-11 21:08:54 -04:00
80712ffaad Merge pull request #25548 from thaJeztah/plugin-api-docs
Add API documentation for experimental plugin features
Upstream-commit: 5b68177a6e3865a3880d8b3a4e5b932d3ccae1dc
Component: engine
2016-08-11 21:52:04 +02:00
3344338b88 Merge pull request #25604 from allencloud/add-missing-fields-in-volume-api
add fields in volume api for 1.24, 1.25
Upstream-commit: a3432c2fdbc2bdab15e49599815f42660904fdd9
Component: engine
2016-08-11 14:03:25 +02:00
0eb3f4278c add fields in volume api for 1.24, 1.25
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: b015fd4fb3a8def4812491bae702275efc6ab0cb
Component: engine
2016-08-11 19:56:17 +08:00
1383b4fbda Merge pull request #25590 from thaJeztah/add-node-force-remove-api-docs
Add node remove "force" parameter to 1.25 API docs
Upstream-commit: e26c35408d178e8f6b7c57e26dc57c6fa611622c
Component: engine
2016-08-11 09:47:41 +02:00
4fe64ab5f6 Fix events "since" / "until" query parameter description
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
2016-08-10 23:17:04 +02:00
fcebb07e97 Add node remove "force" parameter to 1.25 API docs
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
2016-08-10 23:01:17 +02:00
350d752bf5 Add API documentation for experimental plugin features
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 83d11710ebcad6ab42d19f97b50a791660a1e057
Component: engine
2016-08-10 21:15:40 +02:00
058048cb32 Merge pull request #25172 from vdemeester/25153-node-delete-update-api-docs
Add delete and update API documentation
Upstream-commit: 2f167a760904f5cf4f6250a55aa8f735fba74594
Component: engine
2016-08-10 08:01:13 +02:00
1934f7b605 Merge pull request #25530 from thaJeztah/docs-update-image-load-response
docs: add missing "quiet" parameter for image/load and update response
Upstream-commit: 06e3ea141707bc3a1d31a18c4768ed6bbf3976d4
Component: engine
2016-08-09 15:26:16 +02:00