History

Anthony Romano 64840adf70 Merge pull request #8135 from radhikapc/local-cluster dev-guide: clarify concepts in local_cluster doc		2017-07-07 09:56:31 -07:00
..
benchmarks	Docs: replace absolute links with relative ones.	2017-04-04 15:21:42 -07:00
dev-guide	Merge pull request #8135 from radhikapc/local-cluster	2017-07-07 09:56:31 -07:00
dev-internal	Documentation/release: sign *.aci files	2017-06-20 14:18:19 -07:00
learning	Documentation/learning/why: Update link to CockroachDB	2017-07-07 18:01:12 +02:00
op-guide	Documentation: cleanup and fix some typo	2017-06-30 20:41:25 -04:00
platforms	Documentation: add systemd, Container Linux guide	2017-05-23 11:27:27 -07:00
rfc	*: rename storage package to mvcc	2016-04-25 15:25:51 -07:00
upgrades	Documentation/upgrades: link to previous guides	2017-06-09 12:33:39 -07:00
v2	Documentation: cleanup and fix some typo	2017-06-30 20:41:25 -04:00
README.md	documentation: display docs.md in github browser	2017-01-11 10:37:42 -08:00
branch_management.md	Documentation: conform to header style	2016-06-27 12:00:24 -07:00
demo.md	Documentation/demo: add member, auth example	2016-06-23 11:50:37 -07:00
dl_build.md	Documentation: removed an extra step for testing etcd	2017-06-15 14:39:10 -07:00
docs.md	Documentation: add systemd, Container Linux guide	2017-05-23 11:27:27 -07:00
faq.md	Documentation/faq: fix typo in flag names	2017-06-27 16:04:03 -04:00
integrations.md	doc: python-etcd3 is pretty stable now	2017-06-06 15:45:38 +01:00
metrics.md	op-guide: update gRPC requests metrics	2016-11-14 15:20:16 -08:00
production-users.md	doc: modify usecase	2017-05-23 14:57:10 -04:00
reporting_bugs.md	Documentation/v3: fix broken links	2017-05-03 16:57:38 -07:00
tuning.md	Documentation: suggest ionice for disk tuning	2017-03-02 13:58:07 -08:00

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.

Getting started

New etcd users and developers should get started by downloading and building etcd. After getting etcd, follow this quick demo to see the basics of creating and working with an etcd cluster.

Developing with etcd

The easiest way to get started using etcd as a distributed key-value store is to set up a local cluster.

Setting up local clusters
Interacting with etcd
gRPC etcd core and etcd concurrency API references
HTTP JSON API through the gRPC gateway
gRPC naming and discovery
Client and proxy namespacing
Embedding etcd
Experimental features and APIs
System limits

Operating etcd clusters

Administrators who need to create reliable and scalable key-value stores for the developers they support should begin with a cluster on multiple machines.

Platform guides

Upgrading and compatibility

Learning

To learn more about the concepts and internals behind etcd, read the following pages:

Frequently Asked Questions (FAQ)

Answers to common questions about etcd.