Repository files navigation

Note: Themain branch may be in anunstable or even broken state during development. For stable versions, seereleases.

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 theRaft consensus algorithm to manage a highly-available replicated log.

etcd is usedin production by many companies, and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such asKubernetes,locksmith,vulcand,Doorman, and many others. Reliability is further ensured by rigorousrobustness testing.

Seeetcdctl for a simple command line client.

_{Original image credited to xkcd.com/2347, alterations by Josh Berkus.}

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 aboutMaintainers role and responsibilities.

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 therelease page.

For more installation guides, please check outplay.etcd.io andoperating etcd.

First start a single-member cluster of etcd.

If etcd is installed using thepre-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:

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:

• Interactive etcd playground
• Animated quick demo

Theofficial etcd ports are 2379 for client requests, and 2380 for peer communication.

First installgoreman, which manages Procfile-based applications.

OurProcfile script will set up a local example cluster. Start it with:

goreman start

This will bring up 3 etcd membersinfra1,infra2 andinfra3 and optionally etcdgrpc-proxy, which runs locally and composes a cluster.

Every cluster member and proxy accepts key value reads and key value writes.

Follow the comments inProcfile script to add a learner node to the cluster.

go get go.etcd.io/etcd/client/v3

Now it's time to dig into the full etcd API and other guides.

• Read the fulldocumentation.
• Review etcdfrequently asked questions.
• Explore the full gRPCAPI.
• Set up amulti-machine cluster.
• Learn theconfig format, env variables and flags.
• Findlanguage bindings and tools.
• Use TLS tosecure an etcd cluster.
• Tune etcd.

• Email:etcd-dev
• Slack:#sig-etcd channel on Kubernetes (get an invite)
• Community meetings

etcd contributors and maintainers meet every week at11:00 AM (USA Pacific) on Thursday and meetings alternate between community meetings and issue triage meetings. Meeting agendas are recorded in ashared 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 ashared Google sheet.

Meeting recordings are uploaded to the official etcdYouTube channel.

Get calendar invitations by joiningetcd-dev mailing group.

Join the CNCF-funded Zoom channel:zoom.us/my/cncfetcdproject

SeeCONTRIBUTING for details on setting up your development environment, submitting patches and the contribution workflow.

Please refer tocommunity-membership.md for information on becoming an etcd project member. We welcome and look forward to your contributions to the project!

Please also refer toroadmap to get more details on the priorities for the next few major or minor releases.

Seereporting bugs for details about reporting any issues. Before opening an issue please check it is not covered in ourfrequently asked questions.

Seesecurity disclosure and release process for details on how to report a security vulnerability and how the etcd team manages it.

Seeissue triage guidelines for details on how issues are managed.

SeePR management for guidelines on how pull requests are managed.

These 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.

• Fanmin Shi
• Anthony Romano
• Brandon Philips
• Joe Betz
• Gyuho Lee
• Jingyi Hu
• Xiang Li
• Ben Darnell
• Sam Batschelet
• Piotr Tabor
• Hitoshi Mitake

etcd is under the Apache 2.0 license. See theLICENSE file for details.