Browse code

Add documentation for external CA features in API/CLI

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>

Aaron Lehmann authored on 2016/07/01 08:07:25
Showing 4 changed files
... ...
@@ -3644,8 +3644,15 @@ JSON Parameters:
3644 3644
           election.
3645 3645
     - **Dispatcher** – Configuration settings for the task dispatcher.
3646 3646
         - **HeartbeatPeriod** – The delay for an agent to send a heartbeat to the dispatcher.
3647
-    - **CAConfig** – CA configuration.
3647
+    - **CAConfig** – Certificate authority configuration.
3648 3648
         - **NodeCertExpiry** – Automatic expiry for nodes certificates.
3649
+        - **ExternalCA** - Configuration for forwarding signing requests to an external
3650
+          certificate authority.
3651
+            - **Protocol** - Protocol for communication with the external CA
3652
+              (currently only "cfssl" is supported).
3653
+            - **URL** - URL where certificate signing requests should be sent.
3654
+            - **Options** - An object with key/value pairs that are interpreted
3655
+              as protocol-specific options for the external CA driver.
3649 3656
 
3650 3657
 ### Join an existing Swarm
3651 3658
 
... ...
@@ -3792,6 +3799,13 @@ JSON Parameters:
3792 3792
     - **HeartbeatPeriod** – The delay for an agent to send a heartbeat to the dispatcher.
3793 3793
 - **CAConfig** – CA configuration.
3794 3794
     - **NodeCertExpiry** – Automatic expiry for nodes certificates.
3795
+    - **ExternalCA** - Configuration for forwarding signing requests to an external
3796
+      certificate authority.
3797
+        - **Protocol** - Protocol for communication with the external CA
3798
+          (currently only "cfssl" is supported).
3799
+        - **URL** - URL where certificate signing requests should be sent.
3800
+        - **Options** - An object with key/value pairs that are interpreted
3801
+          as protocol-specific options for the external CA driver.
3795 3802
 
3796 3803
 ## 3.8 Services
3797 3804
 
... ...
@@ -3645,8 +3645,15 @@ JSON Parameters:
3645 3645
           election.
3646 3646
     - **Dispatcher** – Configuration settings for the task dispatcher.
3647 3647
         - **HeartbeatPeriod** – The delay for an agent to send a heartbeat to the dispatcher.
3648
-    - **CAConfig** – CA configuration.
3648
+    - **CAConfig** – Certificate authority configuration.
3649 3649
         - **NodeCertExpiry** – Automatic expiry for nodes certificates.
3650
+        - **ExternalCA** - Configuration for forwarding signing requests to an external
3651
+          certificate authority.
3652
+            - **Protocol** - Protocol for communication with the external CA
3653
+              (currently only "cfssl" is supported).
3654
+            - **URL** - URL where certificate signing requests should be sent.
3655
+            - **Options** - An object with key/value pairs that are interpreted
3656
+              as protocol-specific options for the external CA driver.
3650 3657
 
3651 3658
 ### Join an existing Swarm
3652 3659
 
... ...
@@ -3793,6 +3800,13 @@ JSON Parameters:
3793 3793
     - **HeartbeatPeriod** – The delay for an agent to send a heartbeat to the dispatcher.
3794 3794
 - **CAConfig** – CA configuration.
3795 3795
     - **NodeCertExpiry** – Automatic expiry for nodes certificates.
3796
+    - **ExternalCA** - Configuration for forwarding signing requests to an external
3797
+      certificate authority.
3798
+        - **Protocol** - Protocol for communication with the external CA
3799
+          (currently only "cfssl" is supported).
3800
+        - **URL** - URL where certificate signing requests should be sent.
3801
+        - **Options** - An object with key/value pairs that are interpreted
3802
+          as protocol-specific options for the external CA driver.
3796 3803
 
3797 3804
 ## 3.8 Services
3798 3805
 
... ...
@@ -17,6 +17,7 @@ parent = "smn_cli"
17 17
 
18 18
 	Options:
19 19
 	      --auto-accept value   Acceptance policy (default [worker,manager])
20
+	      --external-ca value   Specifications of one or more certificate signing endpoints
20 21
 	      --force-new-cluster   Force create a new cluster from current state.
21 22
 	      --help                Print usage
22 23
 	      --listen-addr value   Listen address (default 0.0.0.0:2377)
... ...
@@ -34,7 +35,7 @@ ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER
34 34
 1ujecd0j9n3ro9i6628smdmth *  manager1  Accepted    Ready   Active        Reachable               Yes
35 35
 ```
36 36
 
37
-###	--auto-accept value
37
+### `--auto-accept value`
38 38
 
39 39
 This flag controls node acceptance into the cluster. By default, both `worker` and `manager`
40 40
 nodes are auto accepted by the cluster. This can be changed by specifing what kinds of nodes
... ...
@@ -49,6 +50,13 @@ $ docker swarm init --listen-addr 192.168.99.121:2377 --auto-accept worker
49 49
 Swarm initialized: current node (1m8cdsylxbf3lk8qriqt07hx1) is now a manager.
50 50
 ```
51 51
 
52
+### `--external-ca value`
53
+
54
+This flag sets up the swarm to use an external CA to issue node certificates. The value takes
55
+the form `protocol=X,url=Y`. The value for `protocol` specifies what protocol should be used
56
+to send signing requests to the external CA. Currently, the only supported value is `cfssl`.
57
+The URL specifies the endpoint where signing requests should be submitted.
58
+
52 59
 ### `--force-new-cluster`
53 60
 
54 61
 This flag forces an existing node that was part of a quorum that was lost to restart as a single node Manager without losing its data
... ...
@@ -17,6 +17,7 @@ parent = "smn_cli"
17 17
 
18 18
     Options:
19 19
           --auto-accept value               Auto acceptance policy (worker, manager or none)
20
+          --external-ca value               Specifications of one or more certificate signing endpoints
20 21
           --dispatcher-heartbeat duration   Dispatcher heartbeat period (default 5s)
21 22
           --help                            Print usage
22 23
           --secret string                   Set secret value needed to accept nodes into cluster