diff --git a/Documentation/cluster-discovery.md b/Documentation/cluster-discovery.md index 262c8e875..89f0d1a36 100644 --- a/Documentation/cluster-discovery.md +++ b/Documentation/cluster-discovery.md @@ -8,6 +8,7 @@ For more information on how etcd can locate the cluster, see the [finding the cl Please note - at least 3 nodes are required for [cluster availability][optimal-cluster-size]. +[cluster-finding]: https://github.com/coreos/etcd/blob/master/Documentation/design/cluster-finding.md [optimal-cluster-size]: https://github.com/coreos/etcd/blob/master/Documentation/optimal-cluster-size.md ## Using discovery.etcd.io @@ -27,8 +28,8 @@ Here's a full example: ``` TOKEN=$(curl https://discovery.etcd.io/new) ./etcd -name instance1 -peer-addr 10.1.2.3:7001 -addr 10.1.2.3:4001 -discovery $TOKEN -./etcd -name instance2 -peer-addr 10.1.2.4:7002 -addr 10.1.2.4:4002 -discovery $TOKEN -./etcd -name instance3 -peer-addr 10.1.2.5:7002 -addr 10.1.2.5:4002 -discovery $TOKEN +./etcd -name instance2 -peer-addr 10.1.2.4:7001 -addr 10.1.2.4:4001 -discovery $TOKEN +./etcd -name instance3 -peer-addr 10.1.2.5:7001 -addr 10.1.2.5:4001 -discovery $TOKEN ``` ## Running Your Own Discovery Endpoint @@ -38,8 +39,8 @@ The discovery API communicates with a separate etcd cluster to store and retriev ``` TOKEN="testcluster" ./etcd -name instance1 -peer-addr 10.1.2.3:7001 -addr 10.1.2.3:4001 -discovery http://10.10.10.10:4001/v2/keys/$TOKEN -./etcd -name instance2 -peer-addr 10.1.2.4:7002 -addr 10.1.2.4:4002 -discovery http://10.10.10.10:4001/v2/keys/$TOKEN -./etcd -name instance3 -peer-addr 10.1.2.5:7002 -addr 10.1.2.5:4002 -discovery http://10.10.10.10:4001/v2/keys/$TOKEN +./etcd -name instance2 -peer-addr 10.1.2.4:7001 -addr 10.1.2.4:4001 -discovery http://10.10.10.10:4001/v2/keys/$TOKEN +./etcd -name instance3 -peer-addr 10.1.2.5:7001 -addr 10.1.2.5:4001 -discovery http://10.10.10.10:4001/v2/keys/$TOKEN ``` If you're interested in how to discovery API works behind the scenes, read about the [Discovery Protocol](https://github.com/coreos/etcd/blob/master/Documentation/discovery-protocol.md). @@ -52,8 +53,6 @@ The Discovery API submits the `-peer-addr` of each etcd instance to the configur The discovery API will automatically clean up the address of a stale peer that is no longer part of the cluster. The TTL for this process is a week, which should be long enough to handle any extremely long outage you may encounter. There is no harm in having stale peers in the list until they are cleaned up, since an etcd instance only needs to connect to one valid peer in the cluster to join. -[discovery-design]: https://github.com/coreos/etcd/blob/master/Documentation/design/cluster-finding.md - ## Lifetime of a Discovery URL A discovery URL identifies a single etcd cluster. Do not re-use discovery URLs for new clusters.