Commit Graph

136 Commits

Author SHA1 Message Date
ba4754cea8 Merge pull request #32180 from joaofnfernandes/run-docs
Clean `docker run -e` reference docs
Upstream-commit: a0a977864f4160cca882bbe8cc72d944025f6fee
Component: engine
2017-04-12 09:34:30 +02:00
7c776ba71c Clean docker run -e reference docs
Simplified the docs on how to set environment variables in a
container. Makes it clear that you have three options, and how
to use them.

Signed-off-by: Joao Fernandes <joao.fernandes@docker.com>
Upstream-commit: d11c1520f4f4f2c2a3206343f573024b92c42bce
Component: engine
2017-04-11 15:03:31 -07:00
e25f6c5a1b Added start period option to health check.
Signed-off-by: Elias Faxö <elias.faxo@gmail.com>
Upstream-commit: e401f63735d8ebcff387c571d1f61ce52bdea86e
Component: engine
2017-04-06 12:35:34 +02:00
6c1668c7bd cli: add --mount to docker run
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
Upstream-commit: 77fe35b3b903831bd9cfb60a806d056195dc14b6
Component: engine
2017-04-05 04:52:08 +00:00
260796fd5f Documentation for bind mount consistency flags.
Signed-off-by: Jeremy Yallop <yallop@docker.com>
Upstream-commit: 1a710c16600c76ec62ff468f99534e3779efa4a7
Component: engine
2017-03-21 11:55:33 +00:00
6aba7fbe3b Fix typo in run.md documentation
Signed-off-by: John Laswell <john.n.laswell@gmail.com>
Upstream-commit: 4a20252137902100a8a01dd86c698e49dc00e8b2
Component: engine
2017-03-09 13:08:48 -05:00
0d16f73693 Fix description of docker run|create --stop-signal in help message
Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: b303e229ca6ec61e43b1b7a93f6ff034a3945644
Component: engine
2017-03-09 09:32:16 +01:00
948c24d8aa remove Jekyll tags from CLI reference
These Markdown files are now embedded in a YAML
file for templating in the documentation, and
these special markers are no longer needed.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 7e3169f26d4600691de9698598a2e5a064ea85eb
Component: engine
2017-03-02 02:14:15 +01:00
7196026b57 Standardized formatting of CLI reference commands
Command name should be a H1

Only Description, Examples, and Related Commands should be H2

Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands

Added some examples where relevant

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 52df69f00d966904ba230dc2e3a0646cc52b7688
Component: engine
2017-02-08 16:57:58 -08:00
ba31fcddc2 Merge pull request #29692 from yongtang/29492-daemon-shm-size
Add daemon option `--default-shm-size`
Upstream-commit: 354bd4aaddc3072dbe9ead45b22a1eaccda6a506
Component: engine
2017-02-01 16:56:10 +01:00
f890132120 Update opts.MemBytes to disable default, and move docker run/create/build to use opts.MemBytes
This fix made several updates:
1. Update opts.MemBytes so that default value will not show up.
   The reason is that in case a default value is decided by daemon,
   instead of client, we actually want to not show default value.
2. Move `docker run/create/build` to use opts.MemBytes for `--shm-size`
   This is to bring consistency between daemon and docker run
3. docs updates.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: d1982862cacb74fb28f8103d0774960fd59a5373
Component: engine
2017-01-27 12:17:06 -08:00
b35799c15f Allow adding rules to cgroup devices.allow on container create/run
This introduce a new `--device-cgroup-rule` flag that allow a user to
add one or more entry to the container cgroup device `devices.allow`

Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
Upstream-commit: 1756af6fafabd9197feb56c0324e49dd7d30b11f
Component: engine
2017-01-26 07:20:45 -08:00
ea8da37d2a Add docs for run|create --init|--init-path
Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: d049ef2b0db4aebfba4f85f5d8294e9884a4b7e2
Component: engine
2017-01-19 08:47:01 -08:00
a6a7d0048a Merge pull request #29741 from yuexiao-wang/update-option
keep network options consistent between network connect and run
Upstream-commit: ee9bb347a678640a5305314eca99870971c1fc65
Component: engine
2017-01-06 19:01:48 +01:00
6fad25131b Tidy --isolation wording
Signed-off-by: John Howard <jhoward@microsoft.com>
Upstream-commit: 3c32916141f7678e3f0a87fc4de5cb03535a816c
Component: engine
2017-01-04 09:14:10 -08:00
47aebadce2 keep network option consistent between network connect and run
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: 4f9b076e8eecb19083b3875b7cacbc3b660fde75
Component: engine
2017-01-04 19:54:03 +08:00
a66f1eed5f Merge pull request #28838 from AkihiroSuda/remove-run-mount
[Revert #26825] cli: remove `--mount` from `docker run`
Upstream-commit: caaa52c124539acb396c0b711ab95bc7ed459540
Component: engine
2016-11-30 11:56:42 -08:00
8d868f3fc6 Merge pull request #28778 from Microsoft/jjh/volumenote
Windows: Note about volumes in run
Upstream-commit: 7debf456e3320f4c84c3f2b2f2a1b914ad77aa40
Component: engine
2016-11-29 17:40:54 +01:00
b1f04046d7 Windows: Note about volumes in run
Signed-off-by: John Howard <jhoward@microsoft.com>
Upstream-commit: b9e65f40cfce3eb1907ad9d8a358c6ae1ad64175
Component: engine
2016-11-28 11:06:01 -08:00
66e7509ec9 Fix instances of doubled words
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 379e9259cf407f6f97ba31f1ddb921256613cee3
Component: engine
2016-11-28 10:48:45 -08:00
8f7e98f07f cli: remove --mount from docker run
This commit reverts 273eeb813c1db0f42c2ad5e053972eeb00907568 (#26825).
For the discussion so far, please refer to #28527.

Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
Upstream-commit: e6d9b7de649c0b3b59c7d9b698af1c58f6dce289
Component: engine
2016-11-26 04:55:28 +00:00
6e9dda554f Fixes typo 'bin-mounts'
Signed-off-by: John Howard <jhoward@microsoft.com>
Upstream-commit: c8c1dfbaf3d4548bbf094c31ccaaf6858b33e6e0
Component: engine
2016-11-23 14:01:57 -08:00
8bb2169ed5 Merge pull request #28186 from yongtang/27567-follow-up-dns-options
Add `--dns-option` to `docker run` and hide `--dns-opt`
Upstream-commit: 33af4dd505aac709d607d26fc19a16d3dffdd66e
Component: engine
2016-11-10 16:20:17 +01:00
0f8fed3268 Merge pull request #28150 from AkihiroSuda/mounttmpcli
opts/mount: add tmpfs-specific options
Upstream-commit: 55543c45a20b38262b966548b05738260d67b065
Component: engine
2016-11-09 17:50:04 -08:00
a8a11f6c62 Add --dns-option to docker run and hide --dns-opt
This fix is a follow up to #27567 based on:
https://github.com/docker/docker/pull/27567#issuecomment-259295055

In #27567, `--dns-options` has been added to `service create/update`,
together with `--dns` and `--dns-search`. The `--dns-opt` was used
in `docker run`.

This fix add `--dns-option` (not `--dns-options`) to `docker run/create`, and hide
`--dns-opt`. It is still possible to use `--dns-opt` with
`docker run/create`, though it will not show up in help output.

This fix change `--dns-options`to --dns-option` for `docker service create`
and `docker service update`.

This fix also updates the docs and bash/zsh completion scripts.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 9b6b3c2076911ea0a510548943180ac9d1b8c286
Component: engine
2016-11-09 12:13:25 -08:00
3cf5c6ee9d Fixes #24083 : Improving cli help for flags with duration option
Signed-off-by: milindchawre <milindchawre@gmail.com>
Upstream-commit: ecb59a2283be35b2dba2951ed1542afe4e896d8a
Component: engine
2016-11-09 12:17:28 +00:00
c90e9f0913 opts/mount: add tmpfs-specific options
added following options:

 * tmpfs-size
 * tmpfs-mode

Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
Upstream-commit: 45ed6a75795918d466054e63c462a1a8b553c8c0
Component: engine
2016-11-09 02:01:53 +00:00
c8300bf35f Windows: Add cpu count option
Signed-off-by: Darren Stahl <darst@microsoft.com>
Upstream-commit: 4e15420b9be50ddd7fa65e5c7f9b732777f9cc35
Component: engine
2016-11-04 13:38:50 -07:00
a4610ccc0a Merge pull request #28064 from lixiaobing10051267/masterInstallation
modify URL because installation directory removed
Upstream-commit: da499758b8f4fd96213889964ca206b2396bed48
Component: engine
2016-11-04 12:06:37 -07:00
133eec9cfa Add --cpus flag to control cpu resources
This fix tries to address the proposal raised in 27921 and add
`--cpus` flag for `docker run/create`.

Basically, `--cpus` will allow user to specify a number (possibly partial)
about how many CPUs the container will use. For example, on a 2-CPU system
`--cpus 1.5` means the container will take 75% (1.5/2) of the CPU share.

This fix adds a `NanoCPUs` field to `HostConfig` since swarmkit alreay
have a concept of NanoCPUs for tasks. The `--cpus` flag will translate
the number into reused `NanoCPUs` to be consistent.

This fix adds integration tests to cover the changes.

Related docs (`docker run` and Remote APIs) have been updated.

This fix fixes 27921.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 846baf1fd3efcbfbf9d3eb99e436ca9a59d3e185
Component: engine
2016-11-04 09:43:10 -07:00
92845e354d modify URL because installation directory removed
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
Upstream-commit: 56cca9292252efbcecad69fc965d63d99fda5e5e
Component: engine
2016-11-04 16:40:15 +08:00
062414bb0e fix frontmatter keywords value type (string, instead of []string) in /docs/reference
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
Upstream-commit: 248c699ec88bb249ce9fd03001d13f29ac0b4b99
Component: engine
2016-11-03 15:48:30 -07:00
2213e9bb9f cli: add --mount to docker run
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
Upstream-commit: 273eeb813c1db0f42c2ad5e053972eeb00907568
Component: engine
2016-11-03 07:08:59 +00:00
3affb6aba8 Implementing support for --cpu-rt-period and --cpu-rt-runtime so that
containers may specify these cgroup values at runtime. This will allow
processes to change their priority to real-time within the container
when CONFIG_RT_GROUP_SCHED is enabled in the kernel. See #22380.

Also added sanity checks for the new --cpu-rt-runtime and --cpu-rt-period
flags to ensure that that the kernel supports these features and that
runtime is not greater than period.

Daemon will support a --cpu-rt-runtime flag to initialize the parent
cgroup on startup, this prevents the administrator from alotting runtime
to docker after each restart.

There are additional checks that could be added but maybe too far? Check
parent cgroups to ensure values are <= parent, inspecting rtprio ulimit
and issuing a warning.

Signed-off-by: Erik St. Martin <alakriti@gmail.com>
Upstream-commit: 56f77d5ade945b3b8816a6c8acb328b7c6dce9a7
Component: engine
2016-10-26 11:33:06 -04:00
bf7ee5e9d0 Merge pull request #27575 from yuexiao-wang/fix-cli-link
Modify the links for docker container commands
Upstream-commit: 78dae2a037e87825381ec4efb9fb47491f41e7e4
Component: engine
2016-10-21 11:15:57 -07:00
b2f3f16f09 Sync docker/docker refs with files mistakenly edited in docker.github.io repo
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 3b36f02c03ec050aa46f9a01cd2d6c60ffd93652
Component: engine
2016-10-20 10:51:30 -07:00
9f68513228 Modify the links for docker container commands
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: e5e1729698404bd1789b1d4d404fd899cb1ddf08
Component: engine
2016-10-20 22:52:20 +08: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
7b84e05ca6 Merge pull request #24771 from aquasecurity/xfs_quota
Implement XFS quota for overlay2
Upstream-commit: 8863a9f62cb16fbdbb318165ffc8140aeb32c597
Component: engine
2016-10-17 09:23:42 -07: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
75a301f015 Windows: Support credential specs
Signed-off-by: John Howard <jhoward@microsoft.com>
Upstream-commit: e85867cb68cc28208c91bb43fc5cdcff824c468e
Component: engine
2016-10-06 09:32:22 -07:00
89f68050aa Merge pull request #26850 from YuPengZTE/devDot
Del the extra dot
Upstream-commit: a70e6dfe80c8b224b1df4510a3729c9a2c1d249e
Component: engine
2016-09-23 10:10:11 +02:00
d9ba2cf275 Del the extra dot
Signed-off-by: YuPengZTE <yu.peng36@zte.com.cn>
Upstream-commit: 73770c00fc322929215108a44049e51f1d89cae5
Component: engine
2016-09-23 15:22:52 +08:00
b3a741308d overlay2: add support for --storage-opt size
Allow passing --storage-opt size=X to docker create/run commands
for the `overlay2` graphriver.

The size option is only available if the backing fs is xfs that is
mounted with the `pquota` mount option.
The user can pass any size less then the backing fs size.

Signed-off-by: Amir Goldstein <amir73il@aquasec.com>
Upstream-commit: 05bac4591a4519fbac9d3724f3b708e882bbad80
Component: engine
2016-09-22 07:03:14 +03:00
dd0606cd40 Misty's edits and additions
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 3de7d725137ee1620ae2050e65ace4990a3af87e)
Upstream-commit: 5880d629533d9b8ad9889500fe841cb2e31a71c8
Component: engine
2016-09-19 12:12:54 +02:00
e605090acb Add --mount syntax documentation to CLI reference
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: eb3a01eb432473beae968a0c9f3817af8b7a7d53
Component: engine
2016-09-19 11:56:59 +02:00
78d01f16b4 Restore missing "format" example
The "format" example got lost during the
rewrite of the documentation for Cobra. This
restores the missing example.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: edbb8fb86d7d0b715adc15415f0cb187433092a5
Component: engine
2016-09-15 16:09:24 +02:00
849847f7b2 fix some incorrect symbols before executing command
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
Upstream-commit: 7b73b5fd6acf7a8fc3e9cee3437221794879b7c6
Component: engine
2016-09-14 22:28:09 +08:00
64292ad8e2 Merge pull request #26218 from frosforever/fix_run_reference_typo
Correct typo in run reference docs that use the create command
Upstream-commit: e73e37f11206a346d2a552c5d133112cd103d562
Component: engine
2016-09-07 22:18:26 +10:00
4fbbab7cfa The first letter docker is small
Upstream-commit: e0e62874bb9bcdaf6418e0d1728c9170527b3c3a
Component: engine
2016-09-01 17:03:01 +08:00