Commit Graph

163 Commits

Author SHA1 Message Date
de785f1386 Documenting Container Tty resize api
Addresses #7840

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Upstream-commit: c7f3fdc629dd654af2fc795c1f3fa1acdaf2552f
Component: engine
2014-09-26 16:26:21 +00:00
55f5c84e4a Merge pull request #8101 from jfrazelle/6974-correct-ct-json-stream
Change content-type for json stream to application/x-json-stream.
Upstream-commit: 42ec80bec02b7cb921397fc79ca58a18190e2c4b
Component: engine
2014-09-23 11:24:31 -07:00
b44c9bd465 Apply @tedyoung's changes to the entire set of API docs.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: ab43ad7d5fa8361736446af323c1fce77f150296
Component: engine
2014-09-23 10:09:49 +10:00
6bc23af935 Misc. fixes and formatting clean-up
Cleaned up and corrected some invalid "example responses".
Added some missing double-quotes for examples that resulted in invalid JSON.
Other general cleanup of stray characters and typos.

Docker-DCO-1.1-Signed-off-by: Ted M. Young <tedyoung@gmail.com> (github: SvenDowideit)
Upstream-commit: f304d4b190276939c9aff2090925342d16c7405e
Component: engine
2014-09-23 10:09:49 +10:00
7b47b2e708 Change content-type for json stream to application/x-json-stream.
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
Upstream-commit: 10ab2089ce189d5bea3f7aaac3b5081471309478
Component: engine
2014-09-22 10:29:56 -07:00
be7f27050e Merge pull request #8061 from SvenDowideit/document-image-tarball-format
Add a little description of the image tarball format.
Upstream-commit: 82aa895c6dc592809d97284744dbd90c869097c5
Component: engine
2014-09-19 10:32:13 +10:00
d38719a9ac Add a little description of the image tarball format.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: db9f8ba55cf2293f590ea5d129463ffc9a4eb23d
Component: engine
2014-09-18 10:40:55 +10:00
44cb0660ec Merge pull request #8081 from abh1nav/master
Update remote_api_client_libraries.md
Upstream-commit: e9b5acba4b7a0a21e030b775b82351189367eb41
Component: engine
2014-09-18 10:24:53 +10:00
8f5fad7c3d Merge pull request #8025 from davidpelaez-forks/docs-fix
Improved X-Registry-Auth content instructions
Upstream-commit: c7c78acf815c081ca56616a8b4c145217329f5e3
Component: engine
2014-09-18 09:54:25 +10:00
24cc16b5b6 Update remote_api_client_libraries.md
Ordering all clients alphabetically, by language.
Including all available languages in `page_keywords`.

Signed-off-by: Abhinav Ajgonkar <abhinav316@gmail.com>
Upstream-commit: ad65930d0bda1026a02efd18e9f6c70dfdae4fb6
Component: engine
2014-09-17 03:42:57 -04:00
56a385e489 Improved X-Registry-Auth content instructions
Hi,

this is a small contribution to fix some slightly unprecise information about the `X-Registry-Auth` header required to pull from private registries through the remote API. After a lot of trial and I error I managed to find that the documentation indications had this issues:

* Apparently single quotes cannot be used and double quotes (regular JSON) is required.
* Also the `auth` key must be passed even if empty or a 403 will result.
* It was not clear what the `serveraddress` had to be.

I added some small clarifications for anyone taking a look at the docs to keep them from the problems I've encountered. Hope this is helpful.

Thanks to all the contributors for bringing so much awesomeness to the linux world. :)

Signed-off-by: David Pelaez Tamayo <hello@davidpelaez.me>
Upstream-commit: 8c2b170c6ef3f8ec40c3a1bd6fdfc37f9271852a
Component: engine
2014-09-16 19:20:47 -05:00
9aa50abf75 Add some documentation for the RestartPolicy feature.
Signed-off-by: Jean-Paul Calderone <jean-paul@clusterhq.com>
Upstream-commit: d758da386a12598533f2388f2887091465c2efd8
Component: engine
2014-09-16 17:40:56 -04:00
abfdc34927 Merge pull request #8056 from SvenDowideit/use-sudo-docker-everywhere
Consistently use 'sudo docker' in examples
Upstream-commit: b64558907139911b86d846de70ab859504cc45a2
Component: engine
2014-09-16 08:43:58 -04:00
0fd379bbda Added missing 't' from the end of the /images/{{id}}/get eg.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: 4352ea7b0a746f00c29fb1170e893242cb8612ef
Component: engine
2014-09-16 15:27:44 +10:00
cd4d60a084 Consistently use 'sudo docker' in examples
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: fc9a3b1c1b835c170a4916362855e127a0e366e1
Component: engine
2014-09-16 11:49:05 +10:00
1bc2448cc5 Merge pull request #8037 from unclejack/shrink_docs_images
docs: shrink images
Upstream-commit: 62b86613e8c6bb8fa1c50fd30a92c050ffbed88e
Component: engine
2014-09-16 10:13:03 +10:00
084a5b1c3f Change the copy command Content-Type header to x-tar
Addresses #6107

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Upstream-commit: 788e4acaa3883bc7369f9462f107266b41c59746
Component: engine
2014-09-15 10:45:06 -07:00
c3fe53e47f docs: shrink images
Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 90dcc7c8405437a10b81e932b49a856502cee626
Component: engine
2014-09-15 14:46:29 +03:00
5d83fcb509 HTTP Status 201 not 200
The http status should be 201 not 200.

Docker-DCO-1.1-Signed-off-by: Erik Kristensen <erik@erikkristensen.com> (github: SvenDowideit)
Upstream-commit: c4db3b8075ab4b8bd0c6599cb19e09eb77c82946
Component: engine
2014-09-15 10:58:45 +10:00
0e0922f67a Merge pull request #7986 from abh1nav/master
Update remote_api_client_libraries.md
Upstream-commit: 64ecef59af2d5befd5624f3eb73e9ff16d827c55
Component: engine
2014-09-12 10:37:00 -07:00
990ce2ca68 docs/reference/api: fix typo in docs
Signed-off-by: Francisco Souza <f@souza.cc>
Upstream-commit: fe5b72e7bb4f7c043409196cb98d46796f2dc390
Component: engine
2014-09-12 13:57:43 -03:00
9153ab8851 Fixed a typo in docs (outpu -> output).
Signed-off-by: Lakshan Perera <lakshan@laktek.com>
Upstream-commit: 7b1fdd6c0460931d458703e175cba157de9b0246
Component: engine
2014-09-11 09:09:59 +00:00
066f8a742f Update remote_api_client_libraries.md
Adding docker rust client lib.

Signed-off-by: Abhinav Ajgonkar <abhinav316@gmail.com>
Upstream-commit: c7310b64637ae29a6d7a07b7e533a546e3524654
Component: engine
2014-09-11 03:04:35 -04:00
ec6681e63c Reformat the API docs so I can read them
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: f36dfbdcaf54ed01721f0871c26fe041c7c6bac0
Component: engine
2014-09-09 16:17:38 +10:00
b5848ae179 Merge pull request #7929 from SvenDowideit/doc-tar-stream
Sven Dowideit 	Update export, copy and build API to say 'TAR STREAM' for all versions.
Upstream-commit: 10e4ca760ca1d1145169dbff94e0c8414928b79c
Component: engine
2014-09-08 14:27:45 -07:00
b754dfbfae add C# docker client library link
Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
Upstream-commit: cde53c51b575d0cdeb01fc3428877ab63165e8b0
Component: engine
2014-09-07 23:29:04 -07:00
30cb064720 Update export, copy and build API to sat 'TAR STREAM' for all versions.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: 77fa306d63f0c0e48f49f6679beeb1ea55673f2a
Component: engine
2014-09-08 11:54:21 +10:00
816f39672a Update docker_remote_api_v1.14.md
It is a tar stream, you should mention that somehow.

Here is the proof:

```
	host:~$ docker run -t -i ubuntu:14.04 bash
	root@c39be4c7b7c8:/# echo "my file contents" > abc
	root@c39be4c7b7c8:/# cat abc
	my file contents
	root@c39be4c7b7c8:/# exit
	host:~$ curl -H "Content-Type: application/json" -d '{"Resource":"/abc"}' http://localhost:4500/containers/c39be4c7b7c8/copy
	abc0100644000000000000000000000002112402102531007674 0ustar0000000000000000my file contents
	host:~$ curl -H "Content-Type: application/json" -d '{"Resource":"/abc"}' http://localhost:4500/containers/c39be4c7b7c8/copy > response_content
	  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
	                                 Dload  Upload   Total   Spent    Left  Speed
	100  2067  100  2048  100    19  56968    528 --:--:-- --:--:-- --:--:-- 58514
	host:~$ tar xvf response_content
	abc
	host:~$ cat abc
	my file contents
```

Docker-DCO-1.1-Signed-off-by: Mustafa Akın <mustafa91@gmail.com> (github: SvenDowideit)
Upstream-commit: b9e889c30988f3babbc059a883d7f3096611ad60
Component: engine
2014-09-08 11:52:27 +10:00
e5f24c4f6a more updates
Signed-off-by: Victor Vieux <vieux@docker.com>
Upstream-commit: 2d8695761d0241d2c9b8bfe4274674c702c6a14d
Component: engine
2014-09-01 18:41:42 +00:00
3d35a8c726 v1.13 and 1.14 api docs now match runconfig/config.go
Upstream-commit: eac6a5d78906a70ddc3264f8d0a87369aefaedf0
Component: engine
2014-09-01 18:33:13 +00:00
4d890308d7 docker save: ability to save multiple images
Now from a single invocation of `docker save`, you can specify multiple
images to include in the output tar, or even just multiple tags of a
particular image/repo.

```
> docker save -o bundle.tar busybox ubuntu:lucid ubuntu:saucy fedora:latest
> tar tf ./bundle.tar | wc -l
42
> tar xOf ./bundle.tar repositories
{"busybox":{"latest":"2d8e5b282c81244037eb15b2068e1c46319c1a42b80493acb128da24b2090739"},"fedora":{"latest":"58394af373423902a1b97f209a31e3777932d9321ef10e64feaaa7b4df609cf9"},"ubuntu":{"lucid":"9cc9ea5ea540116b89e41898dd30858107c1175260fb7ff50322b34704092232","saucy":"9f676bd305a43a931a8d98b13e5840ffbebcd908370765373315926024c7c35e"}}
```

Further, this fixes the bug where the `repositories` file is not created
when saving a specific tag of an image (e.g. ubuntu:latest)

document multi-image save and updated API docs

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: e64131d1bf7c79358d5ee7a1a98626730db3593b
Component: engine
2014-08-28 20:22:33 -04:00
16bdc5c32b Merge pull request #7741 from LK4D4/bump_docs_to_1.15
Bump docs and api to 1.15
Upstream-commit: 4fe6115fb125d5acddec328e2dcfb23b6fe61ffa
Component: engine
2014-08-26 13:44:05 -07:00
b22bbbc6cc Bump docs and api to 1.15
Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com>
Upstream-commit: e261618b24b6837c820dccd8fa734eafc8b7f399
Component: engine
2014-08-26 13:08:50 +04:00
73e4ee940c Fix the other API docs to use an array of key/values
as per #7706

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: b0edced87f2a9bd2e85b0a59f6a6c83aff36e445
Component: engine
2014-08-26 11:36:25 +10:00
db566d8d04 Updating LxcConf to match Docker command line
I've changed LxcConf on a previous API document. Not sure why it keeps getting changed back. I'm seeing Docker 1.2.0 command-line calls are still using the array of key/values.

Docker-DCO-1.1-Signed-off-by: getvictor <victor@victoreda.com> (github: SvenDowideit)
Upstream-commit: 216ab880f96125566f2816510ba9d396dcf103f0
Component: engine
2014-08-26 11:36:25 +10:00
b6a88dc489 Clean up typos in hub_registry_spec.md
Couple of instances of incorrect articles (e.g. "an Docker Hub").
Upstream-commit: c87d9a1de62678743436887edecdbde2e5a67a1a
Component: engine
2014-08-21 11:04:25 -07:00
fc0d245526 Move remote API config out of daemon/
Signed-off-by: Solomon Hykes <solomon@docker.com>
Upstream-commit: 1d10c55aec891df609d36c90ee6c30adb24c16c4
Component: engine
2014-08-13 19:25:51 +00:00
acbbac3aa0 docker ps: introducing filters
* starting with filtering for exit codes. `docker ps -a --filter 'exited=1'`
* API doc for filter parameter
* formatting filters for help usage
* tweaks for review

This requires https://github.com/dotcloud/docker/pull/4430

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 84146719d8b8322e302e7a0250fe8a3ee1a4edcd
Component: engine
2014-08-13 09:12:33 -04:00
a79d7ec92b Revert rm -f deprecation use SIGKILL instead
`rm -f` was originally deprecated in favor of `rm --stop/--kill` since `rm
-f` was sending SIGTERM and potentially very slow.
Instead this will bring back `rm -f` but use SIGKILL isntead

Docker-DCO-1.1-Signed-off-by: Brian Goff <cpuguy83@gmail.com> (github: cpuguy83)
Upstream-commit: 95f86da641dfec9b3db88e0f0a8457685361a871
Component: engine
2014-08-07 18:20:43 -04:00
13e82ab047 #1852 Remote API documentation incorrect regarding private registries
Issues addressed:

- Remote API doco refers to "registry" parameter which is not supported
- Neglects to mention "tag" parameter which is supported
- Offers no guidance on pushing to private registries

Changes made:

- As directed in review comments, `registry` removed from all api versions (1.0-1.14)
- Have added documentation for `tag` parameter and guidance on private registries for versions 1.10-1.14 (I have only validated this on .10)

Docker-DCO-1.1-Signed-off-by: Lachlan Coote <lachlan.t.coote@gmail.com> (github: lcoote)
Upstream-commit: a5c5dc121c794daa199a813a95c0affd766a18f4
Component: engine
2014-08-01 15:58:01 -07:00
c795cf8d33 Merge pull request #7193 from hollietealok/doc_remove
Removed docker_io_oauth_api.md: Docker is not currently accepting regist...
Upstream-commit: 32fdcaa4192577b629bb622991804f9f9148e823
Component: engine
2014-07-31 15:19:58 -04:00
122772c096 Adding the query parameters to insert api call for all <= 1.10 and
removing the insert documentation for > 1.10 since it has been removed
in 1.11. This commit fixes #7183
Docker-DCO-1.1-Signed-off-by: Julien Bordellier <me@julienbordellier.com> (github: jstoja)
Upstream-commit: 2d84b877bdce5e26aac164e14815e1c4fa8648b7
Component: engine
2014-07-26 13:03:04 +02:00
6ae4c9014c update go import path and libcontainer
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: b3ee9ac74e171e00f14027e39278013629e681b8
Component: engine
2014-07-24 22:19:50 +00:00
e57cffad17 Merge remote-tracking branch 'upstream/master' into doc_remove
Docker-DCO-1.1-Signed-off-by: hollietealok <hollie@docker.com> (github: hollietealok)
Upstream-commit: 97283fa985623ca59183026a13951e7e9e6ce144
Component: engine
2014-07-24 11:28:19 -07:00
39a4d3a21d Removed docker_io_oauth_api.md: Docker is not currently accepting registrations for third party auth while it's determined how this will be done, if at all, in the future.
Docker-DCO-1.1-Signed-off-by: hollietealok <hollie@docker.com> (github: hollietealok)
Upstream-commit: 9fbae5924471b63e4f33fbd87f797183ab68be92
Component: engine
2014-07-23 11:55:56 -07:00
d72a089030 [DOCS] replace foo/bar with concrete names
namespaces are not well documented, and I had to jump around to other docs. replacing `foo/bar` hopefully makes what's going on here a bit more obvious.

Docker-DCO-1.1-Signed-off-by: Tim Ruffles <timruffles@gmail.com> (github: timruffles)
Upstream-commit: 455e837e207a01153947fc81e3a22d6bb37d2c89
Component: engine
2014-07-23 15:21:16 +01:00
3db76fe5b3 re-write to put the emphasis on the format
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: ed8b017ee085c26dadd6a976a89d63322a02738b
Component: engine
2014-07-16 11:02:44 +10:00
842f5a9ee6 missing doc for 6896
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 01d16150019c9ffb12779d88bdfe3bc146d44408
Component: engine
2014-07-15 23:32:12 +00:00
98075d5376 Merge pull request #6994 from Aigeruth/fix/docs/registry_api
Fix MarkDown in Docker Registry API docs
Upstream-commit: 9d6f295d5d019cf95bec3e607e1bd6cb0b42e310
Component: engine
2014-07-14 15:15:29 -07:00
b2c113f9b8 Merge pull request #6968 from vieux/cap_add_drop
Add support for --cap-add and --cap-drop
Upstream-commit: 7ebd49c49a9f70c87b6dbcff250035d3fd349a20
Component: engine
2014-07-14 10:42:29 -07:00