Distributed reliable key-value store for the most critical data of a distributed system
Go Protocol Buffer Shell PowerShell Makefile Assembly
Latest commit 89f7cc5 Jan 21, 2017 @xiang90 xiang90 committed on GitHub Merge pull request #7155 from andrewstuart/upgrade-etcd3-docs
Documentation: add upgrade gotchas/further info for better visibility on google, etc
Permalink
Failed to load latest commit information.
.github Merge pull request #6973 from sinsharat/make_contributing_url_based Dec 9, 2016
Documentation Merge pull request #7155 from andrewstuart/upgrade-etcd3-docs Jan 21, 2017
alarm *: update LICENSE header May 13, 2016
auth auth, etcdserver: let maintenance services require root role Jan 14, 2017
client client: update generated ugorji codec Dec 6, 2016
clientv3 clientv3/concurrency: fix rev comparison on concurrent key deletion Jan 20, 2017
cmd vendor: update 'golang.org/x/net' Jan 18, 2017
compactor compactor/compactor.go: corrected the capnslog package name Sep 26, 2016
contrib raftexample: load snapshot when opening WAL Dec 31, 2016
discovery discovery: warn on scheme mismatch Nov 18, 2016
e2e etcdctlv3: snapshot restore works with lease key Jan 20, 2017
embed embed/etcd.go: make v2 endpoint optional. fixes #7100 Jan 20, 2017
error *: update LICENSE header May 13, 2016
etcdctl etcdctlv3: snapshot restore works with lease key Jan 20, 2017
etcdmain Merge pull request #7170 from vimalk78/make-v2-endpoint-optional-#7100 Jan 20, 2017
etcdserver Merge pull request #7176 from heyitsanthony/bump-lread-timeout Jan 18, 2017
hack hack/benchmark: change boom to hey Oct 24, 2016
integration integration: test STM apply on concurrent deletion Jan 20, 2017
lease lease: use atomics for accessing lease expiry Dec 28, 2016
logos logos: add SVG and PNG logos Dec 18, 2014
mvcc mvcc: remove unused restore method Nov 18, 2016
pkg pkg/flags: fixed prefix checking of the env variables Jan 20, 2017
proxy grpcproxy, etcdmain, integration: add close channel to kv proxy Jan 18, 2017
raft Merge pull request #7121 from hhkbp2/add-test-case Jan 10, 2017
rafthttp rafthttp: add 3.2.0 stream type Jan 13, 2017
scripts scripts: use glide update if repo exists in glide.lock Dec 8, 2016
snap *: revendor, update proto files Nov 10, 2016
store store: set Dir attribute, when node expired Jan 19, 2017
tools etcd-tester: use 10K for '--snapshot-count' Jan 15, 2017
version version: bump to v3.2.0+git Jan 13, 2017
wal *: revendor, update proto files Nov 10, 2016
.dockerignore Add .dockerignore to avoid including .git in docker build context Aug 15, 2014
.gitignore scripts/genproto: use 'gopath.proto' for $GOPATH Oct 3, 2016
.godir create .godir Nov 18, 2014
.header .header: update to 'etcd Authors' May 13, 2016
.travis.yml travis: use Go 1.7.4, drop old env var Jan 13, 2017
CONTRIBUTING.md Documentation: conform to header style Jun 27, 2016
DCO docs(readme/contrib): clean up README, merge changes from CONTRIBUTIN… Apr 4, 2014
Dockerfile *: separate Dockerfile for quay build trigger Jun 24, 2016
Dockerfile-release Dockerfile-release: add '/var/lib/etcd/' Jul 27, 2016
LICENSE License project under the Apache License Version 2.0 Jul 31, 2013
MAINTAINERS MAINTAINERS: updating email address of Hitoshi Mitake Jun 11, 2016
NEWS NEWS: fix date for v3.1 release Jan 20, 2017
NOTICE feat(*): initial commit Jan 19, 2014
Procfile Procfile: v3 as default May 23, 2016
README.md README: remove ACI, update Go version Jan 20, 2017
ROADMAP.md roadmap: update roadmap Jan 20, 2017
V2Procfile Procfile: v3 as default May 23, 2016
build build: remove dir use -r flag Dec 13, 2016
build.bat vendor: only vendor on emitted binaries Apr 6, 2016
build.ps1 build: add option to enable binaries stripping for windows Oct 19, 2016
cover test, scripts: use /usr/bin/env to find bash Aug 9, 2015
etcd.conf.yml.sample embed/etcd.go: make v2 endpoint optional. fixes #7100 Jan 20, 2017
glide.lock glide: update 'golang.org/x/net' Jan 18, 2017
glide.yaml glide: update 'golang.org/x/net' Jan 18, 2017
main.go *: update LICENSE header May 13, 2016
test test: passed the test script arguments as the test function parameters Jan 18, 2017

README.md

etcd

Go Report Card Build Status Build Status Docker Repository on Quay.io

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.

the etcd v2 documentation has moved

etcd Logo

etcd is a distributed, consistent key-value store for shared configuration and service discovery, 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, fleet, locksmith, vulcand, Doorman, and many others. Reliability is further ensured by rigorous testing.

See etcdctl for a simple command line client.

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, rkt, 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.7+ 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:

./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_API=3 etcdctl put mykey "this is awesome"
ETCDCTL_API=3 etcdctl get mykey

That's it! etcd is now running and serving client requests. For more

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 etcd proxy proxy, which runs locally and composes a cluster.

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

Running etcd on Kubernetes

If you want to run etcd cluster on Kubernetes, try etcd operator.

Next steps

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

Contact

Contributing

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.

License

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