Version 3.3.13 home Download and build Libraries and tools Metrics Branch management Demo Discovery service protocol etcd release guide Frequently Asked Questions (FAQ) Logging conventions Production users Reporting bugs Tuning Benchmarks Benchmarking etcd v2.1.0 Benchmarking etcd v2.2.0 Benchmarking etcd v2.2.0-rc Benchmarking etcd v2.2.0-rc-memory Benchmarking etcd v3 Storage Memory Usage Benchmark Watch Memory Usage Benchmark Developer guide etcd API Reference etcd concurrency API Reference Experimental APIs and features gRPC naming and discovery Interacting with etcd Set up a local cluster System limits Why gRPC gateway etcd v3 API Learning etcd client architecture Client feature matrix Data model etcd v3 authentication design etcd versus other key-value stores etcd3 API Glossary KV API guarantees Learner Operations guide Clustering Guide Configuration flags Design of runtime reconfiguration Disaster recovery etcd gateway Failure modes gRPC proxy Hardware recommendations Maintenance Migrate applications from using API v2 to API v3 Monitoring etcd Performance Role-based access control Run etcd clusters inside containers Runtime reconfiguration Supported systems Transport security model Versioning Platforms Amazon Web Services Container Linux with systemd FreeBSD Upgrading Upgrade etcd from 2.3 to 3.0 Upgrade etcd from 3.0 to 3.1 Upgrade etcd from 3.1 to 3.2 Upgrade etcd from 3.2 to 3.3 Upgrade etcd from 3.3 to 3.4 Upgrade etcd from 3.4 to 3.5 Upgrading etcd clusters and applications

You are viewing documentation for etcd version: v3.3.13

etcd v3.3.13 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest release, v3.4.0, or the current documentation.

This document defines the various terms used in etcd documentation, command line and source code.


The etcd server raises an alarm whenever the cluster needs operator intervention to remain reliable.


Authentication manages user access permissions for etcd resources.


A client connects to the etcd cluster to issue service requests such as fetching key-value pairs, writing data, or watching for updates.


Cluster consists of several members.

The node in each member follows raft consensus protocol to replicate logs. Cluster receives proposals from members, commits them and apply to local store.


Compaction discards all etcd event history and superseded keys prior to a given revision. It is used to reclaim storage space in the etcd backend database.


The etcd cluster holds elections among its members to choose a leader as part of the raft consensus protocol.


A URL pointing to an etcd service or resource.


A user-defined identifier for storing and retrieving user-defined values in etcd.

Key range

A set of keys containing either an individual key, a lexical interval for all x such that a < x <= b, or all keys greater than a given key.


The set of all keys in an etcd cluster.


A short-lived renewable contract that deletes keys associated with it on its expiry.


A logical etcd server that participates in serving an etcd cluster.

Modification Revision

The first revision to hold the last write to a given key.


Peer is another member of the same cluster.


A proposal is a request (for example a write request, a configuration change request) that needs to go through raft protocol.


The number of active members needed for consensus to modify the cluster state. etcd requires a member majority to reach quorum.


A 64-bit cluster-wide counter that is incremented each time the keyspace is modified.


A unit of permissions over a set of key ranges which may be granted to a set of users for access control.


A point-in-time backup of the etcd cluster state.


The physical storage backing the cluster keyspace.


An atomically executed set of operations. All modified keys in a transaction share the same modification revision.

Key Version

The number of writes to a key since it was created, starting at 1. The version of a nonexistent or deleted key is 0.


A client opens a watcher to observe updates on a given key range.