Commit graph

385 commits

Author SHA1 Message Date
Sebastiaan van Stijn
a5ba032c74 Add missing docs about binary remote contexts
This feature was added in docker 1.8, through
7491f9a9c1.

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;
561bfb268d

This moves the API docs to the correct
versions, and restores the CLI documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-17 16:15:59 +02:00
Sebastiaan van Stijn
45cb33e65c Merge pull request #25704 from thaJeztah/cleanup-api-markdown
Cleanup API docs Markdown formatting and wording
2016-08-17 10:39:45 +02:00
Tõnis Tiigi
9a3e7d9e34 Merge pull request #25701 from WeiZhang555/update-conflict-rm-restart
Forbid update restart policy of container with AutoRemove flag
2016-08-16 10:37:45 -07:00
Sebastiaan van Stijn
641e1564cf Merge pull request #25757 from eskaaren/create_service_id
Capital D in "ID" returned when creating service
2016-08-16 17:01:22 +02:00
Eivin Giske Skaaren
69e481af4e "Annotations" not a parameter
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 15:17:26 +02:00
Eivin Giske Skaaren
9eb2ec799e Capital D in "ID" returned when creating service
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 13:43:23 +02:00
Sebastiaan van Stijn
eb24e9bbd3 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>
2016-08-16 13:22:47 +02:00
Eivin Giske Skaaren
c59bc53727 Add doc for inspect swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 12:49:33 +02:00
Zhang Wei
4754c64ab5 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>
2016-08-16 15:36:13 +08:00
Sebastiaan van Stijn
9079d5ccbb Merge pull request #25706 from thaJeztah/add-authorization-header-to-api-docs
Add X-Registry-Auth header to service API docs
2016-08-15 21:54:06 +02:00
Sebastiaan van Stijn
7cdd693d5d
Move sysctls to correct API version
Commit 067b510dfc move the
sysctls feature to the right API version, but
missed this one.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-15 12:02:54 +02:00
Sebastiaan van Stijn
bde35ef18a
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>
2016-08-15 11:53:12 +02:00
Sebastiaan van Stijn
419d2ad0f8
Update API docs example for image load response
Commit 353af0b3ec 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>
2016-08-12 11:57:34 +02:00
Sebastiaan van Stijn
d8240c8e27 Merge pull request #25564 from coolljt0725/fix_inspect_network
Fix inspect network show gateway with mask
2016-08-12 11:11:09 +02:00
Lei Jitang
096bb5fb07 Fix inspect network show gateway with mask
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2016-08-11 21:08:54 -04:00
Sebastiaan van Stijn
5b68177a6e Merge pull request #25548 from thaJeztah/plugin-api-docs
Add API documentation for experimental plugin features
2016-08-11 21:52:04 +02:00
Vincent Demeester
a3432c2fdb Merge pull request #25604 from allencloud/add-missing-fields-in-volume-api
add fields in volume api for 1.24, 1.25
2016-08-11 14:03:25 +02:00
allencloud
b015fd4fb3 add fields in volume api for 1.24, 1.25
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-08-11 19:56:17 +08:00
Vincent Demeester
e26c35408d Merge pull request #25590 from thaJeztah/add-node-force-remove-api-docs
Add node remove "force" parameter to 1.25 API docs
2016-08-11 09:47:41 +02:00
Sebastiaan van Stijn
ceed39b530
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>
2016-08-10 23:17:04 +02:00
Sebastiaan van Stijn
06fa5c12e8
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>
2016-08-10 23:01:17 +02:00
Sebastiaan van Stijn
83d11710eb Add API documentation for experimental plugin features
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-10 21:15:40 +02:00
Sebastiaan van Stijn
2f167a7609 Merge pull request #25172 from vdemeester/25153-node-delete-update-api-docs
Add delete and update API documentation
2016-08-10 08:01:13 +02:00
Sebastiaan van Stijn
06e3ea1417 Merge pull request #25530 from thaJeztah/docs-update-image-load-response
docs: add missing "quiet" parameter for image/load and update response
2016-08-09 15:26:16 +02:00
Vincent Demeester
da325c035d
Add delete and update API documentation
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-08-09 14:50:46 +02:00
Sebastiaan van Stijn
d13ed38471
docs: add missing "quiet" parameter for image/load and update response
Progress reporting during image load was added
in 415dd86886, 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>
2016-08-09 12:08:33 +02:00
Sebastiaan van Stijn
3892ac7e94
docs: add missing content-type header for image load
Without a content-type header, Go uses a max post size
of 10 megabytes, which makes loading images fail
if they're larger than 10 megabytes

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-09 10:56:49 +02:00
Zhang Wei
7df815d2af Add docs for auto-removal on daemon
Docs for #20848: move "--rm" to daemon side.

Add description for introduced API changes.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
2016-08-09 00:47:12 +08:00
Zhang Wei
6dd8e10d6e Wait container's removal via Events API
If AutoRemove is set, wait until client get `destroy` events, or get
`detach` events that implies container is detached but not stopped.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
2016-08-08 22:46:53 +08:00
Yong Tang
26c913cb60 Update documentation for entrypoint unset with docker run/create
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-08-05 16:35:25 -07:00
Sebastiaan van Stijn
5696c47470 Sync API docs
This synchronizes formatting changes to older
versions of the API

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-05 17:44:58 +02:00
Sebastiaan van Stijn
33bd963cfb
Fix Markdown formatting in API docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-04 14:13:30 +02:00
Vincent Demeester
63d65505b2 Update /node/* api reference documentation
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-08-03 14:55:30 +02:00
Daniel X Moore
397cc85643
409 status code result to create service
Added example 409 status code result to the create service endpoint.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-03 00:46:04 +02:00
Sven Dowideit
1d8617a42b Merge pull request #25241 from jhorwit2/jah/ps-doc-fix
Added shutdown to desired-state docs for filter node/service ps
2016-08-02 13:05:47 -07:00
Josh Horwitz
aae149bd52 Added shutdown to desired-state docs for filter node/service ps
Signed-off-by: Josh Horwitz <horwitzja@gmail.com>

$Updated http docs for /tasks filters

$Signed-off-by: Josh Horwitz <horwitzja@gmail.com>
2016-08-01 09:41:54 -04:00
allencloud
b22a291931 add status code 409 in attach in docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-08-01 01:21:50 +08:00
Justin Cormack
c388a5bdfa Merge pull request #25034 from thaJeztah/update-swarm-usage
Update usage of "Swarm" for consistency
2016-07-29 01:01:00 +01:00
Sebastiaan van Stijn
2b9838eafe
docs: re-enable API 1.25
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-28 02:11:34 +02:00
Sebastiaan van Stijn
f0230049f0
Update usage of "Swarm" for consistency
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-27 23:31:55 +02:00
Sebastiaan van Stijn
053ac127ab
Remove release-candidate advisories
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-27 11:24:16 +02:00
Tibor Vass
c65925f24b Merge pull request #24943 from aaronlehmann/rolling-updates
Add failure action for rolling updates
2016-07-25 10:15:28 -07:00
Aaron Lehmann
57ae29aa74 Add failure action for rolling updates
This changes the default behavior so that rolling updates will not
proceed once an updated task fails to start, or stops running during the
update. Users can use docker service inspect --pretty servicename to see
the update status, and if it pauses due to a failure, it will explain
that the update is paused, and show the task ID that caused it to pause.
It also shows the time since the update started.

A new --update-on-failure=(pause|continue) flag selects the
behavior. Pause means the update stops once a task fails, continue means
the old behavior of continuing the update anyway.

In the future this will be extended with additional behaviors like
automatic rollback, and flags controlling parameters like how many tasks
need to fail for the update to stop proceeding. This is a minimal
solution for 1.12.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-07-25 08:51:19 -07:00
Sebastiaan van Stijn
b0089e4827
Add new error to API docs
Commit cc493a52a4 added
a constraint to network connect/disconnect operations
on "Swarm scoped" networks.

This adds those errors to the API documentation. Also
changes the error to lowercase for consistency.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-25 12:04:55 +02:00
Aaron Lehmann
fca0b18dcb Require listen address and advertise address to be an IP address or an interface name
Hostnames are not supported for now because libnetwork can't use them
for overlay networking yet.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-07-24 09:23:38 -07:00
Aaron Lehmann
a0ccd0d42f Split advertised address from listen address
There are currently problems with "swarm init" and "swarm join" when an
explicit --listen-addr flag is not provided. swarmkit defaults to
finding the IP address associated with the default route, and in cloud
setups this is often the wrong choice.

Introduce a notion of "advertised address", with the client flag
--advertise-addr, and the daemon flag --swarm-default-advertise-addr to
provide a default. The default listening address is now 0.0.0.0, but a
valid advertised address must be detected or specified.

If no explicit advertised address is specified, error out if there is
more than one usable candidate IP address on the system. This requires a
user to explicitly choose instead of letting swarmkit make the wrong
choice. For the purposes of this autodetection, we ignore certain
interfaces that are unlikely to be relevant (currently docker*).

The user is also required to choose a listen address on swarm init if
they specify an explicit advertise address that is a hostname or an IP
address that's not local to the system. This is a requirement for
overlay networking.

Also support specifying interface names to --listen-addr,
--advertise-addr, and the daemon flag --swarm-default-advertise-addr.
This will fail if the interface has multiple IP addresses (unless it has
a single IPv4 address and a single IPv6 address - then we resolve the
tie in favor of IPv4).

This change also exposes the node's externally-reachable address in
docker info, as requested by #24017.

Make corresponding API and CLI docs changes.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-07-24 09:23:07 -07:00
Vincent Demeester
3742557ed4 Merge pull request #24932 from thaJeztah/change-to-camelBack-for-consistency
Change "rotate_worker_token" to "rotateWorkerToken"
2016-07-24 10:05:07 +02:00
Sebastiaan van Stijn
987511712f Remove "secrets" leftovers from docs
f5e1f6f688 replaced "secrets"
with "join tokens", which also removed the "auto-accept"
policy.

This removes some remaining references to those features.

Note that there are other references, but those
are already addressed in another pull request.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-23 01:28:20 +02:00
Sebastiaan van Stijn
bd81df1278
Change "rotate_worker_token" to "rotateWorkerToken"
This renames the `rotate_xxx` flags to camelBack, for
consistency with other API query-params, such as
`detachKeys`, `noOverwriteDirNonDir`, and `fromImage`.

Also makes this flag accept a wider range of boolean
values ("0", "1", "true", "false"), and throw an error
if an invalid value is passed.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-23 01:04:12 +02:00
Tibor Vass
f5e1f6f688 Merge pull request #24823 from aaronlehmann/join-tokens
Replace secrets with join tokens
2016-07-21 18:06:55 -07:00