Commit graph

92 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
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
allencloud
c1be45fa38 fix typos
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-06-02 17:17:22 +08:00
Wang Xing
beca261578 Fix bug which mistakes 400 error for 500
Signed-off-by: Wang Xing <hzwangxing@corp.netease.com>
2016-05-19 20:01:55 +08:00
Sven Dowideit
204a52c689 Small API formating fix.
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2016-04-26 10:29:31 +00:00
Yong Tang
332e3b545b Docs: Container creation param descriptions not under HostConfig
This fix tries to fix issues mentioned in #22100 for incorrect
description of remote API's container creation params.

Several issues have been fixed:
1. CPU and memory related params (e.g., `MemorySwap`, `CpuShares`, etc.)
were incorrectly placed under the top level instead of under the HostConfig.
(v1.18-v1.24)
2. The param `Cpuset` has been deprecated but was never removed.
(v1.18-v1.24)
3. The param `PidsLimit` was not added even though the description
has been added.
(v1.23-v1.24)

This fix fixes #22100

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-04-18 21:15:33 -07:00
Dan Walsh
9caf7aeefd Add support for setting sysctls
This patch will allow users to specify namespace specific "kernel parameters"
for running inside of a container.

Signed-off-by: Dan Walsh <dwalsh@redhat.com>
2016-04-12 13:37:31 -04:00
Yong Tang
f919a26a9f Fix incorrect request json body for /containers/create in remote API docs.
This fix tries to fix the incorrect request json body for
`/containers/create` in remote API docs.

When using the example json request for `/containers/create`, there are two
errors:
(1). `invalid character '"' after object key:value pair`
     This is because a `,` is missing after `"Volumes": {}`
     This issue exists in v1.20-v1.24
(2). `Invalid --security-opt: ""`
     This is becasue in `"SecurityOpt": [""]` line, an empty string
     `""` is passed yet `""` is not a valid `SecurityOpt`. Either no string,
     or a valid string (e.g., "no-new-privileges") could be used.
     This issue exists in v1.15-v1.24

This fix updates the docs and correct the above two issues.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-04-09 18:39:33 +00:00
Yong Tang
4ed2040258 Remote API docs give incorrect example for creating a container with volumes.
This fix tries to address the issue mentioned in Docker Remote API where
the examples for creating a container (`POST /containers/create`) with
volumes were incorrect. In the previous remote API document, the `Mounts`
fields was used for volume creation yet since v1.20 `Volumes` should be
used.

This fix fixes #21335.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-04-02 19:59:02 +00:00
Robin Naundorf
5d2f6b3ea3 Fixed docs fixes #21653
Fixed some http status codes and decreased site-order for docker_remote_api_v1.24.md to appear in the right order in the menu
Signed-off-by: Robin Naundorf <r.naundorf@fh-muenster.de>
2016-03-31 08:39:40 +02:00
Arnaud Porterie
9014ac2d15 docs: fix incorrect output for "/info" endpoint
OomScoreAjd is not part of `/info` output
Wrong field name `DiscoveryBackend` in API reference

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-03-21 12:55:45 +01:00
terryding77
adda1060aa change container word spell in docs
Signed-off-by: terryding77 <550147740@qq.com>
2016-02-29 16:59:53 +08:00
ZJUshuaizhou
220a188ae8 update all the versions from v1.19 to v1.23
update v1.22

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

update all the versions docs

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

revert v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

update v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

revert v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

update v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>
2016-02-23 14:34:27 +08:00
hsinko
5642cdeac5 Update docker_remote_api_v1.22.md and v1.23 to complete the docs
Signed-off-by: hsinko <21551195@zju.edu.cn>

id in example request should be a exact value

Signed-off-by: hsinko <21551195@zju.edu.cn>

revert v1.22 doc

Signed-off-by: hsinko <21551195@zju.edu.cn>

fix tiny errors

Signed-off-by: hsinko <21551195@zju.edu.cn>
2016-02-22 20:49:10 +08:00
tracylihui
df3ede95eb Update docker_remote_api_v1.21.md to complete the docs
Signed-off-by: tracylihui <793912329@qq.com>
2016-02-20 19:17:19 +08:00
Roland Huß
c80b36c938 Extended explanation of NetworkMode's value
* Add network mode `none` to list of possible values for API version 1.15 - 1.23
* For API version 1.21 - 1.23 add explanation that any other value is taken as a custom network's name

Signed-off-by: Roland Huß <roland@jolokia.org>
2016-02-13 10:00:51 +01:00
Sebastiaan van Stijn
1c95b858ac Fix memory-swap description in older API versions
A value of -1 disables the *limit* so enables unlimited swap

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-02-02 14:49:14 +01:00
Mary Anthony
e310d070f4 Creating Engine specific menu
Fixing the links
Updating with Seb's comments
Adding weight
Fixing the engine aliases
Updating after Arun pushed
Removing empty file

Signed-off-by: Mary Anthony <mary@docker.com>
2016-01-26 15:58:53 -08:00
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