be035a0272
YAML docs: add os_type property on flags and (sub)commands
...
This patch adds an `os_type` property in the generated YAML docs, both for
commands, and for flags;
Note that the ostype annotation on flags can have multiple values set,
however, multiple values are currently not used (and unlikely will).
To simplify usage of the os_type property in the YAML, and for consistency with
the same property for commands, we're only using the first ostype that's set.
```yaml
command: docker checkpoint create
short: Create a checkpoint from a running container
long: Create a checkpoint from a running container
usage: docker checkpoint create [OPTIONS] CONTAINER CHECKPOINT [flags]
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: leave-running
value_type: bool
default_value: "false"
description: Leave the container running after checkpoint
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
os_type: windows
```
```yaml
command: docker container start
short: Start one or more stopped containers
long: Start one or more stopped containers
usage: docker container start [OPTIONS] CONTAINER [CONTAINER...] [flags]
pname: docker container
plink: docker_container.yaml
options:
- option: attach
shorthand: a
value_type: bool
default_value: "false"
description: Attach STDOUT/STDERR and forward signals
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: checkpoint
value_type: string
description: Restore from this checkpoint
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
os_type: linux
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
os_type: linux
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
default_value: "false"
description: Attach container's STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
```
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-05-31 22:31:31 +02:00
1f7aa1c036
Add filter support for stack ps and services with Kubernetes
...
Signed-off-by: Mathieu Champlon <mathieu.champlon@docker.com>
2018-05-23 18:27:27 +02:00
fd6165399d
Merge pull request #1070 from taiji-tech/master
...
Update document links of help and comments to make it up-to-date
2018-05-22 16:00:10 +02:00
5119c4d8ef
Update document links and title.
...
Signed-off-by: taiji-tech <csuhqg@foxmail.com>
2018-05-22 21:13:41 +08:00
00d080269a
Hide [flags] in usage output
...
This patch hides the [flags] in the usage output of commands, using the
new `.DisableFlagsInUseLine` option, instead of the temporary workaround
added in 8e600e10f7
2018-05-19 02:51:55 +02:00
3c45963646
Merge pull request #1063 from nkwangleiGIT/master
...
Update some document links of help markdown files
2018-05-18 11:34:17 +02:00
7470d460f6
Document that reserved namespaces org.docker.*, io.docker.*, and
...
org.dockerproject.* in engine labels are now deprecated.
Signed-off-by: Ying Li <ying.li@docker.com>
2018-05-16 14:06:37 -07:00
b6def77c55
Developer Certificate of Origin
...
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: nkwangleiGIT <nkwanglei@126.com>
2018-05-16 20:16:08 +08:00
fdf94de537
Merge pull request #1045 from ieugen/ieugen/patch-1
...
Added description about pids count.
2018-05-14 13:32:47 +02:00
65526a201f
Add namespace column for docker stack ls command while targeting Kubernetes orchestrator
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>
2018-05-09 17:33:16 +02:00
966de2a5f9
Added description about pids count.
...
Documentation in response to issue docker/for-linux#192
Signed-off-by: Ioan Eugen Stan <eu@ieugen.ro>
2018-05-08 22:16:15 +03:00
75c7b95e7a
Allow user to specify default address pools for docker networks
...
This is separate commit for CLI files to address PR 36054
Signed-off-by: selansen <elango.siva@docker.com>
2018-05-05 19:46:28 -04:00
8103326311
Merge pull request #1028 from nstapelbroek/feature/exec-die-event
...
Add exec_die to the list of known container events
2018-04-30 12:26:28 +02:00
13d0c9c695
Add an orchestrator column in the docker stack ls command
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>
2018-04-30 12:04:02 +02:00
4d91812b88
Add exec_die to the list of known container events
...
Signed-off-by: Nico Stapelbroek <nstapelbroek@gmail.com>
2018-04-29 14:52:08 +02:00
55c5e7aa88
Cleaning some manifest documentation typos
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>
2018-04-24 15:00:39 +02:00
771ccaf4ed
Merge pull request #999 from perlun/patch-1
...
build.md: Document --build-arg without value
2018-04-17 10:39:20 -07:00
79c489d812
docker load: Typofix in examples
...
Remove the double "docker docker" from example
Signed-off-by: Henry Ne <henrynmail-github@yahoo.de>
2018-04-16 16:39:54 +02:00
82c23208ee
build.md: Document --build-arg without value
...
This use case is currently _working correctly_, which is nice, but there is no documentation to be found about it. This PR fixes that.
Signed-off-by: Per Lundberg <perlun@gmail.com>
2018-04-16 07:52:13 +03:00
e5980c541a
Merge pull request #970 from cowlinator/temp2
...
Clarify --build-arg documentation
2018-04-13 18:54:16 -07:00
3d0fc8d309
Merge pull request #988 from anusha-ragunathan/plugin_doc
...
Update examples to reflect docker-runc's runtime root for plugins.
2018-04-11 21:32:02 -07:00
066fd62e37
Merge pull request #978 from bogdananton/fix-manifest-docs-typo
...
[docs] Fix typo in manifest command docs: updated `MANFEST` to `MANIFEST`.
2018-04-09 13:25:37 -07:00
5fd9eab3d0
Update examples to reflect docker-runc's runtime root for plugins.
...
Signed-off-by: Anusha Ragunathan <anusha.ragunathan@docker.com>
2018-04-05 12:14:59 -07:00
2ee9635b1e
Fix `docker stack deploy` reference flag
...
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2018-04-03 10:11:52 +02:00
17aaad6f06
Merge pull request #979 from joaofnfernandes/docs-secrets-6294
...
Use printf, not echo when creating secrets
2018-04-03 09:45:11 +02:00
2f7bf40e73
Fix --format example for docker history
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-04-02 16:07:40 -07:00
5238f3e93e
Use printf, not echo when creating secrets
...
Update the docs so that users don't use `echo` when creating
secrets from STDIN. `echo` adds a trailing new line, so users
will probably be confused when their passwords don't work.
Signed-off-by: Joao Fernandes <joao.fernandes@docker.com>
2018-04-02 15:15:19 -07:00
9fa6bd4174
[docs] Fix typo in manifest command docs: updated `MANFEST` to `MANIFEST`.
...
Signed-off-by: Bogdan Anton <contact@bogdananton.ro>
2018-04-01 17:40:31 +03:00
ad44e2d45e
Update build.md
...
Explicitly stated that you must add --build-arg for each build argument.
Added multiple arguments to example of `--build-arg` usage.
Fix for https://github.com/docker/docker.github.io/issues/6248
Signed-off-by: Preston Cowley <cowlinator@gmail.com>
2018-03-26 14:28:49 -07:00
8ca237054f
Clarify behaviour of restart policy in run ref doc
...
This clarifies that the behaviour of `unless-stopped` will restart the container on daemon start. This was implied before, but now the restart-on-daemon-start behaviour is mentioned directly.
Signed-off-by: David Beitey <david@davidjb.com>
2018-03-26 00:21:40 +10:00
e9ce688d6e
Docs touch-ups for "autoremove" and broken anchor
...
`--rm` moved to the daemon, so is now also supported
when combined with `-d`.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-03-21 19:00:11 +01:00
09ec6d4ad9
update doc
...
Signed-off-by: Victor Vieux <victorvieux@gmail.com>
2018-03-13 16:50:56 -07:00
6e21829af4
Refactor content_trust cli/flags handling
...
Remove the global variable used. Allows easier unit testing.
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2018-03-08 15:00:43 -05:00
d281b72a98
Update run.md --restart to include unless-stopped
...
Update --restart option to include unless-stopped to be consistent with https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy
Signed-off-by: Lydell Manganti <lydell.manganti@gmail.com>
2018-02-28 21:05:30 +10:00
b85d87b8ab
docs: mention sctp
...
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2018-02-26 15:27:11 +09:00
ef7d8be86c
Merge pull request #896 from thaJeztah/templated-configs-secrets
...
Add --template-driver option for secrets/configs
2018-02-22 09:44:16 +01:00
84c7dd6057
Merge pull request #843 from sepich/docs-for-pr33130
...
Document long form of --network and --network-add
2018-02-21 23:26:39 +01:00
d11b5ccdfa
Add --template-driver option for secrets/configs
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-02-21 23:22:32 +01:00
1e8530bc34
Merge pull request #885 from thaJeztah/node-engine-version
...
Add Engine version to docker node ls
2018-02-20 18:45:36 +01:00
0c085c2a77
Update docker kill reference docs
...
- explain the either "name" or "id" can be used to reference a container
- explain that signals can be sent by name or number
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-02-20 14:58:55 +01:00
e888dd711f
Add Engine version to docker node ls
...
This adds the Engine version to `docker node ls`, and `.EngineVersion` as a
template option.
With this patch applied:
docker node ls
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS ENGINE VERSION
wp9231itoqsh4rqceojqo01vp * linuxkit-025000000001 Ready Active Leader 18.01.0-ce
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-02-17 02:58:05 +01:00
847cc4bdc0
Merge pull request #564 from thaJeztah/fix-yaml-examples
...
Fix leading characters being stripped from example sections in YAML
2018-02-16 11:22:24 -05:00
94ecd2ba73
Document service --network long form
...
Signed-off-by: Alexander Ryabov <i@sepa.spb.ru>
2018-02-16 09:34:42 +03:00
9a264be221
Merge pull request #869 from mistyhacks/3343-swarm-network-plugins
...
Clarify network plugins and swarm mode
2018-02-13 21:05:44 -05:00
4c50007496
Update reference docs for docker stack deploy
...
`docker stack deploy` now support multiple composefil. This updates the
reference doc to take that fact into account.
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2018-02-09 14:22:45 +01:00
16d29b3cd6
Clarify network plugins and swarm mode
...
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2018-02-08 14:08:31 -08:00
34504d0a1e
Clarify description of volume prune command
...
volume prune command removes only local volumes
not used by at least one container.
Signed-off-by: Sungwon Han <sungwon.han@navercorp.com>
2018-02-08 15:33:07 +09:00
b5df4f69db
Merge pull request #863 from WTFKr0/tls-env-var
...
Add DOCKER_TLS environment variable for --tls option
2018-02-06 10:24:38 -08:00
42fa3ef7d8
Add DOCKER_TLS environment variable
...
Signed-off-by: WTFKr0 <thomas.kovatchitch@gmail.com>
2018-02-06 09:27:05 +01:00
e12f71a9b8
Merge pull request #860 from mistyhacks/explain-netio-blockio
...
Explain the columns shown in docker stats
2018-02-05 18:47:24 -08:00
Sebastiaan van Stijn
Simon Ferquel
Sebastiaan van Stijn
taiji-tech
Ying Li
wanglei
Silvin Lubecki
Ioan Eugen Stan
selansen
Nico Stapelbroek
Henry N
Per Lundberg
Anusha Ragunathan
Vincent Demeester
Vincent Demeester
Joao Fernandes
Bogdan Anton
Preston Cowley
David Beitey
Victor Vieux
Lydell Manganti
Akihiro Suda
Daniel Nephin
Alexander Ryabov
Brian Goff
Misty Stanley-Jones
Sungwon Han
WTFKr0