Commit Graph

440 Commits

Author SHA1 Message Date
c0eebabe70 Service update failure thresholds and rollback
This adds support for two enhancements to swarm service rolling updates:

- Failure thresholds: In Docker 1.12, a service update could be set up
  to either pause or continue after a single failure occurs. This adds
  an --update-max-failure-ratio flag that controls how many tasks need to
  fail to update for the update as a whole to be considered a failure. A
  counterpart flag, --update-monitor, controls how long to monitor each
  task for a failure after starting it during the update.

- Rollback flag: service update --rollback reverts the service to its
  previous version. If a service update encounters task failures, or
  fails to function properly for some other reason, the user can roll back
  the update.

SwarmKit also has the ability to roll back updates automatically after
hitting the failure thresholds, but we've decided not to expose this in
the Docker API/CLI for now, favoring a workflow where the decision to
roll back is always made by an admin. Depending on user feedback, we may
add a "rollback" option to --update-failure-action in the future.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: 6d4b527699b3e95d21d79f6b327252a6cdaca5b0
Component: engine
2016-10-18 10:09:50 -07:00
9fc27540de Add config parameter to change per-container stop timeout during daemon shutdown
This fix tries to add a flag `--stop-timeout` to specify the timeout value
(in seconds) for the container to stop before SIGKILL is issued. If stop timeout
is not specified then the default timeout (10s) is used.

Additional test cases have been added to cover the change.

This fix is related to #22471. Another pull request will add `--shutdown-timeout`
to daemon for #22471.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: e66d2108911a2fad016205bdd6bf181f7e822c1c
Component: engine
2016-10-17 12:28:46 -07:00
fcb8f917ad Merge pull request #27429 from thaJeztah/update-api-changelog
Add KernelMemory to API changelog
Upstream-commit: f302226a5ba9cf5d1af4ee5392cd57a71545b80a
Component: engine
2016-10-17 11:11:00 -07:00
e551cfbd30 Improve API format examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 8e02b29d247379d66280babcf654e467989bd4bb
Component: engine
2016-10-16 19:54:08 -07:00
2d39abd104 Add KernelMemory to API changelog
Commit 9bd8a9b66bb493026599d22c7637909cb460d039
added KernelMemory to the API, but forgot
to include this in the API changelog.

This adds the missing entry in the API
changelog.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: f988a9ce5e5926b211c7e762b67cff8e9dbac380
Component: engine
2016-10-16 19:42:35 -07:00
d77bcd1691 Improve example for env vars in API docs
This was added in e41de3e6318ad4cb30eabab9bec60f9fb9d7a76b,
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>
Upstream-commit: 441c9411e369f5146783c46d7a9413917dacaebe
Component: engine
2016-10-16 19:22:42 -07:00
e3ae59fba6 Fixes #27095 : Removing registrytoken field from doc as it is deprecated by identitytoken field
Signed-off-by: milindchawre <milindchawre@gmail.com>
Upstream-commit: 72dd684c88976b7c76cceeafe0ab6c98c8963b62
Component: engine
2016-10-15 08:38:33 +00:00
9fe833df60 Convert Markdown frontmatter to YAML
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: b30609446d212624e3d4ce814c70130b75c552a0
Component: engine
2016-10-14 15:44:55 -07:00
340a49b4b2 Update docs for Size and RefCount for UsageData
In 27294, `Size` and `RefCount` has been wrapped into `UsageData`
and is only exposed in `GET system/df`. Though the docs was not
updated in `docker_remote_api_v1.25.md`.

This fix updates the docs to refect the changes for `UsageData`.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: a68047fe688f59c390b2e8b210d57ff6857e833a
Component: engine
2016-10-11 15:41:00 -07:00
e61236d868 Inspect populate image OSVersion
Signed-off-by: John Howard <jhoward@microsoft.com>
Upstream-commit: b7f537e811d40244c76da93319e3f6f30c4c88e3
Component: engine
2016-10-06 11:46:24 -07:00
06272d8590 Revert "fix API doc service delete"
This reverts commit a12120e78c5852d5571da38e7b9e4cd49f41edc3.

Signed-off-by: Victor Vieux <vieux@docker.com>
Upstream-commit: bd996414667785fb6f69348038f973cfce20a2bc
Component: engine
2016-10-01 02:12:41 -07:00
b0dfc9bb7f fix API doc service delete
Signed-off-by: Victor Vieux <vieux@docker.com>
Upstream-commit: a12120e78c5852d5571da38e7b9e4cd49f41edc3
Component: engine
2016-09-30 22:31:40 -07:00
9a44b50701 make remove network return 204
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: ea07ef7a7c3a221d6167cc2e36806ed9615ac973
Component: engine
2016-10-01 19:50:40 +08:00
dcd98584e4 Merge pull request #26108 from mlaventure/data-mngt
New Data Management commands
Upstream-commit: 86de7c000f5d854051369754ad1769194e8dd5e1
Component: engine
2016-10-01 03:17:18 +00:00
881a82ffc0 Add documentation for container, volume, image and system prune subcommands
Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
Upstream-commit: 913e5cb77bcb7134be2e9b1aaa7e63627285e676
Component: engine
2016-09-30 14:35:23 -07:00
1de35edb56 Document new /system/df and /{containers,volumes,images}/prune API EndPoints
Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
Upstream-commit: a860d5db451f4cab4e49a831139ddcf554de52a2
Component: engine
2016-09-30 14:35:23 -07:00
3f16b8db80 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>
Upstream-commit: c326e0afe39d19a789f0819cb3d81259167a762f
Component: engine
2016-09-30 05:37:14 -07:00
54d60e9c2d Revert "Add direct link to event chart image"
This reverts commit 86de72fef244b3fe209e5793deb40fb26f5b318e.

The link seems malformed and is breaking the overall docs build.

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 23207def7c4a390fe3549f467413c187cc146fee
Component: engine
2016-09-29 10:16:41 -07:00
48a609d72c Add a new "is-task" ps filter
This makes it easier to list containers that are part of a task
(swarm mode) and those who are not.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 5280ba83e55b94b9d4973a15381e18eb10920233
Component: engine
2016-09-28 12:45:30 +02:00
be83d1256c Merge pull request #26074 from allencloud/return-err-when-remove-container-in-progress
make client side know container removal in progress
Upstream-commit: 97d4b9c46528c2d263a448658a6cf78ffd943075
Component: engine
2016-09-27 18:48:03 +02:00
4ab44ced86 Merge pull request #26255 from Microsoft/jjh/xenon-test-infrastructure
Add isolation to info - enables Hyper-V containers CI bring-up
Upstream-commit: b881148385685f3c538a3a085207bfdf30ae9213
Component: engine
2016-09-27 18:46:51 +02:00
672761b64e make client side know container removal in progress
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 9a58f298d182945eb2b820e5e3539b754fdaa751
Component: engine
2016-09-27 18:06:54 +08:00
6352e3e776 API return network-list if no network-name or id is provided
When calling the /networks/ endpoint with a trailing
slash, the default network was returned.

This changes the endpoint to return the list of networks
instead (same response as `/networks` without trailing
slash).

Also updated the description for GetNetworkByName to
explain that the "default" network is returned if
no name or id is provided.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 6ad4bf0a533f8851b0ddccb56fe3b457819f6146
Component: engine
2016-09-26 21:44:34 +02:00
a034d841ce Add isolation to info
Signed-off-by: John Howard <jhoward@microsoft.com>
Upstream-commit: c4e169727474f24cb0eddea15b94aaa2bfbb3281
Component: engine
2016-09-23 12:13:29 -07:00
cc3c0d322a Implement build cache based on history array
Based on work by KJ Tsanaktsidis

Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: KJ Tsanaktsidis <kjtsanaktsidis@gmail.com>
Upstream-commit: 690882c2e79c3f3742c709cf158584e61594ba00
Component: engine
2016-09-23 11:30:06 -07:00
a0b2adc110 Merge pull request #26516 from yongtang/26453-build-bad-syntax
Check bad syntax on dockerfile before building.
Upstream-commit: 72f556a9ff1043a4188e8eeef892d8a0ba4fe34f
Component: engine
2016-09-23 12:24:20 +02:00
b4a97d150a 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>
Upstream-commit: c53efdf4c1f0b2e7f1fe04294d9d64401b8b09b8
Component: engine
2016-09-22 23:40:05 +02:00
9e4c8c252a 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>
Upstream-commit: e33dea5b40a52c5dcda682a1a292584ae6bff00d
Component: engine
2016-09-22 14:33:37 -07:00
7c1d86c305 Removed engine-api leftovers
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 45818d6fc49e6da0369a33f015967fff7417df1c
Component: engine
2016-09-21 12:36:52 +02:00
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