Commit Graph

38 Commits

Author SHA1 Message Date
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
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
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
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
e5a1aebe66 docs: remove unused "registry" parameter
The "registry" query-param was in added 10c0e990371e065d4fc1c9b680f03a46e5bacc5e,
and removed in docker 0.5.0 via 66a9d06d9fa7a382c6852cf047e1448e0d3e1782.

Aparently, it was never removed from the documentation,
and included in all versions of the API docs.

This removes it from the documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: e035a86c1d981d5e2ade303a9152ee36125a4cb9
Component: engine
2016-04-16 02:09:58 +02: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
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
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
a78e8052d0 Update docs/reference/api to complete the docs
Signed-off-by: tracylihui <793912329@qq.com>
Upstream-commit: cc2ff8c9215e445d2504b0e4916233f72a257ee6
Component: engine
2016-02-21 10:28:07 +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
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
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
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
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
a9fcaeb043 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>
Upstream-commit: 2d43d93410c29cec87deb9cd940c3b2a8af5fbbb
Component: engine
2015-10-02 14:40:22 -04:00
85d177c805 Fix api documenation for /images/json response format
Signed-off-by: Daniel Nephin <dnephin@docker.com>
Upstream-commit: e5967d041d8cb57cc4ddeee6783580d9be3415f2
Component: engine
2015-09-30 12:24:34 -04:00
a505c19468 fix content-type of response for /commit
Signed-off-by: Tobias Gesellchen <tobias@gesellix.de>
Upstream-commit: 78de066a28c5e01524401840ff4d1ae76e8e0fc2
Component: engine
2015-09-23 23:49:16 +02:00
c88accb730 Fix typos in REST API documentation
Replace comma with column
Remove extra curly brace

Fix typo in REST API documentation

Replace comma with column in documentation.

Signed-off-by: Adrian Oprea <adrian@codesi.nz>

Remove extra curly brace

Remove extra curly brace from remote API docs.

Signed-off-by: Adrian Oprea <adrian@codesi.nz>
Upstream-commit: 18d856f55adfd37da5023867e9a63bbfe331dc01
Component: engine
2015-09-14 11:18:41 +03:00
862065b3b2 Add log reading to the journald log driver
If a logdriver doesn't register a callback function to validate log
options, it won't be usable.  Fix the journald driver by adding a dummy
validator.

Teach the client and the daemon's "logs" logic that the server can also
supply "logs" data via the "journald" driver.  Update documentation and
tests that depend on error messages.

Add support for reading log data from the systemd journal to the
journald log driver.  The internal logic uses a goroutine to scan the
journal for matching entries after any specified cutoff time, formats
the messages from those entries as JSONLog messages, and stuffs the
results down a pipe whose reading end we hand back to the caller.

If we are missing any of the 'linux', 'cgo', or 'journald' build tags,
however, we don't implement a reader, so the 'logs' endpoint will still
return an error.

Make the necessary changes to the build setup to ensure that support for
reading container logs from the systemd journal is built.

Rename the Jmap member of the journald logdriver's struct to "vars" to
make it non-public, and to make it easier to tell that it's just there
to hold additional variable values that we want journald to record along
with log data that we're sending to it.

In the client, don't assume that we know which logdrivers the server
implements, and remove the check that looks at the server.  It's
redundant because the server already knows, and the check also makes
using older clients with newer servers (which may have new logdrivers in
them) unnecessarily hard.

When we try to "logs" and have to report that the container's logdriver
doesn't support reading, send the error message through the
might-be-a-multiplexer so that clients which are expecting multiplexed
data will be able to properly display the error, instead of tripping
over the data and printing a less helpful "Unrecognized input header"
error.

Signed-off-by: Nalin Dahyabhai <nalin@redhat.com> (github: nalind)
Upstream-commit: e611a189cb3147cd79ccabfe8ba61ae3e3e28459
Component: engine
2015-09-11 16:50:03 -04:00
5e196ef2cc Fix json examples in the api reference.
Signed-off-by: David Calavera <david.calavera@gmail.com>
Upstream-commit: 7296c845b739ae4133e3d02d56cb7e8df29eb020
Component: engine
2015-08-25 10:55:12 -04:00
e2641596d8 Fix #15212: Add "Labels" key to output of /containers/json
Applied retroactively from API v1.18 - v1.21.

Signed-off-by: Charles Chan <charleswhchan@users.noreply.github.com>
Upstream-commit: b245bcd458492c9b348b790a9422dd7478f9af83
Component: engine
2015-08-03 18:11:33 -07:00
87314dfb81 Clarify filters option in list containers and list images docs
Based on the list containers with filters options it would seem that filtering containers with label `test=docker-java` could be done with `{"test":["docker-java"]}` which doesn't work

The options that work are `{"label":["test"]}` and `{"label":["test=docker-java"]}`

As seen in https://github.com/docker-java/docker-java/pull/262

Signed-off-by: Carlos Sanchez <carlos@apache.org>
Upstream-commit: 1fb29e6c3c13127912d1de9233f2aaaf63ec0ee8
Component: engine
2015-07-24 11:57:18 +02:00
b1387e7404 Add filter to /images/json docs
Closes #14894

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: a20bf5e61c542fea377345d5318293b44c65cbb5
Component: engine
2015-07-23 05:29:09 -07:00
abf0842b64 Add missing 'Names' field to /containers/json API output
Closes #14675

Wasn't sure how far back I needed to go so I did just a few.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 081991c01e13c60af725bea91c4f5598dbcceaa9
Component: engine
2015-07-16 08:23:55 -07:00
d59656f4c5 docs: update docs for API history
The response of hitory API includes more information now.

Signed-off-by: Hu Keping <hukeping@huawei.com>
Upstream-commit: 29660f263e07db404cf95b6a2efdc503e6dea2d2
Component: engine
2015-07-14 19:54:24 +08:00
265055473c Support downloading remote tarball contexts in builder jobs.
Signed-off-by: Moysés Borges <moysesb@gmail.com>
Upstream-commit: d48bface59ef28aedc692c1f7c51a7ddde94a7fe
Component: engine
2015-06-19 16:35:00 -03:00
c6caf278a1 Fixing seds, deleting old stuff
Signed-off-by: Mary Anthony <mary@docker.com>

Upding sed, adding script to avoid redirects, remove mkdos

Signed-off-by: Mary Anthony <mary@docker.com>

Ignoring graphics with sed

Signed-off-by: Mary Anthony <mary@docker.com>

Fixing kitematic image

Signed-off-by: Mary Anthony <mary@docker.com>

Removing draft

Signed-off-by: Mary Anthony <mary@docker.com>

Fixing link

Signed-off-by: Mary Anthony <mary@docker.com>

removing from the menu

Signed-off-by: Mary Anthony <mary@docker.com>

Updatiing order of project material

Signed-off-by: Mary Anthony <mary@docker.com>

Removing from Regsitry v2 content per Olivier

Signed-off-by: Mary Anthony <mary@docker.com>

tweaking the touchup

Signed-off-by: Mary Anthony <mary@docker.com>

Removing include; only used four places; hugo global var replace

Signed-off-by: Mary Anthony <mary@docker.com>

Entering fixes from page-by-page

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 328dbd0aa2a5aca656b45c4148cb09f715fbe677
Component: engine
2015-06-17 21:05:37 -07:00
9a276424db retooling for hugo
Tweaking for Hugo
Updating the Dockerfile with new sed; fix broken link on Kitematic
Fixing image pull for Dockerfile
Removing docs targets

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: f93fee5f48cc92df8668380e4edc2b7bbd6c62c6
Component: engine
2015-06-15 13:19:38 -07:00