Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Distributed reliable key-value store for the most critical data of a distributed system
Go Other
Latest commit a423a55 @xiang90 xiang90 Merge pull request #3857 from es-chow/remove-multinode-goroutine
raft: add an thread-unsafe Node: RawNode
Failed to load latest commit information.
Documentation doc: talk about update client urls in reconf doc
Godeps godep: update godep
client client: regenerate code to unmarshal key response
contrib contrib: add example systemd unit file
discovery *: add missing package descriptions
error *: add missing package descriptions
etcdctl etcdctl: remove duplicate exit line
etcdctlv3 *: add missing package descriptions
etcdmain etcdmain: Add max-snapshots and max-wals to help
etcdserver etcdserver: Fix panic for v3 transaction compares on non-existent keys
hack hack: benchmarking to use Content Type
integration rafthttp: build transport inside pkg instead of passed-in
lease lease: delete items when the lease is revoked.
logos logos: add SVG and PNG logos
pkg *: add missing package descriptions
proxy *: add missing package descriptions
raft raft: add RawNode which is a thread-unsafe node without goroutine and…
rafthttp rafthttp: more detailed logs when filled-up buffer
scripts scripts: clean up genproto
snap *: add missing package descriptions
storage storage: add watch ID to identify watchings
store *: add missing package descriptions
tools tools/etcd-tester: extend timeout for stresser
version *: add missing package descriptions
wal wal: minor typo in wal pkg
.dockerignore Add .dockerignore to avoid including .git in docker build context
.gitignore etcd: use old default data-dir format
.godir create .godir
.header *: switch to line comments for copyright
.travis.yml travis: install libpcap documentation: changed link to style doc
DCO docs(readme/contrib): clean up README, merge changes from CONTRIBUTIN…
Dockerfile Dockerfile: initial commit
LICENSE License project under the Apache License Version 2.0
NOTICE feat(*): initial commit
Procfile Procfile: change it to double-dash in Procfile README: Outright production-readiness Update
V3DemoProcfile V3DemoProcfile: use double dash
build build: fix build error on ubuntu
build.bat build: implemented build shell-script for Windows
cover test, scripts: use /usr/bin/env to find bash
main.go migrate: remove starter code
test test: add license header check


Build Status Build Status Docker Repository on

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 Logo

etcd is a distributed, consistent key-value store for shared configuration and service discovery, with a focus on being:

  • Simple: curl'able user-facing API (HTTP+JSON)
  • Secure: optional SSL client cert authentication
  • Fast: benchmarked 1000s of writes/s per instance
  • 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, fleet, locksmith, vulcand, and many others.

See etcdctl for a simple command line client. Or feel free to just use curl, as in the examples below.

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, AppC (ACI), and Docker. Instructions for using these binaries are on the GitHub releases page.

For those wanting to try the very latest version, you can build the latest version of etcd from the master branch. You will first need Go installed on your machine (version 1.4+ 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:


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:

curl -L -XPUT -d value="this is awesome"
curl -L

You have successfully started an etcd and written a key to the store.

Running local etcd cluster

First install goreman, which manages Procfile-based applications.

Our Procfile script will set up a local example cluster. You can start it with:

goreman start

This will bring up 3 etcd members infra1, infra2 and infra3 and etcd proxy proxy, which runs locally and composes a cluster.

You can write a key to the cluster and retrieve the value back from any member or proxy.

Next Steps

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



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

Reporting bugs

See reporting bugs for details about reporting any issue you may encounter.

Project Details


Service Versioning

etcd uses semantic versioning New minor versions may add additional features to the API.

You can get the version of etcd by issuing a request to /version:

curl -L

API Versioning

The v2 API responses should not change after the 2.0.0 release but new features will be added over time.

32-bit systems

etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #358 for more information.


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

Something went wrong with that request. Please try again.