Distributed reliable key-value store for the most critical data of a distributed system
Branch: master
Clone or download
jingyih Merge pull request #10473 from haroldHT/master
benchmark: fix install docs
Latest commit 8c228d6 Feb 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github *: update github.com links Aug 29, 2018
Documentation Merge pull request #10444 from WIZARD-CXY/nnboltdb Feb 14, 2019
auth auth: disable CommonName auth for gRPC-gateway Jan 8, 2019
client client: update generated ugorji codec, manual remove "yynn2=0" Dec 21, 2018
clientv3 clientv3/integration: add timeout case. Feb 18, 2019
contrib Merge pull request #10167 from nvanbenschoten/nvanbenschoten/limitUnc… Oct 14, 2018
docs docs/README: highlight new documentation website Dec 18, 2018
embed *: add flag to let etcd use the new boltdb freelistType feature Feb 14, 2019
etcdctl etcdctl: fix strings.HasPrefix args order Feb 1, 2019
etcdmain *: add flag to let etcd use the new boltdb freelistType feature Feb 14, 2019
etcdserver *: add flag to let etcd use the new boltdb freelistType feature Feb 14, 2019
functional *: fix github links Nov 10, 2018
hack *: update github.com links Aug 29, 2018
integration tests: update TestV3CurlAuthClientTLSCertAuth for using cert with emp… Jan 22, 2019
lease *: update import paths to "go.etcd.io/etcd" Aug 29, 2018
logos logos: add SVG and PNG logos Dec 18, 2014
mvcc *: add flag to let etcd use the new boltdb freelistType feature Feb 14, 2019
pkg pkg/transport: Limit InvalidCipherSuites to TLS12 Feb 7, 2019
proxy grpcproxy: fix memory leak Dec 15, 2018
raft raft: set lead to none when becomePreCandidate Dec 28, 2018
scripts Merge pull request #10401 from markmc/doc-drop-etcdctl-v3-flag Feb 1, 2019
tests tests/e2e: fix "authLeaseTestLeaseRevoke" Feb 15, 2019
tools benchmark: fix install docs Feb 18, 2019
vendor vendor: fix vendor go mod Feb 19, 2019
version *: revert "internal/version" change Feb 27, 2018
wal wal: update Go import paths to "go.etcd.io/etcd" Aug 29, 2018
.gitignore gitignore: ignore build result and runtime files Jan 1, 2019
.header .header: update to 'etcd Authors' May 13, 2016
.travis.yml *: update Go versions Dec 17, 2018
.words words: whitelist unfreed Oct 4, 2018
CHANGELOG-2.3.md CHANGELOG: add "raft unbounded log growth prevention" PR Oct 24, 2018
CHANGELOG-3.0.md CHANGELOG: add "raft unbounded log growth prevention" PR Oct 24, 2018
CHANGELOG-3.1.md Merge pull request #10443 from Quasilyte/quasilyte/fix_args_order Feb 6, 2019
CHANGELOG-3.2.md Merge pull request #10443 from Quasilyte/quasilyte/fix_args_order Feb 6, 2019
CHANGELOG-3.3.md CHANGELOG-3.3: fix typo in Go version Feb 7, 2019
CHANGELOG-3.4.md Merge pull request #10443 from Quasilyte/quasilyte/fix_args_order Feb 6, 2019
CHANGELOG-3.5.md CHANGELOG: add "raft unbounded log growth prevention" PR Oct 24, 2018
CHANGELOG-4.0.md CHANGELOG: add "raft unbounded log growth prevention" PR Oct 24, 2018
CONTRIBUTING.md CONTRIBUTING: clarify commit message style Jan 18, 2019
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
LICENSE License project under the Apache License Version 2.0 Jul 31, 2013
MAINTAINERS MAINTAINERS: add Sam Batschelet Nov 20, 2018
MAINTAINERS_RULES.md MAINTAINERS: add "MAINTAINERS_RULES" and second email Jan 30, 2018
Makefile build: stop using ETCDCTL_API=3 Jan 14, 2019
NOTICE feat(*): initial commit Jan 19, 2014
OWNERS OWNERS: add hexfusion as approver and remove joelegasse Jan 21, 2019
Procfile *: use "--logger=zap" for Procfile May 17, 2018
Procfile.v2 Documentation/v2: add Procfile.v2 for proxy Oct 3, 2017
README.md README: stop using ETCDCTL_API=3 Jan 14, 2019
ROADMAP.md *: change roadmap, future release dates Oct 1, 2018
bill-of-materials.json vendor: Add dependency on google/uuid for safe UUID generation Oct 22, 2018
bill-of-materials.override.json bill-of-materials.json: regenerate without "bitbucket.org/ww/goautoneg" Apr 11, 2018
build *: Use -n instead of ! -z. [SC2236] Jan 8, 2019
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
go.mod vendor: fix vendor go mod Feb 19, 2019
go.sum vendor: fix vendor go mod Feb 19, 2019
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 test: Add shadow tool Feb 7, 2019

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 will resume at 11:00 am on Thursday, January 10th, 2019.

etcd contributors and maintainers have monthly (every four weeks) meetings at 11:00 AM (USA Pacific) on Thursday.

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.

Please download and import the following iCalendar (.ics) files to calendar system.

Weekly: https://zoom.us/meeting/916003437/ics?icsToken=e4a085b6837f5802d9aef0d2ded4777d0faf1a71e39279c4a6d8b577993d879c

Join Zoom Meeting https://zoom.us/j/916003437

One tap mobile
+14086380986,,916003437# US (San Jose)
+16465588665,,916003437# US (New York)

Dial by location
        +1 408 638 0986 US (San Jose)
        +1 646 558 8665 US (New York)

Meeting ID: 916 003 437

To Find local number: https://zoom.us/u/actX55uPfS

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 put mykey "this is awesome"
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.