etcd-io/etcd


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

https://etcd.io

License: Apache-2.0

Language: Go

Keywords: consensus, database, distributed-database, distributed-systems, etcd, go, key-value, kubernetes, raft


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.

Project Statistics

Sourcerank 15
Repository Size 54.3 MB
Stars 28,380
Forks 5,836
Watchers 1,310
Open issues 559
Dependencies 27
Contributors 474
Tags 162
Created
Last updated
Last pushed

Top Contributors See all

Xiang Li Gyuho Lee Anthony Romano Yicheng Qin Brandon Philips Jonathan Boulle Brian Waldon Hitoshi Mitake Blake Mizerany Ben Johnson Fanmin Shi Barak Michener Sam Batschelet Joe Betz sharat Rob Szumski Ben Darnell Kelsey Hightower Yifan Gu Sahdev Zala

Packages Referencing this Repo

github.com/coreos/etcd/etcdserver/api/v3election/v3electionpb/gw
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/clientv3/namespace
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/etcdserver/api/v3client
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/proxy/tcpproxy
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/clientv3/concurrency
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/tools/benchmark/cmd
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/pkg/stringutil
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/lease
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/etcdserver/stats
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/pkg/proxy
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/raft/raftpb
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/client
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/embed
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/etcdserver/api/snap
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/etcd-io/etcd/client/integration
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/pkg/systemd
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/pkg/debugutil
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/pkg/adt
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
github.com/coreos/etcd/contrib/raftexample
Distributed reliable key-value store for the most critical data of a distributed system
Latest release v3.3.12 - Published - 28.4K stars
etcd
A highly-available key value store for shared configuration and service discovery
Latest release 3.3.1 - Published - 28.4K stars

Recent Tags See all

v3.3.12 February 07, 2019
v3.3.11 January 11, 2019
v3.2.26 January 11, 2019
v3.1.20 October 10, 2018
v3.2.25 October 10, 2018
v3.3.10 October 10, 2018
v3.2.24 July 24, 2018
v3.1.19 July 24, 2018
v3.3.9 July 24, 2018
v3.3.8 June 15, 2018
v3.1.18 June 15, 2018
v3.2.23 June 15, 2018
v3.2.22 June 06, 2018
v3.1.17 June 06, 2018
v3.3.7 June 06, 2018

Interesting Forks See all

alibaba/etcd
Distributed reliable key-value store for the most critical data of a distributed system
Go - Apache-2.0 - Last pushed - 26 stars - 8 forks
docker/etcd
A highly-available key value store for shared configuration and service discovery
Apache-2.0 - Last pushed - 24 stars - 12 forks
skynetservices/etcd
A highly-available key value store for shared configuration and service discovery
Go - Apache-2.0 - Updated - 10 stars
xiang90/etcd
Go - Apache-2.0 - Last pushed - 4 stars - 1 forks
meitu/etcd
Distributed reliable key-value store for the most critical data of a distributed system
Go - Apache-2.0 - Last pushed - 3 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-04-07 03:52:43 UTC

Login to resync this repository