Patroni
Version v3.3 of the documentation is no longer actively maintained. The page that you are viewing is the last archived version. For the latest stable documentation, see v3.5.
gRPC proxy
The gRPC proxy is a stateless etcd reverse proxy operating at the gRPC layer (L7). The proxy is designed to reduce the total processing load on the core etcd cluster. For horizontal scalability, it coalesces watch and lease API requests. To protect the cluster against abusive clients, it caches key range requests.
The gRPC proxy supports multiple etcd server endpoints. When the proxy starts, it randomly picks one etcd server endpoint to use. This endpoint serves all requests until the proxy detects an endpoint failure. If the gRPC proxy detects an endpoint failure, it switches to a different endpoint, if available, to hide failures from its clients. Other retry policies, such as weighted round-robin, may be supported in the future.
Scalable watch API
The gRPC proxy coalesces multiple client watchers (c-watchers) on the same key or range into a single watcher (s-watcher) connected to an etcd server. The proxy broadcasts all events from the s-watcher to its c-watchers.
Assuming N clients watch the same key, one gRPC proxy can reduce the watch load on the etcd server from N to 1. Users can deploy multiple gRPC proxies to further distribute server load.
In the following example, three clients watch on key A. The gRPC proxy coalesces the three watchers, creating a single watcher attached to the etcd server.
+-------------+
| etcd server |
+------+------+
^ watch key A (s-watcher)
|
+-------+-----+
| gRPC proxy | <-------+
| | |
++-----+------+ |watch key A (c-watcher)
watch key A ^ ^ watch key A |
(c-watcher) | | (c-watcher) |
+-------+-+ ++--------+ +----+----+
| client | | client | | client |
| | | | | |
+---------+ +---------+ +---------+
Limitations
To effectively coalesce multiple client watchers into a single watcher, the gRPC proxy coalesces new c-watchers into an existing s-watcher when possible. This coalesced s-watcher may be out of sync with the etcd server due to network delays or buffered undelivered events. When the watch revision is unspecified, the gRPC proxy will not guarantee the c-watcher will start watching from the most recent store revision. For example, if a client watches from an etcd server with revision 1000, that watcher will begin at revision 1000. If a client watches from the gRPC proxy, may begin watching from revision 990.
Similar limitations apply to cancellation. When the watcher is cancelled, the etcd server’s revision may be greater than the cancellation response revision.
These two limitations should not cause problems for most use cases. In the future, there may be additional options to force the watcher to bypass the gRPC proxy for more accurate revision responses.
Scalable lease API
To keep its leases alive, a client must establish at least one gRPC stream to an etcd server for sending periodic heartbeats. If an etcd workload involves heavy lease activity spread over many clients, these streams may contribute to excessive CPU utilization. To reduce the total number of streams on the core cluster, the proxy supports lease stream coalescing.
Assuming N clients are updating leases, a single gRPC proxy reduces the stream load on the etcd server from N to 1. Deployments may have additional gRPC proxies to further distribute streams across multiple proxies.
In the following example, three clients update three independent leases (L1, L2, and L3). The gRPC proxy coalesces the three client lease streams (c-streams) into a single lease keep alive stream (s-stream) attached to an etcd server. The proxy forwards client-side lease heartbeats from the c-streams to the s-stream, then returns the responses to the corresponding c-streams.
+-------------+
| etcd server |
+------+------+
^
| heartbeat L1, L2, L3
| (s-stream)
v
+-------+-----+
| gRPC proxy +<-----------+
+---+------+--+ | heartbeat L3
^ ^ | (c-stream)
heartbeat L1 | | heartbeat L2 |
(c-stream) v v (c-stream) v
+------+-+ +-+------+ +-----+--+
| client | | client | | client |
+--------+ +--------+ +--------+
Abusive clients protection
The gRPC proxy caches responses for requests when it does not break consistency requirements. This can protect the etcd server from abusive clients in tight for loops.
Start etcd gRPC proxy
Consider an etcd cluster with the following static endpoints:
| Name | Address | Hostname |
|---|---|---|
infra0 |
10.0.1.10 |
infra0.example.com |
infra1 |
10.0.1.11 |
infra1.example.com |
infra2 |
10.0.1.12 |
infra2.example.com |
Start the etcd gRPC proxy to use these static endpoints with the command:
$ etcd grpc-proxy start --endpoints=infra0.example.com,infra1.example.com,infra2.example.com --listen-addr=127.0.0.1:2379
The etcd gRPC proxy starts and listens on port 2379. It forwards client requests to one of the three endpoints provided above.
Sending requests through the proxy:
$ ETCDCTL_API=3 etcdctl --endpoints=127.0.0.1:2379 put foo bar OK $ ETCDCTL_API=3 etcdctl --endpoints=127.0.0.1:2379 get foo foo bar
Client endpoint synchronization and name resolution
The proxy supports registering its endpoints for discovery by writing to a user-defined endpoint. This serves two purposes. First, it allows clients to synchronize their endpoints against a set of proxy endpoints for high availability. Second, it is an endpoint provider for etcd gRPC naming.
Register proxy(s) by providing a user-defined prefix:
$ etcd grpc-proxy start --endpoints=localhost:2379 \ --listen-addr=127.0.0.1:23790 \ --advertise-client-url=127.0.0.1:23790 \ --resolver-prefix="___grpc_proxy_endpoint" \ --resolver-ttl=60 $ etcd grpc-proxy start --endpoints=localhost:2379 \ --listen-addr=127.0.0.1:23791 \ --advertise-client-url=127.0.0.1:23791 \ --resolver-prefix="___grpc_proxy_endpoint" \ --resolver-ttl=60
The proxy will list all its members for member list:
ETCDCTL_API=3 etcdctl --endpoints=\http://localhost:23790 member list --write-out table +----+---------+--------------------------------+------------+-----------------+ | ID | STATUS | NAME | PEER ADDRS | CLIENT ADDRS | +----+---------+--------------------------------+------------+-----------------+ | 0 | started | Gyu-Hos-MBP.sfo.coreos.systems | | 127.0.0.1:23791 | | 0 | started | Gyu-Hos-MBP.sfo.coreos.systems | | 127.0.0.1:23790 | +----+---------+--------------------------------+------------+-----------------+
This lets clients automatically discover proxy endpoints through Sync:
cli, err := clientv3.New(clientv3.Config{
Endpoints: []string{"\http://localhost:23790"},
})
if err != nil {
log.Fatal(err)
}
defer cli.Close()
// fetch registered grpc-proxy endpoints
if err := cli.Sync(context.Background()); err != nil {
log.Fatal(err)
}
Note that if a proxy is configured without a resolver prefix,
$ etcd grpc-proxy start --endpoints=localhost:2379 \ --listen-addr=127.0.0.1:23792 \ --advertise-client-url=127.0.0.1:23792
The member list API to the grpc-proxy returns its own advertise-client-url:
ETCDCTL_API=3 etcdctl --endpoints=\http://localhost:23792 member list --write-out table +----+---------+--------------------------------+------------+-----------------+ | ID | STATUS | NAME | PEER ADDRS | CLIENT ADDRS | +----+---------+--------------------------------+------------+-----------------+ | 0 | started | Gyu-Hos-MBP.sfo.coreos.systems | | 127.0.0.1:23792 | +----+---------+--------------------------------+------------+-----------------+
Namespacing
Suppose an application expects full control over the entire key space, but the etcd cluster is shared with other applications. To let all applications run without interfering with each other, the proxy can partition the etcd keyspace so clients appear to have access to the complete keyspace. When the proxy is given the flag --namespace, all client requests going into the proxy are translated to have a user-defined prefix on the keys. Accesses to the etcd cluster will be under the prefix and responses from the proxy will strip away the prefix; to the client, it appears as if there is no prefix at all.
To namespace a proxy, start it with --namespace:
$ etcd grpc-proxy start --endpoints=localhost:2379 \ --listen-addr=127.0.0.1:23790 \ --namespace=my-prefix/
Accesses to the proxy are now transparently prefixed on the etcd cluster:
$ ETCDCTL_API=3 etcdctl --endpoints=localhost:23790 put my-key abc # OK $ ETCDCTL_API=3 etcdctl --endpoints=localhost:23790 get my-key # my-key # abc $ ETCDCTL_API=3 etcdctl --endpoints=localhost:2379 get my-prefix/my-key # my-prefix/my-key # abc
TLS termination
Terminate TLS from a secure etcd cluster with the gRPC proxy by serving an unencrypted local endpoint.
To try it out, start a single member etcd cluster with client https:
$ etcd --listen-client-urls https://localhost:2379 --advertise-client-urls https://localhost:2379 --cert-file=peer.crt --key-file=peer.key --trusted-ca-file=ca.crt --client-cert-auth
Confirm the client port is serving https:
# fails $ ETCDCTL_API=3 etcdctl --endpoints=\http://localhost:2379 endpoint status # works $ ETCDCTL_API=3 etcdctl --endpoints=https://localhost:2379 --cert=client.crt --key=client.key --cacert=ca.crt endpoint status
Next, start a gRPC proxy on localhost:12379 by connecting to the etcd endpoint https://localhost:2379 using the client certificates:
$ etcd grpc-proxy start --endpoints=https://localhost:2379 --listen-addr localhost:12379 --cert client.crt --key client.key --cacert=ca.crt --insecure-skip-tls-verify &
Finally, test the TLS termination by putting a key into the proxy over http:
$ ETCDCTL_API=3 etcdctl --endpoints=\http://localhost:12379 put abc def # OK
Metrics and Health
The gRPC proxy exposes /health and Prometheus /metrics endpoints for the etcd members defined by --endpoints. An alternative define an additional URL that will respond to both the /metrics and /health endpoints with the --metrics-addr flag.
$ etcd grpc-proxy start \ --endpoints https://localhost:2379 \ --metrics-addr https://0.0.0.0:4443 \ --listen-addr 127.0.0.1:23790 \ --key client.key \ --key-file proxy-server.key \ --cert client.crt \ --cert-file proxy-server.crt \ --cacert ca.pem \ --trusted-ca-file proxy-ca.pem
Known issue
The main interface of the proxy serves both HTTP2 and HTTP/1.1. If proxy is setup with TLS as show in the above example, when using a client such as cURL against the listening interface will require explicitly setting the protocol to HTTP/1.1 on the request to return /metrics or /health. By using the --metrics-addr flag the secondary interface will not have this requirement.
$ curl --cacert proxy-ca.pem --key proxy-client.key --cert proxy-client.crt https://127.0.0.1:23790/metrics --http1.1
Last modified April 9, 2022: Fix typos (a2da31e)