From 1fbaf9dbb7f6e3da413feb72ce18d3331e7e5df1 Mon Sep 17 00:00:00 2001 From: Jonathan Yu Date: Tue, 24 Feb 2015 16:24:34 -0500 Subject: [PATCH 1/2] Documentation: fix discovery flag for proxy docs It seems that the -discovery flag used to be -discovery-url. Updated this to use the currently documented and supported -discovery flag. --- Documentation/proxy.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/proxy.md b/Documentation/proxy.md index 838e7db9f..4b7f92bed 100644 --- a/Documentation/proxy.md +++ b/Documentation/proxy.md @@ -5,11 +5,11 @@ etcd can now run as a transparent proxy. Running etcd as a proxy allows for easi etcd currently supports two proxy modes: `readwrite` and `readonly`. The default mode is `readwrite`, which forwards both read and write requests to the etcd cluster. A `readonly` etcd proxy only forwards read requests to the etcd cluster, and returns `HTTP 501` to all write requests. ### Using an etcd proxy -To start etcd in proxy mode, you need to provide three flags: `proxy`, `listen-client-urls`, and `initial-cluster` (or `discovery-url`). +To start etcd in proxy mode, you need to provide three flags: `proxy`, `listen-client-urls`, and `initial-cluster` (or `discovery`). To start a readwrite proxy, set `-proxy on`; To start a readonly proxy, set `-proxy readonly`. -The proxy will be listening on `listen-client-urls` and forward requests to the etcd cluster discovered from in `initial-cluster` or `discovery url`. +The proxy will be listening on `listen-client-urls` and forward requests to the etcd cluster discovered from in `initial-cluster` or `discovery` url. #### Start an etcd proxy with a static configuration To start a proxy that will connect to a statically defined etcd cluster, specify the `initial-cluster` flag: @@ -18,9 +18,9 @@ etcd -proxy on -listen-client-urls 127.0.0.1:8080 -initial-cluster infra0=http:/ ``` #### Start an etcd proxy with the discovery service -If you bootstrap an etcd cluster using the [discovery service][discovery-service], you can also start the proxy with the same `discovery-url`. +If you bootstrap an etcd cluster using the [discovery service][discovery-service], you can also start the proxy with the same `discovery`. -To start a proxy using the discovery service, specify the `discovery-url` flag. The proxy will wait until the etcd cluster defined at the `discovery-url` finishes bootstrapping, and then start to forward the requests. +To start a proxy using the discovery service, specify the `discovery` flag. The proxy will wait until the etcd cluster defined at the `discovery` url finishes bootstrapping, and then start to forward the requests. ``` etcd -proxy on -listen-client-urls 127.0.0.1:8080 -discovery https://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573de From 31bfffaa48c05bee70f7f886a668c7d5e73cc161 Mon Sep 17 00:00:00 2001 From: Jonathan Yu Date: Tue, 24 Feb 2015 16:26:27 -0500 Subject: [PATCH 2/2] Documentation: standardize on url over URL url and URL both appear in this doc. Choose url due to higher frequency --- Documentation/proxy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/proxy.md b/Documentation/proxy.md index 4b7f92bed..ab9c8a1b5 100644 --- a/Documentation/proxy.md +++ b/Documentation/proxy.md @@ -27,6 +27,6 @@ etcd -proxy on -listen-client-urls 127.0.0.1:8080 -discovery https://discovery. ``` #### Fallback to proxy mode with discovery service -If you bootstrap a etcd cluster using [discovery service][discovery-service] with more than the expected number of etcd members, the extra etcd processes will fall back to being `readwrite` proxies by default. They will forward the requests to the cluster as described above. For example, if you create a discovery url with `size=5`, and start ten etcd processes using that same discovery URL, the result will be a cluster with five etcd members and five proxies. Note that this behaviour can be disabled with the `proxy-fallback` flag. +If you bootstrap a etcd cluster using [discovery service][discovery-service] with more than the expected number of etcd members, the extra etcd processes will fall back to being `readwrite` proxies by default. They will forward the requests to the cluster as described above. For example, if you create a discovery url with `size=5`, and start ten etcd processes using that same discovery url, the result will be a cluster with five etcd members and five proxies. Note that this behaviour can be disabled with the `proxy-fallback` flag. [discovery-service]: https://github.com/coreos/etcd/blob/master/Documentation/clustering.md#discovery