README
¶
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 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, fleet, locksmith, vulcand, Doorman, and many others. Reliability is further ensured by rigorous testing.
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, 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.
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 now running and serving client requests. For more
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.
Running etcd on Kubernetes
If you want to run etcd cluster on Kubernetes, try etcd operator.
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.
License
etcd is under the Apache 2.0 license. See the LICENSE file for details.
Documentation
¶
Overview ¶
Package main is a simple wrapper of the real etcd entrypoint package (located at etcd/etcdmain) to ensure that etcd is still "go getable"; e.g. `go get etcd` works as expected and builds a binary in $GOBIN/etcd
This package should NOT be extended or modified in any way; to modify the etcd binary, work in the `etcd/etcdmain` package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package alarm manages health status alarms in etcd.
|
Package alarm manages health status alarms in etcd. |
|
Package auth provides client role authentication for accessing keys in etcd.
|
Package auth provides client role authentication for accessing keys in etcd. |
|
authpb
Package authpb is a generated protocol buffer package.
|
Package authpb is a generated protocol buffer package. |
|
Package client provides bindings for the etcd APIs.
|
Package client provides bindings for the etcd APIs. |
|
integration
Package integration implements tests built upon embedded etcd, focusing on the correctness of the etcd v2 client.
|
Package integration implements tests built upon embedded etcd, focusing on the correctness of the etcd v2 client. |
|
Package clientv3 implements the official Go etcd client for v3.
|
Package clientv3 implements the official Go etcd client for v3. |
|
concurrency
Package concurrency implements concurrency operations on top of etcd such as distributed locks, barriers, and elections.
|
Package concurrency implements concurrency operations on top of etcd such as distributed locks, barriers, and elections. |
|
integration
Package integration implements tests built upon embedded etcd, and focuses on correctness of etcd client.
|
Package integration implements tests built upon embedded etcd, and focuses on correctness of etcd client. |
|
mirror
Package mirror implements etcd mirroring operations.
|
Package mirror implements etcd mirroring operations. |
|
Package compactor implements automated policies for compacting etcd's mvcc storage.
|
Package compactor implements automated policies for compacting etcd's mvcc storage. |
|
contrib
|
|
|
raftexample
raftexample is a simple KV store using the raft and rafthttp libraries.
|
raftexample is a simple KV store using the raft and rafthttp libraries. |
|
Package discovery provides an implementation of the cluster discovery that is used by etcd.
|
Package discovery provides an implementation of the cluster discovery that is used by etcd. |
|
Package e2e implements tests built upon etcd binaries, and focus on end-to-end testing.
|
Package e2e implements tests built upon etcd binaries, and focus on end-to-end testing. |
|
Package embed provides bindings for embedding an etcd server in a program.
|
Package embed provides bindings for embedding an etcd server in a program. |
|
Package error describes errors in etcd project.
|
Package error describes errors in etcd project. |
|
etcdctl is a command line application that controls etcd.
|
etcdctl is a command line application that controls etcd. |
|
ctlv2
Package ctlv2 contains the main entry point for the etcdctl for v2 API.
|
Package ctlv2 contains the main entry point for the etcdctl for v2 API. |
|
ctlv2/command
Package command is a set of libraries for etcdctl commands.
|
Package command is a set of libraries for etcdctl commands. |
|
ctlv3
Package ctlv3 contains the main entry point for the etcdctl for v3 API.
|
Package ctlv3 contains the main entry point for the etcdctl for v3 API. |
|
ctlv3/command
Package command is a set of libraries for etcd v3 commands.
|
Package command is a set of libraries for etcd v3 commands. |
|
Package etcdmain contains the main entry point for the etcd binary.
|
Package etcdmain contains the main entry point for the etcd binary. |
|
Package etcdserver defines how etcd servers interact and store their states.
|
Package etcdserver defines how etcd servers interact and store their states. |
|
api
Package api manages the capabilities and features that are exposed to clients by the etcd cluster.
|
Package api manages the capabilities and features that are exposed to clients by the etcd cluster. |
|
api/v2http
Package v2http provides etcd client and server implementations.
|
Package v2http provides etcd client and server implementations. |
|
api/v2http/httptypes
Package httptypes defines how etcd's HTTP API entities are serialized to and deserialized from JSON.
|
Package httptypes defines how etcd's HTTP API entities are serialized to and deserialized from JSON. |
|
api/v3rpc
Package v3rpc implements etcd v3 RPC system based on gRPC.
|
Package v3rpc implements etcd v3 RPC system based on gRPC. |
|
api/v3rpc/rpctypes
Package rpctypes has types and values shared by the etcd server and client for v3 RPC interaction.
|
Package rpctypes has types and values shared by the etcd server and client for v3 RPC interaction. |
|
auth
Package auth implements etcd authentication.
|
Package auth implements etcd authentication. |
|
etcdserverpb
Package etcdserverpb is a generated protocol buffer package.
|
Package etcdserverpb is a generated protocol buffer package. |
|
stats
Package stats defines a standard interface for etcd cluster statistics.
|
Package stats defines a standard interface for etcd cluster statistics. |
|
Package integration implements tests built upon embedded etcd, and focus on etcd correctness.
|
Package integration implements tests built upon embedded etcd, and focus on etcd correctness. |
|
Package lease provides an interface and implemetation for time-limited leases over arbitrary resources.
|
Package lease provides an interface and implemetation for time-limited leases over arbitrary resources. |
|
leasehttp
Package leasehttp serves lease renewals made through HTTP requests.
|
Package leasehttp serves lease renewals made through HTTP requests. |
|
leasepb
Package leasepb is a generated protocol buffer package.
|
Package leasepb is a generated protocol buffer package. |
|
Package mvcc defines etcd's stable MVCC storage.
|
Package mvcc defines etcd's stable MVCC storage. |
|
backend
Package backend defines a standard interface for etcd's backend MVCC storage.
|
Package backend defines a standard interface for etcd's backend MVCC storage. |
|
mvccpb
Package mvccpb is a generated protocol buffer package.
|
Package mvccpb is a generated protocol buffer package. |
|
pkg
|
|
|
adt
Package adt implements useful abstract data types.
|
Package adt implements useful abstract data types. |
|
contention
Package contention provides facilities for detecting system contention.
|
Package contention provides facilities for detecting system contention. |
|
cors
Package cors handles cross-origin HTTP requests (CORS).
|
Package cors handles cross-origin HTTP requests (CORS). |
|
cpuutil
Package cpuutil provides facilities for detecting cpu-specific features.
|
Package cpuutil provides facilities for detecting cpu-specific features. |
|
crc
Package crc provides utility function for cyclic redundancy check algorithms.
|
Package crc provides utility function for cyclic redundancy check algorithms. |
|
expect
Package expect implements a small expect-style interface
|
Package expect implements a small expect-style interface |
|
fileutil
Package fileutil implements utility functions related to files and paths.
|
Package fileutil implements utility functions related to files and paths. |
|
flags
Package flags implements command-line flag parsing.
|
Package flags implements command-line flag parsing. |
|
httputil
Package httputil provides HTTP utility functions.
|
Package httputil provides HTTP utility functions. |
|
idutil
Package idutil implements utility functions for generating unique, randomized ids.
|
Package idutil implements utility functions for generating unique, randomized ids. |
|
ioutil
Package ioutil implements I/O utility functions.
|
Package ioutil implements I/O utility functions. |
|
logutil
Package logutil includes utilities to facilitate logging.
|
Package logutil includes utilities to facilitate logging. |
|
mock/mockstorage
Package mockstorage provides mock implementations for etcdserver's storage interface.
|
Package mockstorage provides mock implementations for etcdserver's storage interface. |
|
mock/mockstore
Package mockstore provides mock structures for the etcd store package.
|
Package mockstore provides mock structures for the etcd store package. |
|
mock/mockwait
Package mockwait provides mock implementations for pkg/wait.
|
Package mockwait provides mock implementations for pkg/wait. |
|
monotime
Package monotime provides a fast monotonic clock source.
|
Package monotime provides a fast monotonic clock source. |
|
netutil
Package netutil implements network-related utility functions.
|
Package netutil implements network-related utility functions. |
|
osutil
Package osutil implements operating system-related utility functions.
|
Package osutil implements operating system-related utility functions. |
|
pathutil
Package pathutil implements utility functions for handling slash-separated paths.
|
Package pathutil implements utility functions for handling slash-separated paths. |
|
pbutil
Package pbutil defines interfaces for handling Protocol Buffer objects.
|
Package pbutil defines interfaces for handling Protocol Buffer objects. |
|
report
Package report generates human-readable benchmark reports.
|
Package report generates human-readable benchmark reports. |
|
runtime
Package runtime implements utility functions for runtime systems.
|
Package runtime implements utility functions for runtime systems. |
|
schedule
Package schedule provides mechanisms and policies for scheduling units of work.
|
Package schedule provides mechanisms and policies for scheduling units of work. |
|
testutil
Package testutil provides test utility functions.
|
Package testutil provides test utility functions. |
|
tlsutil
Package tlsutil provides utility functions for handling TLS.
|
Package tlsutil provides utility functions for handling TLS. |
|
transport
Package transport implements various HTTP transport utilities based on Go net package.
|
Package transport implements various HTTP transport utilities based on Go net package. |
|
types
Package types declares various data types and implements type-checking functions.
|
Package types declares various data types and implements type-checking functions. |
|
wait
Package wait provides utility functions for polling, listening using Go channel.
|
Package wait provides utility functions for polling, listening using Go channel. |
|
proxy
|
|
|
grpcproxy
Package grpcproxy is an OSI level 7 proxy for etcd v3 API requests.
|
Package grpcproxy is an OSI level 7 proxy for etcd v3 API requests. |
|
httpproxy
Package httpproxy implements etcd httpproxy.
|
Package httpproxy implements etcd httpproxy. |
|
tcpproxy
Package tcpproxy is an OSI level 4 proxy for routing etcd clients to etcd servers.
|
Package tcpproxy is an OSI level 4 proxy for routing etcd clients to etcd servers. |
|
Package raft sends and receives messages in the Protocol Buffer format defined in the raftpb package.
|
Package raft sends and receives messages in the Protocol Buffer format defined in the raftpb package. |
|
raftpb
Package raftpb is a generated protocol buffer package.
|
Package raftpb is a generated protocol buffer package. |
|
rafttest
Package rafttest provides functional tests for etcd's raft implementation.
|
Package rafttest provides functional tests for etcd's raft implementation. |
|
Package rafthttp implements HTTP transportation layer for etcd/raft pkg.
|
Package rafthttp implements HTTP transportation layer for etcd/raft pkg. |
|
Package snap stores raft nodes' states with snapshots.
|
Package snap stores raft nodes' states with snapshots. |
|
snappb
Package snappb is a generated protocol buffer package.
|
Package snappb is a generated protocol buffer package. |
|
Package store defines etcd's in-memory key/value store.
|
Package store defines etcd's in-memory key/value store. |
|
tools
|
|
|
benchmark
benchmark is a program for benchmarking etcd v3 API performance.
|
benchmark is a program for benchmarking etcd v3 API performance. |
|
benchmark/cmd
Package cmd implements individual benchmark commands for the benchmark utility.
|
Package cmd implements individual benchmark commands for the benchmark utility. |
|
etcd-dump-db
etcd-dump-db inspects etcd db files.
|
etcd-dump-db inspects etcd db files. |
|
etcd-dump-logs
etcd-dump-logs is a program for analyzing etcd server write ahead logs.
|
etcd-dump-logs is a program for analyzing etcd server write ahead logs. |
|
functional-tester/etcd-agent
etcd-agent is a daemon for controlling an etcd process via HTTP RPC.
|
etcd-agent is a daemon for controlling an etcd process via HTTP RPC. |
|
functional-tester/etcd-agent/client
Package client provides a client implementation to control an etcd-agent.
|
Package client provides a client implementation to control an etcd-agent. |
|
functional-tester/etcd-runner
etcd-runner is a program for testing etcd clientv3 features against a fault injected cluster.
|
etcd-runner is a program for testing etcd clientv3 features against a fault injected cluster. |
|
functional-tester/etcd-tester
etcd-tester is a single controller for all etcd-agents to manage an etcd cluster and simulate failures.
|
etcd-tester is a single controller for all etcd-agents to manage an etcd cluster and simulate failures. |
|
local-tester/bridge
Package main is the entry point for the local tester network bridge.
|
Package main is the entry point for the local tester network bridge. |
|
Package version implements etcd version parsing and contains latest version information.
|
Package version implements etcd version parsing and contains latest version information. |
|
Package wal provides an implementation of a write ahead log that is used by etcd.
|
Package wal provides an implementation of a write ahead log that is used by etcd. |
|
walpb
Package walpb is a generated protocol buffer package.
|
Package walpb is a generated protocol buffer package. |
Click to show internal directories.
Click to hide internal directories.