6259318521
This commit adds a functionality of attaching an auth token to gRPC connection as a per RPC credential. For doing this, this commit lets clientv3.Client.Dial() create a dedicated gRPC connection for doing authentication. With the dedicated connection, the client calls Authenticate() RPC and obtain its token. The token is attached to the main gRPC connection with grpc.WithPerRPCCredentials(). This commit also adds a new option --username to etcdctl (v3). With this option, etcdctl attaches its auth token to the main gRPC connection (currently it is not used at all).
etcd
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:
- Simple: well-defined, user-facing API (gRPC)
- Secure: automatic TLS with optional 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.
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, 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.
Running etcd
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 running and serving keys.
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 proxy 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.
- Read the full documentation.
- Explore the full gRPC 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.
Contact
- Mailing list: etcd-dev
- IRC: #etcd on freenode.org
- Planning/Roadmap: milestones, roadmap
- Bugs: issues
Contributing
See CONTRIBUTING for details on submitting patches and the contribution workflow.
Reporting bugs
See reporting bugs for details about reporting any issue you may encounter.
Project details
Versioning
Service versioning
etcd uses semantic versioning New minor versions may add additional features to the API.
Get the running etcd cluster version with etcdctl:
ETCDCTL_API=3 etcdctl --endpoints=127.0.0.1:2379 endpoint status
API versioning
The v3 API responses should not change after the 3.0.0 release but new features will be added over time.
32-bit and other unsupported systems
etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #358 for more information.
To avoid inadvertently 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.
License
etcd is under the Apache 2.0 license. See the LICENSE file for details.