README.md

Documentation

etcd is a distributed key-value store designed to reliably and quickly preserve and provide access to critical data. It enables reliable distributed coordination through distributed locking, leader elections, and write barriers. An etcd cluster is intended for high availability and permanent data storage and retrieval.

This is the etcd v2 documentation set. For more recent versions, please see the etcd v3 guides.

Communicating with etcd v2

Reading and writing into the etcd keyspace is done via a simple, RESTful HTTP API, or using language-specific libraries that wrap the HTTP API with higher level primitives.

Reading and Writing

• Client API Documentation
• Libraries, Tools, and Language Bindings
• Admin API Documentation
• Members API

Security, Auth, Access control

• Security Model
• Auth and Security
• Authentication Guide

etcd v2 Cluster Administration

Configuration values are distributed within the cluster for your applications to read. Values can be changed programmatically and smart applications can reconfigure automatically. You'll never again have to run a configuration management tool on every machine in order to change a single config value.

General Info

• etcd Proxies
• Production Users
• Admin Guide
• Configuration Flags
• Frequently Asked Questions

Initial Setup

• Tuning etcd Clusters
• Discovery Service Protocol
• Running etcd under Docker

Live Reconfiguration

• Runtime Configuration

Debugging etcd

• Metrics Collection
• Error Code
• Reporting Bugs

Migration

• Upgrade etcd to 2.3
• Upgrade etcd to 2.2
• Upgrade to etcd 2.1
• Snapshot Migration (0.4.x to 2.x)
• Backward Compatibility