copy of etcd repository
 
 
 
 
 
 
Go to file
Max Lowther 9ab3572662 Doc: Fix typo in revision.go 2019-05-16 14:29:10 +01:00
.github *: update github.com links 2018-08-28 17:47:56 -07:00
Documentation Documentation: provide better user experience with autorefreshing grafana dashboard 2019-05-08 06:58:28 -04:00
auth go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
client Merge pull request #10666 from mkumatag/fix_tests 2019-05-03 11:18:58 -07:00
clientv3 etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
contrib go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
docs docs: update PyYAML to 4.2b1 2019-03-07 11:14:10 -08:00
embed etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
etcdctl go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
etcdmain etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
etcdserver etcdserver: fix typo in log message 2019-05-10 09:54:00 -04:00
functional go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
hack *: update github.com links 2018-08-28 17:47:56 -07:00
integration go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
lease go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
logos logos: add SVG and PNG logos 2014-12-18 14:59:06 -08:00
mvcc Doc: Fix typo in revision.go 2019-05-16 14:29:10 +01:00
pkg go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
proxy go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
raft raft: update raft paper link (previous link deprecated) 2019-05-03 08:50:16 -07:00
scripts scripts: Remove generated code and script 2019-04-23 16:54:44 -04:00
tests go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
tools go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
vendor etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
version *: revert "internal/version" change 2018-02-26 17:11:40 -08:00
wal wal: add a test for wal cleanup, improve comments 2019-05-10 22:36:26 +01:00
.gitignore gitignore: ignore build result and runtime files 2019-01-01 19:14:48 +08:00
.header .header: update to 'etcd Authors' 2016-05-12 20:56:50 -07:00
.travis.yml go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
.words words: whitelist unfreed 2018-10-03 18:12:10 -07:00
CHANGELOG-2.3.md CHANGELOG: add "raft unbounded log growth prevention" PR 2018-10-24 15:55:08 -07:00
CHANGELOG-3.0.md CHANGELOG: add "raft unbounded log growth prevention" PR 2018-10-24 15:55:08 -07:00
CHANGELOG-3.1.md CHANGELOG: remove mailing list reference 2019-05-11 09:24:41 -04:00
CHANGELOG-3.2.md CHANGELOG: remove mailing list reference 2019-05-11 09:24:41 -04:00
CHANGELOG-3.3.md CHANGELOG: remove mailing list reference 2019-05-11 09:24:41 -04:00
CHANGELOG-3.4.md CHANGELOG: update 2019-05-02 10:21:37 -07:00
CHANGELOG-3.5.md CHANGELOG: add "raft unbounded log growth prevention" PR 2018-10-24 15:55:08 -07:00
CHANGELOG-4.0.md CHANGELOG: add "raft unbounded log growth prevention" PR 2018-10-24 15:55:08 -07:00
CONTRIBUTING.md CONTRIBUTING: clarify commit message style 2019-01-18 13:00:24 -05:00
DCO docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 2014-04-04 10:58:34 -07:00
Dockerfile-release Dockerfile-release: add nsswitch.conf into image 2017-03-21 13:08:42 +02:00
Dockerfile-release.arm64 build-docker: Updates for multi-arch release 2017-04-21 10:04:41 -07:00
Dockerfile-release.ppc64le build-docker: Change baseimage for ppc64le dockerfile 2018-03-20 04:34:46 -04:00
LICENSE feat(*): initial commit 2014-01-19 12:25:11 -08:00
MAINTAINERS MAINTAINERS: add Sam Batschelet 2018-11-19 19:43:15 -05:00
MAINTAINERS_RULES.md MAINTAINERS: add "MAINTAINERS_RULES" and second email 2018-01-30 14:05:47 -08:00
Makefile build: stop using ETCDCTL_API=3 2019-01-14 14:46:16 +00:00
NOTICE feat(*): initial commit 2014-01-19 12:25:11 -08:00
OWNERS OWNERS: add hexfusion as approver and remove joelegasse 2019-01-21 10:52:34 -05:00
Procfile *: use "--logger=zap" for Procfile 2018-05-17 02:22:34 -07:00
Procfile.v2 Documentation/v2: add Procfile.v2 for proxy 2017-10-03 09:22:31 -07:00
README.md README: stop using ETCDCTL_API=3 2019-01-14 12:38:37 +00:00
ROADMAP.md *: change roadmap, future release dates 2018-10-01 01:04:24 -07:00
bill-of-materials.json etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
bill-of-materials.override.json etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
build go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
build.bat vendor: only vendor on emitted binaries 2016-04-05 21:01:16 -07:00
build.ps1 build.ps1: update import paths to "go.etcd.io/etcd" 2018-08-28 17:47:55 -07:00
code-of-conduct.md CODE_OF_CONDUCT: update CoC 2018-01-04 22:44:07 +00:00
etcd.conf.yml.sample sample: correct directive name 2018-08-16 22:25:16 +09:00
functional.yaml *: path changes for moving to github/etcd-io/etcd 2018-09-03 21:57:23 +05:30
go.mod etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
go.sum etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
main.go go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
main_test.go go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00
test go modules: Fix module path version to include version number 2019-04-26 15:29:50 -07:00

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.