Skip to content

Commit

Permalink
Merge pull request #8017 from heyitsanthony/doc-gateway-flags
Browse files Browse the repository at this point in the history
op-guide: document configuration flags for gateway
  • Loading branch information
heyitsanthony committed Jun 1, 2017
2 parents f80be42 + 1cbc7cc commit c578ac4
Showing 1 changed file with 41 additions and 2 deletions.
43 changes: 41 additions & 2 deletions Documentation/op-guide/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ The gateway supports multiple etcd server endpoints and works on a simple round-

Every application that accesses etcd must first have the address of an etcd cluster client endpoint. If multiple applications on the same server access the same etcd cluster, every application still needs to know the advertised client endpoints of the etcd cluster. If the etcd cluster is reconfigured to have different endpoints, every application may also need to update its endpoint list. This wide-scale reconfiguration is both tedious and error prone.

etcd gateway solves this problem by serving as a stable local endpoint. A typical etcd gateway configuration has
each machine running a gateway listening on a local address and every etcd application connecting to its local gateway. The upshot is only the gateway needs to update its endpoints instead of updating each and every application.
etcd gateway solves this problem by serving as a stable local endpoint. A typical etcd gateway configuration has each machine running a gateway listening on a local address and every etcd application connecting to its local gateway. The upshot is only the gateway needs to update its endpoints instead of updating each and every application.

In summary, to automatically propagate cluster endpoint changes, the etcd gateway runs on every machine serving multiple applications accessing the same etcd cluster.

Expand Down Expand Up @@ -64,3 +63,43 @@ Start the etcd gateway to fetch the endpoints from the DNS SRV entries with the
$ etcd gateway --discovery-srv=example.com
2016-08-16 11:21:18.867350 I | tcpproxy: ready to proxy client requests to [...]
```

## Configuration flags

### etcd cluster

#### --endpoints

* Comma-separated list of etcd server targets for forwarding client connections.
* Default: `127.0.0.1:2379`
* Invalid example: `https://127.0.0.1:2379` (gateway does not terminate TLS)

#### --discovery-srv

* DNS domain used to bootstrap cluster endpoints through SRV recrods.
* Default: (not set)

### Network

#### --listen-addr

* Interface and port to bind for accepting client requests.
* Default: `127.0.0.1:23790`

#### --retry-delay

* Duration of delay before retrying to connect to failed endpoints.
* Default: 1m0s
* Invalid example: "123" (expects time unit in format)

### Security

#### --insecure-discovery

* Accept SRV records that are insecure or susceptible to man-in-the-middle attacks.
* Default: `false`

#### --trusted-ca-file

* Path to the client TLS CA file for the etcd cluster. Used to authenticate endpoints.
* Default: (not set)

0 comments on commit c578ac4

Please sign in to comment.