copy of etcd repository
 
 
 
 
 
 
Go to file
Benjamin Wang 66553d4f07
Merge pull request #16090 from tjungblu/changelog_leaseput
update change logs with lease put improvements
2023-06-21 13:23:16 +01:00
.devcontainer Add initial .devcontainer for go.19. 2023-03-03 07:03:25 +13:00
.github build(deps): bump github/codeql-action from 2.3.6 to 2.20.0 2023-06-19 18:01:17 +00:00
CHANGELOG update change logs with lease put improvements 2023-06-21 12:18:20 +02:00
Documentation Document new arm64 infra process. 2023-06-17 21:01:55 +12:00
api dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
client dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
contrib ci: add fix-yamllint rule in Makefile 2023-06-01 09:06:36 +08:00
etcdctl dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
etcdutl dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
hack ci: Introduce yamllint for actions workflow files 2023-05-26 16:34:23 +08:00
logos Incorporate xkcd dependency meme into README 2023-04-25 14:49:50 +02:00
pkg dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
scripts Ensure goimports can be fixed individually. 2023-06-16 21:47:46 +12:00
security Update PSC members 2022-12-07 17:59:19 -05:00
server dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
tests Merge pull request #16115 from serathius/robustness-kubernetes-tune 2023-06-20 11:16:02 +02:00
tools dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
.gitignore etcd-dump-logs: Fix order of imports.. 2022-12-30 09:22:39 +01:00
.go-version Update the go version to 1.19.10 patch release. 2023-06-07 14:02:18 +12:00
.header .header: update to 'etcd Authors' 2016-05-12 20:56:50 -07:00
ADOPTERS.md doc: move production users to a standard ADOPTERS file 2019-10-17 18:36:28 -04:00
CONTRIBUTING.md Move to community membership model closer to kubernetes one 2023-04-03 16:42:01 +02: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 Consolidate etcd dockerfiles. 2023-04-26 17:09:25 +12:00
GOVERNANCE.md Move to community membership model closer to kubernetes one 2023-04-03 16:42:01 +02:00
LICENSE License project under the Apache License Version 2.0 2013-07-31 17:39:03 +00:00
MAINTAINERS Update roles reference 2023-05-30 17:34:18 -04:00
Makefile Ensure goimports can be fixed individually. 2023-06-16 21:47:46 +12:00
Procfile remove Procfile.v2 and Procfile.learner 2023-06-09 18:37:09 +05:30
README.md Promote faqs in README.md. 2023-06-05 21:32:28 +12:00
bill-of-materials.json migrate auth tests to common #7 2023-03-27 19:30:41 -07:00
bill-of-materials.override.json etcd: Replace ghodss/yaml with sigs.k8s.io/yaml 2019-05-02 12:34:36 +05:30
code-of-conduct.md *: update project code of conduct 2019-09-18 14:09:18 -04:00
codecov.yml ci: Introduce yamllint for actions workflow files 2023-05-26 16:34:23 +08:00
dummy.go Split etcdctl into etcdctl (public API access) & etcdutl (direct surgery on files) 2021-05-17 11:54:03 +02:00
etcd.conf.yml.sample Add example format for initial-cluster. 2023-05-23 21:15:38 +12:00
go.mod dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00
go.sum dependency: bump golang.org/x/net from 0.10.0 to 0.11.0 2023-06-19 09:25:07 +01:00

README.md

etcd

Go Report Card Coverage Tests codeql-analysis Docs Godoc Releases LICENSE OpenSSF Scorecard

Note: The main branch may be in an unstable or even broken state during development. For stable versions, see releases.

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 robustness testing.

See etcdctl for a simple command line client.

etcd reliability is important

Original image credited to xkcd.com/2347, alterations by Josh Berkus.

Maintainers

MAINTAINERS strive to shape an inclusive open source project culture where users are heard and contributors feel respected and empowered. MAINTAINERS maintain productive relationships across different companies and disciplines. Read more about MAINTAINERS role and responsibilities.

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.

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

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

Install etcd client v3

go get go.etcd.io/etcd/client/v3

Next steps

Now it's time to dig into the full etcd API and other guides.

Contact

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.

Meeting recordings are uploaded to official etcd YouTube channel.

Get calendar invitation by joining etcd-dev mailing group.

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

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

Contributing

See CONTRIBUTING for details on setting up your development environment, submitting patches and the contribution workflow.

Please refer to community-membership.md for information on becoming an etcd project member. We welcome and look forward to your contributions to the project!

Reporting bugs

See reporting bugs for details about reporting any issues. Before opening an issue please check it is not covered in our frequently asked questions.

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
  • Brandon Philips
  • Joe Betz
  • Gyuho Lee
  • Jingyi Hu
  • Wenjia Zhang
  • Xiang Li
  • Ben Darnell
  • Sam Batschelet

License

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