# 官方文档

> 注：内容翻译自 <https://github.com/coreos/etcd/blob/master/Documentation>

etcd 是一个分布式键值对存储，设计用来可靠而快速的保存关键数据并提供访问。通过分布式锁，leader选举和写屏障(write barriers)来实现可靠的分布式协作。etcd集群是为高可用，持久性数据存储和检索而准备。

## 开始

现在 etcd 的用户和开发者可以从 [下载并构建](https://github.com/coreos/etcd/blob/master/Documentation/dl_build.md) etcd开始。在获取etcd之后，参照 [quick demo](https://github.com/coreos/etcd/blob/master/Documentation/demo.md) 来感受构建和操作etcd集群的基本方式。

## 使用 etcd 开发

开始使用 etcd 作为分布式键值存储的最简单的方式是 [搭建本地集群](https://doczhcn.gitbook.io/ETCD/index/index/local_cluster)

* [搭建本地集群](https://doczhcn.gitbook.io/ETCD/index/index/local_cluster)
* [和 etcd 交互](https://doczhcn.gitbook.io/ETCD/index/index/interacting_v3)
* gRPC [etcd core](https://doczhcn.gitbook.io/ETCD/index/index/api_reference_v3) 和 [etcd concurrency](https://doczhcn.gitbook.io/ETCD/index/index/api_concurrency_reference_v3) API 参考文档
* [经由 gRPC 网关的HTTP JSON API](https://doczhcn.gitbook.io/ETCD/index/index/api_grpc_gateway)
* [gRPC 命名和发现](https://doczhcn.gitbook.io/ETCD/index/index/grpc_naming)
* [客户端](https://github.com/doczhcn/etcd/tree/7b0933e2f73373e907e67fabb9f04c50c0e48181/documentation/clientv3/namespace/README.md) 和 [代理](https://doczhcn.gitbook.io/ETCD/index-1/grpc_proxy#namespacing) 命名空间
* [内嵌的etcd](https://godoc.org/github.com/coreos/etcd/embed)
* [试验性的特性和 API](https://doczhcn.gitbook.io/ETCD/index/index/experimental_apis)
* [系统限制](https://github.com/doczhcn/etcd/tree/7b0933e2f73373e907e67fabb9f04c50c0e48181/documentation/dev-guide/dev-guide/limit.md)

## 操作 etcd 集群

管理员，需要为支持的开发人员创建可靠而可扩展的键值存储，应该从 [多机集群](https://doczhcn.gitbook.io/ETCD/index/index-1/clustering) 开始.

### 搭建 etcd

* [配置](https://doczhcn.gitbook.io/ETCD/index/index-1/configuration)
* [多成员集群](https://doczhcn.gitbook.io/ETCD/index/index-1/clustering)
* [在容器内运行etcd集群](https://doczhcn.gitbook.io/ETCD/index/index-1/container)
* [gRPC代理(TBD)](https://doczhcn.gitbook.io/ETCD/index/index-1/grpc_proxy)
* [L4 网关](https://doczhcn.gitbook.io/ETCD/broken-reference)

### 系统配置

* [支持平台](https://doczhcn.gitbook.io/ETCD/index/index-1/supported-platform)
* [硬件推荐(TBD)](https://doczhcn.gitbook.io/ETCD/index/index-1/hardware)
* [性能评测](https://doczhcn.gitbook.io/ETCD/index/index-1/performance)
* [调优(TBD)](https://github.com/doczhcn/etcd/tree/7b0933e2f73373e907e67fabb9f04c50c0e48181/tuning.md)

### 平台指南

> 注：暂时未翻译这部分内容

* [Amazon Web Services](https://github.com/coreos/etcd/blob/master/Documentation/platforms/aws.md)
* [Container Linux, systemd](https://github.com/coreos/etcd/blob/master/Documentation/platforms/container-linux-systemd.md)
* [FreeBSD](https://github.com/coreos/etcd/blob/master/Documentation/platforms/freebsd.md)
* [Docker container](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/container.md#docker)
* [rkt container](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/container.md#rkt)

### 安全

－ [TLS](https://doczhcn.gitbook.io/ETCD/index/index-1/security) － [基于角色的访问控制(TBD)](https://doczhcn.gitbook.io/ETCD/index/index-1/authentication)

### 维护和排错

* [常见问题(TBD)](https://github.com/doczhcn/etcd/tree/7b0933e2f73373e907e67fabb9f04c50c0e48181/faq.md)
* [监控(TBD)](https://doczhcn.gitbook.io/ETCD/index/index-1/monitoring)
* [维护](https://doczhcn.gitbook.io/ETCD/index/index-1/maintenance)
* [故障模式](https://doczhcn.gitbook.io/ETCD/index/index-1/failures)
* [灾难恢复](https://doczhcn.gitbook.io/ETCD/index/index-1/recovery)

### 升级和兼容

> 注：暂时未翻译这部分内容

* [版本](https://doczhcn.gitbook.io/ETCD/index/index-1/versioning)
* [Migrate applications from using API v2 to API v3](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/v2-migration.md)
* [Upgrading a v2.3 cluster to v3.0](https://github.com/coreos/etcd/blob/master/Documentation/upgrades/upgrade_3_0.md)
* [Upgrading a v3.0 cluster to v3.1](https://github.com/coreos/etcd/blob/master/Documentation/upgrades/upgrade_3_1.md)
* [Upgrading a v3.1 cluster to v3.2](https://github.com/coreos/etcd/blob/master/Documentation/upgrades/upgrade_3_2.md)

## 学习

要学习更多 etcd 背后的概念和内部细节，请阅读下面的内容:

* [为什么是etcd?](https://doczhcn.gitbook.io/ETCD/index/index-2/why)
* [理解数据模型](https://doczhcn.gitbook.io/ETCD/index/index-2/data_model)
* [理解API](https://doczhcn.gitbook.io/ETCD/index/index-2/api)
* [术语](https://doczhcn.gitbook.io/ETCD/index/index-2/glossary)
* [API保证](https://doczhcn.gitbook.io/ETCD/index/index-2/api_guarantees)
* Internals
  * [认证子系统(TBD)](https://doczhcn.gitbook.io/ETCD/index/index-2/auth_design)