etcd is a distributed reliable key-value store designed to manage the most critical data of distributed systems with high availability, consistency, and performance. It serves as the foundation for mission-critical applications, ensuring data integrity and seamless operation across clusters.
Key Features:
Raft Consensus Algorithm: Ensures strong consistency and fault tolerance by maintaining a replicated log.
High Performance: Handles up to 10,000 writes per second, making it suitable for high-throughput environments.
Simplicity and Scalability: Built with a well-defined gRPC API, enabling easy integration and scaling across distributed architectures.
Security: Supports automatic TLS encryption and optional client certificate authentication for secure communication.
Audience & Benefit:
Ideal for developers and organizations managing distributed systems or cloud-native applications. etcd provides a reliable, consistent, and performant data store that ensures the availability and security of critical data, enabling faster decision-making and seamless operations in dynamic environments.
etcd is widely adopted in production by companies using it alongside Kubernetes, vulcand, and other distributed tools. It can be installed via winget for easy setup.
README
etcd
Note: The main branch may be in an unstable or even broken state during development. For stable versions, see releases.
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.
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.
For more installation guides, please check out operating etcd.
Running etcd
First start a single-member cluster of etcd.
If etcd is installed using the pre-built release binaries, 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:
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 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.
Meeting recordings are uploaded to the official etcd YouTube channel.
Get calendar invitations by joining etcd-dev mailing group.
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.
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.