Commit Graph

114 Commits

Author SHA1 Message Date
3b7e266f9c docs: add missing IPAM options to API docs
Commit dd28ded711417c72d2e228d1ace129ac5fd05f19
brought in new networking features and API, but
did not document the available IPAM options.

This adds a description of those options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: d69fce79f94b807ccb0f2f64c47881ee8fc31250
Component: engine
2016-10-28 16:18:49 -07:00
b2f3f16f09 Sync docker/docker refs with files mistakenly edited in docker.github.io repo
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 3b36f02c03ec050aa46f9a01cd2d6c60ffd93652
Component: engine
2016-10-20 10:51:30 -07:00
e551cfbd30 Improve API format examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 8e02b29d247379d66280babcf654e467989bd4bb
Component: engine
2016-10-16 19:54:08 -07:00
d77bcd1691 Improve example for env vars in API docs
This was added in e41de3e6318ad4cb30eabab9bec60f9fb9d7a76b,
but can be a bit confusing due to the "outer" brackets
being for JSON, and the "inner" brackets to indicate
optional values.

During review of that change, this alternative
format was suggested.

Updating the example to use the format that was discussed
during review :)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 441c9411e369f5146783c46d7a9413917dacaebe
Component: engine
2016-10-16 19:22:42 -07:00
9fe833df60 Convert Markdown frontmatter to YAML
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: b30609446d212624e3d4ce814c70130b75c552a0
Component: engine
2016-10-14 15:44:55 -07:00
a0b2adc110 Merge pull request #26516 from yongtang/26453-build-bad-syntax
Check bad syntax on dockerfile before building.
Upstream-commit: 72f556a9ff1043a4188e8eeef892d8a0ba4fe34f
Component: engine
2016-09-23 12:24:20 +02:00
b4a97d150a Add missing API docs for "privileged" and "user" exec
The "user" feature was added in docker 1.7.0, and
"privileged" feature was added in docker 1.9.0
only contained CLI docs.

This adds the missing API docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: c53efdf4c1f0b2e7f1fe04294d9d64401b8b09b8
Component: engine
2016-09-22 23:40:05 +02:00
9e4c8c252a Update documentation and change log to include the preliminary validation of dockerfile.
This commit updates documentation and change log to include
the preliminary validation of the dockerfile before instructions
in dockerfile is run one-by-one.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: e33dea5b40a52c5dcda682a1a292584ae6bff00d
Component: engine
2016-09-22 14:33:37 -07:00
f3d4887540 Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 708892c4037e9eef6f6c25b5a3551f7779fb8868
Component: engine
2016-09-20 17:41:59 +02:00
0a2b85a132 Synchronize API docs
This synchronizes changes between API versions, and:

- applies e0a552504e64192946c86d3bdd517ae7b3af348f to
  older versions of the documentation
- applies a2a0a03e2b801545b2e3fb9e8476c76370da9175 to
  API version 1.25
- syncs some minor differences

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 53b1dcb25ca937c61bd47a29ba7be6e68abc25a5
Component: engine
2016-09-17 03:02:12 +02:00
db61cfcc59 docs: reference: api: clarify pull all tags
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
Upstream-commit: 03a8b6798d030a952e85f15208aeea1215e3f801
Component: engine
2016-09-16 16:35:15 +02:00
c65cef03da Replace docker command from 'docker daemon' to 'dockerd'
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: 530668cb2262fc89e60a23d9a0f6555498b0171b
Component: engine
2016-08-25 17:04:44 +08:00
703353742f Add missing docs about binary remote contexts
This feature was added in docker 1.8, through
7491f9a9c11ad3fd3b587fa6f7e53b297b3b88c7.

However, the API docs ended up in the wrong
API version (1.19 instead of 1.20), so were
never included in future API docs.

Also, the CLI docs got lost during splitting
up the cli.md docs into separate files;
561bfb268de3c674b04d48895b7e46ae890ef795

This moves the API docs to the correct
versions, and restores the CLI documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: a5ba032c7421ef7a429e780d12d0f604a045258a
Component: engine
2016-08-17 16:15:59 +02:00
3b1b49d31b Cleanup API docs Markdown formatting and wording
Synchronize formatting between versions, and
update wording to be consistent.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: eb24e9bbd312b0d7392e8012b757e7c9022c9add
Component: engine
2016-08-16 13:22:47 +02:00
6cf3b48c91 Move sysctls to correct API version
Commit 067b510dfc5b90a1d7712c89e857b6dafb184f24 move the
sysctls feature to the right API version, but
missed this one.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 7cdd693d5d2094f73383145eb74d81c6b9bb9b24
Component: engine
2016-08-15 12:02:54 +02:00
4fe64ab5f6 Fix events "since" / "until" query parameter description
The "since" query parameter can be *useful*
for polling (in combination with "until"), but
doesn't actualy stop the endpoint from streaming
events.

This patch updates the description to better
clarify that "since" does not make the endpoint
non-streaming.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: ceed39b530838451b5b9c64b372307a0cc8492ab
Component: engine
2016-08-10 23:17:04 +02:00
b5bd5a422a docs: add missing content-type header for image load
Without a content-type header, Go uses a max post size
of 10 megabytes, which makes loading images fail
if they're larger than 10 megabytes

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 3892ac7e9418547785c36c91c3fb49a9c876c4b1
Component: engine
2016-08-09 10:56:49 +02:00
6a3509b302 Sync API docs
This synchronizes formatting changes to older
versions of the API

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 5696c47470a3163d70b3518657f88534787e9fc3
Component: engine
2016-08-05 17:44:58 +02:00
a86adb0e9c Fix Markdown formatting in API docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 33bd963cfb9396b74387f6f17dc6e86b2ca5fa9d
Component: engine
2016-08-04 14:13:30 +02:00
7065751fcb Fix link errors in 'docs/reference/api/docker_remote_api_v***.md'
Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>

update fix-link-err-in-docs

Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>

update fix-link-err-in-docs

Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>

update fix-link-err-in-docs

Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>
Upstream-commit: f9ef10f853576d67d73b785deb53ecec84c31e63
Component: engine
2016-07-19 02:53:03 +08:00
51ece55ad4 Status code 409 received when conflicting name when creating container
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
Upstream-commit: 5bf46cc43624f230fae80430dd9d1d5f494c0c95
Component: engine
2016-07-14 14:58:43 +02:00
32cd0213a9 Add missing API docs for HostConfig.PidMode
The `--pid` flag was added in Docker 1.5.0, but the
API changes were not documented. In Docker 1.12.0,
`--pid=container:<name|id>` was added as an additional
option, but also undocumented.

This adds the missing API documentation for this
option.

Also see commits
47e3da848ffbe88d0188ae6cfc09d6e1668bc293 (for 1.5.0), and
ebeb5a0422be47e703353e327606a380eb9962ab (for 1.12.0).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 2c9b5addc5022dba33d5d0443b49b2e4c0041ef3
Component: engine
2016-07-12 01:52:42 +02:00
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