Commit Graph

904 Commits

Author SHA1 Message Date
moxiegirl f960a79b7c Merge pull request #11311 from delftswa2014/11309-add-filter-name
Adds 'name' filter to the CLI reference.
2015-03-11 14:54:51 -07:00
moxiegirl d010bf0d99 Merge pull request #11291 from ahmetalpbalkan/info/system-date
Add system time to /info
2015-03-11 09:43:43 -07:00
Doug Davis 1b46248a33 Minor tweak to build -f text to make it clear Dockerfile is in context
Closes #11289

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-11 09:04:30 -07:00
Doug Davis 779dca61e5 Add "Docker" to Reference pull-down for Command Line
A minor thing, but I noticed that the "Reference" drop-down menu just
says "Command line".  This was fine when we just had one command line,
but now there's also 'Compose command line' and I suspect we may add
others later.  We should qualify the Docker one with the word "Docker"
in front

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-11 07:43:33 -07:00
Phil Estes 95dcb27484 Merge pull request #11244 from ChristopherBiscardi/docs-code-fixes
Fix a few code rendering errors in docs
2015-03-11 08:34:53 -04:00
Rick Wieman 179e45f27c Adds 'name' filter to the CLI reference.
Also sorts the filter and fixes the bullet list.

Signed-off-by: Rick Wieman <git@rickw.nl>
2015-03-11 07:41:56 +01:00
moxiegirl dd6f76a76c Merge pull request #10663 from brahmaroutu/events_filterbyname_10645
filter events by container name
2015-03-10 21:16:39 -07:00
Mabin 0648e59ad8 docs: api-enable-cors is deprecated,updated docs description
Signed-off-by: Mabin <bin.ma@huawei.com>
2015-03-11 11:38:37 +08:00
Qiang Huang 837eec064d move resources from Config to HostConfig
Cgroup resources are host dependent, they should be in hostConfig.

For backward compatibility, we just copy it to hostConfig, and leave it in
Config for now, so there is no regressions, but the right way to use this
throught json is to put it in HostConfig, like:
  {
      "Hostname": "",
      ...
      "HostConfig": {
	  "CpuShares": 512,
          "Memory": 314572800,
          ...
      }
  }

As we will add CpusetMems, CpusetCpus is definitely a better name, but some
users are already using Cpuset in their http APIs, we also make it compatible.

The main idea is keep using Cpuset in Config Struct, and make it has the same
value as CpusetCpus, but not always, some scenarios:
 - Users use --cpuset in docker command, it can setup cpuset.cpus and can
   get Cpuset field from docker inspect or other http API which will get
   config info.
 - Users use --cpuset-cpus in docker command, ditto.
 - Users use Cpuset field in their http APIs, ditto.
 - Users use CpusetCpus field in their http APIs, they won't get Cpuset field
   in Config info, because by then, they should already know what happens
   to Cpuset.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-03-11 09:31:18 +08:00
Ahmet Alp Balkan 2977fd2b7a Add system time to /info
This change adds daemon's system time as RFC3339Nano to the `/info` endpoint
and shows in a more readable format (UnixDate) in `docker -D info` output.

I will be using this to fix the clock skew between the remote test host and
the CI machines running `docker events`-related tests as they're using `--since`
and `--until` and the timestamps are not matching when daemon is not on the
same machine.

Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2015-03-10 15:29:05 -07:00
Mary Anthony 10c01fce45 Consistency in the restart policy docs
Signed-off-by: Mary Anthony <mary.anthony@docker.com>
2015-03-10 15:13:34 -07:00
Jessie Frazelle 7e47bb6eff Merge pull request #11235 from coolljt0725/fix_default_restart_name
Set default restart policy name to `no` Closes #10874
2015-03-10 12:12:40 -07:00
Lei Jitang 311a600f19 Set default restart policy name to 'no' Closes #10874
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2015-03-10 10:09:12 +08:00
moxiegirl b85c137f1d Merge pull request #11227 from coolljt0725/fix_start_help_message
Fix docker start help message
2015-03-09 09:54:36 -07:00
moxiegirl 8b516bf5ce Merge pull request #11177 from duglin/10805-cp-to-stdot
Add support for 'docker cp' to write to stdout
2015-03-09 09:51:48 -07:00
moxiegirl 08211aab57 Merge pull request #11146 from SvenDowideit/takeover-11126
fix to cpu.shares documentation by @hqhq
2015-03-09 09:48:33 -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
ChristoperBiscardi 79a0fa29f1 Fix a few code rendering errors in docs
Signed-off-by: ChristoperBiscardi <chris@docker.com>
2015-03-08 16:18:43 -07:00
Lei Jitang 3c37f88aff Fix docker start help message
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2015-03-07 20:45:46 +08:00
moxiegirl faa6fd40f4 Merge pull request #11097 from thaJeztah/11069-run-reference-restart-policies
Docs: add restart-policies to 'Run reference'
2015-03-06 22:08:29 -08:00
Sven Dowideit e058b7980d Merge pull request #11195 from ahmetalpbalkan/doc/remote-api-kind
doc/api: explain Kind (ChangeType)
2015-03-07 07:19:29 +10:00
Srini Brahmaroutu e0fa577378 filter events by container name,id or partial id
Addresses #10645

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
2015-03-06 19:54:57 +00: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
Ahmet Alp Balkan 957bc8ac50 remote api: explain Kind (ChangeType)
Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2015-03-05 19:39:14 -08:00
Zhang Wentao 06a40f0f28 docker info display http/https_proxy setting
Signed-off-by: Zhang Wentao <zhangwentao234@huawei.com>
2015-03-06 09:02:21 +08:00
Doug Davis f3d96e81e9 Add support for 'docker cp' to write to stdout
Closes #10805

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-05 15:22:08 -08:00
Sebastiaan van Stijn 8833779ae0 Docs: add restart-policies to 'Run reference'
This moves some information on restart-policies from
the "command line" page to "run reference".

Also fixes some minor typos and adds a "NOTE"
about --rm and --restart not allowed to be combined.

Also removes inline CSS styles from tables,
which will be styled by the stylesheet, and fixes
some minor MarkDown errors (`<` -> &lt;)

depends on https://github.com/docker/docs-base/pull/1

resolves #11069

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-03-05 01:13:53 +01:00
Sven Dowideit 26e5a9d76a fix to cpu.shares documentation by @hqhq
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-03-04 13:13:22 -08:00
Qiang Huang e8dc07dabc docs: fix cpu.shares part in man pages
The original description has some mistakes and lack of many useful
information, I rewrite them to make it accurate and complete.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-03-04 13:01:30 -08:00
Jessie Frazelle 7b3ffd5cc0 Merge pull request #10586 from resouer/10532-fix-cors-hardcode
Fix 10532 to change --api-enable-cors to string.
2015-03-04 18:42:20 +00:00
Jessie Frazelle ffc755ac14 Merge pull request #11134 from duglin/CheckMultiLineHelp
Fix 'docker ps --help' so the options don't span more than one line
2015-03-04 05:53:47 -08:00
Jessie Frazelle df7ba57f5f Merge pull request #9437 from cpuguy83/set_rlimits_in_container
Allow setting ulimits for containers
2015-03-04 04:00:17 -08:00
Jessie Frazelle beea697be3 Merge pull request #10858 from duglin/10807-MixedcaseDockerfile
Support dockerfile and Dockerfile
2015-03-04 03:52:49 -08:00
moxiegirl 98630b2ef6 Merge pull request #11051 from bdehamer/add-registry-api-client-library
Add reference to docker-reg-client
2015-03-03 20:41:42 -08:00
Doug Davis 15924f2385 Support dockerfile and Dockerfile
Closes #10807

Adds support for `dockerfile` ONLY when `Dockerfile` can't be found.
If we're building from a Dockerfile via stdin/URL then always download
it a `Dockerfile` and ignore the -f flag.

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-03 18:38:50 -08:00
Sven Dowideit 93c82360a6 Notes should be indented
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-03-03 13:58:35 -08:00
Doug Davis 5595da2bde Fix 'docker ps --help' so the options don't span more than one line
and add a testcase to catch this in the future.

While in there I also:
- removed extra periods from the few options that had them (new test)
- made the --filter option consistent across all command

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-03 10:02:23 -08:00
resouer dc0a6c1f5e Rebase & update api doc v1.18 instead
Signed-off-by: harry zhang <resouer@163.com>
2015-03-03 12:32:17 +08:00
resouer f3dd2db4ff Add cors header flag and leave boolean flag not changed
Deprecate api-enable-cors

Update docs & man files

Signed-off-by: harry zhang <resouer@163.com>
2015-03-03 11:21:19 +08:00
Dmitry Gusev 39b3690ba1 Update cli.md
Use `-it` combination in example instead of `-ti`, because this is how it used everywhere in examples.

Update dockerfile_best-practices.md

Fix typo in command name

Signed-off-by: Dmitry Gusev <dmitry.gusev@gmail.com>
2015-02-27 23:18:32 +03:00
Jessie Frazelle 94553f1ba6 Merge pull request #10902 from estesp/10855-fix-add-host-doc
Correct --add-host documentation regarding host IP address retrieval
2015-02-26 17:25:01 -08:00
Brian DeHamer 4835430165 Add reference to docker-reg-client
Update the "Docker Remote API Client Libraries" documentation page to
include a reference to the Go-based docker-reg-client package.

Signed-off-by: Brian DeHamer <brian@dehamer.com>
2015-02-26 13:03:39 -08:00
Brian Goff 3f39050637 Allow setting ulimits for containers
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2015-02-25 19:37:43 -05:00
Michael Crosby 9a2e58dd29 Merge pull request #10498 from ashahab-altiscale/9875-lxc-stats
Implements stats for lxc driver
2015-02-25 13:46:18 -08:00
Phil Estes f8a146311d Correct --add-host documentation regarding host IP address retrieval
Fixes: 10855

The example was actually incorrect for many situations, and also, now
that we have IPv6 we should not that the example is for IPv4 and note
how to find IPv6 addresses.  Also, the device they want to connect to
could be the bridge, or main ethernet device, or some other device
name, so note that as well.

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
2015-02-25 09:56:58 -05:00
Dan Walsh 17abfc3ddc pass --change changes to the import job
Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
2015-02-24 13:01:36 -05:00
Dan Walsh 5767548fa7 add docs for commit --change
Docker-DCO-1.1-Signed-off-by: Daniel, Dao Quang Minh <dqminh89@gmail.com> (github: dqminh)

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
2015-02-24 13:01:36 -05:00
Sven Dowideit 1d27930faa Merge pull request #10724 from SvenDowideit/takeover-10470
Update best practices for entrypoint.
2015-02-24 15:32:16 +10:00
Alexander Morozov 02c8881596 Merge pull request #10933 from ahmetalpbalkan/version-daemon-os-arch
cli: Add server OS/Arch info to 'version' cmd
2015-02-23 15:26:53 -08:00
Ahmet Alp Balkan 3346c2e4d9 cli: Add server OS/Arch info to 'version' cmd
Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2015-02-23 14:32:25 -08:00
Abin Shahab 1a26ed09ee Implements stats for lxc driver
Implements stats and fixes stats test.

Signed-off-by: Abin Shahab <ashahab@altiscale.com> (github: ashahab-altiscale)
2015-02-23 10:16:52 +00:00
Sven Dowideit 3c9d45e213 a little re-writing
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-23 12:00:50 +10:00
Brian Goff 4f0429621c Remove CLI doc entry related to API-only function
Closes #10278

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2015-02-20 11:51:42 -05:00
Jessie Frazelle 934535db9c Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers
Allow docker pause and unpause to accept multiple containers
2015-02-19 15:16:05 -08:00
Steve Francia 1875cc2ef4 Merge pull request #10835 from jfrazelle/port-ranges 2015-02-19 16:11:59 -05:00
Jessie Frazelle dc37358d8c Merge pull request #10619 from bcicen/add-logpath-to-inspect-container
Add logpath to inspect container
2015-02-19 12:56:45 -08:00
Ahmet Alp Balkan 27a73a98b7 Shorten help messages for docker cmd flags
In order to fit printed messages to fit 80 chars,
rewording messages for `-H` and `--tls` flags.

Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2015-02-18 22:52:33 -08:00
Bradley Cicenas 06c01b02f5 add logpath to docker inspect.
Signed-off-by: Bradley Cicenas <bradley.cicenas@gmail.com>
2015-02-18 10:19:52 -05:00
Jessie Frazelle 9054e4dca3 Merge pull request #10779 from duglin/10771-FixStatsHelp
Fix 'docker stats' help message
2015-02-16 11:18:58 -08:00
Colm Hally 5dfef4fe08 Group published and exposed ports by contiguous ranges
Signed-off-by: Colm Hally <colmhally@gmail.com>
2015-02-16 10:52:23 -08:00
Michael Crosby 9ea20f260c Merge pull request #10571 from jfrazelle/8689-remove-all-aliases
Removes the feature to pull all image aliases.
2015-02-16 10:29:20 -08:00
Doug Davis effa5e2c18 Use newer help out for 'docker' and 'docker run'
Closes #10828

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-02-16 08:46:07 -08:00
Sven Dowideit d15f8feaa8 Add some information about the docker build return code
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-16 10:02:56 +10:00
Doug Davis b55346b327 Fix 'docker stats' help message
Closes #10771

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-02-13 12:45:50 -08:00
Arnaud Porterie 7a7c00ca08 Update docs for HTTP_PROXY
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2015-02-12 11:40:56 -08:00
Alexander Morozov d92b4232f7 Bump api version to 1.18
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
2015-02-10 10:48:54 -08:00
André Martins 0ce42dcc96 Fixes #10457-Pause-and-unpause-accept-multi-containers
Applied multi parameters to pause and unpause.
Created a new test file dedicated for pause commands.
Created a new utility function to get a slice of paused containers.
Updated documentation

Signed-off-by: André Martins <martins@noironetworks.com>
2015-02-07 00:28:49 +00:00
Jessie Frazelle e706be77a4 Merge pull request #10546 from SvenDowideit/update-boolean-flags-help
Documentation on boolean flags is wrong #10517
2015-02-06 15:12:11 -08:00
Jessie Frazelle c2f82bba0a Merge pull request #10558 from gierschv/doc-remote-url
Documents build API "remote" parameter
2015-02-06 14:51:51 -08:00
Michael Crosby 7d4bbc2ed8 Merge pull request #10273 from kojiromike/patch-1
Distinguish ENV from setting environment inline
2015-02-06 14:42:02 -08:00
Alexander Morozov 0f8f04a774 Fix example about ps and linked containers
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
2015-02-06 14:05:08 -08:00
Michael Crosby d1f18786ac Merge pull request #10263 from hqhq/hq_check_memoryswap
add check for memoryswap
2015-02-06 13:43:23 -08:00
Sven Dowideit 1e6e68361c Documentation on boolean flags is wrong #10517
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-06 19:52:01 +10:00
Fred Lifton 68b0ed54cb Merge pull request #10574 from SvenDowideit/docker-stats-limited-to-libcontainer
For now, docker stats appears to be libcontainer only
2015-02-05 17:52:36 -08:00
Qiang Huang 0c0f0d5ab4 update docs for memory and memoryswap
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-02-05 09:12:56 +08:00
Sven Dowideit fcb975cfd1 Fix a small spelling error in the dm.blkdiscard docs
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-05 10:57:33 +10:00
Sven Dowideit 1cc774b4fa 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
2015-02-05 10:21:00 +10:00
Sven Dowideit 2507e0b64f For now, docker stats appears to be libcontainer only
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-05 10:12:05 +10:00
Jessica Frazelle 72a9000fcf Removes the feature to pull all image aliases.
It didn't work on v2 anyways. And an image with a lot of aliases was slow to
fetch.

Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <princess@docker.com> (github: jfrazelle)
2015-02-04 15:06:34 -08:00
Jessie Frazelle a271eaeba2 Merge pull request #10547 from duglin/Issue10214
Pretty the help text
2015-02-04 11:31:18 -08:00
Vincent Giersch 3cb78bfa76 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>
2015-02-04 17:07:56 +01:00
Doug Davis 2203b37733 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>
2015-02-04 07:59:16 -08: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
Sven Dowideit e58fdaae05 Docker attach documentation didn't make sense to me
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-03 11:53:14 +10:00
Michael A. Smith 9f6e7e9aed 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>
2015-02-02 14:55:25 -05:00
Chen Hanxiao d619b5594b 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>
2015-02-02 22:39:03 +08:00
James Turnbull ba8e1673ad Merge pull request #10351 from duglin/FixDocsWorkdir
Fix docs so WORKDIR mentions it works for COPY and ADD too
2015-01-29 09:52:01 -05:00
Sebastiaan van Stijn c0969ed3d8 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>
2015-01-28 22:54:10 +01:00
Doug Davis f709da192c 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>
2015-01-26 17:13:44 -08:00
Tony Miller 87d2adf070 fix /etc/host typo in remote API docs
Signed-off-by: Tony Miller <mcfiredrill@gmail.com>
2015-01-27 10:12:54 +09:00
Sven Dowideit f3fef31277 Merge pull request #10272 from mcfiredrill/document-extrahosts-remote-api
document the ExtraHosts parameter for /containers/create for the remote ...
2015-01-27 10:25:00 +10:00
Tony Miller 54c10fe81d 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>
2015-01-23 23:52:04 +09:00
Andrew C. Bodine 51060ee07a Adds docs for /containers/(id)/attach/ws api endpoint
Signed-off-by: Andrew C. Bodine <acbodine@us.ibm.com>
2015-01-21 18:37:08 -08:00
Michael Crosby edaf23b7a7 Merge pull request #10145 from duglin/Issue10141
Docker run -e FOO should erase FOO if FOO isn't set in client env
2015-01-21 14:16:51 -08:00
Michael Crosby db9b1e3654 Update to docker stats documentation
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-01-21 11:44:23 -08:00
Michael Crosby 76141a0077 Add documentation for stats feature
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-01-20 20:21:47 -08:00
James Turnbull a276706719 Merge pull request #10206 from jfrazelle/add-docs-memory-swap
Add docs for `--memory-swap`.
2015-01-20 18:20:13 -05: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
Michael Crosby 1efc940e6f Merge pull request #10124 from duglin/Issue10034
Add the list of possible values for --log-level to help text
2015-01-19 17:09:18 -08:00