Gyuho Lee e13c8942c3 Merge pull request #10795 from jingyih/automated-cherry-pick-of-#10788-origin-release-3.1 | 5 years ago | |
---|---|---|
.github | 8 years ago | |
Documentation | 5 years ago | |
alarm | 8 years ago | |
auth | 7 years ago | |
client | 7 years ago | |
clientv3 | 6 years ago | |
cmd | 7 years ago | |
compactor | 8 years ago | |
contrib | 8 years ago | |
discovery | 7 years ago | |
e2e | 7 years ago | |
embed | 6 years ago | |
error | 8 years ago | |
etcdctl | 5 years ago | |
etcdmain | 6 years ago | |
etcdserver | 6 years ago | |
hack | 6 years ago | |
integration | 6 years ago | |
lease | 7 years ago | |
logos | 10 years ago | |
mvcc | 5 years ago | |
pkg | 6 years ago | |
proxy | 7 years ago | |
raft | 7 years ago | |
rafthttp | 6 years ago | |
scripts | 7 years ago | |
snap | 6 years ago | |
store | 8 years ago | |
tests | 6 years ago | |
tools | 6 years ago | |
version | 6 years ago | |
wal | 7 years ago | |
.dockerignore | 10 years ago | |
.gitignore | 8 years ago | |
.godir | 10 years ago | |
.header | 8 years ago | |
.travis.yml | 6 years ago | |
CONTRIBUTING.md | 8 years ago | |
DCO | 10 years ago | |
Dockerfile | 8 years ago | |
Dockerfile-release | 7 years ago | |
Dockerfile-test | 7 years ago | |
LICENSE | 11 years ago | |
MAINTAINERS | 8 years ago | |
Makefile | 6 years ago | |
NEWS | 8 years ago | |
NOTICE | 11 years ago | |
Procfile | 8 years ago | |
README.md | 7 years ago | |
ROADMAP.md | 8 years ago | |
V2Procfile | 8 years ago | |
build | 8 years ago | |
build.bat | 8 years ago | |
build.ps1 | 8 years ago | |
cover | 9 years ago | |
etcd.conf.yml.sample | 8 years ago | |
glide.lock | 7 years ago | |
glide.yaml | 7 years ago | |
main.go | 8 years ago | |
test | 6 years ago |
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 is a distributed, consistent key-value store for shared configuration and service discovery, with a focus on being:
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.
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, you can build the latest version of etcd from the master
branch.
You will first need Go installed on your machine (version 1.7+ 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.
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
The official etcd ports are 2379 for client requests, and 2380 for peer communication.
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.
If you want to run etcd cluster on Kubernetes, try etcd operator.
Now it's time to dig into the full etcd API and other guides.
See CONTRIBUTING for details on submitting patches and the contribution workflow.
See reporting bugs for details about reporting any issue you may encounter.
etcd is under the Apache 2.0 license. See the LICENSE file for details.