Browse code

Document updates for cluster-store-opt

This updates the docs for the daemon based on the new cluster-store-opt
for TLS support.

Signed-off-by: Daniel Hiltgen <daniel.hiltgen@docker.com>

Daniel Hiltgen authored on 2015/10/10 01:04:34
Showing 2 changed files
... ...
@@ -536,7 +536,7 @@ please check the [run](run.md) reference.
536 536
 
537 537
 `--cluster-advertise` specifies the 'host:port' combination that this particular
538 538
 daemon instance should use when advertising itself to the cluster. The daemon
539
-should be reachable by remote hosts on this 'host:port' combination.
539
+is reached by remote hosts on this 'host:port' combination.
540 540
 
541 541
 The daemon uses [libkv](https://github.com/docker/libkv/) to advertise
542 542
 the node within the cluster.  Some Key/Value backends support mutual
... ...
@@ -545,6 +545,7 @@ using the `--cluster-store-opt` flag, specifying the paths to PEM encoded
545 545
 files. For example:
546 546
 
547 547
 ```bash
548
+docker daemon \
548 549
     --cluster-advertise 192.168.1.2:2376 \
549 550
     --cluster-store etcd://192.168.1.2:2379 \
550 551
     --cluster-store-opt kv.cacertfile=/path/to/ca.pem \
... ...
@@ -552,6 +553,25 @@ files. For example:
552 552
     --cluster-store-opt kv.keyfile=/path/to/key.pem
553 553
 ```
554 554
 
555
+The currently supported cluster store options are:
556
+
557
+*  `kv.cacertfile`
558
+
559
+    Specifies the path to a local file with PEM encoded CA certificates to trust
560
+
561
+*  `kv.certfile`
562
+
563
+    Specifies the path to a local file with a PEM encoded certificate.  This
564
+    certificate is used as the client cert for communication with the
565
+    Key/Value store.
566
+
567
+*  `kv.keyfile`
568
+
569
+    Specifies the path to a local file with a PEM encoded private key.  This
570
+    private key is used as the client key for communication with the
571
+    Key/Value store.
572
+
573
+
555 574
 ## Miscellaneous options
556 575
 
557 576
 IP masquerading uses address translation to allow containers without a public
... ...
@@ -9,6 +9,9 @@ docker-daemon - Enable daemon mode
9 9
 [**--api-cors-header**=[=*API-CORS-HEADER*]]
10 10
 [**-b**|**--bridge**[=*BRIDGE*]]
11 11
 [**--bip**[=*BIP*]]
12
+[**--cluster-store**[=*[]*]]
13
+[**--cluster-advertise**[=*[]*]]
14
+[**--cluster-store-opt**[=*map[]*]]
12 15
 [**-D**|**--debug**[=*false*]]
13 16
 [**--default-gateway**[=*DEFAULT-GATEWAY*]]
14 17
 [**--default-gateway-v6**[=*DEFAULT-GATEWAY-V6*]]
... ...
@@ -74,6 +77,16 @@ format.
74 74
 **--bip**=""
75 75
   Use the provided CIDR notation address for the dynamically created bridge (docker0); Mutually exclusive of \-b
76 76
 
77
+**--cluster-store**=""
78
+  URL of the distributed storage backend
79
+
80
+**--cluster-advertise**=""
81
+  Specifies the 'host:port' combination that this particular daemon instance should use when advertising
82
+  itself to the cluster. The daemon is reached by remote hosts on this 'host:port' combination.
83
+
84
+**--cluster-store-opt**=""
85
+  Specifies options for the Key/Value store.
86
+
77 87
 **-D**, **--debug**=*true*|*false*
78 88
   Enable debug mode. Default is false.
79 89
 
... ...
@@ -422,6 +435,31 @@ this topic, see
422 422
 Otherwise, set this flag for migrating existing Docker daemons to a
423 423
 daemon with a supported environment.
424 424
 
425
+# CLUSTER STORE OPTIONS
426
+
427
+The daemon uses libkv to advertise
428
+the node within the cluster.  Some Key/Value backends support mutual
429
+TLS, and the client TLS settings used by the daemon can be configured
430
+using the **--cluster-store-opt** flag, specifying the paths to PEM encoded
431
+files.
432
+
433
+#### kv.cacertfile
434
+
435
+Specifies the path to a local file with PEM encoded CA certificates to trust
436
+
437
+#### kv.certfile
438
+
439
+Specifies the path to a local file with a PEM encoded certificate.  This
440
+certificate is used as the client cert for communication with the
441
+Key/Value store.
442
+
443
+#### kv.keyfile
444
+
445
+Specifies the path to a local file with a PEM encoded private key.  This
446
+private key is used as the client key for communication with the
447
+Key/Value store.
448
+
449
+
425 450
 # HISTORY
426 451
 Sept 2015, Originally compiled by Shishir Mahajan <shishir.mahajan@redhat.com>
427 452
 based on docker.com source material and internal work.