Skip to content
/ etcd Public
forked from etcd-io/etcd

Distributed reliable key-value store for the most critical data of a distributed system

License

Notifications You must be signed in to change notification settings

maor-lb/etcd

This branch is 6700 commits behind etcd-io/etcd:main.

Folders and files

NameName
Last commit message
Last commit date
Jul 23, 2019
Feb 8, 2020
Feb 9, 2020
Jan 30, 2020
Feb 14, 2020
Feb 11, 2020
Feb 10, 2020
Feb 12, 2020
Feb 12, 2020
Feb 18, 2020
Oct 23, 2019
Sep 15, 2019
Feb 14, 2020
Jan 30, 2020
Dec 18, 2014
Feb 15, 2020
Feb 12, 2020
Feb 12, 2020
Jan 29, 2020
Jan 20, 2020
Jul 23, 2019
Dec 10, 2019
Feb 4, 2020
Feb 12, 2020
Aug 2, 2019
Feb 6, 2020
Jan 1, 2019
May 13, 2016
Nov 14, 2019
Sep 25, 2019
Oct 17, 2019
Oct 24, 2018
Aug 1, 2019
Sep 17, 2019
Feb 13, 2020
Feb 13, 2020
Feb 13, 2020
Feb 13, 2020
Jan 15, 2020
Feb 9, 2020
Apr 4, 2014
Jul 23, 2019
Jul 23, 2019
Jul 23, 2019
Jan 20, 2020
Sep 30, 2019
Jul 31, 2013
Sep 30, 2019
Feb 6, 2020
Nov 6, 2019
Nov 6, 2019
Nov 6, 2019
Jan 21, 2020
Oct 1, 2018
Feb 12, 2020
May 2, 2019
May 28, 2019
Apr 6, 2016
Aug 29, 2018
Sep 18, 2019
Aug 16, 2018
Aug 8, 2019
Feb 12, 2020
Feb 12, 2020
May 28, 2019
May 28, 2019
Jan 21, 2020

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

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.

Time:

Join Hangouts Meet: meet.google.com/umg-nrxn-qvs

Join by phone: +1 405-792-0633‬ PIN: ‪299 906‬#

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.13+ 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.

Follow the steps in Procfile.learner to add a learner node to the cluster. Start the learner node with:

goreman -f ./Procfile.learner start

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

See security disclosure and release process for details on how to report a security vulnerability and how the etcd team manages it.

Issue and PR management

See issue triage guidelines for details on how issues are managed.

See PR management for guidelines on how pull requests are managed.

etcd Emeritus Maintainers

These emeritus maintainers dedicated a part of their career to etcd and reviewed code, triaged bugs, and pushed the project forward over a substantial period of time. Their contribution is greatly appreciated.

  • Fanmin Shi
  • Anthony Romano

License

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

About

Distributed reliable key-value store for the most critical data of a distributed system

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 97.3%
  • Shell 2.1%
  • Other 0.6%