Commit graph

132 commits

Author SHA1 Message Date
Vincent Demeester
72f556a9ff Merge pull request #26516 from yongtang/26453-build-bad-syntax
Check bad syntax on dockerfile before building.
2016-09-23 12:24:20 +02:00
Sebastiaan van Stijn
c53efdf4c1
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>
2016-09-22 23:40:05 +02:00
Yong Tang
e33dea5b40 Update documentation and change log to include the preliminary validation of dockerfile.
This commit updates documentation and change log to include
the preliminary validation of the dockerfile before instructions
in dockerfile is run one-by-one.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-09-22 14:33:37 -07:00
Sebastiaan van Stijn
708892c403
Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-20 17:41:59 +02:00
Sebastiaan van Stijn
36a25bdbe4
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>
2016-09-20 13:51:55 +02:00
Sebastiaan van Stijn
788a8a3cac Merge pull request #26634 from thaJeztah/fix-api-docs-for-services
Fix service and tasks API documentation
2016-09-17 16:13:15 +02:00
Sebastiaan van Stijn
1fb556bb7e Merge pull request #26654 from thaJeztah/sync-api-docs
Synchronize API docs
2016-09-17 16:11:42 +02:00
Sebastiaan van Stijn
53b1dcb25c
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>
2016-09-17 03:02:12 +02:00
Sebastiaan van Stijn
cd73ceffd8
Move HostConfig.Mounts to correct API version
This was added in fc7b904dce,
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>
2016-09-17 02:36:07 +02:00
Sebastiaan van Stijn
d69409fd43
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>
2016-09-17 02:29:38 +02:00
Antonio Murdaca
03a8b6798d
docs: reference: api: clarify pull all tags
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
2016-09-16 16:35:15 +02:00
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
Charles Smith
6f0502b89b Merge pull request #26156 from mstanleyjones/24905_swarm_noun_usage
Sanitize uses of Swarm as a proper and improper noun (Fixes #24905)
2016-09-07 10:38:59 -07:00
Misty Stanley-Jones
a2a0a03e2b Add response to swarm/init example (fixes #25625
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-06 08:39:53 -07:00
Vincent Demeester
fb8b6438f2
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>
2016-09-04 18:01:57 +02:00
Misty Stanley-Jones
82304abd80 Sanitize uses of Swarm as a proper and improper noun
Fixes #24905

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-08-30 11:04:41 -07:00
Vincent Demeester
daf454d8cd Merge pull request #25719 from eskaaren/master
You can force leave swarm
2016-08-22 09:15:37 +02:00
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
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
Eivin Giske Skaaren
033482d9ff You can force leave swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 09:32:45 +02: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
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
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
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
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
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