Distributed reliable key-value store for the most critical data of a distributed system
Go Protocol Buffer Other
Latest commit f73258a Aug 28, 2016 @gyuho gyuho committed on GitHub Merge pull request #6282 from gyuho/tester-error
etcd-tester: return error for mismatch rev/hash
Permalink
Failed to load latest commit information.
.github .github: add pull request and issue template Apr 25, 2016
Documentation Documentation: update links for unaligned 64-bit atomics issue Aug 24, 2016
alarm *: update LICENSE header May 13, 2016
auth *: regenerate proto with latest grpc-gateway Jul 27, 2016
client build: support go install github.com/coreos/etcd/cmd/etcd Aug 15, 2016
clientv3 clientv3/integration: wait for two request timeouts in txn tests Aug 26, 2016
cmd vendor: update grpc/grpc-go for clientconn patch Aug 19, 2016
compactor compactor: wait for After() in TestPeriodic Aug 12, 2016
contrib session: remove session manager and add ttl Aug 15, 2016
discovery discovery: reject IP address records in SRVGetCluster Aug 24, 2016
e2e e2e: remove server testing in etcdctl test Aug 22, 2016
embed embed: use default route IP for default advertise URL Aug 15, 2016
error *: update LICENSE header May 13, 2016
etcdctl etcdctl: list output options Aug 23, 2016
etcdmain etcdmain: report default advertise detection / fallback Aug 15, 2016
etcdserver Merge pull request #6264 from heyitsanthony/error-codes Aug 26, 2016
hack hack/benchmark: remove deprecated boom parameter Jul 14, 2016
integration integration: improve TestTransferLeader Aug 19, 2016
lease *: minor cleanup for lease Aug 5, 2016
logos logos: add SVG and PNG logos Dec 18, 2014
mvcc mvcc: force commit and hash should be atomic for getting hash Aug 28, 2016
pkg fileutil: add ZeroToEnd for zeroing files Aug 25, 2016
proxy grpc-proxy: invalidate cache entries when there is a put/delete Aug 19, 2016
raft raft: handled panic for Term due to IOB Aug 18, 2016
rafthttp rafthttp: fix race in TestStreamWriterAttachOutgoingConn Aug 20, 2016
scripts scripts: use glide in updatedep.sh Aug 15, 2016
snap *: regenerate proto with latest grpc-gateway Jul 27, 2016
store store: copy old value when refresh + cas Jun 15, 2016
tools etcd-tester: return error for mismatch rev/hash Aug 28, 2016
version *: remove unnecessary data upgrade code Jul 11, 2016
wal wal: hold file lock while renaming WAL directory on non-Windows Aug 26, 2016
.dockerignore Add .dockerignore to avoid including .git in docker build context Aug 15, 2014
.gitignore hack: add tls-setup example generated certs to gitignore Jun 30, 2016
.godir create .godir Nov 18, 2014
.header .header: update to 'etcd Authors' May 13, 2016
.travis.yml build: re-enable building outside gopath Aug 17, 2016
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: add v3.0.5 Aug 17, 2016
NOTICE feat(*): initial commit Jan 19, 2014
Procfile Procfile: v3 as default May 23, 2016
README.md Documentation: add instruction on vendoring, build Jul 5, 2016
ROADMAP.md ROADMAP: update Aug 15, 2016
V2Procfile Procfile: v3 as default May 23, 2016
build build: re-enable building outside gopath Aug 17, 2016
build.bat vendor: only vendor on emitted binaries Apr 6, 2016
build.ps1 build: support go install github.com/coreos/etcd/cmd/etcd Aug 15, 2016
cover test, scripts: use /usr/bin/env to find bash Aug 9, 2015
etcd.conf.yml.sample etcd: correct security configuration for peers in sample config file Jul 12, 2016
glide.lock vendor: update grpc/grpc-go for clientconn patch Aug 19, 2016
glide.yaml vendor: update grpc/grpc-go for clientconn patch Aug 19, 2016
main.go *: update LICENSE header May 13, 2016
test build: don't override gopath by default, demote old gopath on override Aug 16, 2016

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, 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.6+ 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.

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.