etcd/Documentation/clients-matrix.md

2.6 KiB

Client libraries support matrix for etcd

As etcd features support is really uneven between client libraries, a compatibility matrix can be important. We will consider in detail only the features of clients supporting the v2 API. Clients still supporting the v1 API only are listed below.

v1-only clients

Clients supporting only the API version 1

v2 clients

The v2 API has a lot of features, we will categorize them in a few categories:

  • HTTPS Auth: Support for SSL-certificate based authentication
  • Reconnect: If the client is able to reconnect automatically to another server if one fails.
  • Mod/Lock: Support for the locking module
  • Mod/Leader: Support for the leader election module
  • GET,PUT,POST,DEL Features: Support for all the modifiers when calling the etcd server with said HTTP method.

Supported features matrix

Client go-etcd jetcd python-etcd python-etcd-client node-etcd nodejs-etcd etcd-ruby etcd-api cetcd clj-etcd etcetera
HTTPS Auth Y Y Y Y Y Y - - - - -
Reconnect Y - Y Y - - - Y - - -
Mod/Lock Y - Y Y - - - - - - -
Mod/Leader Y - - Y - - - - - - -
GET Features F B F F F F F B F G F
PUT Features F B F F F F F G F G F
POST Features F - F F - F F - - - F
DEL Features F B F F F F F B G B F

Legend

F: Full support G: Good support B: Basic support Y: Feature supported -: Feature not supported