Browse code
Merge pull request #25194 from vdemeester/23597-swarm-api-ref-fixes
Update `/node/*` api reference documentation
(cherry picked from commit 0ab06816ea5887098039ba4ddecc964654335594)
Conflicts:
docs/reference/api/docker_remote_api_v1.24.md
docs/reference/api/docker_remote_api_v1.25.md
Sebastiaan van Stijn authored on 2016/08/03 22:44:18Showing 1 changed files
| ... | ... |
@@ -3351,8 +3351,12 @@ List nodes |
| 3351 | 3351 |
"CreatedAt": "2016-06-07T20:31:11.853781916Z", |
| 3352 | 3352 |
"UpdatedAt": "2016-06-07T20:31:11.999868824Z", |
| 3353 | 3353 |
"Spec": {
|
| 3354 |
+ "Name": "my-node", |
|
| 3354 | 3355 |
"Role": "MANAGER", |
| 3355 | 3356 |
"Availability": "ACTIVE" |
| 3357 |
+ "Labels": {
|
|
| 3358 |
+ "foo": "bar" |
|
| 3359 |
+ } |
|
| 3356 | 3360 |
}, |
| 3357 | 3361 |
"Description": {
|
| 3358 | 3362 |
"Hostname": "bf3067039e47", |
| ... | ... |
@@ -3366,6 +3370,9 @@ List nodes |
| 3366 | 3366 |
}, |
| 3367 | 3367 |
"Engine": {
|
| 3368 | 3368 |
"EngineVersion": "1.12.0-dev", |
| 3369 |
+ "Labels": {
|
|
| 3370 |
+ "foo": "bar", |
|
| 3371 |
+ } |
|
| 3369 | 3372 |
"Plugins": [ |
| 3370 | 3373 |
{
|
| 3371 | 3374 |
"Type": "Volume", |
| ... | ... |
@@ -3373,69 +3380,26 @@ List nodes |
| 3373 | 3373 |
}, |
| 3374 | 3374 |
{
|
| 3375 | 3375 |
"Type": "Network", |
| 3376 |
+ "Name": "bridge" |
|
| 3377 |
+ } |
|
| 3378 |
+ {
|
|
| 3379 |
+ "Type": "Network", |
|
| 3380 |
+ "Name": "null" |
|
| 3381 |
+ } |
|
| 3382 |
+ {
|
|
| 3383 |
+ "Type": "Network", |
|
| 3376 | 3384 |
"Name": "overlay" |
| 3377 | 3385 |
} |
| 3378 | 3386 |
] |
| 3379 | 3387 |
} |
| 3380 | 3388 |
}, |
| 3381 | 3389 |
"Status": {
|
| 3382 |
- "State": "READY" |
|
| 3383 |
- }, |
|
| 3384 |
- "Manager": {
|
|
| 3385 |
- "Raft": {
|
|
| 3386 |
- "RaftID": 10070664527094528000, |
|
| 3387 |
- "Addr": "172.17.0.2:4500", |
|
| 3388 |
- "Status": {
|
|
| 3389 |
- "Leader": true, |
|
| 3390 |
- "Reachability": "REACHABLE" |
|
| 3391 |
- } |
|
| 3392 |
- } |
|
| 3390 |
+ "State": "ready" |
|
| 3393 | 3391 |
}, |
| 3394 |
- "Attachment": {
|
|
| 3395 |
- "Network": {
|
|
| 3396 |
- "ID": "4qvuz4ko70xaltuqbt8956gd1", |
|
| 3397 |
- "Version": {
|
|
| 3398 |
- "Index": 6 |
|
| 3399 |
- }, |
|
| 3400 |
- "CreatedAt": "2016-06-07T20:31:11.912919752Z", |
|
| 3401 |
- "UpdatedAt": "2016-06-07T20:31:11.921784144Z", |
|
| 3402 |
- "Spec": {
|
|
| 3403 |
- "Name": "ingress", |
|
| 3404 |
- "Labels": {
|
|
| 3405 |
- "com.docker.swarm.internal": "true" |
|
| 3406 |
- }, |
|
| 3407 |
- "DriverConfiguration": {},
|
|
| 3408 |
- "IPAM": {
|
|
| 3409 |
- "Driver": {},
|
|
| 3410 |
- "Configs": [ |
|
| 3411 |
- {
|
|
| 3412 |
- "Family": "UNKNOWN", |
|
| 3413 |
- "Subnet": "10.255.0.0/16" |
|
| 3414 |
- } |
|
| 3415 |
- ] |
|
| 3416 |
- } |
|
| 3417 |
- }, |
|
| 3418 |
- "DriverState": {
|
|
| 3419 |
- "Name": "overlay", |
|
| 3420 |
- "Options": {
|
|
| 3421 |
- "com.docker.network.driver.overlay.vxlanid_list": "256" |
|
| 3422 |
- } |
|
| 3423 |
- }, |
|
| 3424 |
- "IPAM": {
|
|
| 3425 |
- "Driver": {
|
|
| 3426 |
- "Name": "default" |
|
| 3427 |
- }, |
|
| 3428 |
- "Configs": [ |
|
| 3429 |
- {
|
|
| 3430 |
- "Family": "UNKNOWN", |
|
| 3431 |
- "Subnet": "10.255.0.0/16" |
|
| 3432 |
- } |
|
| 3433 |
- ] |
|
| 3434 |
- } |
|
| 3435 |
- }, |
|
| 3436 |
- "Addresses": [ |
|
| 3437 |
- "10.255.0.2/16" |
|
| 3438 |
- ] |
|
| 3392 |
+ "ManagerStatus": {
|
|
| 3393 |
+ "Leader": true, |
|
| 3394 |
+ "Reachability": "reachable", |
|
| 3395 |
+ "Addr": "172.17.0.2:2377"" |
|
| 3439 | 3396 |
} |
| 3440 | 3397 |
} |
| 3441 | 3398 |
] |
| ... | ... |
@@ -3478,8 +3442,12 @@ Return low-level information on the node `id` |
| 3478 | 3478 |
"CreatedAt": "2016-06-07T20:31:11.853781916Z", |
| 3479 | 3479 |
"UpdatedAt": "2016-06-07T20:31:11.999868824Z", |
| 3480 | 3480 |
"Spec": {
|
| 3481 |
+ "Name": "my-node", |
|
| 3481 | 3482 |
"Role": "MANAGER", |
| 3482 | 3483 |
"Availability": "ACTIVE" |
| 3484 |
+ "Labels": {
|
|
| 3485 |
+ "foo": "bar" |
|
| 3486 |
+ } |
|
| 3483 | 3487 |
}, |
| 3484 | 3488 |
"Description": {
|
| 3485 | 3489 |
"Hostname": "bf3067039e47", |
| ... | ... |
@@ -3493,6 +3461,9 @@ Return low-level information on the node `id` |
| 3493 | 3493 |
}, |
| 3494 | 3494 |
"Engine": {
|
| 3495 | 3495 |
"EngineVersion": "1.12.0-dev", |
| 3496 |
+ "Labels": {
|
|
| 3497 |
+ "foo": "bar", |
|
| 3498 |
+ } |
|
| 3496 | 3499 |
"Plugins": [ |
| 3497 | 3500 |
{
|
| 3498 | 3501 |
"Type": "Volume", |
| ... | ... |
@@ -3500,69 +3471,26 @@ Return low-level information on the node `id` |
| 3500 | 3500 |
}, |
| 3501 | 3501 |
{
|
| 3502 | 3502 |
"Type": "Network", |
| 3503 |
+ "Name": "bridge" |
|
| 3504 |
+ } |
|
| 3505 |
+ {
|
|
| 3506 |
+ "Type": "Network", |
|
| 3507 |
+ "Name": "null" |
|
| 3508 |
+ } |
|
| 3509 |
+ {
|
|
| 3510 |
+ "Type": "Network", |
|
| 3503 | 3511 |
"Name": "overlay" |
| 3504 | 3512 |
} |
| 3505 | 3513 |
] |
| 3506 | 3514 |
} |
| 3507 | 3515 |
}, |
| 3508 | 3516 |
"Status": {
|
| 3509 |
- "State": "READY" |
|
| 3510 |
- }, |
|
| 3511 |
- "Manager": {
|
|
| 3512 |
- "Raft": {
|
|
| 3513 |
- "RaftID": 10070664527094528000, |
|
| 3514 |
- "Addr": "172.17.0.2:4500", |
|
| 3515 |
- "Status": {
|
|
| 3516 |
- "Leader": true, |
|
| 3517 |
- "Reachability": "REACHABLE" |
|
| 3518 |
- } |
|
| 3519 |
- } |
|
| 3517 |
+ "State": "ready" |
|
| 3520 | 3518 |
}, |
| 3521 |
- "Attachment": {
|
|
| 3522 |
- "Network": {
|
|
| 3523 |
- "ID": "4qvuz4ko70xaltuqbt8956gd1", |
|
| 3524 |
- "Version": {
|
|
| 3525 |
- "Index": 6 |
|
| 3526 |
- }, |
|
| 3527 |
- "CreatedAt": "2016-06-07T20:31:11.912919752Z", |
|
| 3528 |
- "UpdatedAt": "2016-06-07T20:31:11.921784144Z", |
|
| 3529 |
- "Spec": {
|
|
| 3530 |
- "Name": "ingress", |
|
| 3531 |
- "Labels": {
|
|
| 3532 |
- "com.docker.swarm.internal": "true" |
|
| 3533 |
- }, |
|
| 3534 |
- "DriverConfiguration": {},
|
|
| 3535 |
- "IPAM": {
|
|
| 3536 |
- "Driver": {},
|
|
| 3537 |
- "Configs": [ |
|
| 3538 |
- {
|
|
| 3539 |
- "Family": "UNKNOWN", |
|
| 3540 |
- "Subnet": "10.255.0.0/16" |
|
| 3541 |
- } |
|
| 3542 |
- ] |
|
| 3543 |
- } |
|
| 3544 |
- }, |
|
| 3545 |
- "DriverState": {
|
|
| 3546 |
- "Name": "overlay", |
|
| 3547 |
- "Options": {
|
|
| 3548 |
- "com.docker.network.driver.overlay.vxlanid_list": "256" |
|
| 3549 |
- } |
|
| 3550 |
- }, |
|
| 3551 |
- "IPAM": {
|
|
| 3552 |
- "Driver": {
|
|
| 3553 |
- "Name": "default" |
|
| 3554 |
- }, |
|
| 3555 |
- "Configs": [ |
|
| 3556 |
- {
|
|
| 3557 |
- "Family": "UNKNOWN", |
|
| 3558 |
- "Subnet": "10.255.0.0/16" |
|
| 3559 |
- } |
|
| 3560 |
- ] |
|
| 3561 |
- } |
|
| 3562 |
- }, |
|
| 3563 |
- "Addresses": [ |
|
| 3564 |
- "10.255.0.2/16" |
|
| 3565 |
- ] |
|
| 3519 |
+ "ManagerStatus": {
|
|
| 3520 |
+ "Leader": true, |
|
| 3521 |
+ "Reachability": "reachable", |
|
| 3522 |
+ "Addr": "172.17.0.2:2377"" |
|
| 3566 | 3523 |
} |
| 3567 | 3524 |
} |
| 3568 | 3525 |
|
| ... | ... |
@@ -3587,8 +3515,8 @@ Initialize a new Swarm |
| 3587 | 3587 |
Content-Type: application/json |
| 3588 | 3588 |
|
| 3589 | 3589 |
{
|
| 3590 |
- "ListenAddr": "0.0.0.0:4500", |
|
| 3591 |
- "AdvertiseAddr": "192.168.1.1:4500", |
|
| 3590 |
+ "ListenAddr": "0.0.0.0:2377", |
|
| 3591 |
+ "AdvertiseAddr": "192.168.1.1:2377", |
|
| 3592 | 3592 |
"ForceNewCluster": false, |
| 3593 | 3593 |
"Spec": {
|
| 3594 | 3594 |
"Orchestration": {},
|
| ... | ... |
@@ -3659,9 +3587,9 @@ Join an existing new Swarm |
| 3659 | 3659 |
Content-Type: application/json |
| 3660 | 3660 |
|
| 3661 | 3661 |
{
|
| 3662 |
- "ListenAddr": "0.0.0.0:4500", |
|
| 3663 |
- "AdvertiseAddr: "192.168.1.1:4500", |
|
| 3664 |
- "RemoteAddrs": ["node1:4500"], |
|
| 3662 |
+ "ListenAddr": "0.0.0.0:2377", |
|
| 3663 |
+ "AdvertiseAddr: "192.168.1.1:2377", |
|
| 3664 |
+ "RemoteAddrs": ["node1:2377"], |
|
| 3665 | 3665 |
"JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" |
| 3666 | 3666 |
} |
| 3667 | 3667 |
|