moby/docs/reference/commandline
Josh Hawn 4921171587 Update ContainerWait API
This patch adds the untilRemoved option to the ContainerWait API which
allows the client to wait until the container is not only exited but
also removed.

This patch also adds some more CLI integration tests for waiting for a
created container and waiting with the new --until-removed flag.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Handle detach sequence in CLI

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Update Container Wait Conditions

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Apply container wait changes to API 1.30

The set of changes to the containerWait API missed the cut for the
Docker 17.05 release (API version 1.29). This patch bumps the version
checks to use 1.30 instead.

This patch also makes a minor update to a testfile which was added to
the builder/dockerfile package.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Remove wait changes from CLI

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Address minor nits on wait changes

- Changed the name of the tty Proxy wrapper to `escapeProxy`
- Removed the unnecessary Error() method on container.State
- Fixes a typo in comment (repeated word)

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Use router.WithCancel in the containerWait handler

This handler previously added this functionality manually but now uses
the existing wrapper which does it for us.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Add WaitCondition constants to api/types/container

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Address more ContainerWait review comments

- Update ContainerWait backend interface to not return pointer values
  for container.StateStatus type.
- Updated container state's Wait() method comments to clarify that a
  context MUST be used for cancelling the request, setting timeouts,
  and to avoid goroutine leaks.
- Removed unnecessary buffering when making channels in the client's
  ContainerWait methods.
- Renamed result and error channels in client's ContainerWait methods
  to clarify that only a single result or error value would be sent
  on the channel.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Move container.WaitCondition type to separate file

... to avoid conflict with swagger-generated code for API response

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

Address more ContainerWait review comments

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)
2017-05-16 15:11:39 -07:00
..
attach.md Update attach.md 2017-05-02 18:09:04 -07:00
build.md Merge pull request #33185 from tonistiigi/docs-build-target 2017-05-15 22:14:54 +02:00
cli.md Update CLI docs and add opts/config.go 2017-05-11 10:08:21 -07:00
commit.md Added word to documentation 2017-04-10 09:14:01 -04:00
container.md Add cli reference docs for root-level commands 2017-03-27 11:10:58 +02:00
container_prune.md Update docs of label filter for docker system prune 2017-04-11 12:08:55 -07:00
cp.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
create.md remove --init-path from client 2017-04-10 16:49:43 +02:00
deploy.md Add --prune to stack deploy. 2017-03-14 16:09:28 -04:00
diff.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
dockerd.md Merge pull request #31104 from cpuguy83/dm_lvmsetup 2017-05-05 07:35:24 -04:00
events.md Add doc for system events and events[Fix #32748] 2017-04-26 21:27:45 +03:00
exec.md Clarify where the RUN command runs from 2017-04-26 13:54:48 -04:00
export.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
history.md Minor fixups for history CLI reference 2017-04-16 12:51:29 -05:00
image.md Add cli reference docs for root-level commands 2017-03-27 11:10:58 +02:00
image_prune.md Update docs of label filter for docker system prune 2017-04-11 12:08:55 -07:00
images.md Fix markdown indentation level 2017-04-16 12:56:00 -05:00
import.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
index.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
info.md Update the CLI docs to display whether a root rotation is in progress 2017-05-11 10:48:22 -07:00
inspect.md Merge pull request #31901 from davidxia/fix-docs 2017-03-28 14:00:05 +02:00
kill.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
load.md docs: added support for CLI yaml file generation 2017-03-14 16:04:08 -07:00
login.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
logout.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
logs.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
network.md Edits to CLI reference 2017-04-05 11:27:09 -07:00
network_connect.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
network_create.md Allow user to modify ingress network 2017-03-26 15:46:18 -07:00
network_disconnect.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
network_inspect.md Enhance network inspect to show all tasks, local & non-local, in swarm mode 2017-03-13 17:52:08 -07:00
network_ls.md Add --filter scope=swarm|local for docker network ls 2017-03-23 18:48:11 -07:00
network_prune.md Update docs of label filter for docker system prune 2017-04-11 12:08:55 -07:00
network_rm.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
node.md Add cli reference docs for root-level commands 2017-03-27 11:10:58 +02:00
node_demote.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
node_inspect.md Update the CLI docs to display whether a root rotation is in progress 2017-05-11 10:48:22 -07:00
node_ls.md Update the CLI docs to display whether a root rotation is in progress 2017-05-11 10:48:22 -07:00
node_promote.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
node_ps.md provide examples 2017-03-31 05:11:36 +08:00
node_rm.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
node_update.md Merge pull request #30814 from YuPengZTE/devSwarmCliExplain 2017-02-21 00:59:58 +01:00
pause.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
plugin.md Add cli reference docs for root-level commands 2017-03-27 11:10:58 +02:00
plugin_create.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
plugin_disable.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
plugin_enable.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
plugin_inspect.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
plugin_install.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
plugin_ls.md Add support for metrics plugins 2017-05-12 00:30:09 -04:00
plugin_push.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
plugin_rm.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
plugin_set.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
plugin_upgrade.md fix some typos for plugin 2017-04-28 23:47:45 +08:00
port.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
ps.md Fix markdown in references for Kramdown 2017-03-12 12:01:06 -07:00
pull.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
push.md Updated push.md with progress bar info 2017-03-24 10:25:52 -04:00
rename.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
restart.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
rm.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
rmi.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
run.md Clarify --env-file usage with names without values 2017-04-28 09:03:40 +02:00
save.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
search.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
secret.md Add cli reference docs for root-level commands 2017-03-27 11:10:58 +02:00
secret_create.md specify max size for secret in doc 2017-03-28 10:17:03 +08:00
secret_inspect.md specify max size for secret in doc 2017-03-28 10:17:03 +08:00
secret_ls.md Merge pull request #30810 from allencloud/make-secret-ls-support-filter 2017-03-28 13:43:19 +02:00
secret_rm.md specify max size for secret in doc 2017-03-28 10:17:03 +08:00
service.md Fix inconsisticy for service logs 2017-04-12 22:43:14 +08:00
service_create.md do not allow duration less than 1 ms in healthcheck parameters 2017-04-12 10:48:31 -07:00
service_inspect.md remove Jekyll tags from CLI reference 2017-03-02 02:14:15 +01:00
service_logs.md Remove experimental from service logs 2017-04-10 13:40:45 -07:00
service_ls.md Add PORTS field for docker service ls (ingress) 2017-04-03 18:40:15 -07:00
service_ps.md provide examples 2017-03-31 05:11:36 +08:00
service_rm.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
service_scale.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
service_update.md do not allow duration less than 1 ms in healthcheck parameters 2017-04-12 10:48:31 -07:00
stack.md Add cli reference docs for root-level commands 2017-03-27 11:10:58 +02:00
stack_deploy.md Add --prune to stack deploy. 2017-03-14 16:09:28 -04:00
stack_ls.md Add format to docker stack ls 2017-04-25 16:45:30 +03:00
stack_ps.md provide examples 2017-03-31 05:11:36 +08:00
stack_rm.md stack rm should accept multiple arguments 2017-04-05 01:08:37 -04:00
stack_services.md Fix markdown in references for Kramdown 2017-03-12 12:01:06 -07:00
start.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
stats.md remove Jekyll tags from CLI reference 2017-03-02 02:14:15 +01:00
stop.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
swarm.md Add cli reference docs for root-level commands 2017-03-27 11:10:58 +02:00
swarm_init.md Inroduce SWARM --data-path-addr flag 2017-04-26 15:33:15 -07:00
swarm_join.md Inroduce SWARM --data-path-addr flag 2017-04-26 15:33:15 -07:00
swarm_join_token.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
swarm_leave.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
swarm_unlock.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
swarm_unlock_key.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
swarm_update.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
system.md Edits to CLI reference 2017-04-05 11:27:09 -07:00
system_df.md Add bash completion for system df --format 2017-04-27 10:29:19 +02:00
system_events.md Add doc for system events and events[Fix #32748] 2017-04-26 21:27:45 +03:00
system_prune.md Update docs of label filter for docker system prune 2017-04-11 12:08:55 -07:00
tag.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
top.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
unpause.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
update.md Add --cpus support for docker update 2017-04-06 15:40:12 -07:00
version.md remove Jekyll tags from CLI reference 2017-03-02 02:14:15 +01:00
volume.md Edits to CLI reference 2017-04-05 11:27:09 -07:00
volume_create.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
volume_inspect.md remove Jekyll tags from CLI reference 2017-03-02 02:14:15 +01:00
volume_ls.md remove Jekyll tags from CLI reference 2017-03-02 02:14:15 +01:00
volume_prune.md Update docs of label filter for docker system prune 2017-04-11 12:08:55 -07:00
volume_rm.md Standardized formatting of CLI reference commands 2017-02-08 16:57:58 -08:00
wait.md Update ContainerWait API 2017-05-16 15:11:39 -07:00