etcd/Documentation
Iwasaki Yudai 6b775cd786 *: Add dbSizeInUse to StatusResposne
Existing dbSize shows physically allocated DB size and the backend
(boltdb) won't shrink it after a compaction until a user runs the defrag command.
The new dbSizeInUse shows the DB size that excludes free pages created
by compactions so that users can see the actual DB usage. dbSize >=
dbSizeInUse is always true.
Note that dbSizeInUse shows a page-based size and not byte level usage.
2018-02-01 12:15:23 -08:00
..
benchmarks Docs: replace absolute links with relative ones. 2017-04-04 15:21:42 -07:00
dev-guide *: Add dbSizeInUse to StatusResposne 2018-02-01 12:15:23 -08:00
dev-internal Documentation/dev-internal: remove ACI in release.md 2017-12-20 15:36:50 -08:00
learning Documentation/learning: Fix a typo 2018-01-20 00:15:38 +08:00
op-guide *: Add dbSizeInUse to StatusResposne 2018-02-01 12:15:23 -08:00
platforms docs: remove link-breaking space 2017-09-19 15:54:16 -07:00
rfc *: rename storage package to mvcc 2016-04-25 15:25:51 -07:00
upgrades Documentation/upgrades: highlight "health", remove "errors" field 2018-01-17 15:58:53 -08:00
v2 Documentation: drop fleet from integration lists 2018-01-25 12:08:46 -08:00
README.md documentation: display docs.md in github browser 2017-01-11 10:37:42 -08:00
branch_management.md Documentation: Add release manager table 2017-11-27 15:43:35 -08:00
demo.md Documentation/demo: add member, auth example 2016-06-23 11:50:37 -07:00
dl_build.md Documentation/dl_build: remove "./cmd/etcd" 2018-01-24 15:26:17 -08:00
docs.md docs: adding an index for upgrade pages. 2017-07-25 10:53:02 -07:00
faq.md Documentation: add TCP RST flag on stream close 2018-01-18 12:20:21 -08:00
integrations.md Documentation: drop fleet from integration lists 2018-01-25 12:08:46 -08:00
metrics.md op-guide: update gRPC requests metrics 2016-11-14 15:20:16 -08:00
production-users.md Documentation: Update to include Huawei (renamed Canal) 2017-08-16 15:42:03 -07: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.

Operating etcd clusters

Administrators who need a fault-tolerant etcd cluster for either development or production should begin with a cluster on multiple machines.

Setting up etcd

System configuration

Platform guides

Security

Maintenance and troubleshooting

Learning

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