Commit Graph

67 Commits

Author SHA1 Message Date
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
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
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
458ae31cfd Allow the container to share the PID namespace with the host
We want to be able to use container without the PID namespace.  We basically
want containers that can manage the host os, which I call Super Privileged
Containers.  We eventually would like to get to the point where the only
namespace we use is the MNT namespace to bring the Apps userspace with it.

By eliminating the PID namespace we can get better communication between the
host and the clients and potentially tools like strace and gdb become easier
to use.  We also see tools like libvirtd running within a container telling
systemd to place a VM in a particular cgroup, we need to have communications of the PID.

I don't see us needing to share PID namespaces between containers, since this
is really what docker exec does.

So currently I see us just needing docker run --pid=host

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: 23feaaa240853c0e7f9817f8c2d272dd1c93ac3f
Component: engine
2015-01-13 16:35:17 -08:00
8a09cfa886 Fixed minor typo
Signed-off-by: Christian Stefanescu <st.chris@gmail.com>
Upstream-commit: 32ac770f753a6435cd83f957c1e5d73722d09974
Component: engine
2015-01-06 09:52:21 -08:00
986d8f11d2 add ability to publish range of ports
Closes #8899
Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Upstream-commit: 2338a9cf5a1ba5576b92e49065335a9c9251ade0
Component: engine
2015-01-02 23:21:26 +00:00
912c56d931 add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: fbb9223b1adc16834768acaa7a5776697825deb2
Component: engine
2014-12-16 14:46:25 +10:00
f19d3d8426 Merge pull request #9318 from shishir-a412ed/doc-cpu-share
Enhanced description for 'docker run' command, -c/--cpu-shares flag
Upstream-commit: fb810d18bd27636097baec0eb8db85d1596cb0e5
Component: engine
2014-12-09 17:21:09 -08:00
1d39a69298 Forbid client piping to tty enabled container
Forbid `docker run -t` with a redirected stdin (such as `echo test |
docker run -ti busybox cat`). Forbid `docker exec -t` with a redirected
stdin. Forbid `docker attach` with a redirect stdin toward a tty enabled
container.

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 67e3ddb75ff27b8de0022e330413b4308ec5b010
Component: engine
2014-12-09 14:30:49 -08:00
1e5e5cb310 Added description for 'docker run' command, -c/--cpu-shares flag
Signed-off-by: Shishir Mahajan <shishir.mahajan@redhat.com>
Upstream-commit: 2597bffe9a6538c2db73e2ce380294547b738e2e
Component: engine
2014-12-09 09:55:56 -05:00
b99dd269f2 Merge pull request #9522 from SvenDowideit/add-some-cap-add-examples
Add some cap add examples
Upstream-commit: 03d1622ab82071bcfb10ac29d37a51aa5d77b5d5
Component: engine
2014-12-08 15:50:25 -08:00
85c2d97483 Add a fuse example, combining both SYS_ADMIN and --device
inspired by #9448 and #9487

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
Upstream-commit: 5f2000944b0377f1e5ce86a887f495f1f295dd90
Component: engine
2014-12-05 16:42:48 +10:00
a6b462feda add --cap-add=NET_ADMIN to make a new network device
inspired by #9452

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
Upstream-commit: 48a596a804a24a5b4b3512a58a785b17781c49d0
Component: engine
2014-12-05 16:30:54 +10:00
f3226b6931 Note that using -lxc-conf to change things Docker manages has pitfalls
Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: b91d330088958bca4e59285a55fdc5593d2a86ad
Component: engine
2014-12-04 11:49:06 +10:00
e390ce1d8e Merge pull request #9144 from miminar/sigproxy_tty
Corrected description of --sig-proxy
Upstream-commit: c7e6ad8e987d06385894ee8cd77fe2571ca9bb50
Component: engine
2014-11-19 14:52:01 -08:00
a56997089b 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>
Upstream-commit: e71f241c4b8006f097e4c63f7b3ea28d4591ddee
Component: engine
2014-11-13 10:50:06 +01:00
09b8238fe6 Allow IPC namespace to be shared between containers or with the host
Some workloads rely on IPC for communications with other processes.  We
would like to split workloads between two container but still allow them
to communicate though shared IPC.

This patch mimics the --net code to allow --ipc=host to not split off
the IPC Namespace.  ipc=container:CONTAINERID to share ipc between containers

If you share IPC between containers, then you need to make sure SELinux labels
match.

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: 497fc8876ede9924f61c0eee4dfadd71e5d9f537
Component: engine
2014-11-12 11:29:58 -05:00
b25bfe881c unify (en dash) to - when specifying options
Signed-off-by: Xie Shi <georgexsh@gmail.com>
Upstream-commit: c81337d5dbcc6a670d24f2faf9b181730fe547e4
Component: engine
2014-11-05 13:50:59 +08:00
d1a9c32b50 enhancing set-macaddress docu #2
Signed-off-by: Malte Janduda <mail@janduda.net>
Upstream-commit: 28605bc4d55bcfc7a5562e4de3e01b1d5cd9bdcd
Component: engine
2014-11-04 15:19:47 +01:00
590a54ca61 enhancing set-macaddress docu
Signed-off-by: Malte Janduda <mail@janduda.net>
Upstream-commit: 971fc2253af77ae4a22a3741fff51d84cd9bc697
Component: engine
2014-11-03 11:43:27 +01:00
c0897a4514 Adding docker-cli run param to set MAC address
Signed-off-by: Malte Janduda <mail@janduda.net>
Upstream-commit: f2df38050e019c0db265e7c3e38ee0de8948ca77
Component: engine
2014-11-01 15:35:09 +01:00
b972337ce2 adding support for port ranges on --expose
Closes #1834

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Upstream-commit: fd774a818c7d8942922b4f74eabd2a4e14094e1a
Component: engine
2014-10-31 23:06:30 +00:00
a67bf902c4 Link to run reference from cli doc
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: 9e137ceb578bd427124d4937bc6e440ae5267bf6
Component: engine
2014-10-21 11:21:11 +10:00
fcf584741e Merge pull request #8465 from SvenDowideit/document-device-flag-permission-options
Add info on --device flag permissions ':rwm'
Upstream-commit: 4b594721c409318040d691d2dc1a58dbbab888b5
Component: engine
2014-10-16 14:00:09 -07:00
a91e1dbdcd Add info on --device flag permissions ':rwm'
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: 2709c4677c252a07d49a24f7583adcc17b38fa14
Component: engine
2014-10-13 17:41:12 +10:00
d55dc2f6f0 Add some docs about which env vars are defined in new containers
@SvenDowideit FYI

Closes #3087

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 7d1e197f25d119fd8917d1867cc0284ceea46db4
Component: engine
2014-10-10 15:40:52 -07:00
ee5a12c020 Fix security-opt docs
Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: a260772e48bdb69a2e95b78fccf9ea0fd1a9898b
Component: engine
2014-10-09 15:18:28 -04:00
5cc74547b7 update docs
Signed-off-by: Victor Vieux <vieux@docker.com>
Upstream-commit: 226bc669aa9a886c5a6855e054b751e72d20971b
Component: engine
2014-09-30 18:15:23 +00:00
fe37a1db8f Add --security-opts options to allow user to customize security configuration
security-opts will allow you to customise the security subsystem.

For example the labeling system like SELinux will run on a container.

    --security-opt="label:user:USER"   : Set the label user for the container
    --security-opt="label:role:ROLE"   : Set the label role for the container
    --security-opt="label:type:TYPE"   : Set the label type for the container
    --security-opt="label:level:LEVEL" : Set the label level for the container
    --security-opt="label:disabled"    : Turn off label confinement for the container

Since we are passing a list of string options instead of a space separated
string of options, I will change function calls to use InitLabels instead of
GenLabels.  Genlabels interface is Depracated.

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: 87e732a0f3503517d7a66804bb9a7f74977347e5
Component: engine
2014-09-30 00:06:22 +00:00
e733686489 Doc update to clarify random port mapping on docker run -P
Signed-off-by: Dan Cotora <d@bluevision.ro>
Upstream-commit: a8775d2f9a211b90474b5709ad75b8e1fcb2e189
Component: engine
2014-09-22 08:39:09 +03:00
604739ede9 Allow extra lines in /etc/hosts
This adds a --add-host host:ip flag which appends lines to /etc/hosts.  This is needed in places where you want the container to get a different name resolution than it would through DNS.  This was submitted before as #5525, closed, and now I am re-opening.  It has come up 2 or 3 times in the last couple days.

Signed-off-by: Tim Hockin <thockin@google.com>
Upstream-commit: 68e48b65a64df10fc797cbaa89d6caa2188eadc9
Component: engine
2014-09-16 23:38:23 +00:00
cd4d60a084 Consistently use 'sudo docker' in examples
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: fc9a3b1c1b835c170a4916362855e127a0e366e1
Component: engine
2014-09-16 11:49:05 +10:00
4e3172a877 add -p PORT as a valid format specification
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: e4d2a8231a53794c2b5b28ccf63125a85749e648
Component: engine
2014-09-09 11:16:02 +10:00
a6318245ce Added --device flag to run reference
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 9e34c42d20ef95225bb6c36235d22935365cbef9
Component: engine
2014-09-07 23:17:14 -04:00
ac32065d5c Update /etc/hosts when linked container is restarted
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 450740c891c60dda15b7abe29f35b8e142c2c40e
Component: engine
2014-08-27 18:23:41 -07:00
6ae4c9014c update go import path and libcontainer
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: b3ee9ac74e171e00f14027e39278013629e681b8
Component: engine
2014-07-24 22:19:50 +00:00
19a14797ac Added info re: image[:tag] to make docs consistent. Fixed a markdown issue.
Closes issue #6833

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: 41d6ab6318cc2c8905a174ed28a78dfcad06cef5
Component: engine
2014-07-16 16:39:44 -07:00
19c5a08bfa Adjust Link description to match target
The target document headline is "Managing data in containers" and so should the link be named.
Upstream-commit: fb51a330bb1bfb442f2e220a39a991ea0c69c69b
Component: engine
2014-07-15 22:24:08 +02:00
76bdfebd46 update api doc
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 6bb27f18d19201d8c0b3c509151935308c001c22
Component: engine
2014-07-12 01:03:12 +00:00
c802db49a3 add doc
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: e7d9854414ed77765db49af136533871ba443f3c
Component: engine
2014-07-11 23:43:21 +00:00
323df0e24b Fix typos
Docker-DCO-1.1-Signed-off-by: Bryan Bess <squarejaw@bsbess.com> (github: squarejaw)
Upstream-commit: 1df4049e17e4a3edf4487b072f2085bc2dd2ee0b
Component: engine
2014-07-09 23:14:06 -05:00
0664d3e7f1 run.md: Fix references to cli
There are now no other occurrences of `#cli-` in this document.

TODO: Find other places with wrong links.
Upstream-commit: 95870ef3349920efc981a703d52f5832b79ee18e
Component: engine
2014-07-06 14:47:37 +02:00
c8806a50df I'm going to wish I didn't do this
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: fa29b1f062d25c1a8ca62f02b9cc7533df4c7449
Component: engine
2014-07-03 10:31:56 +10:00
ee97bfaf79 Formatting and consistency fixes to CLI and RUN references
* Removed double backticks.
* Reformatted paragraphs.
* Fixed consistent STDOUT/STDIN/STDERR references.
* Fixed several broken URLs.
* Fixed backtick mismatches.

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 8c765ae68a4a9aceb9886f4d92f2ded7af144e22
Component: engine
2014-06-29 22:25:12 -04:00
87588f265b Fix typo in the docs.
Fix a minor typographical error inside `run.md`.
Upstream-commit: cf6834d797627208a9ec34326a85d594cdf1c918
Component: engine
2014-06-24 03:26:22 +08:00
4cf3d437f1 Fix flag names
Upstream-commit: 80bc06f1cf0833479d59078dc2a73c40711f3980
Component: engine
2014-06-19 11:25:14 +02:00
4c39400bd1 Document the potential insecurity of --net host
Docker-DCO-1.1-Signed-off-by: Timothy <timothyhobbs@seznam.cz> (github: https://github.com/timthelion)
Upstream-commit: ed5054389aa7cd0456bfdf1d940d3cdad0313f8f
Component: engine
2014-06-16 20:40:07 +00:00
99ccd1838c Fix several typos
Docker-DCO-1.1-Signed-off-by: Michael Prokop <github@michael-prokop.at> (github: mika)
Upstream-commit: c0c58b6b46626c0ae5cc9c0b37519c505f5a8484
Component: engine
2014-06-14 23:16:30 +02:00
1b1746cd69 Adding User Guide
* Added User Guide section outlines.
* Added User Guide to menu.
* Moved HTTPS example to articles.
* Replaced Hello World example with User Guide.
* Moved use cases out of examples.
* Updated Introduction to add User Guide.
* Redirected migrated /use and /articles links.
* Added Docker.io section
* Added Dockerized section
* Added Using Docker section
* Added Docker Images section
* Added Docker Links section
* Added Docker Volumes section

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: a7b2c4804b2d98c2b5622db40d3d70b88529d7fe
Component: engine
2014-06-01 17:34:07 -04:00