Distributed reliable key-value store for the most critical data of a distributed system
Clone or download
xiang90 Merge pull request #10109 from jingyih/add_db_integrity_verification_…
…to_snapshot_status

clientv3: add db integrity check in snapshot status
Latest commit d987cae Sep 21, 2018
Permalink
Failed to load latest commit information.
.github *: update github.com links Aug 29, 2018
Documentation Documentation: add erlang client for etcd API v3 Sep 20, 2018
auth auth: update Go import paths to "go.etcd.io" Aug 29, 2018
client client,clientv3: update client docs to "go.etcd.io" Aug 30, 2018
clientv3 clientv3: add integrity check in snapshot status Sep 20, 2018
contrib raftexample: use Rlock instead of Lock in getsnapshot Sep 19, 2018
docs docs: fix pronunciation notation Aug 31, 2018
embed *: update import paths to "go.etcd.io/etcd" Aug 29, 2018
etcdctl *: use "go.etcd.io/bbolt" Aug 29, 2018
etcdmain *: rerun "gofmt" Aug 29, 2018
etcdserver etcdserver: fix gofmt warnings with Go 1.11 Aug 29, 2018
functional *: path changes for moving to github/etcd-io/etcd Sep 3, 2018
hack *: update github.com links Aug 29, 2018
integration integration: Replace *testing.T with testing.TB Sep 4, 2018
lease *: update import paths to "go.etcd.io/etcd" Aug 29, 2018
logos logos: add SVG and PNG logos Dec 18, 2014
mvcc mvcc/backend: use "go.etcd.io/bbolt" Aug 29, 2018
pkg *: fix gofmt warnings with Go 1.11 Aug 29, 2018
proxy Merge pull request #10019 from thrawn01/grpc-proxy-watch-errors Sep 10, 2018
raft raft: fix Ready.MustSync logic Sep 19, 2018
scripts *: path changes for moving to github/etcd-io/etcd Sep 3, 2018
tests *: use "go.etcd.io/bbolt" Aug 29, 2018
tools tools/etcd-dump-db: fix iterate-bucket example. Sep 6, 2018
vendor vendor: use "go.etcd.io/bbolt" v1.3.1-etcd.7 Aug 29, 2018
version *: revert "internal/version" change Feb 27, 2018
wal wal: update Go import paths to "go.etcd.io/etcd" Aug 29, 2018
.gitignore gitignore: add "*.coverprofile" May 4, 2018
.header .header: update to 'etcd Authors' May 13, 2016
.travis.yml travis.yml: bump up to Go 1.11 Aug 29, 2018
.words words: whitelist "ErrConnClosing" Aug 10, 2018
CHANGELOG-2.3.md CHANGELOG: add Go versions, add security change details Mar 17, 2018
CHANGELOG-3.0.md CHANGELOG: add all recent changes Aug 29, 2018
CHANGELOG-3.1.md CHANGELOG: add all recent changes Aug 29, 2018
CHANGELOG-3.2.md CHANGELOG: add all recent changes Aug 29, 2018
CHANGELOG-3.3.md CHANGELOG: add all recent changes Aug 29, 2018
CHANGELOG-3.4.md CHANGELOG: add all recent changes Aug 29, 2018
CHANGELOG-3.5.md CHANGELOG: add all recent changes Aug 29, 2018
CHANGELOG-4.0.md CHANGELOG: add all recent changes Aug 29, 2018
CONTRIBUTING.md *: update github links Aug 29, 2018
DCO docs(readme/contrib): clean up README, merge changes from CONTRIBUTIN… Apr 4, 2014
Dockerfile-release Dockerfile-release: add nsswitch.conf into image Mar 21, 2017
Dockerfile-release.arm64 build-docker: Updates for multi-arch release Apr 21, 2017
Dockerfile-release.ppc64le build-docker: Change baseimage for ppc64le dockerfile Mar 20, 2018
Gopkg.lock vendor: use "go.etcd.io/bbolt" v1.3.1-etcd.7 Aug 29, 2018
Gopkg.toml Gopkg.toml: remove unnecessary constraints and add pruning Jan 31, 2018
LICENSE License project under the Apache License Version 2.0 Jul 31, 2013
MAINTAINERS MAINTAINERS: update import path to "go.etcd.io" Aug 29, 2018
MAINTAINERS_RULES.md MAINTAINERS: add "MAINTAINERS_RULES" and second email Jan 30, 2018
Makefile Makefile: bump up to Go 1.11 Aug 29, 2018
NOTICE feat(*): initial commit Jan 19, 2014
Procfile *: use "--logger=zap" for Procfile May 17, 2018
Procfile.v2 Documentation/v2: add Procfile.v2 for proxy Oct 3, 2017
README.md *: update github links Aug 29, 2018
ROADMAP.md *: update github.com links Aug 29, 2018
bill-of-materials.json bill-of-materials: regenerate with "go.etcd.io/bbolt" Aug 29, 2018
bill-of-materials.override.json bill-of-materials.json: regenerate without "bitbucket.org/ww/goautoneg" Apr 11, 2018
build build: upgrade local GOPATH Aug 29, 2018
build.bat vendor: only vendor on emitted binaries Apr 6, 2016
build.ps1 build.ps1: update import paths to "go.etcd.io/etcd" Aug 29, 2018
code-of-conduct.md CODE_OF_CONDUCT: update CoC Jan 4, 2018
etcd.conf.yml.sample sample: correct directive name Aug 16, 2018
functional.yaml *: path changes for moving to github/etcd-io/etcd Sep 3, 2018
main.go *: update import paths to "go.etcd.io/etcd" Aug 29, 2018
main_test.go *: remove os.Kill from signal.Notify Apr 7, 2017
test *: path changes for moving to github/etcd-io/etcd Sep 3, 2018

README.md

etcd

Go Report Card Coverage Build Status Travis Build Status Semaphore Docs Godoc Releases LICENSE

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

Community meeting is put on hold for now.

etcd contributors and maintainers have bi-weekly meetings at 11:00 AM (USA Pacific) on Tuesdays.

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.

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

etcd is now running and serving client requests. For more, please check out:

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 grpc-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 issues.

Reporting a security vulnerability

Due to their public nature, GitHub and mailing lists are NOT appropriate places for reporting vulnerabilities. Please refer to CoreOS's security disclosure process when reporting issues that may be security related.

License

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