Commit graph

450 commits

Author SHA1 Message Date
Aaron Lehmann
c9fdf9abf8 Add force option to service update
Currently, there's no way to restart the tasks of a service without
making an actual change to the service. This leads to us giving awkward
workarounds as in
https://github.com/docker/docker.github.io/pull/178/files, where we tell
people to scale a service up and down to restore balance, or make
unnecessary changes to trigger a restart.

This change adds a --force option to "docker service update", which
forces the service to be updated even if no changes require that.

Since rolling update parameters are respected, the user can use
"docker service --force" to do a rolling restart. For example, the
following is supported:

   docker service update --force --update-parallelism 2 \
   --update-delay 5s myservice

Since the default value of --update-parallelism is 1, the default
behavior is to restart the service one task at a time.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-10-21 17:43:27 -07:00
Akihiro Suda
afb2177631 add missing changes in API v1.25 (prune) to docker_remote_api.md
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2016-10-21 01:33:08 +00:00
Misty Stanley-Jones
790629c021 Merge pull request #27560 from mstanleyjones/sync_docs_master
Sync docker/docker refs with files mistakenly edited in docker.github.io repo
2016-10-20 13:42:40 -07:00
Vincent Demeester
13fd75c3dd Merge pull request #27470 from runcom/expose-exec-pid
record pid of exec'd process
2016-10-20 21:36:21 +02:00
Misty Stanley-Jones
3b36f02c03 Sync docker/docker refs with files mistakenly edited in docker.github.io repo
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-20 10:51:30 -07:00
allencloud
c37d6bf2a0 change created description in api change
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-10-21 00:10:16 +08:00
Antonio Murdaca
1808348136
record pid of exec'd process
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
2016-10-20 17:06:11 +02:00
Yong Tang
9ce8aac55e Show volume options for docker volume inspect
This fix tries to address the issue raised in 25545 where
volume options at the creation time is not showed up
in `docker volume inspect`.

This fix adds the field `Options` in `Volume` type and
persist the options in volume db so that `volume inspect`
could display the options.

This fix adds a couple of test cases to cover the changes.

This fix fixes 25545.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-10-20 05:14:27 -07:00
Jonh Wendell
e03bf1221e Exec: Add ability to set environment variables
Keeping the current behavior for exec, i.e., inheriting
variables from main process. New variables will be added
to current ones. If there's already a variable with that
name it will be overwritten.

Example of usage: docker exec -it -e TERM=vt100 <container> top

Closes #24355.

Signed-off-by: Jonh Wendell <jonh.wendell@redhat.com>
2016-10-19 12:39:25 -02:00
Akihiro Suda
b5bb7de5d2 add creation timestamp to docker network inspect
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2016-10-19 06:38:39 +00:00
Aaron Lehmann
6d4b527699 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>
2016-10-18 10:09:50 -07:00
Yong Tang
e66d210891 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>
2016-10-17 12:28:46 -07:00
Sebastiaan van Stijn
f302226a5b Merge pull request #27429 from thaJeztah/update-api-changelog
Add KernelMemory to API changelog
2016-10-17 11:11:00 -07:00
Sebastiaan van Stijn
8e02b29d24
Improve API format examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-10-16 19:54:08 -07:00
Sebastiaan van Stijn
f988a9ce5e
Add KernelMemory to API changelog
Commit 9bd8a9b66b
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>
2016-10-16 19:42:35 -07:00
Sebastiaan van Stijn
441c9411e3
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>
2016-10-16 19:22:42 -07:00
milindchawre
72dd684c88 Fixes #27095 : Removing registrytoken field from doc as it is deprecated by identitytoken field
Signed-off-by: milindchawre <milindchawre@gmail.com>
2016-10-15 08:38:33 +00:00
Misty Stanley-Jones
b30609446d 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>
2016-10-14 15:44:55 -07:00
Yong Tang
a68047fe68 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>
2016-10-11 15:41:00 -07:00
John Howard
b7f537e811 Inspect populate image OSVersion
Signed-off-by: John Howard <jhoward@microsoft.com>
2016-10-06 11:46:24 -07:00
Victor Vieux
bd99641466 Revert "fix API doc service delete"
This reverts commit a12120e78c.

Signed-off-by: Victor Vieux <vieux@docker.com>
2016-10-01 02:12:41 -07:00
Victor Vieux
a12120e78c fix API doc service delete
Signed-off-by: Victor Vieux <vieux@docker.com>
2016-09-30 22:31:40 -07:00
allencloud
ea07ef7a7c make remove network return 204
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-10-01 19:50:40 +08:00
Arnaud Porterie
86de7c000f Merge pull request #26108 from mlaventure/data-mngt
New Data Management commands
2016-10-01 03:17:18 +00:00
Kenfe-Mickael Laventure
913e5cb77b Add documentation for container, volume, image and system prune subcommands
Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-09-30 14:35:23 -07:00
Kenfe-Mickael Laventure
a860d5db45 Document new /system/df and /{containers,volumes,images}/prune API EndPoints
Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-09-30 14:35:23 -07:00
Yong Tang
c326e0afe3 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>
2016-09-30 05:37:14 -07:00
Misty Stanley-Jones
23207def7c Revert "Add direct link to event chart image"
This reverts commit 86de72fef2.

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

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-29 10:16:41 -07:00
Vincent Demeester
5280ba83e5
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>
2016-09-28 12:45:30 +02:00
Vincent Demeester
97d4b9c465 Merge pull request #26074 from allencloud/return-err-when-remove-container-in-progress
make client side know container removal in progress
2016-09-27 18:48:03 +02:00
Vincent Demeester
b881148385 Merge pull request #26255 from Microsoft/jjh/xenon-test-infrastructure
Add isolation to info - enables Hyper-V containers CI bring-up
2016-09-27 18:46:51 +02:00
allencloud
9a58f298d1 make client side know container removal in progress
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-09-27 18:06:54 +08:00
Sebastiaan van Stijn
6ad4bf0a53 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>
2016-09-26 21:44:34 +02:00
John Howard
c4e1697274 Add isolation to info
Signed-off-by: John Howard <jhoward@microsoft.com>
2016-09-23 12:13:29 -07:00
Tõnis Tiigi
690882c2e7 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>
2016-09-23 11:30:06 -07:00
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
45818d6fc4
Removed engine-api leftovers
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-21 12:36:52 +02: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
Sebastiaan van Stijn
86de72fef2
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>
2016-09-14 23:16:32 +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
Sven Dowideit
2cce7bf33a Merge pull request #26306 from deployable/patch-1
Remote API documentation consistancy
2016-09-12 10:52:30 +10:00