118 Commits

Author SHA1 Message Date
Sean McIntyre
955c0bde09 Add HostConfig.Tmpfs to docs for container creation remote API
Signed-off-by: Sean McIntyre <s.mcintyre@xverba.ca>
(cherry picked from commit 2c38d43eb5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 20:01:34 +01:00
Sebastiaan van Stijn
06b34e507d Improve API format examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 8e02b29d24)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 19:09:08 +01:00
Sebastiaan van Stijn
6d972ff0f7 Improve example for env vars in API docs
This was added in e41de3e631,
but can be a bit confusing due to the "outer" brackets
being for JSON, and the "inner" brackets to indicate
optional values.

During review of that change, this alternative
format was suggested.

Updating the example to use the format that was discussed
during review :)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 441c9411e3)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 19:08:48 +01:00
milindchawre
073515574d Fixes #27095 : Removing registrytoken field from doc as it is deprecated by identitytoken field
Signed-off-by: milindchawre <milindchawre@gmail.com>
(cherry picked from commit 72dd684c88)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 18:55:40 +01:00
Yong Tang
3707a30459 Update docs for node filter of docker service ps
As is specified in 26964, it is possible to specify
a filter based on the node name or node ID.

This fix updates the related docs for that.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
(cherry picked from commit c326e0afe3)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 18:55:03 +01:00
Sebastiaan van Stijn
5dab892618 docs: add missing IPAM options to API docs
Commit dd28ded711
brought in new networking features and API, but
did not document the available IPAM options.

This adds a description of those options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit d69fce79f9)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 18:48:36 +01:00
Misty Stanley-Jones
cf60af87f9 Formatting changes to make 1.12.x ref docs buildable in Jekyll
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-11-09 13:07:24 -08:00
allencloud
180d122c5b make remove network return 204
Signed-off-by: allencloud <allen.sun@daocloud.io>
(cherry picked from commit ea07ef7a7c)
Signed-off-by: Victor Vieux <vieux@docker.com>
2016-09-30 22:49:20 -07:00
Sebastiaan van Stijn
fc884da817 Add missing API docs for "privileged" and "user" exec
The "user" feature was added in docker 1.7.0, and
"privileged" feature was added in docker 1.9.0
only contained CLI docs.

This adds the missing API docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit c53efdf4c1)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:09 +02:00
Sebastiaan van Stijn
121cd6f9e6 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>
(cherry picked from commit 36a25bdbe4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:41 +02:00
Sebastiaan van Stijn
cdda81146b Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 708892c403)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:27 +02:00
Sebastiaan van Stijn
9a207a7eb7 Synchronize API docs
This synchronizes changes between API versions, and:

- applies e0a552504e to
  older versions of the documentation
- applies a2a0a03e2b to
  API version 1.25
- syncs some minor differences

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 53b1dcb25c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:09 +02:00
Sebastiaan van Stijn
ac1eb9edd0 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>
(cherry picked from commit d69409fd43)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:02 +02:00
Antonio Murdaca
7fad9da9f2 docs: reference: api: clarify pull all tags
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
(cherry picked from commit 03a8b6798d)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:17:45 +02:00
Vincent Demeester
c6e7fececb Merge pull request #25719 from eskaaren/master
You can force leave swarm
(cherry picked from commit daf454d8cd)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-14 09:48:23 -07:00
Charles Smith
dc98c76772 Merge pull request #26156 from mstanleyjones/24905_swarm_noun_usage
Sanitize uses of Swarm as a proper and improper noun (Fixes #24905)
(cherry picked from commit 6f0502b89b)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-09 14:44:29 -07:00
Sven Dowideit
5c34d579dc Merge pull request #26302 from vdemeester/health_status-in-event-docs
Add health status as action on events documentations
(cherry picked from commit b468df9eac)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:04:23 -07:00
Vincent Demeester
b7e9344365 Merge pull request #26258 from mstanleyjones/25625_swarm_init_return_value
Add response to swarm/init example (fixes #25625
(cherry picked from commit d4e173fc34)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:02:00 -07:00
Sebastiaan van Stijn
21e168053f Merge pull request #25709 from thaJeztah/fix-missing-docs-for-binary-remote-context
Add missing docs about binary remote contexts
(cherry picked from commit b4abe38d43)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-08-26 15:44:11 -07:00
Sebastiaan van Stijn
88bd4cb0ea Merge pull request #25704 from thaJeztah/cleanup-api-markdown
Cleanup API docs Markdown formatting and wording
(cherry picked from commit 45cb33e65c)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-08-26 15:41:54 -07:00
Eivin Giske Skaaren
c745f4db98 "Annotations" not a parameter
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
(cherry picked from commit 69e481af4e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-17 23:22:00 +02:00
Eivin Giske Skaaren
b313230fa8 Capital D in "ID" returned when creating service
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
(cherry picked from commit 9eb2ec799e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-17 23:22:00 +02:00
Eivin Giske Skaaren
a193f2995e Add doc for inspect swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
(cherry picked from commit c59bc53727)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-17 23:22:00 +02:00
Sebastiaan van Stijn
e24421a6ef 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>
(cherry picked from commit 7cdd693d5d)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-17 23:21:59 +02:00
Sebastiaan van Stijn
e2c8597c8f 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>
(cherry picked from commit bde35ef18a)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-17 23:21:59 +02:00
Tibor Vass
5680192346 Merge pull request #25632 from SvenDowideit/more-docs-1.12.1-cherry-picks
More docs 1.12.1 cherry picks
2016-08-12 00:14:30 -07:00
Sebastiaan van Stijn
798e0b07cb Update usage of "Swarm" for consistency
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit f0230049f0)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-08-11 17:56:43 -07:00
Vincent Demeester
151b799147 Merge pull request #25604 from allencloud/add-missing-fields-in-volume-api
add fields in volume api for 1.24, 1.25
(cherry picked from commit a3432c2fdb)

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 23:45:24 +00:00
Sebastiaan van Stijn
ec26e561b0 Merge pull request #25548 from thaJeztah/plugin-api-docs
Add API documentation for experimental plugin features
(cherry picked from commit 5b68177a6e)

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 23:45:24 +00:00
Sebastiaan van Stijn
6811254691 Merge pull request #25588 from thaJeztah/fix-events-since-description
Fix events "since" query parameter description
(cherry picked from commit 960b7de456)

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md

(cherry picked from commit 006f50ae27)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-08-11 16:36:34 -07:00
Sebastiaan van Stijn
7bd1512ad6 Merge pull request #25172 from vdemeester/25153-node-delete-update-api-docs
Add delete and update API documentation
(cherry picked from commit 2f167a7609)

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md

(cherry picked from commit ee59531352)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-08-11 16:36:34 -07:00
Sebastiaan van Stijn
39d7e266de Merge pull request #25530 from thaJeztah/docs-update-image-load-response
docs: add missing "quiet" parameter for image/load and update response
(cherry picked from commit 06e3ea1417)
Signed-off-by: Tibor Vass <tibor@docker.com>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 16:32:25 -07:00
Sebastiaan van Stijn
f558e71cd2 Merge pull request #25527 from thaJeztah/fix-image-load-api-docs
docs: add missing content-type header for image load
(cherry picked from commit 5fd483695f)
Signed-off-by: Tibor Vass <tibor@docker.com>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 16:32:24 -07:00
Sebastiaan van Stijn
bc967c6ea9 Merge pull request #25405 from thaJeztah/fix-api-markdown
Fix Markdown formatting in API docs
(cherry picked from commit 66671d4ec2)

Signed-off-by: Tibor Vass <tibor@docker.com>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 16:32:21 -07:00
Sebastiaan van Stijn
222e44179c Merge pull request #25194 from vdemeester/23597-swarm-api-ref-fixes
Update `/node/*` api reference documentation
(cherry picked from commit 0ab06816ea)

Signed-off-by: Tibor Vass <tibor@docker.com>

Conflicts:
	docs/reference/api/docker_remote_api_v1.24.md
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 16:32:19 -07:00
Sebastiaan van Stijn
514c1da2bf Merge pull request #25349 from thaJeztah/carry-25174-api-docs-update
[carry 25174] 409 status code result to create service
(cherry picked from commit 2cb1281a4a)

Signed-off-by: Tibor Vass <tibor@docker.com>

Conflicts:
	docs/reference/api/docker_remote_api_v1.24.md
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 16:32:18 -07:00
Sven Dowideit
7ab84e8daf Merge pull request #25241 from jhorwit2/jah/ps-doc-fix
Added shutdown to desired-state docs for filter node/service ps
(cherry picked from commit 1d8617a42b)

Signed-off-by: Tibor Vass <tibor@docker.com>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 16:32:16 -07:00
Vincent Demeester
5f38d112fc Merge pull request #25269 from allencloud/update-remote-api-docs-about-409
add status code 409 in attach in docs
(cherry picked from commit 56cbfc587f)

Signed-off-by: Tibor Vass <tibor@docker.com>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-08-11 16:32:16 -07:00
Sebastiaan van Stijn
2e8165d503 Remove release-candidate advisories
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 053ac127ab)
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
	docs/reference/commandline/service_create.md
2016-07-27 21:46:51 +10:00
Mickaël FORTUNATO
9fa212ba59 Update docker_remote_api_v1.22.md
Update docker_remote_api_v1.23.md
Update docker_remote_api_v1.24.md
Update docker_remote_api_v1.25.md

look like ExecDriver is not return anymore

Signed-off-by: Mickaël Fortunato <morsi.morsicus@gmail.com>
(cherry picked from commit 166928a24b)
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Conflicts:
	docs/reference/api/docker_remote_api_v1.25.md
2016-07-27 20:39:02 +10:00
Aaron Lehmann
a3639e6ac6 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>
(cherry picked from commit 57ae29aa74)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:24:43 -07:00
Sebastiaan van Stijn
e9190e0764 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>
(cherry picked from commit b0089e4827)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:18:23 -07:00
Aaron Lehmann
a0d1201e02 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>
(cherry picked from commit fca0b18dcb)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:18:12 -07:00
Aaron Lehmann
762a73bf7f 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>
(cherry picked from commit a0ccd0d42f)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:18:03 -07:00
Sebastiaan van Stijn
b7a38b19b3 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>
(cherry picked from commit bd81df1278)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:17:26 -07:00
Sebastiaan van Stijn
98f1c30e8c 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>
(cherry picked from commit 987511712f)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:17:06 -07:00
Aaron Lehmann
5d7a3f7b5f Replace secrets with join tokens
Implement the proposal from
https://github.com/docker/docker/issues/24430#issuecomment-233100121

Removes acceptance policy and secret in favor of an automatically
generated join token that combines the secret, CA hash, and
manager/worker role into a single opaque string.

Adds a docker swarm join-token subcommand to inspect and rotate the
tokens.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
(cherry picked from commit 2cc5bd33ee)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:16:59 -07:00
Sebastiaan van Stijn
4d7d354cff Change mount-types to lowercase
these values were changed to lowercase in
690cb2d08c,
but not changed accordingly in docker/docker.

this changes the mounttypes to lowercase

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 8f93128cd6)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:16:28 -07:00
Sebastiaan van Stijn
84e78fe955 Add missing --log-driver and --log-opt docs
Adds documentation for "--log-driver" and "--log-opt"
for services.

Also updated the API docs to include the new
options, and generated a more complete JSON
example.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 5ece2a6e0d)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:15:50 -07:00
Sebastiaan van Stijn
47a16dbe31 bump Go to 1.6.3
following the announcement;
https://groups.google.com/forum/m/#!topic/golang-announce/7JTsd70ZAT0

> [security] Go 1.6.3 and Go 1.7rc2 pre-announcement
>
> Hello gophers,
> We plan to issue Go 1.6.3 and Go 1.7rc2 on Monday July 18 at approximately 2am UTC.
> These are minor release to fix a security issue.
>
> Following our policy at https://golang.org/security, this is the pre-announcement of those releases.
>
> Because we are so late in the release cycle for Go 1.7, we will not issue a minor release of Go 1.5.
> Additionally, we plan to issue Go 1.7rc3 later next week, which will include any changes between 1.7rc1 and tip.
>
> Cheers,
> Chris on behalf of the Go team

**Note:**
the man/Dockerfile is not yet updated, because
the official image for Go 1.6.2 has not yet
been updated.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 589bafddf3)
Signed-off-by: Tibor Vass <tibor@docker.com>
2016-07-25 23:15:39 -07:00