Commit Graph

427 Commits

Author SHA1 Message Date
e8160e6d23 Update docs for HTTP_PROXY
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 8c6610787a
Component: cli
2017-06-02 00:06:46 +00:00
2859cab687 Documentation on boolean flags is wrong #10517
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 2202790fcd
Component: cli
2017-06-02 00:06:46 +00:00
f0885a3ea4 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: 95fe3a1a93
Component: cli
2017-06-02 00:06:46 +00:00
d738b0d9c0 Fix example about ps and linked containers
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
Upstream-commit: 74279772e5
Component: cli
2017-06-02 00:06:46 +00:00
9882c59f32 Format awsconfig sample config correctly
Reflow change in commit 195f3a3f removed newlines in the config format.

This change reverts the sample config to the original formatting, which
matches the actual config format of a `awsconfig` file.

Signed-off-by: Katie McLaughlin <katie@glasnt.com>
Upstream-commit: 2fedce8411
Component: cli
2017-06-02 00:06:46 +00:00
d22e4aebf1 update docs for memory and memoryswap
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Upstream-commit: c03b0700a4
Component: cli
2017-06-02 00:06:46 +00:00
5a74dcd37e For now, docker stats appears to be libcontainer only
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: e52b4ad35c
Component: cli
2017-06-02 00:06:46 +00:00
f6eff1aac5 Fix a small spelling error in the dm.blkdiscard docs
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: aa33ee11d0
Component: cli
2017-06-02 00:06:46 +00:00
5b966c6a59 Docker attach documentation didn't make sense to me
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 89e02d9d88
Component: cli
2017-06-02 00:06:46 +00:00
f0ff9d086e 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: 130c0bf094
Component: cli
2017-06-02 00:06:46 +00:00
352ffbf987 Spelling mistake in dockerlinks
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: c995dee4c1
Component: cli
2017-06-02 00:06:46 +00:00
3b006fc8cc 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: 2627488a27
Component: cli
2017-06-02 00:06:46 +00:00
5d0802d112 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: 37fd964edb
Component: cli
2017-06-02 00:06:46 +00:00
ec0d1c6463 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: 642218cefa
Component: cli
2017-06-02 00:06:45 +00:00
3de3e281b4 Update to docker stats documentation
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: 3296ada2ed
Component: cli
2017-06-02 00:06:45 +00:00
1bdb79875f Add documentation for stats feature
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: 9da6238f41
Component: cli
2017-06-02 00:06:45 +00:00
417805a657 An initial quick import of documentation from Compose, Machine and Swarm
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: ff12640c2b
Component: cli
2017-06-02 00:06:45 +00:00
a556d8bf19 Add docs for --memory-swap.
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
Upstream-commit: f870b2c6f5
Component: cli
2017-06-02 00:06:45 +00:00
5dccac542c Update the docs for --link accept container id
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: ca57d01f87
Component: cli
2017-06-02 00:06:45 +00:00
ef7ce74d6b 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: 6f56148726
Component: cli
2017-06-02 00:06:45 +00:00
5e88125007 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: 7c63b49df6
Component: cli
2017-06-02 00:06:45 +00:00
b6a4c9fe71 Add documentation for HTTP proxies
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 4939c04b28
Component: cli
2017-06-02 00:06:45 +00:00
88a2eb4a22 Support whitespaces in ADD and COPY continued
Add tests and documentation for this new feature.

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 776f4e478e
Component: cli
2017-06-02 00:06:45 +00:00
686c224963 Fix typo.
Signed-off-by: Liang-Chi Hsieh <viirya@gmail.com>
Upstream-commit: da1720cca2
Component: cli
2017-06-02 00:06:45 +00:00
a7ed566eb0 Add build --pull and evenets --filter flags to the docs for 1.4
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 11c19fc0f3
Component: cli
2017-06-02 00:06:45 +00:00
4b071354e8 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: 74b009e816
Component: cli
2017-06-02 00:06:45 +00:00
fb3a2bf634 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: 72aae7c046
Component: cli
2017-06-02 00:06:45 +00:00
8b57d28fc0 changed format of cli note
Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
Upstream-commit: 40ee6737ea
Component: cli
2017-06-02 00:06:45 +00:00
3c02a08288 added note to man & cli docs on search limit
Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
Upstream-commit: 1c6f4dc7fb
Component: cli
2017-06-02 00:06:45 +00:00
909c972594 Add --readonly for read only container rootfs
Add a --readonly flag to allow the container's root filesystem to be
mounted as readonly.  This can be used in combination with volumes to
force a container's process to only write to locations that will be
persisted.  This is useful in many cases where the admin controls where
they would like developers to write files and error on any other
locations.

Closes #7923
Closes #8752

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: 221cd67e25
Component: cli
2017-06-02 00:06:45 +00:00
3af7c4551a 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)
Upstream-commit: e14d0cf87e
Component: cli
2017-06-02 00:06:44 +00:00
1e0e65f98b 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: f4573ee0bc
Component: cli
2017-06-02 00:06:44 +00:00
07a134c3ff rename a existing container
Closes #3036

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Upstream-commit: d246ce1f3d
Component: cli
2017-06-02 00:06:44 +00:00
67ff33a519 Fix order of pause and port in command line documentation.
Signed-off-by: Andreas Köhler <andi5.py@gmx.net>
Upstream-commit: dde41d008e
Component: cli
2017-06-02 00:06:44 +00:00
52d9478b69 Adding IPv6 network support to docker
Signed-off-by: Malte Janduda <mail@janduda.net>
Upstream-commit: 663bc8e969
Component: cli
2017-06-02 00:06:44 +00:00
2cd1fe2d7b Add @ArikaChen's tip for using HTTPS proxy to pull
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
Upstream-commit: 2b97e7c82e
Component: cli
2017-06-02 00:06:44 +00:00
c0e17b6f88 Specify ENV variables are also used for CMD.
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: fbe252581a
Component: cli
2017-06-02 00:06:44 +00:00
a07f74111e Allow for Dockerfile to be named something else.
Add a check to make sure Dockerfile is in the build context
Add docs and a testcase
Make -f relative to current dir, not build context

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 350d2e33b7
Component: cli
2017-06-02 00:06:44 +00:00
d5c66b30ea Have .dockerignore support Dockerfile/.dockerignore
If .dockerignore mentions either then the client will send them to the
daemon but the daemon will erase them after the Dockerfile has been parsed
to simulate them never being sent in the first place.

an events test kept failing for me so I tried to fix that too

Closes #8330

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: c88762b38b
Component: cli
2017-06-02 00:06:44 +00:00
5119c5b376 Fixed minor typo
Signed-off-by: Christian Stefanescu <st.chris@gmail.com>
Upstream-commit: c5bd80c738
Component: cli
2017-06-02 00:06:44 +00:00
f57d12a5d7 Explicitly mention that '-P' maps to random ports
as noted in https://github.com/boot2docker/boot2docker/issues/690

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: d8d520cfbc
Component: cli
2017-06-02 00:06:44 +00:00
87fbe5d3b9 --help option and help command should print to stdout not stderr
--help and help are successful commands so output should not go to error.

    QE teams have requested this change, also users doing docker help | less
    or docker run --help | less would expect this to work.

    Usage statement should only be printed when the user asks for it.
    Errors should print error message and then suggest the docker COMMAND --help
    command to see usage information.

    The current behaviour causes the user to have to search for the error message
    and sometimes scrolls right off the screen.  For example a error on a
    "docker run" command is very difficult to diagnose.

    Finally erros should always exit with a non 0 exit code, if the user
    makes a CLI error.

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: ea4024d2bd
Component: cli
2017-06-02 00:06:44 +00:00
c998ef06dc Add docs Cloudfront cache invalidation
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
Upstream-commit: bc5dd0cd32
Component: cli
2017-06-02 00:06:44 +00:00
b19512b38c add ability to publish range of ports
Closes #8899
Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Upstream-commit: c33d198609
Component: cli
2017-06-02 00:06:44 +00:00
978d20a4ab Document that there is a delay before the --restart policy restart, and that its double the last one
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
Upstream-commit: 6345932ff1
Component: cli
2017-06-02 00:06:44 +00:00
23e65f459b 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>
Upstream-commit: 04e44cef6b
Component: cli
2017-06-02 00:06:44 +00:00
1fa3bb9676 Add "OOM killed" event based on OOM state information
Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
Upstream-commit: bd4bbf0034
Component: cli
2017-06-02 00:06:43 +00:00
f021a10a56 Allow for relative paths on ADD/COPY
Moved Tianon's PR from: https://github.com/docker/docker/pull/7870
on top of the latest code

Closes: #3936

Signed-off-by: Andrew Page <admwiggin@gmail.com>
Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: c5bc505744
Component: cli
2017-06-02 00:06:43 +00:00
4b167499c3 Update the documentation for #9356 fix
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 8b6198a7f2
Component: cli
2017-06-02 00:06:43 +00:00
b39e021d90 add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 1cc7a4eb81
Component: cli
2017-06-02 00:06:43 +00:00