etcd

Note: The master branch may be in an unstable or even broken state during development. Please use releases instead of the master branch in order to get stable binaries.

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, locksmith, vulcand, Doorman, and many others. Reliability is further ensured by rigorous testing.

See etcdctl for a simple command line client.

Community meetings

etcd contributors and maintainers have monthly (every four weeks) meetings at 11:00 AM (USA Pacific) on Thursday.

An initial agenda will be posted to the shared Google docs a day before each meeting, and everyone is welcome to suggest additional topics or other agendas.

Time:

• Jan 10th, 2019 11:00 AM video
• Feb 7th, 2019 11:00 AM video
• Mar 7th, 2019 11:00 AM video
• Apr 4th, 2019 11:00 AM video
• May 2nd, 2019 11:00 AM video
• May 30th, 2019 11:00 AM video
• Jul 11th, 2019 11:00 AM video
• Jul 25, 2019 11:00 AM video
• Aug 22, 2019 11:00 AM video
• Sep 19, 2019 11:00 AM video
• Nov 14, 2019 11:00 AM
• Dec 12, 2019 11:00 AM
• Jan 09, 2020 11:00 AM
• Feb 06, 2020 11:00 AM
• Mar 05, 2020 11:00 AM
• Apr 02, 2020 11:00 AM
• Apr 30, 2020 11:00 AM
• May 28, 2020 11:00 AM
• Jun 25, 2020 11:00 AM
• Jul 23, 2020 11:00 AM
• Aug 20, 2020 11:00 AM
• Sep 17, 2020 11:00 AM
• Oct 15, 2020 11:00 AM
• Nov 12, 2020 11:00 AM
• Dec 10, 2020 11:00 AM

Join Hangouts Meet: meet.google.com/umg-nrxn-qvs

Join by phone: +1 405-792-0633‬ PIN: ‪299 906‬#

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 play.etcd.io and operating etcd.

For those wanting to try the very latest version, build the latest version of etcd from the master branch. This first needs Go installed (version 1.13+ is required). All development occurs on master, including new features and bug fixes. Bug fixes are first targeted at master and subsequently ported to release branches, as described in the branch management guide.

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:

mv /tmp/etcd-download-test/etcd /usr/local/bin/
etcd

If etcd is built from the master branch, run it as below:

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

etcd TCP ports

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

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 steps in Procfile.learner to add a learner node to the cluster. Start the learner node with:

goreman -f ./Procfile.learner start

Next steps

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

• Read the full documentation.
• Explore the full gRPC API.
• Set up a multi-machine cluster.
• Learn the config format, env variables and flags.
• Find language bindings and tools.
• Use TLS to secure an etcd cluster.
• Tune etcd.

Contact

• Mailing list: etcd-dev
• IRC: #etcd on freenode.org
• Planning/Roadmap: milestones, roadmap
• Bugs: issues

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Reporting bugs

See reporting bugs for details about reporting any issues.

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

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

License

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