Commit Graph

890 Commits

Author SHA1 Message Date
Alexander Morozov de22669377 docs: move sysctls docs to current API version
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
2016-06-14 15:14:16 -07:00
Kenfe-Mickael Laventure 7b2e5216b8 Add support for multiples runtimes
Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-06-14 07:47:31 -07:00
Sven Dowideit c913dd5f57 Merge pull request #23489 from thaJeztah/fix-indentation
API docs cleanup
2016-06-14 21:49:48 +10:00
Sven Dowideit 2a96ac66ea Merge pull request #23492 from londoncalling/docs-surface-tutorials-v1.12
surfacing Learn by example topics to top level of Docker Engine docs
2016-06-14 21:10:17 +10:00
Amit Shukla 9acf97b72a CLI docs
Signed-off-by: Amit Shukla <amit.shukla@docker.com>
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:17:15 -07:00
Arnaud Porterie (icecrime) d4abe1d84a Add swarm api reference docs
Signed-off-by: Arnaud Porterie (icecrime) <arnaud.porterie@docker.com>
2016-06-13 22:16:18 -07:00
John Howard bfed05be0b Merge pull request #23447 from Microsoft/RemoveQosValidation
Removed QoS validation on Windows
2016-06-13 14:47:06 -07:00
Victoria Bialas 8eca8089fa surfacing Learn by example topics to top level of Docker Engine docs
fixing links after moving surfacing tutorials

fixing more links for the newly located tutorials

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2016-06-13 13:32:30 -07:00
Michael Crosby 8a2f9a249c Merge pull request #22126 from dmcgowan/overlay-native-diff
Overlay multiple lower directory support
2016-06-13 13:15:39 -07:00
Derek McGowan a546042b91 Add documentation for using overlay2
Add mention in dockerd command line and storage driver selection documentation.

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
2016-06-13 11:06:47 -07:00
Shoubhik Bose e6e8c4d700 Added example for using image digest in the docker run command
Signed-off-by: Shoubhik Bose <sbose78@gmail.com>

Added explanation for the example with image's digest ( as per @thaJeztah 's comment

Signed-off-by: Shoubhik Bose <sbose78@gmail.com>

Wrapped to ~80 chars

Signed-off-by: Shoubhik Bose <sbose78@gmail.com>
2016-06-13 18:00:41 +00:00
Sebastiaan van Stijn a4438ca606
API docs cleanup
fix some formatting issues and consistency;

- Change capitalization (Query Parameters -> Query parameters, Json -> JSON)
- Make Query/JSON parameters and Status codes headings bold
- Fix indentation of some code blocks
- Fix headings (H2 -> H1), although all headings should be shifted the other way
  round ;-)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-13 16:37:24 +02:00
Charles Chan 0c3a4a1fcd Add link to Docker Hub.
* To make it consistent with similar references in other parts of document.

Signed-off-by: Charles Chan <charleswhchan@users.noreply.github.com>
2016-06-11 14:31:53 -07:00
Kevin Burke c9a68ffb2a typo in builder.md: its => it's
Signed-off-by: Kevin Burke <kev@inburke.com>
2016-06-11 12:33:58 -07:00
Darren Stahl ea3a7899f5 Removed QoS validation on Windows
Signed-off-by: Darren Stahl <darst@microsoft.com>
2016-06-10 16:30:54 -07:00
Sebastiaan van Stijn 1164f917fa Merge pull request #23359 from londoncalling/docker-engine-overview
re-doing Docker Engine overview topics for v.1.12
2016-06-10 00:02:56 +02:00
Victoria Bialas 8bd33b430b re-doing Docker Engine overview topics for v.1.12
fixed broken links created from Engine Overview update by adding missing topic to daemon reference page and updating the hrefs in the api pages

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2016-06-08 17:35:28 -07:00
Brian Goff 9db33b7646 Merge pull request #23377 from vdemeester/carry-pr-23007
Carry #23007 :  Say something useful during docker load
2016-06-08 13:42:22 -04:00
Vincent Demeester 9b5e0ea7de
Update docker-load documentation
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-06-08 17:40:37 +02:00
Vincent Demeester 430950e2d1 Merge pull request #23305 from thaJeztah/fix-network-examples
network docs cleanup
2016-06-08 17:32:00 +02:00
Ben Firshman 322e2a7d05 Return remote API errors as JSON
Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-06-07 18:45:27 -07:00
Sebastiaan van Stijn 7c46ba02e6
add support for filtering by network ID
This adds support for filtering by network ID, to be
consistent with other filter options.

Note that only *full* matches are returned; this is
consistent with other filters (e.g. volume), that
also return full matches only.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-07 16:50:31 +02:00
Sainath Grandhi 912af1ae8f Adding network filter to docker ps command
Signed-off-by: Sainath Grandhi <sainath.grandhi@intel.com>
2016-06-07 16:43:11 +02:00
Vincent Demeester 148d2b8e4a Merge pull request #22149 from vdemeester/deprecated-copy-endpoint
Deprecate /containers/(id or name)/copy endpoint
2016-06-07 12:50:04 +02:00
Yong Tang 2e506039ff Fix a couple of typos in the docs of `docker attach`
This fix fixed a couple of typos in the docs of `docker attach`:
docs/reference/commandline/attach.md
man/docker-attach.1.md

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-06-06 19:06:50 -07:00
Sebastiaan van Stijn feabf71dc1
network docs cleanup
This fixes some Markup and formatting
issues in the network documentation;

- wrap text to 80 chars
- add missing language hints for code examples
- add missing line continuations (\)
- update USAGE output for Cobra

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-06 14:20:41 +02:00
Sebastiaan van Stijn ac14aa11b6 Merge pull request #23293 from mountkin/network-docs
docs: correct network create command
2016-06-06 12:07:23 +02:00
Shijiang Wei 041aad6d72 docs: correct network create command
Signed-off-by: Shijiang Wei <mountkin@gmail.com>
2016-06-06 13:50:29 +08:00
Yong Tang 5667365ed1 Fix a couple of typos in docker attach docs.
This fix fixes a couple of typos in docker attach docs:
docs/reference/commandline/attach.md
man/docker-attach.1.md

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-06-05 14:03:23 -07:00
Vincent Demeester df1dd1322d Merge pull request #22489 from Microsoft/jjh/shell
Builder shell configuration
2016-06-05 17:43:12 +02:00
Vincent Demeester 3db23a4eaf Merge pull request #23232 from thaJeztah/update-default-retries
Healthcheck: set default retries to 3
2016-06-04 07:50:04 +02:00
Brian Goff ad8d0c9a8b Merge pull request #23244 from LK4D4/no_interface
attach: replace interface with simple type
2016-06-03 22:03:11 -04:00
Alexander Morozov 3accde6dee attach: replace interface with simple type
Also add docs to detach events

Signed-off-by: Alexander Morozov <lk4d4@docker.com>
2016-06-03 16:40:43 -07:00
Sven Dowideit 0cddc783cf docs validation fixes
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2016-06-03 21:43:45 +00:00
John Howard b18ae8c9cc Builder default shell
Signed-off-by: John Howard <jhoward@microsoft.com>
2016-06-03 13:54:31 -07:00
Vincent Demeester 428328908d
Deprecate /containers/(id or name)/copy endpoint
This endpoint has been deprecated since 1.8. Return an error starting
from this API version (1.24) in order to make sure it's not used for the
next API version and so that we can remove it some times later.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-06-03 19:38:03 +02:00
Sebastiaan van Stijn 020a86b3d9 Merge pull request #23107 from yongtang/23055-docker-search-limit
Add `--limit` option to `docker search`
2016-06-03 14:25:42 +02:00
Sebastiaan van Stijn 50e470fab4
Healthcheck: set default retries to 3
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-03 13:28:08 +02:00
Yong Tang 92f10fe228 Add `--limit` option to `docker search`
This fix tries to address the issue raised in #23055.
Currently `docker search` result caps at 25 and there is
no way to allow getting more results (if exist).

This fix adds the flag `--limit` so that it is possible
to return more results from the `docker search`.

Related documentation has been updated.

Additional tests have been added to cover the changes.

This fix fixes #23055.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-06-02 19:12:20 -07:00
Yong Tang 8913dace34 Add support for comment in .dockerignore
This fix tries to address the issue raised in #20083 where
comment is not supported in `.dockerignore`.

This fix updated the processing of `.dockerignore` so that any
lines starting with `#` are ignored, which is similiar to the
behavior of `.gitignore`.

Related documentation has been updated.

Additional tests have been added to cover the changes.

This fix fixes #20083.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-06-02 19:06:52 -07:00
Sven Dowideit 98c245c9e6 Merge pull request #23193 from allencloud/fix-typos
use grep to find all a/an typos
2016-06-02 18:45:08 -07:00
Sven Dowideit 9be8f04950 Merge pull request #22763 from zreigz/doc-multiple-daemons
Add documentation for running multiple daemons
2016-06-02 18:01:02 -07:00
Thomas Leonard b6c7becbfe
Add support for user-defined healthchecks
This PR adds support for user-defined health-check probes for Docker
containers. It adds a `HEALTHCHECK` instruction to the Dockerfile syntax plus
some corresponding "docker run" options. It can be used with a restart policy
to automatically restart a container if the check fails.

The `HEALTHCHECK` instruction has two forms:

* `HEALTHCHECK [OPTIONS] CMD command` (check container health by running a command inside the container)
* `HEALTHCHECK NONE` (disable any healthcheck inherited from the base image)

The `HEALTHCHECK` instruction tells Docker how to test a container to check that
it is still working. This can detect cases such as a web server that is stuck in
an infinite loop and unable to handle new connections, even though the server
process is still running.

When a container has a healthcheck specified, it has a _health status_ in
addition to its normal status. This status is initially `starting`. Whenever a
health check passes, it becomes `healthy` (whatever state it was previously in).
After a certain number of consecutive failures, it becomes `unhealthy`.

The options that can appear before `CMD` are:

* `--interval=DURATION` (default: `30s`)
* `--timeout=DURATION` (default: `30s`)
* `--retries=N` (default: `1`)

The health check will first run **interval** seconds after the container is
started, and then again **interval** seconds after each previous check completes.

If a single run of the check takes longer than **timeout** seconds then the check
is considered to have failed.

It takes **retries** consecutive failures of the health check for the container
to be considered `unhealthy`.

There can only be one `HEALTHCHECK` instruction in a Dockerfile. If you list
more than one then only the last `HEALTHCHECK` will take effect.

The command after the `CMD` keyword can be either a shell command (e.g. `HEALTHCHECK
CMD /bin/check-running`) or an _exec_ array (as with other Dockerfile commands;
see e.g. `ENTRYPOINT` for details).

The command's exit status indicates the health status of the container.
The possible values are:

- 0: success - the container is healthy and ready for use
- 1: unhealthy - the container is not working correctly
- 2: starting - the container is not ready for use yet, but is working correctly

If the probe returns 2 ("starting") when the container has already moved out of the
"starting" state then it is treated as "unhealthy" instead.

For example, to check every five minutes or so that a web-server is able to
serve the site's main page within three seconds:

    HEALTHCHECK --interval=5m --timeout=3s \
      CMD curl -f http://localhost/ || exit 1

To help debug failing probes, any output text (UTF-8 encoded) that the command writes
on stdout or stderr will be stored in the health status and can be queried with
`docker inspect`. Such output should be kept short (only the first 4096 bytes
are stored currently).

When the health status of a container changes, a `health_status` event is
generated with the new status. The health status is also displayed in the
`docker ps` output.

Signed-off-by: Thomas Leonard <thomas.leonard@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-02 23:58:34 +02:00
allencloud c1be45fa38 fix typos
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-06-02 17:17:22 +08:00
Yong Tang 7b08941882 Update remote API docs for the removal of deprecated `force` in `docker tag`.
This fix updates remote API docs for the removal of deprecated `force` in `docker tag`.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-06-01 09:45:10 -07:00
Shijiang Wei 0a8386c8be remove deprecated feature of passing HostConfig at API container start
Signed-off-by: Shijiang Wei <mountkin@gmail.com>
2016-06-01 22:25:17 +08:00
Lukasz Zajaczkowski 3152a706c9 Add documentation for running multiple daemons
Signed-off-by: Lukasz Zajaczkowski <lukasz.zajaczkowski@ts.fujitsu.com>
2016-06-01 08:38:53 +02:00
Ben Firshman 896fbb470a Remove status column from client libraries page
They are all "active". If they are not active, we should probably
remove them.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-05-31 16:12:14 -07:00
Ben Firshman 2fea5b6e28 Update client libraries introduction text
Explain what they actually are.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-05-31 16:11:36 -07:00
Sebastiaan van Stijn 068d466cc7 Merge pull request #23060 from friism/add-power-shell-example
Add power shell example
2016-05-27 21:21:32 +02:00