README.md
1# Documentation
2
3etcd 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.
4
5This is the etcd v2 documentation set. For more recent versions, please see the [etcd v3 guides][etcd-v3].
6
7## Communicating with etcd v2
8
9Reading 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.
10
11### Reading and Writing
12
13 - [Client API Documentation][api]
14 - [Libraries, Tools, and Language Bindings][libraries]
15 - [Admin API Documentation][admin-api]
16 - [Members API][members-api]
17
18### Security, Auth, Access control
19
20 - [Security Model][security]
21 - [Auth and Security][auth_api]
22 - [Authentication Guide][authentication]
23
24## etcd v2 Cluster Administration
25
26Configuration 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.
27
28### General Info
29
30 - [etcd Proxies][proxy]
31 - [Production Users][production-users]
32 - [Admin Guide][admin_guide]
33 - [Configuration Flags][configuration]
34 - [Frequently Asked Questions][faq]
35
36### Initial Setup
37
38 - [Tuning etcd Clusters][tuning]
39 - [Discovery Service Protocol][discovery_protocol]
40 - [Running etcd under Docker][docker_guide]
41
42### Live Reconfiguration
43
44 - [Runtime Configuration][runtime-configuration]
45
46### Debugging etcd
47
48 - [Metrics Collection][metrics]
49 - [Error Code][errorcode]
50 - [Reporting Bugs][reporting_bugs]
51
52### Migration
53
54 - [Upgrade etcd to 2.3][upgrade_2_3]
55 - [Upgrade etcd to 2.2][upgrade_2_2]
56 - [Upgrade to etcd 2.1][upgrade_2_1]
57 - [Snapshot Migration (0.4.x to 2.x)][04_to_2_snapshot_migration]
58 - [Backward Compatibility][backward_compatibility]
59
60
61[etcd-v3]: ../docs.md
62[api]: api.md
63[libraries]: libraries-and-tools.md
64[admin-api]: other_apis.md
65[members-api]: members_api.md
66[security]: security.md
67[auth_api]: auth_api.md
68[authentication]: authentication.md
69[proxy]: proxy.md
70[production-users]: production-users.md
71[admin_guide]: admin_guide.md
72[configuration]: configuration.md
73[faq]: faq.md
74[tuning]: tuning.md
75[discovery_protocol]: discovery_protocol.md
76[docker_guide]: docker_guide.md
77[runtime-configuration]: runtime-configuration.md
78[metrics]: metrics.md
79[errorcode]: errorcode.md
80[reporting_bugs]: reporting_bugs.md
81[upgrade_2_3]: upgrade_2_3.md
82[upgrade_2_2]: upgrade_2_2.md
83[upgrade_2_1]: upgrade_2_1.md
84[04_to_2_snapshot_migration]: 04_to_2_snapshot_migration.md
85[backward_compatibility]: backward_compatibility.md
86