etcd/Documentation/docs.md

51 lines
1.6 KiB
Markdown
Raw Normal View History

2016-04-22 01:20:07 +03:00
# 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][download_build] etcd.
2016-04-22 01:20:07 +03:00
## Developing with etcd
The easiest way to get started using etcd as a distributed key-value store for your applications is to [set up a local cluster][local_cluster].
2016-04-22 01:20:07 +03:00
- [Setting up local clusters][local_cluster]
- [Interacting with etcd][interacting]
- [API references][api_ref]
2016-04-22 01:20:07 +03:00
## 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][clustering].
2016-04-22 01:20:07 +03:00
2016-04-25 04:25:04 +03:00
- [Setting up clusters][clustering]
- [Configuration][conf]
2016-04-22 01:20:07 +03:00
- Security
- Monitoring
- [Maintenance][maintenance]
2016-04-24 08:40:24 +03:00
- [Disaster recovery][recovery]
2016-04-22 01:20:07 +03:00
- Performance
## Learning
To learn more about the concepts and internals behind etcd, read the following pages:
2016-04-22 01:20:07 +03:00
- Why etcd
- Concepts
- Internals
- [Glossary][glossary]
2016-04-22 01:20:07 +03:00
## Upgrading and compatibility
## Troubleshooting
[api_ref]: dev-guide/api_reference_v3.md
2016-04-25 04:25:04 +03:00
[clustering]: op-guide/clustering.md
[conf]: op-guide/configuration.md
[download_build]: dl_build.md
[glossary]: learning/glossary.md
[interacting]: dev-guide/interacting_v3.md
[local_cluster]: dev-guide/local_cluster.md
2016-04-25 04:25:04 +03:00
[recovery]: op-guide/recovery.md
[maintenance]: op-guide/maintenance.md