Commit Graph

787 Commits

Author SHA1 Message Date
2c48e42531 Update docs for HTTP_PROXY
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 7a7c00ca0834e6bad0132d834399bcee4d3b957b
Component: engine
2015-02-12 11:40:56 -08:00
5c56835bc1 Bump api version to 1.18
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
Upstream-commit: d92b4232f7c7cb64efd8e56c33238b4426fe22af
Component: engine
2015-02-10 10:48:54 -08:00
d10ffd08ef Merge pull request #10546 from SvenDowideit/update-boolean-flags-help
Documentation on boolean flags is wrong #10517
Upstream-commit: e706be77a46b11ed2202e226b10f547aa85a8a85
Component: engine
2015-02-06 15:12:11 -08:00
35392998b3 Merge pull request #10558 from gierschv/doc-remote-url
Documents build API "remote" parameter
Upstream-commit: c2f82bba0a7d365ae4712804d9aed50dff788898
Component: engine
2015-02-06 14:51:51 -08:00
4c675886ca Merge pull request #10273 from kojiromike/patch-1
Distinguish ENV from setting environment inline
Upstream-commit: 7d4bbc2ed8305a730267e861bfe71ac7dbd3e373
Component: engine
2015-02-06 14:42:02 -08:00
2d864c1626 Fix example about ps and linked containers
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
Upstream-commit: 0f8f04a77492ddf37ca9c163ef0c3ddaf8a93a40
Component: engine
2015-02-06 14:05:08 -08:00
24564a4544 Merge pull request #10263 from hqhq/hq_check_memoryswap
add check for memoryswap
Upstream-commit: d1f18786ac009fedb716373ebc2ea6d646d3d8f2
Component: engine
2015-02-06 13:43:23 -08:00
f3b4b47f92 Documentation on boolean flags is wrong #10517
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 1e6e68361c6cc42ab92288e0a0132b14ef6c9426
Component: engine
2015-02-06 19:52:01 +10:00
8eee87ed67 Merge pull request #10574 from SvenDowideit/docker-stats-limited-to-libcontainer
For now, docker stats appears to be libcontainer only
Upstream-commit: 68b0ed54cb7ed9e4b66e8a9e0708577b32088de2
Component: engine
2015-02-05 17:52:36 -08:00
a56a6166e9 update docs for memory and memoryswap
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Upstream-commit: 0c0f0d5ab41cae62a441502f26c1c300fc61e25d
Component: engine
2015-02-05 09:12:56 +08:00
a31c4ae7c4 Fix a small spelling error in the dm.blkdiscard docs
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: fcb975cfd17cfbe45b7f6661c2c1c4a94de04c94
Component: engine
2015-02-05 10:57:33 +10:00
13f79dd103 Merge pull request #10508 from SvenDowideit/ctrl-backslash-used-to-generate-a-stacktrace
Remove docker attach generates a stacktrace on ctrl-\ docs, as i can't trigger it
Upstream-commit: 1cc774b4faebdc11f419add5467a6bc19288bce9
Component: engine
2015-02-05 10:21:00 +10:00
38af1c98bd For now, docker stats appears to be libcontainer only
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 2507e0b64fc037a38bf48405b9a0cce1e56cb7c8
Component: engine
2015-02-05 10:12:05 +10:00
8423899da1 Merge pull request #10547 from duglin/Issue10214
Pretty the help text
Upstream-commit: a271eaeba224652e3a12af0287afbae6f82a9333
Component: engine
2015-02-04 11:31:18 -08:00
04baf7b642 Documents build API "remote" parameter
Introduced in Docker v0.4.5 / Remove API v1.1 (#848), the remote
parameter of the API method POST /build allows to specify a buildable
remote URL (HTTPS, HTTP or Git).

Signed-off-by: Vincent Giersch <vincent.giersch@ovh.net>
Upstream-commit: 3cb78bfa76b2b4cc13d697ba6d0136465588828f
Component: engine
2015-02-04 17:07:56 +01:00
013dbb146f Pretty the help text
This modifies the "docker help" text so that it is no wider than 80 chars
and each description fits on one line. This will also try to use ~ when
possible

Added a test to make sure we don't go over 80 chars again.
Added a test to make sure we use ~

Applied rules/tests to all docker commands - not just main help text

Closes #10214

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 2203b37733e76d653cfe3b0ec5870786076adce7
Component: engine
2015-02-04 07:59:16 -08:00
e21086902c Spelling mistake in dockerlinks
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: ea6db8af18c9eee2147d78f987cdacacd37e93fb
Component: engine
2015-02-04 12:12:46 +10:00
e0ba739be5 Docker attach documentation didn't make sense to me
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: e58fdaae056491207349df8747289ed52e04462a
Component: engine
2015-02-03 11:53:14 +10:00
ed0cd8ff3b Distinguish ENV from setting environment inline
It's ambiguous to say that `ENV` is _functionally equivalent to prefixing the command with `<key>=<value>`_. `ENV` sets the environment for all future commands, but `RUN` can take chained commands like `RUN foo=bar bash -c 'echo $foo' && bash -c 'echo $foo $bar'`. Users with a solid understanding of `exec` may grok this without confusion, but less experienced users may need this distinction.

Signed-off-by: Michael A. Smith <msmith3@ebay.com>

Improve Environment Handling Descriptions

- Link `ENV` and `Environment Replacement`
- Improve side-effects of `ENV` text
- Rearrange avoiding side effects text

Signed-off-by: Michael A. Smith <msmith3@ebay.com>
Upstream-commit: 9f6e7e9aed85464651745090692317b30e4a3526
Component: engine
2015-02-02 14:55:25 -05:00
a661737346 docs: change events --since to fit RFC3339Nano
PR6931 changed time format to RFC3339Nano.
But the example in cli.md does not changed.

Signed-off-by: Chen Hanxiao <chenhanxiao@cn.fujitsu.com>
Upstream-commit: d619b5594ba136ab285b93128bbe8fe246678488
Component: engine
2015-02-02 22:39:03 +08:00
69b545f6ad Merge pull request #10351 from duglin/FixDocsWorkdir
Fix docs so WORKDIR mentions it works for COPY and ADD too
Upstream-commit: ba8e1673ad81f97d836acfdacbed5f4c54a0ef68
Component: engine
2015-01-29 09:52:01 -05:00
65b792b36b Replace "base" with "ubuntu" in documentation
The API documentation uses the "base" image in various
places. The "base" image is deprecated and it is no longer
possible to download this image.

This changes the API documentation to use "ubuntu" in stead.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: c0969ed3d896c9add0a2cca7b9a9074cd138571b
Component: engine
2015-01-28 22:54:10 +01:00
a4bc7ec4fb Fix docs so WORKDIR mentions it works for COPY and ADD too
The docs around COPY/ADD already mentioned that it will do a relative
copy/add based on WORKDIR, so that part is already ok.  Just needed to
tweak the WORKDIR section since w/o mentioning COPY/ADD it can be misleading.

Noticed by @phemmer

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: f709da192cda47c9aaaa212b03442d4f28afdb97
Component: engine
2015-01-26 17:13:44 -08:00
aa7720d90d fix /etc/host typo in remote API docs
Signed-off-by: Tony Miller <mcfiredrill@gmail.com>
Upstream-commit: 87d2adf070a44d3d62dfe7ca8c13e95e92f53b64
Component: engine
2015-01-27 10:12:54 +09:00
2bb1b521d1 Merge pull request #10272 from mcfiredrill/document-extrahosts-remote-api
document the ExtraHosts parameter for /containers/create for the remote ...
Upstream-commit: f3fef3127742a2128990d6f824681695478833bc
Component: engine
2015-01-27 10:25:00 +10:00
513e38914d document the ExtraHosts parameter for /containers/create for the remote API
I think this was added from version 1.15.

Signed-off-by: Tony Miller <mcfiredrill@gmail.com>
Upstream-commit: 54c10fe81d1894f9683293601a53a0d87a0d7fbd
Component: engine
2015-01-23 23:52:04 +09:00
5c5aa72c84 Adds docs for /containers/(id)/attach/ws api endpoint
Signed-off-by: Andrew C. Bodine <acbodine@us.ibm.com>
Upstream-commit: 51060ee07aaf3ff10ac7187558bd665f4ddd3507
Component: engine
2015-01-21 18:37:08 -08:00
32b5682b75 Merge pull request #10145 from duglin/Issue10141
Docker run -e FOO should erase FOO if FOO isn't set in client env
Upstream-commit: edaf23b7a7f71626bdafb4e3a9677ad05fa17cab
Component: engine
2015-01-21 14:16:51 -08:00
f0170e8737 Update to docker stats documentation
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: db9b1e3654464b0e7008fbad15d43fbbba87b1a4
Component: engine
2015-01-21 11:44:23 -08:00
a77fb96f4c Add documentation for stats feature
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: 76141a00779880368b15ef2a5ffd28a80e4637df
Component: engine
2015-01-20 20:21:47 -08:00
1c8677b886 Merge pull request #10206 from jfrazelle/add-docs-memory-swap
Add docs for `--memory-swap`.
Upstream-commit: a276706719a9c2d437c643281639ffa80daf1fdd
Component: engine
2015-01-20 18:20:13 -05:00
304cd59f67 Merge pull request #10135 from coolljt0725/update_link_docs
Update the docs for --link accept container id
Upstream-commit: e6a70a6f819c09f2d33b59adc7378f758349ae6d
Component: engine
2015-01-19 18:12:50 -08:00
f4d05bcf4d Merge pull request #10124 from duglin/Issue10034
Add the list of possible values for --log-level to help text
Upstream-commit: 1efc940e6f547760e5e8f4648acb120ff19fdc58
Component: engine
2015-01-19 17:09:18 -08:00
3a60e835c5 Add docs for --memory-swap.
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
Upstream-commit: 7bb4b56cf98662ef5f1deb64bdf8a120490bc258
Component: engine
2015-01-19 16:17:58 -08:00
6d7d2d6f8c Merge pull request #10170 from thaJeztah/docs-note-environment-vars
Document that ENV vars are not automatically updated
Upstream-commit: 04d1b93fce4789ad186b4762d94629c11c79ffbe
Component: engine
2015-01-20 10:04:25 +10:00
bfeba0bea3 Merge pull request #10192 from icecrime/9951_client_proxy_doc
Add documentation for HTTP proxies
Upstream-commit: 826e0beade7deecdae19322e93a417c6c4872822
Component: engine
2015-01-19 18:55:25 -05:00
1a5071a250 Merge pull request #9826 from icecrime/8318_whitespace_add_copy
Support whitespace in paths for ADD and COPY
Upstream-commit: 50ff27caa13b4c558b0ddc9f65297b6ef6eb119d
Component: engine
2015-01-19 18:37:53 -05:00
51e443fb29 Add documentation for HTTP proxies
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 3a1dbef8232ee4f58cbaf3a2776c27a4d5b04bc4
Component: engine
2015-01-19 11:23:31 -08:00
5d2fe159f4 Docker run -e FOO should erase FOO if FOO isn't set in client env
See #10141 for more info, but the main point of this is to make sure
that if you do "docker run -e FOO ..." that FOO from the current env
is passed into the container.  This means that if there's a value, its
set.  But it also means that if FOO isn't set then it should be unset in
the container too - even if it has to remove it from the env.  So,
   unset HOSTNAME
   docker run -e HOSTNAME busybox env
should _NOT_ show HOSTNAME in the list at all

Closes #10141

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 9ab73260f8e4662e7321b257c636928892f023cf
Component: engine
2015-01-19 08:00:32 -08:00
b9a7e1b9ee Fix typo.
Signed-off-by: Liang-Chi Hsieh <viirya@gmail.com>
Upstream-commit: 1b4a926377524455653019c772355bd71a148045
Component: engine
2015-01-19 18:02:23 +08:00
9f931ee8fa Update the docs for --link accept container id
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: 750373875e25455acb046001cb0582873a90bd73
Component: engine
2015-01-19 09:57:44 +08:00
86e0c72c59 Document that ENV vars are not automatically updated
Unlike the entries in `/etc/hosts`, environment-variables for linked
containers are not automatically updated if the linked container is
restarted.

This adds a note to the documentation in;
https://docs.docker.com/userguide/dockerlinks/#environment-variables
and
https://docs.docker.com/reference/run/#env-environment-variables

To make users aware that this is the case and recommends them to use
the `/etc/hosts` entries in stead.

I added this change because users were expecting environment variables
to be updated automatically as well (https://github.com/docker/docker/issues/10164).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 3fb06dc104bb66c3ec7be8a95a33845310083999
Component: engine
2015-01-19 00:23:57 +01:00
611f8510fe Merge pull request #9941 from SvenDowideit/build-pull-option-docs
Add build --pull and evenets --filter flags to the docs for 1.4
Upstream-commit: 00d19150bb937bcc4572edf1f397d4051abb37c1
Component: engine
2015-01-16 13:49:56 -08:00
712286a324 Merge pull request #10125 from estesp/9960-add-backingfs-info
Add backing filesystem info to `docker info` command where applicable
Upstream-commit: eaf3c6f1aca3d2e3bd58300781dd31eec93622b1
Component: engine
2015-01-16 13:41:37 -08:00
310b2cd524 Add backing filesystem info to docker info command where applicable
Fixes #9960

This adds the output of a "Backing Filesystem:" entry to `docker info`
to overlay, aufs, and devicemapper graphdrivers. The default list
includes a fairly complete list of common filesystem names from
linux/include/uapi/linux/magic.h, but if the backing filesystem is not
recognized, the code will simply show "<unknown>"

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
Upstream-commit: 48b1dd0084904678728817d728bb9ab1c0183aad
Component: engine
2015-01-16 14:43:43 -05:00
1964402004 Merge pull request #10104 from thaJeztah/docs-add-note-to-cli-export
Docs: Add note that export doesn't include volume data.
Upstream-commit: 9725433988b7d83bcbbf2af1976995efc0aadd4e
Component: engine
2015-01-16 12:15:46 +13:00
8333dd3c16 Merge pull request #9840 from nhsiehgit/searchapidocs
updated search api docs to include pagination changes
Upstream-commit: 25a8602cbabaec44d5646923b2ae1564a3ba7f8b
Component: engine
2015-01-15 17:40:04 -05:00
468fbf0066 Add the list of possible values for --log-level to help text
Closes #10034

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: ed13110e88846694a675696c161ce6456402f3ef
Component: engine
2015-01-15 12:20:41 -08:00
3b76395570 changed format of cli note
Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
Upstream-commit: c252d5f3f4fc98062fbda6335a04cca2602a4223
Component: engine
2015-01-15 08:39:16 -08:00
3abcc54bab Docs: Add note that export doesn't include volume data.
The documentation on `docker export` doesn't mention that
data in volumes is not included in the export.

This adds a note that volumes are not part of the export
and refers to the "Backup, restore, or migrate data volumes"
to give the user some pointers.

Relates to https://github.com/docker/docker/issues/10095

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 67588d0ec4d73a8f2efb150d555c38b7ebfca7f6
Component: engine
2015-01-15 16:54:45 +01:00