etcd with a fix
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Vitaliy Filippov 5c726cfe25 etcdserver: Fix 64 KB websocket notification message limit 3 months ago
.github github: workflows: add asset-transparency release action 5 months ago
Documentation *: Execution of ./scripts/genproto.sh after versions change 3 months ago
api *: Refresh of dependencies (#12399) 3 months ago
auth pkg: Rename imports after making 'pkg' a module 3 months ago
client *: Refresh of dependencies (#12399) 3 months ago
clientv3 pkg: Rename imports after making 'pkg' a module 3 months ago
contrib pkg: Rename imports after making 'pkg' a module 3 months ago
embed etcdserver: Fix 64 KB websocket notification message limit 3 months ago
etcdctl client: Move client to client/v2 as a module. 3 months ago
etcdmain pkg: Rename imports after making 'pkg' a module 3 months ago
etcdserver client: Move client to client/v2 as a module. 3 months ago
hack grpcproxy: make grpc keep alive related options configurable (#11711) 9 months ago
lease *: Execution of ./scripts/genproto.sh after versions change 3 months ago
logos logos: add SVG and PNG logos 6 years ago
mvcc pkg: Rename imports after making 'pkg' a module 3 months ago
pkg *: Refresh of dependencies (#12399) 3 months ago
proxy pkg: Rename imports after making 'pkg' a module 3 months ago
raft *: Refresh of dependencies (#12399) 3 months ago
scripts client: Move client to client/v2 as a module. 3 months ago
security CHANGELOG: update with added audit report 5 months ago
server/mock pkg: Rename imports after making 'pkg' a module 3 months ago
tests *: Refresh of dependencies (#12399) 3 months ago
tools *: Refresh of dependencies (#12399) 3 months ago
wal *: Execution of ./scripts/genproto.sh after versions change 3 months ago
.gitignore script/genproto.sh: Refactor to be explicit about versions. 3 months ago
.header .header: update to 'etcd Authors' 4 years ago
.travis.yml go.mod,tests: Update go.mod for tests and . to reflect new dependencies. 3 months ago
.words clientv3: Expose clientv3/examples close to the code. 3 months ago
ADOPTERS.md doc: move production users to a standard ADOPTERS file 1 year ago
CHANGELOG-2.3.md CHANGELOG: add "raft unbounded log growth prevention" PR 2 years ago
CHANGELOG-3.0.md CHANGELOG: update with latest changes, make language consistent 1 year ago
CHANGELOG-3.1.md CHANGELOG: update with patch release 1 year ago
CHANGELOG-3.2.md CHANGELOG: update release-3.2 dates 5 months ago
CHANGELOG-3.3.md CHANGELOG: file perm updates in 3.4 and 3.3 5 months ago
CHANGELOG-3.4.md CHANGELOG: update from 12288 and 12299 4 months ago
CHANGELOG-3.5.md client: Move client to client/v2 as a module. 3 months ago
CHANGELOG-4.0.md CHANGELOG: update recommended versions (#11520) 1 year ago
CONTRIBUTING.md contributing: invalid link to "reporting-bugs" 11 months ago
DCO docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 6 years ago
Dockerfile-release fix(Dockerfile-release): from image was missing image name 8 months ago
Dockerfile-release.arm64 chore(Dockerfile-release): Update base image to use new debian-base:v2.1.0 (#11885) 8 months ago
Dockerfile-release.ppc64le chore(Dockerfile-release): Update base image to use new debian-base:v2.1.0 (#11885) 8 months ago
Dockerfile-release.s390x chore(Dockerfile-release): Update base image to use new debian-base:v2.1.0 (#11885) 8 months ago
GOVERNANCE.md *: create project governance 1 year ago
LICENSE License project under the Apache License Version 2.0 7 years ago
MAINTAINERS MAINTAINERS: update @philips email 9 months ago
Makefile tests: Move functional tests to 'tests' module. 3 months ago
Procfile Procfiles: Added Comments To Procfiles 1 year ago
Procfile.learner Procfiles: Added Comments To Procfiles 1 year ago
Procfile.v2 Procfiles: Added Comments To Procfiles 1 year ago
README.md README: Fixed the link to test dir 3 months ago
ROADMAP.md *: change roadmap, future release dates 2 years ago
bill-of-materials.json *: Refresh of dependencies (#12399) 3 months ago
bill-of-materials.override.json etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 1 year ago
build tools: Migrate remaining tools to gobin 3 months ago
build.bat vendor: only vendor on emitted binaries 4 years ago
build.ps1 build.ps1: update import paths to "go.etcd.io/etcd" 2 years ago
build.sh tools: Migrate remaining tools to gobin 3 months ago
code-of-conduct.md *: update project code of conduct 1 year ago
etcd.conf.yml.sample sample: correct directive name 2 years ago
go.mod *: Refresh of dependencies (#12399) 3 months ago
go.sum *: Refresh of dependencies (#12399) 3 months ago
main.go tests/e2e,etcdctl,etcdmain: Fix go test --tags cov -v ./tests/e2e 4 months ago
main_test.go tests/e2e,etcdctl,etcdmain: Fix go test --tags cov -v ./tests/e2e 4 months ago
test *: Refresh of dependencies (#12399) 3 months ago
test.sh tools: Migrate remaining tools to gobin 3 months ago

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

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