From 63d65505b28046f23a3cce4374e458720b76bc80 Mon Sep 17 00:00:00 2001 From: Vincent Demeester Date: Thu, 28 Jul 2016 17:48:32 +0200 Subject: [PATCH] Update `/node/*` api reference documentation Signed-off-by: Vincent Demeester --- docs/reference/api/docker_remote_api_v1.24.md | 162 +++++------------- docs/reference/api/docker_remote_api_v1.25.md | 162 +++++------------- 2 files changed, 90 insertions(+), 234 deletions(-) diff --git a/docs/reference/api/docker_remote_api_v1.24.md b/docs/reference/api/docker_remote_api_v1.24.md index b70094a6df..514fdb167d 100644 --- a/docs/reference/api/docker_remote_api_v1.24.md +++ b/docs/reference/api/docker_remote_api_v1.24.md @@ -3351,8 +3351,12 @@ List nodes "CreatedAt": "2016-06-07T20:31:11.853781916Z", "UpdatedAt": "2016-06-07T20:31:11.999868824Z", "Spec": { + "Name": "my-node", "Role": "MANAGER", "Availability": "ACTIVE" + "Labels": { + "foo": "bar" + } }, "Description": { "Hostname": "bf3067039e47", @@ -3366,11 +3370,22 @@ List nodes }, "Engine": { "EngineVersion": "1.12.0-dev", + "Labels": { + "foo": "bar", + } "Plugins": [ { "Type": "Volume", "Name": "local" }, + { + "Type": "Network", + "Name": "bridge" + } + { + "Type": "Network", + "Name": "null" + } { "Type": "Network", "Name": "overlay" @@ -3379,63 +3394,12 @@ List nodes } }, "Status": { - "State": "READY" + "State": "ready" }, - "Manager": { - "Raft": { - "RaftID": 10070664527094528000, - "Addr": "172.17.0.2:4500", - "Status": { - "Leader": true, - "Reachability": "REACHABLE" - } - } - }, - "Attachment": { - "Network": { - "ID": "4qvuz4ko70xaltuqbt8956gd1", - "Version": { - "Index": 6 - }, - "CreatedAt": "2016-06-07T20:31:11.912919752Z", - "UpdatedAt": "2016-06-07T20:31:11.921784144Z", - "Spec": { - "Name": "ingress", - "Labels": { - "com.docker.swarm.internal": "true" - }, - "DriverConfiguration": {}, - "IPAM": { - "Driver": {}, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "DriverState": { - "Name": "overlay", - "Options": { - "com.docker.network.driver.overlay.vxlanid_list": "256" - } - }, - "IPAM": { - "Driver": { - "Name": "default" - }, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "Addresses": [ - "10.255.0.2/16" - ] + "ManagerStatus": { + "Leader": true, + "Reachability": "reachable", + "Addr": "172.17.0.2:2377"" } } ] @@ -3478,8 +3442,12 @@ Return low-level information on the node `id` "CreatedAt": "2016-06-07T20:31:11.853781916Z", "UpdatedAt": "2016-06-07T20:31:11.999868824Z", "Spec": { + "Name": "my-node", "Role": "MANAGER", "Availability": "ACTIVE" + "Labels": { + "foo": "bar" + } }, "Description": { "Hostname": "bf3067039e47", @@ -3493,11 +3461,22 @@ Return low-level information on the node `id` }, "Engine": { "EngineVersion": "1.12.0-dev", + "Labels": { + "foo": "bar", + } "Plugins": [ { "Type": "Volume", "Name": "local" }, + { + "Type": "Network", + "Name": "bridge" + } + { + "Type": "Network", + "Name": "null" + } { "Type": "Network", "Name": "overlay" @@ -3506,63 +3485,12 @@ Return low-level information on the node `id` } }, "Status": { - "State": "READY" + "State": "ready" }, - "Manager": { - "Raft": { - "RaftID": 10070664527094528000, - "Addr": "172.17.0.2:4500", - "Status": { - "Leader": true, - "Reachability": "REACHABLE" - } - } - }, - "Attachment": { - "Network": { - "ID": "4qvuz4ko70xaltuqbt8956gd1", - "Version": { - "Index": 6 - }, - "CreatedAt": "2016-06-07T20:31:11.912919752Z", - "UpdatedAt": "2016-06-07T20:31:11.921784144Z", - "Spec": { - "Name": "ingress", - "Labels": { - "com.docker.swarm.internal": "true" - }, - "DriverConfiguration": {}, - "IPAM": { - "Driver": {}, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "DriverState": { - "Name": "overlay", - "Options": { - "com.docker.network.driver.overlay.vxlanid_list": "256" - } - }, - "IPAM": { - "Driver": { - "Name": "default" - }, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "Addresses": [ - "10.255.0.2/16" - ] + "ManagerStatus": { + "Leader": true, + "Reachability": "reachable", + "Addr": "172.17.0.2:2377"" } } @@ -3587,8 +3515,8 @@ Initialize a new swarm Content-Type: application/json { - "ListenAddr": "0.0.0.0:4500", - "AdvertiseAddr": "192.168.1.1:4500", + "ListenAddr": "0.0.0.0:2377", + "AdvertiseAddr": "192.168.1.1:2377", "ForceNewCluster": false, "Spec": { "Orchestration": {}, @@ -3658,9 +3586,9 @@ Join an existing swarm Content-Type: application/json { - "ListenAddr": "0.0.0.0:4500", - "AdvertiseAddr": "192.168.1.1:4500", - "RemoteAddrs": ["node1:4500"], + "ListenAddr": "0.0.0.0:2377", + "AdvertiseAddr: "192.168.1.1:2377", + "RemoteAddrs": ["node1:2377"], "JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" } diff --git a/docs/reference/api/docker_remote_api_v1.25.md b/docs/reference/api/docker_remote_api_v1.25.md index 3b6f7fb3ea..f5f3507fe7 100644 --- a/docs/reference/api/docker_remote_api_v1.25.md +++ b/docs/reference/api/docker_remote_api_v1.25.md @@ -3351,8 +3351,12 @@ List nodes "CreatedAt": "2016-06-07T20:31:11.853781916Z", "UpdatedAt": "2016-06-07T20:31:11.999868824Z", "Spec": { + "Name": "my-node", "Role": "MANAGER", "Availability": "ACTIVE" + "Labels": { + "foo": "bar" + } }, "Description": { "Hostname": "bf3067039e47", @@ -3366,11 +3370,22 @@ List nodes }, "Engine": { "EngineVersion": "1.12.0-dev", + "Labels": { + "foo": "bar", + } "Plugins": [ { "Type": "Volume", "Name": "local" }, + { + "Type": "Network", + "Name": "bridge" + } + { + "Type": "Network", + "Name": "null" + } { "Type": "Network", "Name": "overlay" @@ -3379,63 +3394,12 @@ List nodes } }, "Status": { - "State": "READY" + "State": "ready" }, - "Manager": { - "Raft": { - "RaftID": 10070664527094528000, - "Addr": "172.17.0.2:4500", - "Status": { - "Leader": true, - "Reachability": "REACHABLE" - } - } - }, - "Attachment": { - "Network": { - "ID": "4qvuz4ko70xaltuqbt8956gd1", - "Version": { - "Index": 6 - }, - "CreatedAt": "2016-06-07T20:31:11.912919752Z", - "UpdatedAt": "2016-06-07T20:31:11.921784144Z", - "Spec": { - "Name": "ingress", - "Labels": { - "com.docker.swarm.internal": "true" - }, - "DriverConfiguration": {}, - "IPAM": { - "Driver": {}, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "DriverState": { - "Name": "overlay", - "Options": { - "com.docker.network.driver.overlay.vxlanid_list": "256" - } - }, - "IPAM": { - "Driver": { - "Name": "default" - }, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "Addresses": [ - "10.255.0.2/16" - ] + "ManagerStatus": { + "Leader": true, + "Reachability": "reachable", + "Addr": "172.17.0.2:2377"" } } ] @@ -3478,8 +3442,12 @@ Return low-level information on the node `id` "CreatedAt": "2016-06-07T20:31:11.853781916Z", "UpdatedAt": "2016-06-07T20:31:11.999868824Z", "Spec": { + "Name": "my-node", "Role": "MANAGER", "Availability": "ACTIVE" + "Labels": { + "foo": "bar" + } }, "Description": { "Hostname": "bf3067039e47", @@ -3493,11 +3461,22 @@ Return low-level information on the node `id` }, "Engine": { "EngineVersion": "1.12.0-dev", + "Labels": { + "foo": "bar", + } "Plugins": [ { "Type": "Volume", "Name": "local" }, + { + "Type": "Network", + "Name": "bridge" + } + { + "Type": "Network", + "Name": "null" + } { "Type": "Network", "Name": "overlay" @@ -3506,63 +3485,12 @@ Return low-level information on the node `id` } }, "Status": { - "State": "READY" + "State": "ready" }, - "Manager": { - "Raft": { - "RaftID": 10070664527094528000, - "Addr": "172.17.0.2:4500", - "Status": { - "Leader": true, - "Reachability": "REACHABLE" - } - } - }, - "Attachment": { - "Network": { - "ID": "4qvuz4ko70xaltuqbt8956gd1", - "Version": { - "Index": 6 - }, - "CreatedAt": "2016-06-07T20:31:11.912919752Z", - "UpdatedAt": "2016-06-07T20:31:11.921784144Z", - "Spec": { - "Name": "ingress", - "Labels": { - "com.docker.swarm.internal": "true" - }, - "DriverConfiguration": {}, - "IPAM": { - "Driver": {}, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "DriverState": { - "Name": "overlay", - "Options": { - "com.docker.network.driver.overlay.vxlanid_list": "256" - } - }, - "IPAM": { - "Driver": { - "Name": "default" - }, - "Configs": [ - { - "Family": "UNKNOWN", - "Subnet": "10.255.0.0/16" - } - ] - } - }, - "Addresses": [ - "10.255.0.2/16" - ] + "ManagerStatus": { + "Leader": true, + "Reachability": "reachable", + "Addr": "172.17.0.2:2377"" } } @@ -3587,8 +3515,8 @@ Initialize a new swarm Content-Type: application/json { - "ListenAddr": "0.0.0.0:4500", - "AdvertiseAddr": "192.168.1.1:4500", + "ListenAddr": "0.0.0.0:2377", + "AdvertiseAddr": "192.168.1.1:2377", "ForceNewCluster": false, "Spec": { "Orchestration": {}, @@ -3658,9 +3586,9 @@ Join an existing swarm Content-Type: application/json { - "ListenAddr": "0.0.0.0:4500", - "AdvertiseAddr": "192.168.1.1:4500", - "RemoteAddrs": ["node1:4500"], + "ListenAddr": "0.0.0.0:2377", + "AdvertiseAddr": "192.168.1.1:2377", + "RemoteAddrs": ["node1:2377"], "JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" }