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 is a distributed, consistent key-value store for shared configuration and service discovery, with a focus on being:
- Simple: curl'able user-facing API (HTTP+JSON)
- Secure: optional SSL client cert authentication
- Fast: benchmarked 1000s of writes/s per instance
- 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, and many others.
See etcdctl for a simple command line client.
Or feel free to just use curl, as in the examples below.
The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, AppC (ACI), 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.5+ 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/etcdThis 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:
curl -L http://127.0.0.1:2379/v2/keys/mykey -XPUT -d value="this is awesome"
curl -L http://127.0.0.1:2379/v2/keys/mykey
You have successfully started an etcd and written a key to the store.
The official etcd ports are 2379 for client requests, and 2380 for peer communication. To maintain compatibility, some etcd configuration and documentation continues to refer to the legacy ports 4001 and 7001, but all new etcd use and discussion should adopt the IANA-assigned ports. The legacy ports 4001 and 7001 will be fully deprecated, and support for their use removed, in future etcd releases.
First install goreman, which manages Procfile-based applications.
Our Procfile script will set up a local example cluster. You can start it with:
goreman startThis will bring up 3 etcd members infra1, infra2 and infra3 and etcd proxy proxy, which runs locally and composes a cluster.
You can write a key to the cluster and retrieve the value back from any member or proxy.
Now it's time to dig into the full etcd API and other guides.
- Explore the full API.
- Set up a multi-machine cluster.
- Learn the config format, env variables and flags.
- Find language bindings and tools.
- Use TLS to secure an etcd cluster.
- Tune etcd.
- Upgrade from 0.4.9+ to 2.2.0.
- Mailing list: etcd-dev
- IRC: #etcd on freenode.org
- Planning/Roadmap: milestones, roadmap
- Bugs: issues
See CONTRIBUTING for details on submitting patches and the contribution workflow.
See reporting bugs for details about reporting any issue you may encounter.
etcd uses semantic versioning New minor versions may add additional features to the API.
You can get the version of etcd by issuing a request to /version:
curl -L http://127.0.0.1:2379/versionThe v2 API responses should not change after the 2.0.0 release but new features will be added over time.
etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #358 for more information.
To avoid inadvertantly running a possibly unstable etcd server, etcd on unsupported architectures will print
a warning message and immediately exit if the environment variable ETCD_UNSUPPORTED_ARCH is not set to
the target architecture.
Currently only the amd64 architecture is officially supported by etcd.
etcd is under the Apache 2.0 license. See the LICENSE file for details.