Commit graph

74 commits

Author SHA1 Message Date
Shishir Mahajan
50305d66f5 man page fix: remove -e/--exec-drive=native related description
Signed-off-by: Shishir Mahajan <shishir.mahajan@redhat.com>
2016-01-07 14:21:01 -05:00
Oliver Neal
ade71ace7d added documentation for groupadd within hostConfig that was added in remote api 1.20
Signed-off-by: Oliver Neal <ItsVeryWindy@users.noreply.github.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-01-07 12:30:27 +01:00
moxiegirl
180ff8d501 Merge pull request #19045 from wenchma/network_api_update
Update docker network api doc
2016-01-05 10:55:56 -08:00
Kai Qiang Wu(Kennan)
52b944dbba Fix the unnecessary parameter
Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
2016-01-05 10:26:01 +00:00
Wen Cheng Ma
d92d1de3d5 Update docker network api doc
Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
2016-01-04 18:05:02 +08:00
Wen Cheng Ma
597835e645 Sync the docker network create api docs with the error code
Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
2015-12-17 17:48:50 +08:00
Sebastiaan van Stijn
a06d5273b3 docs: move API changes to the correct API version
These changes were made as part of https://github.com/docker/docker/pull/17478
but inadvertently added to the v1.21 API version.

Also added a short description to the API changelog.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-11-25 14:10:18 +01:00
Morgan Bauer
e28e4c7840
update 'top' api endpoint documentation
- update example based on '-ef' behavior
 - new example specifying ps args 'aux'
 - resolves #7205

Signed-off-by: Morgan Bauer <mbauer@us.ibm.com>
2015-11-23 15:41:34 -08:00
Wen Cheng Ma
01b86d612c Update docs and test of exec create api return codes
Fixes issue #18054

Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
2015-11-19 22:22:27 +08:00
Vincent Demeester
49779b674a Add pkg/parsers/architecture and pkg/platform
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2015-11-14 23:03:02 +01:00
Olle Jonsson
4e8fcd4002 /info: Add keys Architecture, OSType
- introduces Swarm-relevant keys, see #13634
  - docs updated

Signed-off-by: Olle Jonsson <olle.jonsson@gmail.com>
2015-11-14 22:21:45 +01:00
Christopher Jones
93939c3f9f Fixed broken links in docker_remote_api
Signed-off-by: Christopher Jones <tophj@linux.vnet.ibm.com>
2015-11-06 16:12:51 -06:00
Sebastiaan van Stijn
7a2669f596 Merge pull request #17610 from thaJeztah/add-env-example
Add examples for ENV vars in API
2015-11-06 01:19:58 +01:00
Madhu Venugopal
39dfc536d4 Updating networking docs with technical information
- the /etc/hosts read caveat due to dynamic update
- information about docker_gwbridge
- Carries and closes #17654
- Updating with last change by Madhu
- Updating with the IPAM api 1.22

Signed-off-by: Mary Anthony <mary@docker.com>
2015-11-03 08:42:40 -08:00
Sebastiaan van Stijn
286fe69d53 docs: update remote API responses and minor fixes
Add back the "old" networksettings fields that were removed,
but added back to maintain backward compatibility, in
https://github.com/docker/docker/pull/17538

Update network endpoint responses, with updated response
introduced in;
https://github.com/docker/docker/pull/17536

Added changes to v1.22 that were applied to the v1.21 / v1.20 docs
after the API bump(s);

https://github.com/docker/docker/pull/17085
https://github.com/docker/docker/pull/17127
https://github.com/docker/docker/pull/13707

Also fixed some mixed tab/spaces indentation
and Markdown formatting issues (causing code-blocks to
be rendered incorrectly)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-11-03 15:24:31 +01:00
Sebastiaan van Stijn
e41de3e631 Add examples for ENV vars in API
As discussed in https://github.com/docker/docker/issues/16623,
the API calls for setting ENV-vars lacked an actual example.

This PR adds some examples to the API calls.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-11-02 17:44:31 +01:00
Mary Anthony
5ce093e945 Fixing broken links
Fixing the weight

Signed-off-by: Mary Anthony <mary@docker.com>
2015-10-31 19:45:56 -07:00
David Calavera
9a7e632cf0 Update inspect api examples with new network settings.
Signed-off-by: David Calavera <david.calavera@gmail.com>
2015-10-27 19:56:29 -04:00
Sebastiaan van Stijn
b96e076af9 Merge pull request #16017 from flowlo/master
docs: Explain volume_name in POST /container Binds
2015-10-27 23:28:47 +01:00
Sebastiaan van Stijn
448398c2a8 Merge pull request #15780 from mountkin/build-multi-tags
Add ability to add multiple tags with docker build
2015-10-23 13:50:35 -07:00
Shijiang Wei
c2eb37f9ae Add ability to add multiple tags with docker build
Signed-off-by: Shijiang Wei <mountkin@gmail.com>
2015-10-24 00:59:56 +08:00
Vincent Demeester
f664f6e4b1 Use RepoTags & RepoDigest in inspect
To be coherent with /images/json (images command)

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2015-10-22 23:00:59 +02:00
Sebastiaan van Stijn
492945235b Merge pull request #17136 from gesellix/change-route-volume-create
rename `POST /volumes` to `POST /volumes/create`
2015-10-21 10:21:27 -07:00
Hu Keping
969f1d9773 Docs: update docs for API stats
Signed-off-by: Hu Keping <hukeping@huawei.com>
2015-10-20 16:31:20 +08:00
Tobias Gesellchen
0c95eeb584 rename POST /volumes to POST /volumes/create to be consistent with the other POST /.../create endpoints
see #17132

Signed-off-by: Tobias Gesellchen <tobias@gesellix.de>
2015-10-17 14:13:40 +02:00
Tobias Gesellchen
3e064371e7 docs: fix description of filters param for /volumes and /networks.
fixes #17091

Signed-off-by: Tobias Gesellchen <tobias@gesellix.de>
2015-10-17 00:24:40 +02:00
Daniel Nephin
2ec4404ba0 Correct API docs for /images/create
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-10-15 16:00:05 -04:00
Vincent Demeester
ce607916e9 Merge pull request #15796 from azurezk/add-size-to-inspect
add container size info to inspect
2015-10-13 23:16:10 +02:00
Victor Costan
26bd356078 Document CFS CPU period / quota support in the API.
Docker 1.7 got support for specifying the CFS scheduler's CPU quota and
period. The work appears to have started around commit
dcc50e1d59. This change updates the API
documentation to reflect the existing support.

Signed-off-by: Victor Costan <costan@gmail.com>
2015-10-12 11:26:39 -04:00
Mary Anthony
8fee1c2020 Enabled GitHub Flavored Markdown
GitHub flavored markdown is now supported for links and images. Also, ran LinkChecker and FileResolver. Yay!
Fixes from Spider check
Output for docker/docker now goes into engine directory

Signed-off-by: Mary Anthony <mary@docker.com>
2015-10-11 07:49:54 -07:00
Zhang Kun
b4d6b23838 add size to inspect
Signed-off-by: Zhang Kun <zkazure@gmail.com>
2015-10-10 20:44:29 +08:00
Sebastiaan van Stijn
dbc20693f7 Merge pull request #16604 from mountkin/add-missing-commit-parameters
add missing parameters of the commit API to the docs
2015-10-09 20:55:54 +02:00
Shijiang Wei
b69f4f3c13 add missing parameters of the commit API to the docs
Signed-off-by: Shijiang Wei <mountkin@gmail.com>
2015-10-09 23:21:12 +08:00
Lorenz Leutgeb
2bd2893b92 docs: Explain volume_name in POST /container Binds
Signed-off-by: Lorenz Leutgeb <lorenz.leutgeb@gmail.com>
2015-10-09 11:32:11 +02:00
Deng Guangxing
54f98f40a4 update dockernetwork.md and network api
Signed-off-by: Deng Guangxing <dengguangxing@huawei.com>
2015-10-08 15:34:24 +08:00
Madhu Venugopal
dd28ded711 Networking API and UX documentation
More doc updates will follow

Signed-off-by: Madhu Venugopal <madhu@docker.com>
2015-10-07 03:54:27 -07:00
Daniel Nephin
c1713e7c5a Documentation for filtering events by label
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-10-02 16:45:08 -04:00
Brian Goff
2d43d93410 Make exec start return proper error codes
Exec start was sending HTTP 500 for every error.

Fixed an error where pausing a container and then calling exec start
caused the daemon to freeze.

Updated API docs which incorrectly showed that a successful exec start
was an HTTP 201, in reality it is HTTP 200.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2015-10-02 14:40:22 -04:00
Jess Frazelle
d6f8365258 Merge pull request #16680 from dnephin/update_list_image_api_docs
Update api docs for /images/json
2015-10-02 11:23:49 -07:00
Lei Jitang
3fcf481361 Fix docker ps truncate long image name by default
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2015-10-02 22:56:42 +08:00
Daniel Nephin
e5967d041d Fix api documenation for /images/json response format
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-09-30 12:24:34 -04:00
Arnaud Porterie
7d193ef1f3 Add builtin nodes discovery
Use `pkg/discovery` to provide nodes discovery between daemon instances.

The functionality is driven by two different command-line flags: the
experimental `--cluster-store` (previously `--kv-store`) and
`--cluster-advertise`. It can be used in two ways by interested
components:

1. Externally by calling the `/info` API and examining the cluster store
   field. The `pkg/discovery` package can then be used to hit the same
   endpoint and watch for appearing or disappearing nodes. That is the
   method that will for example be used by Swarm.
2. Internally by using the `Daemon.discoveryWatcher` instance. That is
   the method that will for example be used by libnetwork.

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2015-09-25 14:52:09 -07:00
Jess Frazelle
84b53c8d87 Merge pull request #14579 from hqhq/hq_add_softlimit
Add support for memory reservation
2015-09-24 12:11:36 -07:00
Tobias Gesellchen
78de066a28 fix content-type of response for /commit
Signed-off-by: Tobias Gesellchen <tobias@gesellix.de>
2015-09-23 23:49:16 +02:00
qhuang
aa1780997f Add support for memory reservation
Signed-off-by: qhuang <qhuang@10.0.2.15>
2015-09-23 14:02:45 +08:00
Zhang Kun
7cf343d106 add docker server version to /info
Signed-off-by: Zhang Kun <zkazure@gmail.com>
2015-09-21 21:15:32 +08:00
Vincent Batts
4026512a2c events/jsonmessage: add and prefer TimeNano for events
This way provide both Time and TimeNano in the event. For the display of
the JSONMessage, use either, but prefer TimeNano Proving only TimeNano
would break Subscribers that are using the `Time` field, so both are set
for backwards compatibility.

The events logging uses nano formatting, but only provides a Unix()
time, therefor ordering may get lost in the output. Example:
```
2015-09-15T14:18:51.000000000-04:00 ee46febd64ac629f7de9cd8bf58582e6f263d97ff46896adc5b508db804682da: (from busybox) resize
2015-09-15T14:18:51.000000000-04:00 a78c9149b1c0474502a117efaa814541926c2ae6ec3c76607e1c931b84c3a44b: (from busybox) resize
```

By having a field just for Nano time, when set, the marshalling back to
`time.Unix(sec int64, nsec int64)` has zeros exactly where it needs to.
This does not break any existing use of jsonmessage.JSONMessage, but now
allows for use of `UnixNano()` and get event formatting that has
distinguishable order. Example:
```
2015-09-15T15:37:23.810295632-04:00 6adcf8ed9f5f5ec059a915466cd1cde86a18b4a085fc3af405e9cc9fecbbbbaf: (from busybox) resize
2015-09-15T15:37:23.810412202-04:00 6b7c5bfdc3f902096f5a91e628f21bd4b56e32590c5b4b97044aafc005ddcb0d: (from busybox) resize
```

Including tests for TimeNano and updated event API reference doc.

Signed-off-by: Vincent Batts <vbatts@redhat.com>
2015-09-18 13:15:26 -04:00
Madhav Puri
8cfcd87380 incorporate doc review comments
Signed-off-by: Madhav Puri <madhav.puri@gmail.com>
2015-09-16 03:31:15 -07:00
Madhav Puri
54240f8da9 Support for passing build-time variables in build context
- The build-time variables are passed as environment-context for command(s)
run as part of the RUN primitve. These variables are not persisted in environment of
intermediate and final images when passed as context for RUN. The build environment
is prepended to the intermediate continer's command string for aiding cache lookups.
It also helps with build traceability. But this also makes the feature less secure from
point of view of passing build time secrets.

- The build-time variables also get used to expand the symbols used in certain
Dockerfile primitves like ADD, COPY, USER etc, without an explicit prior definiton using a
ENV primitive. These variables get persisted in the intermediate and final images
whenever they are expanded.

- The build-time variables are only expanded or passed to the RUN primtive if they
are defined in Dockerfile using the ARG primitive or belong to list of built-in variables.
HTTP_PROXY, HTTPS_PROXY, http_proxy, https_proxy, FTP_PROXY and NO_PROXY are built-in
variables that needn't be explicitly defined in Dockerfile to use this feature.

Signed-off-by: Madhav Puri <madhav.puri@gmail.com>
2015-09-16 03:31:15 -07:00
Tim Hockin
3d4685e258 Add support for DNS options
Signed-off-by: Tim Hockin <thockin@google.com>
2015-09-16 14:06:45 -07:00