站内导读
定位:etcd 是用 Go 编写的分布式键值存储,用来存放分布式系统里最关键的数据,常与 Kubernetes、locksmith 等应用搭配。
核心能力
- 对外只提供一套定义清晰的 gRPC API,客户端库与 etcdctl 命令行都基于它读写。
- 用 Raft 共识算法维护高可用复制日志,多数节点存活即可继续提供读写服务。
- 支持自动 TLS,并可选用客户端证书认证,兼顾传输加密与身份校验。
- 官方基准约每秒 1 万次写入,仓库内另设健壮性测试目录用于验证可靠性。
适用人群:需要为 Kubernetes、分布式锁、网关等系统提供一致配置与选主能力的后端和基础设施工程师;需具备 Go 环境或 gRPC 客户端,以及多节点部署条件。
注意:main 分支开发期可能不稳定,稳定版本请用 releases。
位置づけ:etcd は Go で書かれた分散キーバリューストアで、分散システムで最も重要なデータを保持するために使われ、Kubernetes や locksmith などと組み合わせて使われることが多い。
主な機能
- 外部向けには定義の明確な gRPC API を 1 セットだけ提供し、クライアントライブラリも etcdctl コマンドラインもこの API で読み書きする。
- Raft 合意アルゴリズムで高可用な複製ログを維持し、過半数のノードが生きていれば読み書きを継続できる。
- 自動 TLS に対応し、クライアント証明書認証も選択でき、転送の暗号化と本人確認を両立する。
- 公式ベンチマークは約毎秒 1 万書き込み。リポジトリ内には信頼性検証用の堅牢性テストディレクトリも別途ある。
向いている人:Kubernetes、分散ロック、ゲートウェイなどのシステムに一貫した設定管理とリーダー選出を提供したいバックエンド/インフラエンジニア。Go 環境または gRPC クライアントと、複数ノードのデプロイ環境が必要。
注意:main ブランチは開発中で不安定な場合がある。安定版は releases を使うこと。
정의: etcd는 Go로 작성된 분산 키-값 저장소로, 분산 시스템에서 가장 중요한 데이터를 보관하는 데 쓰이며 Kubernetes, locksmith 등과 함께 쓰이는 경우가 많다.
핵심 기능
- 외부에는 명확히 정의된 gRPC API 한 세트만 제공하며, 클라이언트 라이브러리와 etcdctl 명령줄 도구 모두 이 API로 읽고 쓴다.
- Raft 합의 알고리즘으로 고가용 복제 로그를 유지해, 과반수 노드가 살아 있으면 읽기와 쓰기를 계속 제공할 수 있다.
- 자동 TLS를 지원하고 클라이언트 인증서 인증도 선택할 수 있어 전송 암호화와 신원 확인을 함께 갖췄다.
- 공식 벤치마크는 초당 약 1만 회 쓰기이며, 저장소 안에 신뢰성 검증을 위한 견고성 테스트 디렉터리도 별도로 있다.
대상: Kubernetes, 분산 잠금, 게이트웨이 같은 시스템에 일관된 설정과 리더 선출 기능을 제공해야 하는 백엔드 및 인프라 엔지니어. Go 환경이나 gRPC 클라이언트, 그리고 다중 노드 배포 환경이 필요하다.
주의: main 브랜치는 개발 중이라 불안정할 수 있으니 안정 버전은 releases를 사용할 것.
What it is: etcd is a distributed, reliable key-value store written in Go by the etcd project, built to hold the most critical data of a distributed system and often paired with Kubernetes, locksmith and similar tools.
Key capabilities
- One well-defined gRPC API that client libraries and the etcdctl command-line tool both speak.
- A replicated log kept highly available by Raft; writes continue while a majority of nodes are up.
- Automatic TLS, with optional client certificate authentication for identity checks.
- Benchmarked at 10,000 writes per second, with a dedicated robustness testing suite in the repo.
README · 详细文档
来源 · 查看原文
etcd
Note: The main branch may be in an unstable or even broken state during development. For stable versions, see [releases][github-release].
etcd is a distributed reliable key-value store for the most critical data of a distributed system, with a focus on being:
- Simple: well-defined, user-facing API (gRPC)
- Secure: automatic TLS with optional client cert authentication
- Fast: benchmarked 10,000 writes/sec
- Reliable: properly distributed using Raft
etcd is written in Go and uses the [Raft][] consensus algorithm to manage a highly-available replicated log.
etcd is used in production by many companies, and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [locksmith][], [vulcand][], [Doorman][], and many others. Reliability is further ensured by rigorous **robustness testing**.
See [etcdctl][etcdctl] for a simple command line client.
etcd reliability is important
Original image credited to xkcd.com/2347, alterations by Josh Berkus.
[raft]: https://raft.github.io/ [k8s]: http://kubernetes.io/ [doorman]: https://github.com/youtube/doorman [locksmith]: https://github.com/coreos/locksmith [vulcand]: https://github.com/vulcand/vulcand [etcdctl]: https://github.com/etcd-io/etcd/tree/main/etcdctl
Documentation
The most common API documentation you'll need can be found here:
- go.etcd.io/etcd/api/v3
- go.etcd.io/etcd/client/pkg/v3
- go.etcd.io/etcd/client/v3
- go.etcd.io/etcd/etcdctl/v3
- go.etcd.io/etcd/pkg/v3
- go.etcd.io/etcd/raft/v3
- go.etcd.io/etcd/server/v3
Maintainers
Maintainers strive to shape an inclusive open source project culture where users are heard and contributors feel respected and empowered. Maintainers aim to build productive relationships across different companies and disciplines. Read more about Maintainers role and responsibilities.
Getting started
Getting etcd
The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, and Docker on the [release page][github-release].
For more installation guides, please check out operating etcd.
[github-release]: https://github.com/etcd-io/etcd/releases
Running etcd
First start a single-member cluster of etcd.
If etcd is installed using the [pre-built release binaries][github-release], run it from the installation location as below:
/tmp/etcd-download-test/etcd
The etcd command can be simply run as such if it is moved to the system path as below:
mv /tmp/etcd-download-test/etcd /usr/local/bin/
etcd
This will bring up etcd listening on port 2379 for client communication and on port 2380 for server-to-server communication.
Next, let's set a single key, and then retrieve it:
etcdctl put mykey "this is awesome"
etcdctl get mykey
etcd is now running and serving client requests. For more, please check out:
etcd TCP ports
The [official etcd ports][iana-ports] are 2379 for client requests, and 2380 for peer communication.
[iana-ports]: http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt
Running a local etcd cluster
First install goreman, which manages Procfile-based applications.
Our Procfile script will set up a local example cluster. Start it with:
goreman start
This will bring up 3 etcd members infra1, infra2 and infra3 and optionally etcd grpc-proxy, which runs locally and composes a cluster.
Every cluster member and proxy accepts key value reads and key value writes.
Follow the comments in Procfile script to add a learner node to the cluster.
Install etcd client v3
go get go.etcd.io/etcd/client/v3
Next steps
Now it's time to dig into the full etcd API and other guides.
- Read the full [documentation].
- Review etcd [frequently asked questions].
- Explore the full gRPC [API].
- Set up a [multi-machine cluster][clustering].
- Learn the [config format, env variables and flags][configuration].
- Find [language bindings and tools][integrations].
- Use TLS to [secure an etcd cluster][security].
- [Tune etcd][tuning].
[documentation]: https://etcd.io/docs/latest [api]: https://etcd.io/docs/latest/learning/api [clustering]: https://etcd.io/docs/latest/op-guide/clustering [configuration]: https://etcd.io/docs/latest/op-guide/configuration [integrations]: https://etcd.io/docs/latest/integrations [security]: https://etcd.io/docs/latest/op-guide/security [tuning]: https://etcd.io/docs/latest/tuning
Contact
- Email: etcd-dev
- Slack: #sig-etcd channel on Kubernetes (get an invite)
- Community meetings
Community meetings
etcd contributors and maintainers meet every week at 11:00 AM (USA Pacific) on Thursday and meetings alternate between community meetings and issue triage meetings. Meeting agendas are recorded in a [shared Google doc][shared-meeting-notes] and everyone is welcome to suggest additional topics or other agendas.
Issue triage meetings are aimed at getting through our backlog of PRs and Issues. Triage meetings are open to any contributor; you don't have to be a reviewer or approver to help out! They can also be a good way to get started contributing.
The meeting lead role is rotated for each meeting between etcd maintainers or sig-etcd leads and is recorded in a [shared Google sheet][shared-rotation-sheet].
Meeting recordings are uploaded to the official etcd [YouTube channel].
Get calendar invitations by joining etcd-dev mailing group.
Join the CNCF-funded Zoom channel: zoom.us/my/cncfetcdproject
[shared-meeting-notes]: https://docs.google.com/document/d/16XEGyPBisZvmmoIHSZzv__LoyOeluC5a4x353CX0SIM/edit [shared-rotation-sheet]: https://docs.google.com/spreadsheets/d/1jodHIO7Dk2VWTs1IRnfMFaRktS9IH8XRyifOnPdSY8I/edit [YouTube channel]: https://www.youtube.com/@etcdio
Contributing
See CONTRIBUTING for details on setting up your development environment, submitting patches and the contribution workflow.
Please refer to community-membership.md for information on becoming an etcd project member. We welcome and look forward to your contributions to the project!
Please also refer to roadmap to get more details on the priorities for the next few major or minor releases.
Reporting bugs
See reporting bugs for details about reporting any issues. Before opening an issue please check it is not covered in our [frequently asked questions].
[frequently asked questions]: https://etcd.io/docs/latest/faq
Reporting a security vulnerability
See security disclosure and release process for details on how to report a security vulnerability and how the etcd team manages it.
Issue and PR management
See issue triage guidelines for details on how issues are managed.
See PR management for guidelines on how pull requests are managed.
etcd Emeritus Maintainers
etcd emeritus maintainers dedicated a part of their career to etcd and reviewed code, triaged bugs and pushed the project forward over a substantial period of time. Their contribution is greatly appreciated.
License
etcd is under the Apache 2.0 license. See the LICENSE file for details.