No Description

Gyuho Lee cc959b4e5a Merge pull request #11195 from andyliuliming/release-3.2-cherry 5 years ago
.github c8a2c7f64f *: eschew you from documentation 7 years ago
Documentation c552f11bfe helper document update. 5 years ago
alarm ef44f71da9 *: update LICENSE header 8 years ago
auth a2b420c364 auth: disable CommonName auth for gRPC-gateway 6 years ago
client 15e9510d2c client: fail over to next endpoint on oneshot failure 7 years ago
clientv3 26cce20022 clientv3: concurrency.Mutex.Lock() - preserve invariant 6 years ago
cmd 8f59849ca2 vendor: add "gogo/protobuf/gogoproto" 6 years ago
compactor 0265457183 compactor: fix error message of Revision compactor 7 years ago
contrib 7c6a9a7317 contrib/raftexample: use bytes.Buffer.String (no 'string()') 7 years ago
discovery 07ad18178d pkg/srv: package for SRV utilities 7 years ago
e2e 4e375497ea etcdctl/ctlv3: do not modify db file on "restore" 5 years ago
embed 6fa95eb497 embed: support custom cipher suites 6 years ago
error 8ab42fb045 *: move v2http handlers without /v2 prefix to etcdhttp 7 years ago
etcdctl 4e375497ea etcdctl/ctlv3: do not modify db file on "restore" 5 years ago
etcdmain c552f11bfe helper document update. 5 years ago
etcdserver 6e15f11fd9 etcdserver: add "etcd_server_read_indexes_failed_total" 6 years ago
functional 21e7a30d31 functional/tester: remove Txn stresser in 3.2 6 years ago
hack f8fc817ce8 *: remove unused env vars 6 years ago
integration ba4a7e004b integration: test client-side TLS cipher suites 6 years ago
lease 6e5e3d134e *: enforce max lease TTL with 9,000,000,000 seconds 6 years ago
logos d375b67a50 logos: add SVG and PNG logos 10 years ago
mvcc 948c284235 mvcc: add store revision metrics 5 years ago
pkg ab1f4fec07 etcdserver: add unit test. 5 years ago
proxy ada4af3b2a grpcproxy: fix memory leak 6 years ago
raft eb1589ad35 *: regenerate proto 7 years ago
rafthttp b6d11019e0 rafthttp: probe all raft transports 6 years ago
scripts c7e4e50879 scripts: remove "ACI" builds 5 years ago
snap 8f1d366c0e etcdserver/api/snap: add v3 snapshot fsync metrics 6 years ago
snapshot 244b3b3d3c snapshot: remove tests 6 years ago
store 978cf804ca store: replace testify asserts with testutil asserts 7 years ago
tests 360484a3f0 tests: update test scripts 6 years ago
version bdd97d5ffa version: 3.2.27 5 years ago
wal 78a5eb79b5 *: add swagger and grpc-gateway assets for v3lock and v3election 7 years ago
.dockerignore f734ba9974 Add .dockerignore to avoid including .git in docker build context 10 years ago
.gitignore 4ed57689cb gitignore: sync with master branch 7 years ago
.godir 03bacc1984 create .godir 10 years ago
.header 71e6c4b06a .header: update to 'etcd Authors' 8 years ago
.travis.yml 360484a3f0 tests: update test scripts 6 years ago
CONTRIBUTING.md c8a2c7f64f *: eschew you from documentation 7 years ago
DCO fd9ad4fa2c docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 10 years ago
Dockerfile 8a71f749d7 *: separate Dockerfile for quay build trigger 8 years ago
Dockerfile-release b9d91483d0 Dockerfile-release: add nsswitch.conf into image 7 years ago
Dockerfile-release.arm64 0c8988aa07 build-docker: Updates for multi-arch release 7 years ago
Dockerfile-release.ppc64le 0c8988aa07 build-docker: Updates for multi-arch release 7 years ago
Dockerfile-test 52be1d7b19 hack/scripts-dev: add Makefile, Dockerfile-test 7 years ago
LICENSE 3381177341 License project under the Apache License Version 2.0 11 years ago
MAINTAINERS 9d74eb5c60 MAINTAINERS: add Fanmin 7 years ago
Makefile b5dc2266a6 Makefile: update 6 years ago
NEWS 2511535ea0 NEWS: update v3.1.6 7 years ago
NOTICE 054de85da2 feat(*): initial commit 11 years ago
Procfile 3351ea1ae2 Procfile: v3 as default 8 years ago
README.md 25eef5a6e4 Merge pull request #7893 from philips/readme-tagline 7 years ago
ROADMAP.md 83efd2c745 ROADMAP: make 'release-3.2' stable branch 7 years ago
V2Procfile 3351ea1ae2 Procfile: v3 as default 8 years ago
bill-of-materials.json 8de0c0419a vendor: Switch from boltdb v1.3.0 to coreos/bbolt v1.3.1-coreos.3 7 years ago
bill-of-materials.override.json 959d55ae80 bill-of-materials: regenerate with multi licenses 7 years ago
build 743192aa3b *: clear rarer shellcheck errors on scripts 7 years ago
build.bat b1d41016b2 vendor: only vendor on emitted binaries 8 years ago
build.ps1 751a8d5b04 build: add option to enable binaries stripping for windows 8 years ago
cover 1239e1ce6f test, scripts: use /usr/bin/env to find bash 9 years ago
etcd.conf.yml.sample fa0f278783 embed: add 'enable-pprof' tag for config file 7 years ago
functional.yaml 4e11cea8cb functional: disable auto TLS 6 years ago
glide.lock 8f59849ca2 vendor: add "gogo/protobuf/gogoproto" 6 years ago
glide.yaml a43ae13106 cmd/vendor: add "go.uber.org/zap" 6 years ago
main.go ef44f71da9 *: update LICENSE header 8 years ago
main_test.go 7e05b33aa0 *: remove os.Kill from signal.Notify 7 years ago
test 3b770ee8b4 test: set up gopath in 3.2 6 years ago

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