docs/api
Andrea Luzzardi cafbc6df28 Improve container state refresh.
Currently, container inspection is performed only on creation (or during
exec by the API).

The problem is that certain informations such as NetworkSettings are not
available during creation, therefore we must inspect the containers
during other events.

This change refactors a bit the API so that RefreshContainer() and
RefreshContainers() now accept a `full` flag to force a deep refresh.

The node event handler in turn uses that flag whenever a container
starts or dies.

Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2015-01-26 13:39:52 -08:00
..
README.md add support for history, inspect for images and improve inspect for containers 2015-01-22 00:49:02 +00:00
api.go Improve container state refresh. 2015-01-26 13:39:52 -08:00
api_test.go createRouter doesn't yield errors 2015-01-13 02:02:01 +01:00
events.go Events: Embed the entire Node object rather than its attributes. 2014-12-17 17:54:07 -08:00
events_test.go Events: Embed the entire Node object rather than its attributes. 2014-12-17 17:54:07 -08:00
flusher.go add docker stats support 2015-01-21 23:28:41 +00:00
server.go createRouter doesn't yield errors 2015-01-13 02:02:01 +01:00
server_unix.go separate unix-related codes to make Swarm buildable on Windows 2014-12-30 11:25:49 +07:00
server_windows.go separate unix-related codes to make Swarm buildable on Windows 2014-12-30 11:25:49 +07:00
sorter.go replace 0.0.0.0 by node IP 2014-11-13 02:42:13 +00:00
utils.go Merge pull request #269 from vieux/add_stats 2015-01-21 17:31:04 -08:00

README.md

Docker Swarm API

The Docker Swarm API is compatible with the Offical Docker API:

Here are the main differences:

####Some endpoints are not (yet) implemented

GET "/images/get"
GET "/images/{name:.*}/get"
GET "/containers/{name:.*}/attach/ws"

POST "/commit"
POST "/build"
POST "/images/create"
POST "/images/load"
POST "/images/{name:.*}/push"
POST "/images/{name:.*}/tag"

DELETE "/images/{name:.*}"

####Some endpoints have more information

  • GET "/containers/{name:.*}/json": New field Node added:
"Node": {
        "ID": "ODAI:IC6Q:MSBL:TPB5:HIEE:6IKC:VCAM:QRNH:PRGX:ERZT:OK46:PMFX",
	"IP": "0.0.0.0",
	"Addr": "http://0.0.0.0:4243",
	"Name": "vagrant-ubuntu-saucy-64",
	"Cpus": 1,
	"Memory": 2099654656,
	"Labels": {
            "executiondriver": "native-0.2",
            "kernelversion": "3.11.0-15-generic",
            "operatingsystem": "Ubuntu 13.10",
            "storagedriver": "aufs"
	    }
    },
  • GET "/containers/{name:.*}/json": HostIP replaced by the the actual Node's IP if HostIP is 0.0.0.0

  • GET "/containers"/json": Node's name prepended to the container name.

  • GET "/containers"/json": HostIP replaed by the the actual Node's IP if HostIP is 0.0.0.0