Commit Graph

42 Commits

Author SHA1 Message Date
2700d23ec3 Merge pull request #35102 from ripcurld0/doc_31926
Elaborate more about port allocation in docs
Upstream-commit: a6f09a7509cd77b4ce0bf26845a253a7d9997d11
Component: engine
2017-10-30 20:28:36 +01:00
6bfaa3dd46 Elaborate more about port allocation in docs
Describe more how host port allocation is done when
container is stopped/started in "PublishAllPorts".

Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com>
Upstream-commit: dfd706e1a59c3830c87b8240c466489ae6cc9d15
Component: engine
2017-10-17 15:19:54 +03:00
efe89988fe Return 400 error if API client is too new
Commit e98e4a71110fd33852bb755a9b8b4ebc9df904db implemented API version
negotiation using the `/_ping` endpoint. In that change, URL validation for the
maximum supported API version was removed from the API server (validation for
the _minimum_ version was kept in place).

With this feature, clients that support version negotiation would negotiate the
maximum version supported by the daemon, and downgrade to an older API version
if the client's default API version is not supported.

However, clients that do _not_ support version negotiation can call API versions
that are higher than the maximum supported version. Due to the missing version
check, this is silently ignored, and the daemon's default API version is used.

This is a problem, because the actual API version in use is non-deterministic;
for example, calling `/v9999.9999/version` on a daemon that runs API v1.34 will
use API v1.34, but calling the same URL on an older daemon may use API version
v1.24.

This patch reverts the removal of the API check for maximum supported versions.
The documentation has been updated accordingly

Before this patch is applied, the daemon returns a 200 (success):

    $ curl -v --unix-socket /var/run/docker.sock http://localhost/v9999.9999/version
    *   Trying /var/run/docker.sock...
    * Connected to localhost (/Users/sebastiaan/Library/Containers/com.dock) port 80 (#0)
    > GET /v9999.9999/version HTTP/1.1
    > Host: localhost
    > User-Agent: curl/7.54.0
    > Accept: */*
    >
    < HTTP/1.1 200 OK
    < Api-Version: 1.32
    < Content-Length: 240
    < Content-Type: application/json
    < Date: Tue, 10 Oct 2017 09:11:29 GMT
    < Docker-Experimental: true
    < Ostype: linux
    < Server: Docker/17.09.0-ce (linux)
    <
    {"Version":"17.09.0-ce","ApiVersion":"1.32","MinAPIVersion":"1.12","GitCommit":"afdb6d4","GoVersion":"go1.8.3","Os":"linux","Arch":"amd64","KernelVersion":"4.9.49-moby","Experimental":true,"BuildTime":"2017-09-26T22:45:38.000000000+00:00"}
    * Connection #0 to host localhost left intact

After this patch is applied, a 400 (Bad Request) is returned:

    $ curl -v --unix-socket /var/run/docker.sock http://localhost/v9999.9999/version
    *   Trying /var/run/docker.sock...
    * Connected to localhost (/var/run/docker.sock) port 80 (#0)
    > GET /v9999.9999/info HTTP/1.1
    > Host: localhost
    > User-Agent: curl/7.52.1
    > Accept: */*
    >
    < HTTP/1.1 400 Bad Request
    < Content-Type: application/json
    < Date: Tue, 10 Oct 2017 08:08:34 GMT
    < Content-Length: 89
    <
    {"message":"client version 9999.9999 is too new. Maximim supported API version is 1.34"}
    * Curl_http_done: called premature == 0
    * Connection #0 to host localhost left intact

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 01f9227ec9116b3969cb0725787e43a5fa26aac2
Component: engine
2017-10-10 11:17:48 +02:00
9b23ae7d55 API docs: add information about Content-Length header
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: a249ec36dd75df0fffa5d22f98422f778c60126e
Component: engine
2017-10-09 01:43:10 +02:00
1bfeb65ddc Fix GitHub spelling
Signed-off-by: Frieder Bluemle <frieder.bluemle@gmail.com>
Upstream-commit: b80472cef449d900ca9496d97e1527556ff6a04f
Component: engine
2017-10-07 00:10:24 +08:00
3c66acc139 Dropped hyphen in bind mount where appropriate
Signed-off-by: Christophe Vidal <kriss@krizalys.com>
Upstream-commit: dffa5d6df2e51556edfbcebc4695fdbc0bcc1a90
Component: engine
2017-08-19 21:25:07 +07:00
643654c2f0 Spelling fixes
* additional
* ambiguous
* anonymous
* anything
* application
* because
* before
* building
* capabilities
* circumstances
* commit
* committer
* compresses
* concatenated
* config
* container
* container's
* current
* definition
* delimiter
* disassociates
* discovery
* distributed
* doesnotexist
* downloads
* duplicates
* either
* enhancing
* enumerate
* escapable
* exactly
* expect
* expectations
* expected
* explicitly
* false
* filesystem
* following
* forbidden
* git with
* healthcheck
* ignore
* independent
* inheritance
* investigating
* irrelevant
* it
* logging
* looking
* membership
* mimic
* minimum
* modify
* mountpoint
* multiline
* notifier
* outputting
* outside
* overridden
* override
* parsable
* plugins
* precedence
* propagation
* provided
* provides
* registries
* repositories
* returning
* settings
* should
* signals
* someone
* something
* specifically
* successfully
* synchronize
* they've
* thinking
* uninitialized
* unintentionally
* unmarshaling
* unnamed
* unreferenced
* verify

Signed-off-by: Josh Soref <jsoref@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 39bcaee47b8a284a46b761afe218ba7deda0d482
Component: engine
2017-07-03 13:13:09 -07:00
b5c88cd04e Merge pull request #32504 from dongluochen/healthcheck_duration
do not allow duration less than 1 ms in healthcheck parameters
Upstream-commit: a7519152d9be7a0dd6941d529ea4b83cf4b7f1d4
Component: engine
2017-04-27 23:54:00 -04:00
7994679b80 update status code for network api
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 56dca8b676cee2781021cb1138f48d42ace415a4
Component: engine
2017-04-14 10:11:17 +08:00
2f0c087a4c set 1ms as container duration minimum value
Signed-off-by: Dong Chen <dongluo.chen@docker.com>
Upstream-commit: d8b6a35d0272d9bb121dda7d0bc53d0e53d8bd22
Component: engine
2017-04-12 15:45:29 -07:00
c09eedcd69 Merge pull request #30265 from allencloud/add-CheckDuplicate-details-and-logic
add CheckDuplicate docs and logics in network
Upstream-commit: e1da516598e6f4e8f58964fce62ff13be1d8cc09
Component: engine
2017-03-03 14:18:52 +01:00
301cc805aa Merge pull request #30814 from YuPengZTE/devSwarmCliExplain
fix the type
Upstream-commit: 25500d56a5f3a94456bd8172a64bf119cc36dd7f
Component: engine
2017-02-21 00:59:58 +01:00
a532e48c46 fix the type
Signed-off-by: yupengzte <yu.peng36@zte.com.cn>
Upstream-commit: d735972d3150fa4e286ce468f033156fa22fddb7
Component: engine
2017-02-14 09:54:27 +08:00
6aa42ecc9e add CheckDuplicate docs and logics in network
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 94b880f919937b3995a3424a284d1f6769e60f4b
Component: engine
2017-02-13 00:34:40 +08:00
439a3c18ed add link query in container rm api doc
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 2972b99f1b0c615d5a6e3ee1645ed104cfb8fe94
Component: engine
2017-02-11 00:17:37 +08:00
3f7730c74a Merge pull request #30734 from allencloud/add-400-status-code-for-events-endpoint
add status code 400 for api endpoint /events
Upstream-commit: f3da980a459c11a35248daa8a6be9919bf65fda2
Component: engine
2017-02-07 17:02:50 +01:00
8dc7e39e0a add status code 400 for api endpoint /events
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 323f575087d7e2068d74598283ec485b1f115226
Component: engine
2017-02-04 13:40:24 +08:00
cbb944b4cd add status code 404 for plugin api endpoint enable and disable
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 75f73058888347261edc4668c9d65f9ca161338d
Component: engine
2017-02-03 15:13:10 +08:00
5c27e35fbb validate healthcheck params in daemon side
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: e399c558e6eeef519a84a2e0bb11dade5a345014
Component: engine
2017-01-29 13:35:32 +08:00
58a26ce2d7 Merge pull request #30478 from mstanleyjones/fix_broken_links
Fix broken relative links in old API docs
Upstream-commit: 05d4c1314efd6b2ce408734aeece0e73f5d278f0
Component: engine
2017-01-27 09:45:52 -08:00
41ea58b118 Fix broken relative links in old API docs
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 37b13201c41753574942e567562f7ad098b827bf
Component: engine
2017-01-26 10:15:47 -08:00
cab1925d86 update api docs on Placement.Constraints for services
Signed-off-by: Lars-Magnus Skog <ralphtheninja@riseup.net>
Upstream-commit: 9c98bffc2b92625f113b390442b6dca245cb4be5
Component: engine
2017-01-26 15:01:21 +01:00
2b0805b53f typo: fix typo in api documents
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: 2f0d4946823019d2b41a0aac7eaa6b84f8e96e49
Component: engine
2017-01-23 22:05:44 -05:00
8f27f74ad0 Update docs and code to use application/x-tar in the build API
At the "Build image from Dockerfile" section in the API docs
the Content-Type header is missing.
In addition, some parts in the code are still setting the
Content-Type header to application/tar while it was changed
to application/x-tar since 16th September 2015.

Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com>
Upstream-commit: b1996728aaeaa147c2045c8be79373d59ce7117a
Component: engine
2017-01-10 06:40:06 +02:00
a688a9fc84 Attempts -> MaxAttempts in /services/create
Signed-off-by: Lars-Magnus Skog <ralphtheninja@riseup.net>
Upstream-commit: 778eeaea2089eed1f0f113bdc73f427b4e68c572
Component: engine
2017-01-09 16:04:34 +01:00
5c56c3f06a Fix typo in docs
s/BlkioDeviceWiiteIOps/BlkioDeviceWriteIOps/g

Signed-off-by: David Xia <dxia@spotify.com>
Upstream-commit: f394b1d77614d33e85c93ecb10f0a6676538b2e7
Component: engine
2016-12-25 11:48:11 -05:00
1e12b9ad9a Merge pull request #29600 from allencloud/update-docs-about-service-update
update service update in docs
Upstream-commit: 524704143b1f27650db9debe22adb9cf1e583930
Component: engine
2016-12-22 15:17:51 +01:00
1173e9c692 Merge pull request #29637 from wxb0521/bo-docker-0.5
some punctuation errors and a verb form error
Upstream-commit: 584485abca124d45e08b618e23b7cbf7b947895f
Component: engine
2016-12-21 12:18:04 -05:00
5f8f7eaafe update service update in docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: b44efead25a1d2600f0950e5e2800c17e7489a43
Component: engine
2016-12-22 00:11:08 +08:00
b238e8e00f some punctuation errors and a verb form error
Signed-off-by: Xinbo Weng <xihuanbo_0521@zju.edu.cn>
Upstream-commit: 32996d6016a9f109a44301279d52d881651790e9
Component: engine
2016-12-21 20:05:19 +08:00
c2a452db81 Fix document typos
Change the `State` field of the `/containers/json` remote API response to lowercase.
This change involves docs/api/v1.23.md and docs/api/v1.24.md

Signed-off-by: Anran Qiao <anran.qiao@daocloud.io>
Upstream-commit: 3dc3921c76a2d21c652ec867e42e9bbe095d91da
Component: engine
2016-12-21 18:28:52 +08:00
1201f538ea add missing status code 403 for services/create in docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 19654fd71ec5b9b075863f4623fdb80a955f5187
Component: engine
2016-12-10 01:54:51 +08:00
2a1f61f581 Merge pull request #29062 from erxian/refine-api-swagger.yaml-towards-image-create-status-code
refine api swagger.yaml towards image create status code
Upstream-commit: 9468d687ac924db8df95fd8d2bcbe7facafb8c2d
Component: engine
2016-12-07 22:03:54 +01:00
e148b77b83 modify URLs for bind docker in docs/api
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
Upstream-commit: 9c76fb253ecc53cc54d196a4460d8e1d91c1683d
Component: engine
2016-12-07 15:06:16 +08:00
afe61e5090 refine api swagger.yaml towards image create status code
Signed-off-by: erxian <evelynhsu21@gmail.com>
Upstream-commit: 15be050fb307d0da1521767a6f53d9b95429396b
Component: engine
2016-12-07 10:27:40 +08:00
13d5eb7768 add 403 for endpoint network create
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 0d21e24b9fb90ea804ba37af303de7547743ba2b
Component: engine
2016-12-06 14:36:50 +08:00
25a255f4fc add missing status code in api docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 9a1f7b6b0bba7bd28c5ae1fabef7ef267e5fbfbd
Component: engine
2016-12-02 11:24:45 +08:00
0a639f6e9e Merge pull request #28840 from bfirsh/2016-11-25-api-docs
Updates to swagger.yaml and API documentation
Upstream-commit: 643b1c0175206291d8850a87608912d906009a71
Component: engine
2016-11-30 15:49:25 +01:00
d6a43b5d6a Fix headings in old API docs
Jekyll automatically adds titles based on the title of the page,
so this was causing duplicate titles.

Also, made all the headings the correct level.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
Upstream-commit: d9b109b807a1ea859b9d71eb22663f577b0b8c47
Component: engine
2016-11-28 11:24:22 +00:00
c1c6b75097 update the secret command docs
Signed-off-by: erxian <evelynhsu21@gmail.com>
Upstream-commit: c22821014a8d951d7028f9d2888072c4d9f7c593
Component: engine
2016-11-23 10:36:11 +08:00
e5912f7d7e Rename Remote API to Engine API
Implementation of https://github.com/docker/docker/issues/28319

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
Upstream-commit: f0d55cd081c6e8ad2a8222c787d54f9aae15723f
Component: engine
2016-11-22 12:49:38 +00:00
7e2e397a31 Move API reference to new location
See: https://github.com/docker/docker.github.io/pull/606

Also:
- Add missing redirects to API reference pages
- Remove v1.25 and 1.26, because they are being replaced with
  swagger generated docs.
- Remove all other docs which aren't reference material, because
  this can live in docker/docker.github.io

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
Upstream-commit: 993854f58fa4132ff82c2e1ffe291d90b301db5a
Component: engine
2016-11-22 12:47:25 +00:00