Commit Graph

92 Commits

Author SHA1 Message Date
896826cadf docs: move sysctls docs to current API version
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
Upstream-commit: de22669377d074a2594de33be01ae4d9723283a8
Component: engine
2016-06-14 15:14:16 -07:00
abee2dc945 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>
Upstream-commit: 8bd33b430b950ca5355f950d4b79a04ba0363c3c
Component: engine
2016-06-08 17:35:28 -07:00
35c5774373 fix typos
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: c1be45fa38e82054dcad606d71446a662524f2d5
Component: engine
2016-06-02 17:17:22 +08:00
b96d544c7a Fix bug which mistakes 400 error for 500
Signed-off-by: Wang Xing <hzwangxing@corp.netease.com>
Upstream-commit: beca2615782e24fa28803ada067129fdfa88c77d
Component: engine
2016-05-19 20:01:55 +08:00
21117de54d Small API formating fix.
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 204a52c689204a4d9506d500955673f7b5361d1d
Component: engine
2016-04-26 10:29:31 +00:00
888a7f4130 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>
Upstream-commit: 332e3b545b0c0e825364c0f09315f82546c791f0
Component: engine
2016-04-18 21:15:33 -07:00
3b52ebb9ff 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>
Upstream-commit: 9caf7aeefd23263a209c26c8439d26c147972d81
Component: engine
2016-04-12 13:37:31 -04:00
8e90b734bc 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>
Upstream-commit: f919a26a9fb96ef07133183b4f693ff9508ae823
Component: engine
2016-04-09 18:39:33 +00:00
e0605e5ec1 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>
Upstream-commit: 4ed20402580c4476360736f2bdaa2604dc76cd54
Component: engine
2016-04-02 19:59:02 +00:00
8bd53c59b9 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>
Upstream-commit: 5d2f6b3ea3d307c32089757d84c94fab3d8e55d7
Component: engine
2016-03-31 08:39:40 +02:00
b9d40a7c24 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>
Upstream-commit: 9014ac2d15b65559468ef0496061a38b919e1680
Component: engine
2016-03-21 12:55:45 +01:00
7294d486c4 change container word spell in docs
Signed-off-by: terryding77 <550147740@qq.com>
Upstream-commit: adda1060aa3c7a41fddc4cdeaac92f946c40e2d8
Component: engine
2016-02-29 16:59:53 +08:00
c78bf4e1c8 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>
Upstream-commit: 220a188ae820fac1198c54b7f0358525457a8609
Component: engine
2016-02-23 14:34:27 +08:00
4baeda8a40 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>
Upstream-commit: 5642cdeac5df08414744203235462a6b99261239
Component: engine
2016-02-22 20:49:10 +08:00
1da6a4053e Update docker_remote_api_v1.21.md to complete the docs
Signed-off-by: tracylihui <793912329@qq.com>
Upstream-commit: df3ede95ebdc708ea6fb954c8799cf14203916c2
Component: engine
2016-02-20 19:17:19 +08:00
d4a856da9f 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>
Upstream-commit: c80b36c938306ef9cc9ad6865cfc251a694f59aa
Component: engine
2016-02-13 10:00:51 +01:00
ec3cd49e30 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>
Upstream-commit: 1c95b858ac040974d2be73bb31d0d59af9b0b960
Component: engine
2016-02-02 14:49:14 +01:00
e734434f58 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>
Upstream-commit: e310d070f498a2ac494c6d3fde0ec5d6e4479e14
Component: engine
2016-01-26 15:58:53 -08:00
5831ef280d man page fix: remove -e/--exec-drive=native related description
Signed-off-by: Shishir Mahajan <shishir.mahajan@redhat.com>
Upstream-commit: 50305d66f56774488b6fec2534fd592c263c91e0
Component: engine
2016-01-07 14:21:01 -05:00
c4d25ca65c 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>
Upstream-commit: ade71ace7df285795381d1317f8069f14e099bb3
Component: engine
2016-01-07 12:30:27 +01:00
caf108c7a2 Merge pull request #19045 from wenchma/network_api_update
Update docker network api doc
Upstream-commit: 180ff8d5015d60f1d1d7c9838d476ca5e4fc6117
Component: engine
2016-01-05 10:55:56 -08:00
d4f5e05d82 Fix the unnecessary parameter
Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: 52b944dbba74b7d2be5bcabfe6937a5578020101
Component: engine
2016-01-05 10:26:01 +00:00
cf1cf1d767 Update docker network api doc
Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
Upstream-commit: d92d1de3d529343317e47f604963e5ad8476b3e6
Component: engine
2016-01-04 18:05:02 +08:00
fe1109030f Sync the docker network create api docs with the error code
Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
Upstream-commit: 597835e6454be55963959f5f9d586b71517a7f1e
Component: engine
2015-12-17 17:48:50 +08:00
7da657059d 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>
Upstream-commit: a06d5273b3cb72f68fc32da26955842287314970
Component: engine
2015-11-25 14:10:18 +01:00
0ec3e50e8d 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>
Upstream-commit: e28e4c7840455e97ac277a121a429f99a0c079df
Component: engine
2015-11-23 15:41:34 -08:00
7d68517eab Update docs and test of exec create api return codes
Fixes issue #18054

Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
Upstream-commit: 01b86d612cba22602509b436aad36d41135f14ce
Component: engine
2015-11-19 22:22:27 +08:00
964f8b63bd Add pkg/parsers/architecture and pkg/platform
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 49779b674af09b46c165c8dfe2e76054336b0595
Component: engine
2015-11-14 23:03:02 +01:00
3e0bec1370 /info: Add keys Architecture, OSType
- introduces Swarm-relevant keys, see #13634
  - docs updated

Signed-off-by: Olle Jonsson <olle.jonsson@gmail.com>
Upstream-commit: 4e8fcd40028ed09b139b6f86954e676a1839be9c
Component: engine
2015-11-14 22:21:45 +01:00
012c3d4b3c Fixed broken links in docker_remote_api
Signed-off-by: Christopher Jones <tophj@linux.vnet.ibm.com>
Upstream-commit: 93939c3f9fda70930ec2d3af4c6231ccfbc6b8ef
Component: engine
2015-11-06 16:12:51 -06:00
c6ff072fba Merge pull request #17610 from thaJeztah/add-env-example
Add examples for ENV vars in API
Upstream-commit: 7a2669f59683c9d286494fa1360c792cc501e98f
Component: engine
2015-11-06 01:19:58 +01:00
b768870c71 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>
Upstream-commit: 39dfc536d444df8745124ffa38504241a0a985f7
Component: engine
2015-11-03 08:42:40 -08:00
6f36892ab1 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>
Upstream-commit: 286fe69d5376add77dc31833dc3c2fcc9639dd17
Component: engine
2015-11-03 15:24:31 +01:00
3736c71ac8 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>
Upstream-commit: e41de3e6318ad4cb30eabab9bec60f9fb9d7a76b
Component: engine
2015-11-02 17:44:31 +01:00
f3f473fc03 Fixing broken links
Fixing the weight

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 5ce093e94565a5f32df9adf78dcdb6deeda75f79
Component: engine
2015-10-31 19:45:56 -07:00
28eb09ab06 Update inspect api examples with new network settings.
Signed-off-by: David Calavera <david.calavera@gmail.com>
Upstream-commit: 9a7e632cf097b71aab6e46ef010d038f602e03d3
Component: engine
2015-10-27 19:56:29 -04:00
3babd01129 Merge pull request #16017 from flowlo/master
docs: Explain volume_name in POST /container Binds
Upstream-commit: b96e076af9478f37c5efd3f56e5f0aa42c846b66
Component: engine
2015-10-27 23:28:47 +01:00
1489d6cd3f Merge pull request #15780 from mountkin/build-multi-tags
Add ability to add multiple tags with docker build
Upstream-commit: 448398c2a8a41b6589dd7deb59fdc889e78db223
Component: engine
2015-10-23 13:50:35 -07:00
a4eeeb73b3 Add ability to add multiple tags with docker build
Signed-off-by: Shijiang Wei <mountkin@gmail.com>
Upstream-commit: c2eb37f9aeb6215293483e02613514e49011cf2c
Component: engine
2015-10-24 00:59:56 +08:00
e1f1cd631a Use RepoTags & RepoDigest in inspect
To be coherent with /images/json (images command)

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: f664f6e4b19d4e155d78af2eacddcd941dae4fce
Component: engine
2015-10-22 23:00:59 +02:00
6672204b41 Merge pull request #17136 from gesellix/change-route-volume-create
rename `POST /volumes` to `POST /volumes/create`
Upstream-commit: 492945235b6be7f2f7ff8721de0c01a93d0b0f6f
Component: engine
2015-10-21 10:21:27 -07:00
57a4cfdd46 Docs: update docs for API stats
Signed-off-by: Hu Keping <hukeping@huawei.com>
Upstream-commit: 969f1d9773509940666a87f8342168bd2a8cf06d
Component: engine
2015-10-20 16:31:20 +08:00
4a78d859fe 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>
Upstream-commit: 0c95eeb584f5033e1f1cc8eb383306b87d3f133f
Component: engine
2015-10-17 14:13:40 +02:00
ce075943c3 docs: fix description of filters param for /volumes and /networks.
fixes #17091

Signed-off-by: Tobias Gesellchen <tobias@gesellix.de>
Upstream-commit: 3e064371e7ddec0de4dd2af75d5ac227b1080d53
Component: engine
2015-10-17 00:24:40 +02:00
494b1b71ae Correct API docs for /images/create
Signed-off-by: Daniel Nephin <dnephin@docker.com>
Upstream-commit: 2ec4404ba039c6e6c40358cecd7d7ca16ee5b3e7
Component: engine
2015-10-15 16:00:05 -04:00
019ffb819f Merge pull request #15796 from azurezk/add-size-to-inspect
add container size info to inspect
Upstream-commit: ce607916e9b4e294e66188bbaf50acaa86e3909f
Component: engine
2015-10-13 23:16:10 +02:00
ce2e2998fb 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
dcc50e1d593fd7995189872791c6d7a013f16970. This change updates the API
documentation to reflect the existing support.

Signed-off-by: Victor Costan <costan@gmail.com>
Upstream-commit: 26bd356078a02313649c7562369a2b2de6b63e19
Component: engine
2015-10-12 11:26:39 -04:00
6b6c7cc2b6 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>
Upstream-commit: 8fee1c2020186ac100b45e64864b94ae3a169ad5
Component: engine
2015-10-11 07:49:54 -07:00
9375e8c909 add size to inspect
Signed-off-by: Zhang Kun <zkazure@gmail.com>
Upstream-commit: b4d6b23838bb7d8436a1966fc3ef3ade83544d58
Component: engine
2015-10-10 20:44:29 +08:00
6d8620acc6 Merge pull request #16604 from mountkin/add-missing-commit-parameters
add missing parameters of the commit API to the docs
Upstream-commit: dbc20693f7bc6ce9bc1da3f6c4c0cd725e0454c1
Component: engine
2015-10-09 20:55:54 +02:00