Commit graph

156 commits

Author SHA1 Message Date
Mary Anthony
6ddfe883dd Updating with Sven's comments and other tweaks
Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-16 21:49:33 -07:00
Arnaud Porterie
b6ac111abf Merge pull request #9882 from ibuildthecloud/labels
Proposal: One Meta Data to Rule Them All => Labels
2015-03-16 20:20:05 -07:00
Michael Crosby
e6b18cb66d Merge pull request #11210 from xuhdev/patch-1
Update doc: "docker create" must specify a command
2015-03-16 17:43:17 -07:00
Darren Shepherd
fae92d5f0a Documentation changes for labels
Signed-off-by: Darren Shepherd <darren@rancher.com>
2015-03-16 17:08:40 -07:00
Sebastiaan van Stijn
7d89e66dac Add labels documentation
Adds more documentation for labels and adds the label instruction to the
man-pages.

Also included is a document called "Labels - custom meta-data in Docker"
in the user-guide, this is still a work-in-progress I started to describe
the "namespaces" conventions, an example on storing structured data.

I ran a bit "out of steam" (writers block?) on that document, but kept
it in (for now), in case it still ends up useful.

The Remote API documentation changes will need to be moved to the
docker_remote_api_v1.18.md document when rebasing the whole PR.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Darren Shepherd <darren@rancher.com>
2015-03-13 10:02:04 -07:00
Michal Minar
0eb3544c43 Use system's ephemeral port range for port allocation
Read `/proc/sys/net/ipv4/ip_local_port_range` kernel parameter to obtain
ephemeral port range that now sets the boundaries of port allocator
which finds free host ports for those exported by containers.

Signed-off-by: Michal Minar <miminar@redhat.com>
2015-03-09 09:13:20 +01:00
Hong Xu
fb6fab83df Update doc: specify a dummy command for "docker create"
"docker create" for data containers should specify a dummy command to
avoid accidential "docker start" to cause unexpected data loss.

Signed-off-by: Hong Xu <hong@topbug.net>
2015-03-06 14:37:28 -08:00
moxiegirl
55fc7f5c9d Merge pull request #11204 from duglin/VolumeDocs
Tell users about how VOLUME initializes the new mount point/volume
2015-03-06 10:44:03 -08:00
Doug Davis
9be2ca2394 Tell users about how VOLUME initializes the new mount point/volume
Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-06 10:25:47 -08:00
Doug Davis
3c9425d40d Add some text about env vars when linking containers
In particular, the security implications.

Closes #5169

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-05 09:39:10 -08:00
Sven Dowideit
6d4b0f5334 update the mkdocs.yml to add new docs
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-26 12:11:29 +10:00
Steve Francia
356fe89d24 Merge pull request #10818 from estesp/link-add-aliases 2015-02-19 17:22:53 -05:00
Phil Estes
16aa64dc82 Add linked container's name and hostname as aliases to /etc/hosts
Currently when containers are linked the alias name (e.g. from `--link
name:alias`) is added to the parent container's `/etc/hosts` with a
reference to the IP of the linked container.  Some software requires
using the official hostname or node name in operations that need to
match on those values, and it is therefore helpful if the parent
container can refer to the child/link using those same values and still
access the same IP.

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
2015-02-19 14:19:38 -08:00
Sebastiaan van Stijn
00f2fd1dd5 Docs: Improve description on volume removal
A comment in https://github.com/docker/docker/issues/6354#issuecomment-74160215
brought to light that the "Managing Data in containers" section contained an
incorrect (or confusing) line;

  "Volumes persist until no containers use them"

Which implies that volumes are automatically removed if they are no longer
referenced by a container.

This pull-request attempts to add some information explaining that volumes are
never automatically removed by Docker and adds some extra hints on working
with data volumes.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-02-14 17:04:06 +01:00
Mihai Borobocea
48ee443eca docs: fix typo
There are 2 not 3 RUN instructions in the userguide's Dockerfile.

Signed-off-by: Mihai Borobocea <MihaiBorobocea@gmail.com>
2015-02-04 23:15:18 +02:00
Sven Dowideit
ea6db8af18 Spelling mistake in dockerlinks
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-04 12:12:46 +10:00
Jessie Frazelle
0018afebb8 Merge pull request #10480 from yihangho/docstypo
Fix a tiny typo.
2015-02-03 14:37:35 -08:00
Yihang Ho
50c3ffd009 Fix a tiny typo.
'saving', not 'saveing'

Signed-off-by: Yihang Ho <hoyihang5@gmail.com>
2015-02-01 00:37:27 +08:00
John Tims
2f5919966a Fix documentation typo
Signed-off-by: John Tims <john.k.tims@gmail.com>
2015-01-30 12:44:42 -05:00
Mehul Kar
f1bc02e91f Improve explanation of port mapping from containers
Signed-off-by: Mehul Kar <mehul.kar@gmail.com>
2015-01-29 09:09:44 -08:00
Fred Lifton
e6a70a6f81 Merge pull request #10135 from coolljt0725/update_link_docs
Update the docs for --link accept container id
2015-01-19 18:12:50 -08:00
Sven Dowideit
04d1b93fce Merge pull request #10170 from thaJeztah/docs-note-environment-vars
Document that ENV vars are not automatically updated
2015-01-20 10:04:25 +10:00
James Turnbull
27602f2a21 Merge pull request #10138 from ShockwaveNN/patch-1
fix link to introducion on 'Working with Docker Images' page
2015-01-19 10:53:15 -05:00
Lei Jitang
750373875e Update the docs for --link accept container id
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2015-01-19 09:57:44 +08:00
Sebastiaan van Stijn
3fb06dc104 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>
2015-01-19 00:23:57 +01:00
Bruno Gazzera
44cde56333 There was a missing command to re-run the web container.
Signed-off-by: Bruno Gazzera <bgazzera@paginar.com>
2015-01-18 12:17:49 -03:00
Pavel Lobashov
43b9736842 fix link to introducion on 'Working with Docker Images' page
Old link go to Table of content page, but by context it should go to 'understaning-docker' pag

Signed-off-by: Pavel Lobashov <shockwavenn@gmail.com>
2015-01-16 14:16:10 +03:00
Sven Dowideit
d5df948829 Add a note that remote and Boot2Docker users should not type sudo
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
2015-01-13 21:40:14 -05:00
Fred Lifton
880aeab00d Merge pull request #9491 from SvenDowideit/note-that-volumes-in-b2d-are-special
Add a note to point out to new users that B2D bind-mounts are special-ish
2014-12-31 11:15:01 -08:00
Sven Dowideit
e52988528d Add a note to point out to new users that B2D bind-mounts are special-ish
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
2014-12-30 13:37:31 +10:00
Sven Dowideit
1d4a138670 Talk up the 1.4 change to initialise volumes at time
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
2014-12-30 13:08:53 +10:00
Aaron Huslage
8d7ee36970 Remove -t="" and -m="". Make -t and -m options consistent with help text and other documentation.
Docker-DCO-1.1-Signed-off-by: Aaron Huslage <huslage@gmail.com> (github: huslage)
2014-12-26 12:31:01 -05:00
Sven Dowideit
fbb9223b1a add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2014-12-16 14:46:25 +10:00
James Turnbull
1e81a69618 Merge pull request #9460 from shin-/docs_webhooks2
Webhooks documentation: additional improvements
2014-12-02 17:42:26 -05:00
James Turnbull
6a98ce2fc0 Merge pull request #9273 from programmerq/dockerimages_hub
refer to the registry instead of the hub
2014-12-02 17:15:04 -05:00
Joffrey F
bcef353557 Webhooks documentation: second pass addressing @fredlf's comments
Signed-off-by: Joffrey F <joffrey@docker.com>
2014-12-02 13:49:17 -08:00
Jeff Anderson
46437d1a60 Update dockerimages.md
remove 'public registry'

Signed-off-by: Jeff Anderson <jeff@docker.com>
2014-12-02 10:48:39 -07:00
James Turnbull
9aad1a7d10 Merge pull request #9321 from shin-/docs_webhooks2
Expanded documentation for Webhooks 2.0
2014-11-29 02:11:38 -05:00
James Turnbull
07e9ea86ca Merge pull request #9329 from acbodine/9296-dockervolume-doc-mount-behaviour-fix
Closes #9296 adds a more detailed note about the mount behavior with -v ...
2014-11-27 00:22:19 -05:00
Joffrey F
c83cd5c7ac Expanded documentation for Webhooks 2.0 (chains and callbacks information)
Signed-off-by: Joffrey Fuhrer <joffrey@gmail.com>
2014-11-25 22:22:04 +01:00
Andrew C. Bodine
efb8e8a345 Closes #9296 adds a more detailed note about the mount behavior with -v flag
Signed-off-by: Andrew C. Bodine <acbodine@us.ibm.com>
2014-11-24 23:41:49 -08:00
Joel Friedly
2d2b3535ca Fix typos in the user guide main page
Signed-off-by: Joel Friedly <joelfriedly@gmail.com>
2014-11-21 03:17:00 +00:00
Jeff Anderson
7b20c1fd18 refer to the registry instead of the hub
Signed-off-by: Jeff Anderson <jeff@docker.com>
2014-11-20 16:54:46 -08:00
Michal Minar
e71f241c4b Corrected description of --sig-proxy
Signal proxy does work only in non-TTY mode (--tty=false). Man pages and
commands should not lie about it.

Signed-off-by: Michal Minar <miminar@redhat.com>
2014-11-13 10:50:06 +01:00
Andrey Stolbovsky
932cc23081 Fix typo in Docker Links chapter of User Guide 2014-11-09 23:23:45 +03:00
James Turnbull
387c892126 Merge pull request #8915 from gDD/patch-1
Remove extra line feed typo
2014-11-05 08:22:09 +01:00
Mengdi Gao
795533ede7 Remove extra line feed typo
The removed extra line feed broke the paragraph at https://docs.docker.com/userguide/dockerizing/
2014-11-02 22:55:36 +08:00
Médi-Rémi Hashim
d22d32d61f Grammatical mistake in docs
Change `The team can now use this image by run their own containers.` to `The team can now use this image by running their own containers.`
2014-11-01 21:22:43 +00:00
Thomas LEVEIL
906985123a Reword a sentence bringing confusion about docker links
As [discovered][1] doing user support, the sentence `You've learned that a link creates a
source container that can provide information about itself to a recipient container` brings
confusion.

[1]: http://stackoverflow.com/questions/26652877/how-to-avoid-redundant-container-linking-in-docker-when-propagating-ip-addresses/26654203?noredirect=1#comment41945048_26654203

Signed-off-by: Thomas LEVEIL <thomasleveil@gmail.com>
2014-10-31 13:00:59 +00:00
Sven Dowideit
f1ddda6cf7 Merge pull request #8808 from nhsiehgit/dockerfiletut
changed dockerfile back button to look nicer
2014-10-28 19:41:18 -07:00