Commit graph

265 commits

Author SHA1 Message Date
Tony Miller
08f2fad40b document the ExtraHosts parameter for /containers/create for the remote API
I think this was added from version 1.15.

Signed-off-by: Tony Miller <mcfiredrill@gmail.com>
2015-01-27 19:35:24 -08:00
Andrew C. Bodine
32f189cd08 Adds docs for /containers/(id)/attach/ws api endpoint
Signed-off-by: Andrew C. Bodine <acbodine@us.ibm.com>
2015-01-27 19:35:23 -08:00
Michael Crosby
db9b1e3654 Update to docker stats documentation
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-01-21 11:44:23 -08:00
Michael Crosby
76141a0077 Add documentation for stats feature
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-01-20 20:21:47 -08:00
James Turnbull
25a8602cba Merge pull request #9840 from nhsiehgit/searchapidocs
updated search api docs to include pagination changes
2015-01-15 17:40:04 -05:00
Michael Crosby
409407091a Add --readonly for read only container rootfs
Add a --readonly flag to allow the container's root filesystem to be
mounted as readonly.  This can be used in combination with volumes to
force a container's process to only write to locations that will be
persisted.  This is useful in many cases where the admin controls where
they would like developers to write files and error on any other
locations.

Closes #7923
Closes #8752

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-01-14 15:41:31 -08:00
Michael Crosby
8ac075b846 Merge pull request #10036 from HuKeping/docs-next
docs: update docker inspect part of docs
2015-01-13 16:43:42 -08:00
Jessica Frazelle
ee78e3f284 Add reference to rename endpoint in correct version & add to new
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
2015-01-13 15:22:04 -08:00
Srini Brahmaroutu
21a809d9ae rename a existing container
Closes #3036

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
2015-01-13 03:27:17 +00:00
HuKeping
8d414fd434 docs: update docker inspect part of docs
The docker inspect part of docs is quit different with what it
really be.

Signed-off-by: Hu Keping <hukeping@huawei.com>
2015-01-12 13:20:27 +08:00
Jean-Paul Calderone
807f486f87 Change some instances of this mistake in the documentation as well.
Signed-off-by: Jean-Paul Calderone <exarkun@twistedmatrix.com>

Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@linux.com> (github: jfrazelle)
2015-01-09 20:31:38 -08:00
James Turnbull
90149b11db Merge pull request #9964 from duglin/MoveBuildDocs
Move docs on the build API out of 'misc' and under 'Images' section
2015-01-09 07:17:53 -05:00
Luis Martínez de Bartolomé Izquierdo
e54d8c47e4 Add c++ client library
Signed-off-by: Luis Martínez de Bartolomé Izquierdo <lmartinez@biicode.com>
Signed-off-by: Luis Martínez de Bartolomé Izquierdo <lasote@gmail.com>
2015-01-08 16:24:52 +01:00
Doug Davis
b7cb29137b Move docs on the build API out of 'misc' and under 'Images' section
It seems odd to have such an important API hidden under 'misc'.
While in there I noticed that during the "-f Dockerfile" PR I changed
the query param from f to dockerfile and missed this one spot in the docs.

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-01-07 20:27:09 -08:00
Sven Dowideit
f65b781d21 Merge pull request #9933 from cpuguy83/fix_api_docs_for_info
doc: Update API docs to reflect correct values for /info
2015-01-07 14:26:28 +10:00
Doug Davis
eb3ea3b43c Allow for Dockerfile to be named something else.
Add a check to make sure Dockerfile is in the build context
Add docs and a testcase
Make -f relative to current dir, not build context

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-01-06 16:33:26 -08:00
Brian Goff
cc3bf34c78 Update API docs to reflect correct values for /info
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2015-01-06 15:35:45 -08:00
Sven Dowideit
ceedaceb5c Merge pull request #9884 from flowlo/patch-1
doc: Standardise JSON examples
2015-01-06 15:32:04 +10:00
Lorenz Leutgeb
975f5b0c28 doc: Broaden JSON standardisation by patching
This is:

    git format-patch -1 --stdout HEAD \
    | patch -p1 docs/sources/reference/api/docker_remote_api_v1.*.md

Applying the changes I initially made on the docs for v1.15 to all
other versions led to acceptable results.

Signed-off-by: Lorenz Leutgeb <lorenz.leutgeb@gmail.com>
2015-01-05 11:45:10 +01:00
Lorenz Leutgeb
e583cc1eb4 doc: Try to standardise JSON examples
Fixed:
 * Invalid JSON
 * Inconsistent spacing at colon

Expression for binary data streams (line 468 vs. 1474) remain inconsistent.
Could fix that too, if you like.

Signed-off-by: Lorenz Leutgeb <lorenz.leutgeb@gmail.com>
2015-01-03 18:20:59 +01:00
Daehyeok Mun
fc7f055096 Add list of events in remote API docs
Add exec create and exec start to list of events in remote API docs

Signed-off-by: Daehyeok Mun <daehyeok@gmail.com>
2015-01-03 20:40:25 +09:00
Nathan Hsieh
1aac999f70 updated docs with information regarding search pagination
Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
2015-01-02 16:21:51 -08:00
Nathan Hsieh
686585f33a updated search api docs to include pagination changes
Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
2015-01-02 13:01:28 -08:00
Sven Dowideit
35873e747d Document that there is a delay before the --restart policy restart, and that its double the last one
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
2014-12-30 12:36:04 +10:00
Alexander Morozov
12fef2d8df Merge pull request #9800 from vieux/execIDs_inspect
Add ExecIDs to docker inspect
2014-12-29 15:32:33 -08:00
Victor Vieux
bbb92e1436 add docs
Signed-off-by: Victor Vieux <vieux@docker.com>
2014-12-24 00:12:35 +00:00
Phil Estes
44cab4a4ff Add "OOM killed" event based on OOM state information
Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
2014-12-23 18:22:31 -05:00
Jean-Tiare Le Bigot
800a8e896e start new API v1.17 docs
Signed-off-by: Jean-Tiare Le Bigot <jt@yadutaf.fr>
2014-12-22 09:01:33 +01:00
Fred Lifton
5df189a1b0 Merge pull request #9682 from SvenDowideit/scottstamp-stale-links-pr-carry
Scottstamp stale links pr carry
2014-12-17 16:03:55 -08:00
Alexander Morozov
f538e4be6b Merge pull request #9652 from yadutaf/master
Set HTTP upgrade headers when hijacking connection
2014-12-16 16:21:29 -08:00
Jean-Tiare Le Bigot
afb06a3ce2 Update connection hijacking documentation with HTTP Upgrade Headers
Signed-off-by: Jean-Tiare Le Bigot <jt@yadutaf.fr>
2014-12-17 00:22:06 +01:00
James Turnbull
92d24e3b7c Merge pull request #9651 from kdomanski/filter_docs
Document container list filtering in API docs
2014-12-16 01:38:49 -05:00
Sven Dowideit
fbb9223b1a add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2014-12-16 14:46:25 +10:00
Brian Goff
d44c9f9147 Fix volumes-from/bind-mounts passed in on start
Fixes #9628
Slightly reverts #8683, HostConfig on start is _not_ deprecated.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2014-12-15 16:51:15 -05:00
Kamil Domanski
51da97628a Add available filters for containers, images and events to API docs.
Signed-off-by: Kamil Domański <kamil@domanski.co> (github: kdomanski)
2014-12-15 16:51:29 +01:00
Kamil Domanski
37bdb05615 Add container list filtering to API docs.
Signed-off-by: Kamil Domański <kamil@domanski.co> (github: kdomanski)
2014-12-15 16:50:56 +01:00
Jonathan A. Sternberg
eb7d646a44 Fixing docs formatting for the forcerm flag on docker build
Signed-off-by: Jonathan A. Sternberg <jonathansternberg@gmail.com>
2014-12-04 12:35:31 -05:00
James Turnbull
e15ffa45a6 Merge pull request #9486 from ClusterHQ/9484-fromSrc-api-docs
Document fromSrc more clearly
2014-12-03 20:31:44 -05:00
Jessie Frazelle
67fda33197 Merge pull request #9089 from cpuguy83/8942_create_volumes_on_create
Initialize volumes when container is created
2014-12-03 15:42:09 -08:00
Jean-Paul Calderone
0888c1880f Update the most recent released version of the docs as well.
Signed-off-by: Jean-Paul Calderone <exarkun@twistedmatrix.com>
2014-12-03 17:14:08 -05:00
Jean-Paul Calderone
826f809d09 Talk about URL support and the real meaning of - in the latest fromSrc API documentation.
Signed-off-by: Jean-Paul Calderone <exarkun@twistedmatrix.com>
2014-12-03 17:13:48 -05:00
Neal McBurnett
4bf72613fe Fixes #9418 Docker Registry now open source
Signed-off-by: Neal McBurnett <neal@mcburnett.org>
2014-11-30 21:12:57 -07:00
Jessie Frazelle
00c2a8f323 Merge pull request #9208 from duglin/Issue8703
Add support for docker exec to return cmd exitStatus
2014-11-25 18:03:51 -08:00
Jessie Frazelle
9160e01cef Merge pull request #8893 from vieux/filter_events
Events filtering (daemon side)
2014-11-25 17:52:27 -08:00
Doug Davis
90928eb114 Add support for docker exec to return cmd exitStatus
Note - only support the non-detached mode of exec right now.
Another PR will add -d support.

Closes #8703

Signed-off-by: Doug Davis <dug@us.ibm.com>
2014-11-25 17:49:25 -08:00
Jessie Frazelle
39284be960 Merge pull request #9263 from cpuguy83/docs_cleanup_exec_api
Cleanup exec API docs and available params
2014-11-24 13:35:45 -08:00
Michael Crosby
5e19ecf25c Merge pull request #9281 from unclejack/build_pull_flag
build: add pull flag to force image pulling
2014-11-24 12:10:45 -08:00
Richard Metzler
91a8b916b0 Empty Line should fix Markdown unordered list
Without the line break the list would render as one single paragraph.
2014-11-23 23:57:43 +01:00
Brian Goff
d4ba00bd42 Cleanup exec API docs and available params
Adds pertitent information about what is expected in the json payload
and comments out unsupported (exec) features in runConfig.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2014-11-21 21:11:07 -05:00
unclejack
054e57a622 build: add pull flag to force image pulling
Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com>
2014-11-21 19:59:44 +02:00