Go Protocol Buffer Shell PowerShell Makefile Assembly
Latest commit 36735d5 Mar 28, 2017 @xiang90 xiang90 committed on GitHub Merge pull request #7622 from heyitsanthony/faq-disk-leader
Documentation: add disk latency leader loss question to FAQ
Permalink
Failed to load latest commit information.
.github *: eschew you from documentation Mar 6, 2017
Documentation Merge pull request #7622 from heyitsanthony/faq-disk-leader Mar 29, 2017
alarm *: update LICENSE header May 13, 2016
auth doc: link auth design in doc Mar 27, 2017
client client/integration: use only digits in unix port Mar 22, 2017
clientv3 clientv3,v3client: maintenance to embedded client Mar 28, 2017
cmd vendor: import jwt-go for auth v3 Mar 7, 2017
compactor compactor: make TestPeriodic die early Mar 28, 2017
contrib *: eschew you from documentation Mar 6, 2017
discovery discovery: fix print format Mar 10, 2017
e2e Merge pull request #7524 from mitake/del-and-revoke-role Mar 23, 2017
embed embed: don't return error when closing on embed etcd Mar 17, 2017
error *: update LICENSE header May 13, 2016
etcdctl Merge pull request #7591 from xiang90/validate Mar 28, 2017
etcdmain etcdmain: add prefixing support to grpc proxy Mar 22, 2017
etcdserver clientv3,v3client: maintenance to embedded client Mar 28, 2017
hack *: eschew you from documentation Mar 6, 2017
integration integration: use maintenance API adapter in tests Mar 28, 2017
lease *: base initial mmap size on quota size Mar 17, 2017
logos logos: add SVG and PNG logos Dec 18, 2014
mvcc Merge pull request #7579 from gyuho/fix-defrage Mar 23, 2017
pkg testutil: check for grpc resources in AfterTest Mar 24, 2017
proxy grpcproxy/adapter: add maintenance API support Mar 28, 2017
raft raft: use rs.req.Entries[0].Data as the key for deletion in advance() Mar 24, 2017
rafthttp *: remove never-unused vars, minor lint fix Mar 6, 2017
scripts scripts: generate lock service rpc stubs Mar 13, 2017
snap *: use filepath.Join for files Mar 16, 2017
store *: remove never-unused vars, minor lint fix Mar 6, 2017
tools tools/etcd-tester: add timeout for 'defrag' Mar 23, 2017
version version: bump to v3.2.0+git Jan 13, 2017
wal *: use 'io.Seek*' for go1.7+ Mar 20, 2017
.dockerignore Add .dockerignore to avoid including .git in docker build context Aug 15, 2014
.gitignore .gitignore: Adding .idea to .gitignore Jan 25, 2017
.godir create .godir Nov 18, 2014
.header .header: update to 'etcd Authors' May 13, 2016
.travis.yml travis: always 'go get -u' in 'before_install' Mar 21, 2017
CONTRIBUTING.md *: eschew you from documentation Mar 6, 2017
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 nsswitch.conf into image Mar 21, 2017
Dockerfile-release.ppc64le script: Build docker image for ppc64le Feb 28, 2017
LICENSE License project under the Apache License Version 2.0 Jul 31, 2013
MAINTAINERS MAINTAINERS: add Fanmin Feb 23, 2017
NEWS NEWS: add v3.1.4, v3.1.5 Mar 27, 2017
NOTICE feat(*): initial commit Jan 19, 2014
Procfile Procfile: v3 as default May 23, 2016
README.md *: use 'io.Seek*' for go1.7+ Mar 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 vendor: import jwt-go for auth v3 Mar 7, 2017
glide.yaml vendor: import jwt-go for auth v3 Mar 7, 2017
main.go *: update LICENSE header May 13, 2016
main_test.go e2e: modify e2e to run code coverage Feb 15, 2017
test test: add proxy to coverage tests Mar 24, 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, build the latest version of etcd from the master branch. This first needs Go installed (version 1.8+ 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

To run an 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 issues.

License

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