docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs/api
History
Daniel Hiltgen dde577d154 Add token pass-thru for Authconfig 
This augments the CreateContainer call to detect the AuthConfig header
and use any supplied auth for pull operations.  This will allow pulling
of protected image on to specific node during the create operation.

CLI usage example using username/password:

    # Calculate the header
    REPO_USER=yourusername
    read -s PASSWORD
    HEADER=$(echo "{\"username\":\"${REPO_USER}\",\"password\":\"${PASSWORD}\"}"|base64 -w 0 )
    unset PASSWORD
    echo HEADER=$HEADER

    # Then add the following to your ~/.docker/config.json
    "HttpHeaders": {
        "X-Registry-Auth": "<HEADER string from above>"
    }

    # Now run a private image against swarm:
    docker run --rm -it yourprivateimage:latest

CLI usage example using registry tokens: (Required engine 1.10 with new auth token support)

    REPO=yourrepo/yourimage
    REPO_USER=yourusername
    read -s PASSWORD
    AUTH_URL=https://auth.docker.io/token
    TOKEN=$(curl -s -u "${REPO_USER}:${PASSWORD}" "${AUTH_URL}?scope=repository:${REPO}:pull&service=registry.docker.io" |
        jq -r ".token")
    HEADER=$(echo "{\"registrytoken\":\"${TOKEN}\"}"|base64 -w 0 )
    echo HEADER=$HEADER

    # Update the docker config as above, but the token will expire quickly...

Signed-off-by: Daniel Hiltgen <daniel.hiltgen@docker.com>
 		2015-12-11 18:36:55 -08:00
..
README.md Fix 'Scheduler' typos and update User Guide link 2015-07-20 20:41:33 -07:00
events.go Close tcp connection when client stops '/events' request. 2015-11-24 16:18:18 -08:00
events_test.go add newline to event json to match docker 2015-11-15 14:14:02 -08:00
flusher.go Improve godocs for exported values in api pkg 2015-03-30 21:32:08 -07:00
handlers.go Add token pass-thru for Authconfig 2015-12-11 18:36:55 -08:00
primary.go Route network connect/disconnect request to the right engine. 2015-12-02 18:46:16 -08:00
replica.go replica proxy: Improve error messages. 2015-06-12 13:27:35 -07:00
server.go Fix various golint issues. 2015-10-19 13:58:21 -07: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 docker ps: Support for filters and improve state management. 2015-05-06 23:38:32 -07:00
status.go leader election: Display replica status in docker info. 2015-06-11 18:56:02 -07:00
utils.go Ensure CloseWrite is called for hijacked TLS conns 2015-12-03 22:48:28 -05:00
utils_test.go improve build 2015-08-04 02:45:06 -04:00

README.md

page_title page_description page_keywords
Docker Swarm API Swarm API docker, swarm, clustering, api

Docker Swarm API

The Docker Swarm API is mostly compatible with the Docker Remote API. This document is an overview of the differences between the Swarm API and the Docker Remote API.

Endpoints which behave differently

  • 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",
    },

  • 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 replaced by the the actual Node's IP if HostIP is 0.0.0.0

  • GET "/containers/json" : Containers started from the swarm official image are hidden by default, use all=1 to display them.

  • GET "/images/json" : Use '--filter node=<Node name>' to show images of the specific node.

Docker Swarm documentation index