From a1d16b4557233368ee70af39e55909c63fef3915 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 29 Apr 2016 17:37:04 +0200 Subject: [PATCH 1/5] update API example response for docker events the events API was rewritten in 723be0a3325799fd6b2a6b689af54f5a07edf992, but the example response in the documentation doesn't reflect the actual output this fixes the example response Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 3932d46a7878e3e75d8119f332b927fd2107cb32) Signed-off-by: Sebastiaan van Stijn --- docs/reference/api/docker_remote_api_v1.22.md | 192 +++++++++++++---- docs/reference/api/docker_remote_api_v1.23.md | 193 ++++++++++++++---- 2 files changed, 301 insertions(+), 84 deletions(-) diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md index 4a28423a3f..3c6ec0e989 100644 --- a/docs/reference/api/docker_remote_api_v1.22.md +++ b/docs/reference/api/docker_remote_api_v1.22.md @@ -2359,49 +2359,157 @@ Docker networks report the following events: HTTP/1.1 200 OK Content-Type: application/json + Server: Docker/1.10.0 (linux) + Date: Fri, 29 Apr 2016 15:18:06 GMT + Transfer-Encoding: chunked - [ - { - "action": "pull", - "type": "image", - "actor": { - "id": "busybox:latest", - "attributes": {} - } - "time": 1442421700, - "timeNano": 1442421700598988358 - }, - { - "action": "create", - "type": "container", - "actor": { - "id": "5745704abe9caa5", - "attributes": {"image": "busybox"} - } - "time": 1442421716, - "timeNano": 1442421716853979870 - }, - { - "action": "attach", - "type": "container", - "actor": { - "id": "5745704abe9caa5", - "attributes": {"image": "busybox"} - } - "time": 1442421716, - "timeNano": 1442421716894759198 - }, - { - "action": "start", - "type": "container", - "actor": { - "id": "5745704abe9caa5", - "attributes": {"image": "busybox"} - } - "time": 1442421716, - "timeNano": 1442421716983607193 - } - ] + { + "status": "pull", + "id": "alpine:latest", + "Type": "image", + "Action": "pull", + "Actor": { + "ID": "alpine:latest", + "Attributes": { + "name": "alpine" + } + }, + "time": 1461943101, + "timeNano": 1461943101301854122 + } + { + "status": "create", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "create", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943101, + "timeNano": 1461943101381709551 + } + { + "status": "attach", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "attach", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943101, + "timeNano": 1461943101383858412 + } + { + "Type": "network", + "Action": "connect", + "Actor": { + "ID": "7dc8ac97d5d29ef6c31b6052f3938c1e8f2749abbd17d1bd1febf2608db1b474", + "Attributes": { + "container": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "name": "bridge", + "type": "bridge" + } + }, + "time": 1461943101, + "timeNano": 1461943101394865557 + } + { + "status": "start", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "start", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943101, + "timeNano": 1461943101607533796 + } + { + "status": "resize", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "resize", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "height": "46", + "image": "alpine", + "name": "my-container", + "width": "204" + } + }, + "time": 1461943101, + "timeNano": 1461943101610269268 + } + { + "status": "die", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "die", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "exitCode": "0", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943105, + "timeNano": 1461943105079144137 + } + { + "Type": "network", + "Action": "disconnect", + "Actor": { + "ID": "7dc8ac97d5d29ef6c31b6052f3938c1e8f2749abbd17d1bd1febf2608db1b474", + "Attributes": { + "container": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "name": "bridge", + "type": "bridge" + } + }, + "time": 1461943105, + "timeNano": 1461943105230860245 + } + { + "status": "destroy", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "destroy", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943105, + "timeNano": 1461943105338056026 + } Query Parameters: diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md index 06fa2603b8..cff4bcedc6 100644 --- a/docs/reference/api/docker_remote_api_v1.23.md +++ b/docs/reference/api/docker_remote_api_v1.23.md @@ -2404,49 +2404,158 @@ Docker networks report the following events: HTTP/1.1 200 OK Content-Type: application/json + Server: Docker/1.11.0 (linux) + Date: Fri, 29 Apr 2016 15:18:06 GMT + Transfer-Encoding: chunked + + { + "status": "pull", + "id": "alpine:latest", + "Type": "image", + "Action": "pull", + "Actor": { + "ID": "alpine:latest", + "Attributes": { + "name": "alpine" + } + }, + "time": 1461943101, + "timeNano": 1461943101301854122 + } + { + "status": "create", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "create", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943101, + "timeNano": 1461943101381709551 + } + { + "status": "attach", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "attach", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943101, + "timeNano": 1461943101383858412 + } + { + "Type": "network", + "Action": "connect", + "Actor": { + "ID": "7dc8ac97d5d29ef6c31b6052f3938c1e8f2749abbd17d1bd1febf2608db1b474", + "Attributes": { + "container": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "name": "bridge", + "type": "bridge" + } + }, + "time": 1461943101, + "timeNano": 1461943101394865557 + } + { + "status": "start", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "start", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943101, + "timeNano": 1461943101607533796 + } + { + "status": "resize", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "resize", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "height": "46", + "image": "alpine", + "name": "my-container", + "width": "204" + } + }, + "time": 1461943101, + "timeNano": 1461943101610269268 + } + { + "status": "die", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "die", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "exitCode": "0", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943105, + "timeNano": 1461943105079144137 + } + { + "Type": "network", + "Action": "disconnect", + "Actor": { + "ID": "7dc8ac97d5d29ef6c31b6052f3938c1e8f2749abbd17d1bd1febf2608db1b474", + "Attributes": { + "container": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "name": "bridge", + "type": "bridge" + } + }, + "time": 1461943105, + "timeNano": 1461943105230860245 + } + { + "status": "destroy", + "id": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "from": "alpine", + "Type": "container", + "Action": "destroy", + "Actor": { + "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743", + "Attributes": { + "com.example.some-label": "some-label-value", + "image": "alpine", + "name": "my-container" + } + }, + "time": 1461943105, + "timeNano": 1461943105338056026 + } - [ - { - "action": "pull", - "type": "image", - "actor": { - "id": "busybox:latest", - "attributes": {} - } - "time": 1442421700, - "timeNano": 1442421700598988358 - }, - { - "action": "create", - "type": "container", - "actor": { - "id": "5745704abe9caa5", - "attributes": {"image": "busybox"} - } - "time": 1442421716, - "timeNano": 1442421716853979870 - }, - { - "action": "attach", - "type": "container", - "actor": { - "id": "5745704abe9caa5", - "attributes": {"image": "busybox"} - } - "time": 1442421716, - "timeNano": 1442421716894759198 - }, - { - "action": "start", - "type": "container", - "actor": { - "id": "5745704abe9caa5", - "attributes": {"image": "busybox"} - } - "time": 1442421716, - "timeNano": 1442421716983607193 - } - ] Query Parameters: From 14a2985f37b1c7515b8b9a4cc3c13898e147d684 Mon Sep 17 00:00:00 2001 From: Lorenzo Fontana Date: Mon, 25 Apr 2016 15:31:23 +0200 Subject: [PATCH 2/5] Mention the fact that authz plugins are available today Signed-off-by: Lorenzo Fontana (cherry picked from commit 96cc1ee44cc4412511e944d48eed14434cac2c31) Signed-off-by: Sebastiaan van Stijn --- docs/extend/plugins.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/extend/plugins.md b/docs/extend/plugins.md index 7eec419c97..e40c611282 100644 --- a/docs/extend/plugins.md +++ b/docs/extend/plugins.md @@ -22,7 +22,7 @@ example, a [volume plugin](plugins_volume.md) might enable Docker volumes to persist across multiple Docker hosts and a [network plugin](plugins_network.md) might provide network plumbing. -Currently Docker supports volume and network driver plugins. In the future it +Currently Docker supports authorization, volume and network driver plugins. In the future it will support additional plugin types. ## Installing a plugin @@ -65,6 +65,11 @@ Plugin [Quobyte Volume Plugin](https://github.com/quobyte/docker-volume) | A volume plugin that connects Docker to [Quobyte](http://www.quobyte.com/containers)'s data center file system, a general-purpose scalable and fault-tolerant storage platform. [REX-Ray plugin](https://github.com/emccode/rexray) | A volume plugin which is written in Go and provides advanced storage functionality for many platforms including VirtualBox, EC2, Google Compute Engine, OpenStack, and EMC. +### Authorization plugins + + Plugin | Description +------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + [Twistlock AuthZ Broker](https://github.com/twistlock/authz) | A basic extendable authorization plugin that runs directly on the host or inside a container. This plugin allows you to define user policies that it evaluates during authorization. Basic authorization is provided if Docker daemon is started with the --tlsverify flag (username is extracted from the certificate common name). ## Troubleshooting a plugin From 0b5c960bb08462ad9e170b7aa655c2d4fb51dd0a Mon Sep 17 00:00:00 2001 From: Yuan Sun Date: Sun, 1 May 2016 15:37:11 +0800 Subject: [PATCH 3/5] remove "the" in docs. Signed-off-by: Yuan Sun (cherry picked from commit 043c9ef076477a391a58792930100402b48bbe1e) Signed-off-by: Sebastiaan van Stijn --- docs/reference/run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/run.md b/docs/reference/run.md index d135aa9965..e0b7a2bbe3 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -848,7 +848,7 @@ limit and "K" the kernel limit. There are three possible ways to set limits: deployments where the total amount of memory per-cgroup is overcommitted. Overcommitting kernel memory limits is definitely not recommended, since the box can still run out of non-reclaimable memory. - In this case, the you can configure K so that the sum of all groups is + In this case, you can configure K so that the sum of all groups is never greater than the total memory. Then, freely set U at the expense of the system's service quality. From 3b2ed5b2dffda13c5f0a21b5ae0bd8b1539c11cb Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Thu, 21 Apr 2016 16:24:51 -0700 Subject: [PATCH 4/5] Fix lasote/docker_client link Signed-off-by: Ben Firshman (cherry picked from commit 91fe274dcf09dfd580aaa1c88fa2ddbb4758bf66) Signed-off-by: Sebastiaan van Stijn --- docs/reference/api/remote_api_client_libraries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/api/remote_api_client_libraries.md b/docs/reference/api/remote_api_client_libraries.md index fd4b3e39f1..ea88b1494e 100644 --- a/docs/reference/api/remote_api_client_libraries.md +++ b/docs/reference/api/remote_api_client_libraries.md @@ -41,7 +41,7 @@ will add the libraries here. C++ lasote/docker_client - http://www.biicode.com/lasote/docker_client (Biicode C++ dependency manager) + https://github.com/lasote/docker_client Active From 340c9a4619372519c38f42feccc08f1b645807c1 Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Thu, 21 Apr 2016 17:07:55 -0700 Subject: [PATCH 5/5] Remove out-of-date client libraries For each language, if there is one library which is clearly the best or most active, I've removed the other libraries so users aren't mislead. I've removed the web UIs because they're not really client libraries. Signed-off-by: Ben Firshman (cherry picked from commit bb94cfce62b5b07f7ec00bfbbc229c7f87b7a6e8) Signed-off-by: Sebastiaan van Stijn --- .../api/remote_api_client_libraries.md | 93 +------------------ 1 file changed, 1 insertion(+), 92 deletions(-) diff --git a/docs/reference/api/remote_api_client_libraries.md b/docs/reference/api/remote_api_client_libraries.md index ea88b1494e..b82062deff 100644 --- a/docs/reference/api/remote_api_client_libraries.md +++ b/docs/reference/api/remote_api_client_libraries.md @@ -62,18 +62,6 @@ will add the libraries here. https://github.com/docker/engine-api Active - - Go - go-dockerclient - https://github.com/fsouza/go-dockerclient - Active - - - Go - dockerclient - https://github.com/samalba/dockerclient - Active - Gradle gradle-docker-plugin @@ -111,97 +99,24 @@ will add the libraries here. Active - Java - jclouds-docker - https://github.com/jclouds/jclouds-labs/tree/master/docker - Active - - - Java - rx-docker-client - https://github.com/shekhargulati/rx-docker-client - Active - - - JavaScript (NodeJS) - dockerizer - https://github.com/kesarion/dockerizer - Active - - - JavaScript (NodeJS) + NodeJS dockerode https://github.com/apocas/dockerode Install via NPM: npm install dockerode Active - - JavaScript (NodeJS) - docker.io - https://github.com/appersonlabs/docker.io - Install via NPM: npm install docker.io - Active - - - JavaScript - docker-js - https://github.com/dgoujard/docker-js - Outdated - - - JavaScript (Angular) WebUI - Albatros - https://github.com/dcylabs/albatros - Active - - - JavaScript (Angular) WebUI - docker-cp - https://github.com/13W/docker-cp - Active - - - JavaScript (Angular) WebUI - dockerui - https://github.com/crosbymichael/dockerui - Active - - - JavaScript (Angular) WebUI - dockery - https://github.com/lexandro/dockery - Active - - - Perl - Net::Docker - https://metacpan.org/pod/Net::Docker - Active - Perl Eixo::Docker https://github.com/alambike/eixo-docker Active - - PHP - Alvine - http://pear.alvine.io/ (alpha) - Active - PHP Docker-PHP https://github.com/docker-php/docker-php Active - - PHP - Docker-PHP-Client - https://github.com/jarkt/docker-php-client - Active - Python docker-py @@ -214,12 +129,6 @@ will add the libraries here. https://github.com/swipely/docker-api Active - - Ruby - docker-client - https://github.com/geku/docker-client - Outdated - Rust docker-rust