From e52b8611ea8dd746e35df6cf1248272faed4edfd Mon Sep 17 00:00:00 2001 From: Gyuho Lee Date: Tue, 28 Aug 2018 20:54:35 -0700 Subject: [PATCH] docs: update links to "go.etcd.io" Signed-off-by: Gyuho Lee --- docs/client-architecture.rst | 8 ++++---- docs/client-feature-matrix.rst | 28 ++++++++++++++-------------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/client-architecture.rst b/docs/client-architecture.rst index ca3589a91..5fb785a82 100644 --- a/docs/client-architecture.rst +++ b/docs/client-architecture.rst @@ -40,9 +40,9 @@ Client Requirements *Correctness*. Requests may fail in the presence of server faults. However, it never violates consistency guarantees: global ordering properties, never write corrupted data, at-most once semantics for mutable operations, watch never observes partial events, and so on. -*Liveness*. Servers may fail or disconnect briefly. Clients should make progress in either way. Clients should `never deadlock `_ waiting for a server to come back from offline, unless configured to do so. Ideally, clients detect unavailable servers with HTTP/2 ping and failover to other nodes with clear error messages. +*Liveness*. Servers may fail or disconnect briefly. Clients should make progress in either way. Clients should `never deadlock `_ waiting for a server to come back from offline, unless configured to do so. Ideally, clients detect unavailable servers with HTTP/2 ping and failover to other nodes with clear error messages. -*Effectiveness*. Clients should operate effectively with minimum resources: previous TCP connections should be `gracefully closed `_ after endpoint switch. Failover mechanism should effectively predict the next replica to connect, without wastefully retrying on failed nodes. +*Effectiveness*. Clients should operate effectively with minimum resources: previous TCP connections should be `gracefully closed `_ after endpoint switch. Failover mechanism should effectively predict the next replica to connect, without wastefully retrying on failed nodes. *Portability*. Official client should be clearly documented and its implementation be applicable to other language bindings. Error handling between different language bindings should be consistent. Since etcd is fully committed to gRPC, implementation should be closely aligned with gRPC long-term design goals (e.g. pluggable retry policy should be compatible with `gRPC retry `_). Upgrades between two client versions should be non-disruptive. @@ -110,7 +110,7 @@ Stream RPCs, such as Watch and KeepAlive, are often requested with no timeouts. clientv3-grpc1.7: Balancer Limitation ------------------------------------- -``clientv3-grpc1.7`` balancer sends HTTP/2 keepalives to detect disconnects from streaming requests. It is a simple gRPC server ping mechanism and does not reason about cluster membership, thus unable to detect network partitions. Since partitioned gRPC server can still respond to client pings, balancer may get stuck with a partitioned node. Ideally, keepalive ping detects partition and triggers endpoint switch, before request time-out (see `issue#8673 `_ and *Figure 7*). +``clientv3-grpc1.7`` balancer sends HTTP/2 keepalives to detect disconnects from streaming requests. It is a simple gRPC server ping mechanism and does not reason about cluster membership, thus unable to detect network partitions. Since partitioned gRPC server can still respond to client pings, balancer may get stuck with a partitioned node. Ideally, keepalive ping detects partition and triggers endpoint switch, before request time-out (see `issue#8673 `_ and *Figure 7*). .. image:: img/client-architecture-balancer-figure-07.png :align: center @@ -146,6 +146,6 @@ clientv3-grpc1.14: Balancer Limitation Improvements can be made by caching the status of each endpoint. For instance, balancer can ping each server in advance to maintain a list of healthy candidates, and use this information when doing round-robin. Or when disconnected, balancer can prioritize healthy endpoints. This may complicate the balancer implementation, thus can be addressed in later versions. -Client-side keepalive ping still does not reason about network partitions. Streaming request may get stuck with a partitioned node. Advanced health checking service need to be implemented to understand the cluster membership (see `issue#8673 `_ for more detail). +Client-side keepalive ping still does not reason about network partitions. Streaming request may get stuck with a partitioned node. Advanced health checking service need to be implemented to understand the cluster membership (see `issue#8673 `_ for more detail). Currently, retry logic is handled manually as an interceptor. This may be simplified via `official gRPC retries `_. diff --git a/docs/client-feature-matrix.rst b/docs/client-feature-matrix.rst index d990d18cc..ae47bccbf 100644 --- a/docs/client-feature-matrix.rst +++ b/docs/client-feature-matrix.rst @@ -39,7 +39,7 @@ Features +----------------------------------------+-------------------------+-------------------+ -`KV `_ +`KV `_ ============================================================ +---------------+-------------------------+-------------------+ @@ -59,7 +59,7 @@ Features +---------------+-------------------------+-------------------+ -`Lease `_ +`Lease `_ ================================================================== +-------------------+-------------------------+-------------------+ @@ -79,7 +79,7 @@ Features +-------------------+-------------------------+-------------------+ -`Watcher `_ +`Watcher `_ ====================================================================== +---------------------+-------------------------+-------------------+ @@ -91,7 +91,7 @@ Features +---------------------+-------------------------+-------------------+ -`Cluster `_ +`Cluster `_ ====================================================================== +------------------+-------------------------+-------------------+ @@ -107,7 +107,7 @@ Features +------------------+-------------------------+-------------------+ -`Maintenance `_ +`Maintenance `_ ============================================================================== +-----------------+-------------------------+-------------------+ @@ -129,7 +129,7 @@ Features +-----------------+-------------------------+-------------------+ -`Auth `_ +`Auth `_ ================================================================ +----------------------------+-------------------------+-------------------+ @@ -167,7 +167,7 @@ Features +----------------------------+-------------------------+-------------------+ -`clientv3util `_ +`clientv3util `_ ================================================================================ +---------------------------+-------------------------+-------------------+ @@ -179,7 +179,7 @@ Features +---------------------------+-------------------------+-------------------+ -`concurrency `_ +`concurrency `_ ============================================================================== +----------------------------------------+-------------------------+-------------------+ @@ -211,7 +211,7 @@ Features +----------------------------------------+-------------------------+-------------------+ -`leasing `_ +`leasing `_ ====================================================================== +---------------------------+-------------------------+-------------------+ @@ -221,7 +221,7 @@ Features +---------------------------+-------------------------+-------------------+ -`mirror `_ +`mirror `_ ====================================================================== +------------------+-------------------------+-------------------+ @@ -233,7 +233,7 @@ Features +------------------+-------------------------+-------------------+ -`namespace `_ +`namespace `_ ========================================================================== +-------------+-------------------------+-------------------+ @@ -247,7 +247,7 @@ Features +-------------+-------------------------+-------------------+ -`naming `_ +`naming `_ ==================================================================== +--------------------+-------------------------+-------------------+ @@ -257,7 +257,7 @@ Features +--------------------+-------------------------+-------------------+ -`ordering `_ +`ordering `_ ======================================================================== +----------+-------------------------+-------------------+ @@ -267,7 +267,7 @@ Features +----------+-------------------------+-------------------+ -`snapshot `_ +`snapshot `_ ======================================================================== +-------------+-------------------------+-------------------+