README
¶
etcd
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.
See etcdctl for a simple command line client. Or feel free to just use curl, as in the examples below.
If you're considering etcd for production use, please see: production-ready.md
Getting Started
Getting etcd
The easiest way to get etcd is to install one of the pre-built binaries from the tagged releases: instructions are available on GitHub.
For those wanting to try the very latest version, you can build the latest version of etcd from the master branch.
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:
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.
Running local etcd cluster
First install goreman, which manages Procfile-based applications.
Our Procfile script will set up a local example cluster. You can 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.
You can write a key to the cluster and retrieve the value back from any member or proxy.
Next Steps
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.
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.
You can get the version of etcd by issuing a request to /version:
curl -L http://127.0.0.1:2379/version
API Versioning
The v2 API responses should not change after the 2.0.0 release but new features will be added over time.
32-bit systems
etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #358 for more information.
License
etcd is under the Apache 2.0 license. See the LICENSE file for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/bitbucket.org/ww/goautoneg
HTTP Content-Type Autonegotiation.
|
HTTP Content-Type Autonegotiation. |
|
_workspace/src/github.com/akrennmair/gopcap
Interface to both live and offline pcap parsing.
|
Interface to both live and offline pcap parsing. |
|
_workspace/src/github.com/beorn7/perks/quantile
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds.
|
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds. |
|
_workspace/src/github.com/boltdb/bolt
Package bolt implements a low-level key/value store in pure Go.
|
Package bolt implements a low-level key/value store in pure Go. |
|
_workspace/src/github.com/codegangsta/cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
|
Package cli provides a minimal framework for creating and organizing command line Go applications. |
|
_workspace/src/github.com/coreos/go-systemd/daemon
Code forked from Docker project
|
Code forked from Docker project |
|
_workspace/src/github.com/coreos/go-systemd/journal
Package journal provides write bindings to the systemd journal
|
Package journal provides write bindings to the systemd journal |
|
_workspace/src/github.com/coreos/go-systemd/util
Package util contains utility functions related to systemd that applications can use to check things like whether systemd is running.
|
Package util contains utility functions related to systemd that applications can use to check things like whether systemd is running. |
|
_workspace/src/github.com/gogo/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
|
_workspace/src/github.com/gogo/protobuf/proto/proto3_proto
Package proto3_proto is a generated protocol buffer package.
|
Package proto3_proto is a generated protocol buffer package. |
|
_workspace/src/github.com/golang/glog
Package glog implements logging analogous to the Google-internal C++ INFO/ERROR/V setup.
|
Package glog implements logging analogous to the Google-internal C++ INFO/ERROR/V setup. |
|
_workspace/src/github.com/golang/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
|
_workspace/src/github.com/golang/protobuf/proto/proto3_proto
Package proto3_proto is a generated protocol buffer package.
|
Package proto3_proto is a generated protocol buffer package. |
|
_workspace/src/github.com/google/btree
Package btree implements in-memory B-Trees of arbitrary degree.
|
Package btree implements in-memory B-Trees of arbitrary degree. |
|
_workspace/src/github.com/kballard/go-shellquote
Shellquote provides utilities for joining/splitting strings using sh's word-splitting rules.
|
Shellquote provides utilities for joining/splitting strings using sh's word-splitting rules. |
|
_workspace/src/github.com/kr/pty
Package pty provides functions for working with Unix terminals.
|
Package pty provides functions for working with Unix terminals. |
|
_workspace/src/github.com/matttproud/golang_protobuf_extensions/pbutil
Package pbutil provides record length-delimited Protocol Buffer streaming.
|
Package pbutil provides record length-delimited Protocol Buffer streaming. |
|
_workspace/src/github.com/olekukonko/ts
This module is a Terminal API for the Go Programming Language.
|
This module is a Terminal API for the Go Programming Language. |
|
_workspace/src/github.com/prometheus/client_golang/prometheus
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface.
|
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface. |
|
_workspace/src/github.com/prometheus/client_model/go
Package io_prometheus_client is a generated protocol buffer package.
|
Package io_prometheus_client is a generated protocol buffer package. |
|
_workspace/src/github.com/prometheus/common/expfmt
A package for reading and writing Prometheus metrics.
|
A package for reading and writing Prometheus metrics. |
|
_workspace/src/github.com/prometheus/common/model
Package model contains common data structures that are shared across Prometheus componenets and libraries.
|
Package model contains common data structures that are shared across Prometheus componenets and libraries. |
|
_workspace/src/github.com/prometheus/procfs
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc.
|
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc. |
|
_workspace/src/github.com/russross/blackfriday
Blackfriday markdown processor.
|
Blackfriday markdown processor. |
|
_workspace/src/github.com/shurcooL/sanitized_anchor_name
Package sanitized_anchor_name provides a func to create sanitized anchor names.
|
Package sanitized_anchor_name provides a func to create sanitized anchor names. |
|
_workspace/src/github.com/spf13/cobra
Package cobra is a commander providing a simple interface to create powerful modern CLI interfaces.
|
Package cobra is a commander providing a simple interface to create powerful modern CLI interfaces. |
|
_workspace/src/github.com/spf13/pflag
Package pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.
|
Package pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags. |
|
_workspace/src/github.com/ugorji/go/codec
High Performance, Feature-Rich Idiomatic Go codec/encoding library for binc, msgpack, cbor, json.
|
High Performance, Feature-Rich Idiomatic Go codec/encoding library for binc, msgpack, cbor, json. |
|
_workspace/src/github.com/ugorji/go/codec/codecgen
codecgen generates codec.Selfer implementations for a set of types.
|
codecgen generates codec.Selfer implementations for a set of types. |
|
_workspace/src/golang.org/x/crypto/bcrypt
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm.
|
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm. |
|
_workspace/src/golang.org/x/crypto/blowfish
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.
|
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm. |
|
_workspace/src/golang.org/x/net/context
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
|
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes. |
|
_workspace/src/golang.org/x/net/context/ctxhttp
Package ctxhttp provides helper functions for performing context-aware HTTP requests.
|
Package ctxhttp provides helper functions for performing context-aware HTTP requests. |
|
_workspace/src/golang.org/x/net/http2
Package http2 implements the HTTP/2 protocol.
|
Package http2 implements the HTTP/2 protocol. |
|
_workspace/src/golang.org/x/net/http2/h2i
The h2i command is an interactive HTTP/2 console.
|
The h2i command is an interactive HTTP/2 console. |
|
_workspace/src/golang.org/x/net/http2/hpack
Package hpack implements HPACK, a compression format for efficiently representing HTTP header fields in the context of HTTP/2.
|
Package hpack implements HPACK, a compression format for efficiently representing HTTP header fields in the context of HTTP/2. |
|
_workspace/src/golang.org/x/net/internal/timeseries
Package timeseries implements a time series structure for stats collection.
|
Package timeseries implements a time series structure for stats collection. |
|
_workspace/src/golang.org/x/net/trace
Package trace implements tracing of requests and long-lived objects.
|
Package trace implements tracing of requests and long-lived objects. |
|
_workspace/src/golang.org/x/sys/unix
Package unix contains an interface to the low-level operating system primitives.
|
Package unix contains an interface to the low-level operating system primitives. |
|
_workspace/src/google.golang.org/grpc
Package grpc implements an RPC system called gRPC.
|
Package grpc implements an RPC system called gRPC. |
|
_workspace/src/google.golang.org/grpc/benchmark
Package benchmark implements the building blocks to setup end-to-end gRPC benchmarks.
|
Package benchmark implements the building blocks to setup end-to-end gRPC benchmarks. |
|
_workspace/src/google.golang.org/grpc/benchmark/grpc_testing
Package grpc_testing is a generated protocol buffer package.
|
Package grpc_testing is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/grpc/codes
Package codes defines the canonical error codes used by gRPC.
|
Package codes defines the canonical error codes used by gRPC. |
|
_workspace/src/google.golang.org/grpc/credentials
Package credentials implements various credentials supported by gRPC library, which encapsulate all the state needed by a client to authenticate with a server and make various assertions, e.g., about the client's identity, role, or whether it is authorized to make a particular call.
|
Package credentials implements various credentials supported by gRPC library, which encapsulate all the state needed by a client to authenticate with a server and make various assertions, e.g., about the client's identity, role, or whether it is authorized to make a particular call. |
|
_workspace/src/google.golang.org/grpc/credentials/oauth
Package oauth implements gRPC credentials using OAuth.
|
Package oauth implements gRPC credentials using OAuth. |
|
_workspace/src/google.golang.org/grpc/examples/helloworld/helloworld
Package helloworld is a generated protocol buffer package.
|
Package helloworld is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/grpc/examples/route_guide/client
Package main implements a simple gRPC client that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs.
|
Package main implements a simple gRPC client that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs. |
|
_workspace/src/google.golang.org/grpc/examples/route_guide/routeguide
Package routeguide is a generated protocol buffer package.
|
Package routeguide is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/grpc/examples/route_guide/server
Package main implements a simple gRPC server that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs.
|
Package main implements a simple gRPC server that demonstrates how to use gRPC-Go libraries to perform unary, client streaming, server streaming and full duplex RPCs. |
|
_workspace/src/google.golang.org/grpc/grpclog
Package grpclog defines logging for grpc.
|
Package grpclog defines logging for grpc. |
|
_workspace/src/google.golang.org/grpc/grpclog/glogger
Package glogger defines glog-based logging for grpc.
|
Package glogger defines glog-based logging for grpc. |
|
_workspace/src/google.golang.org/grpc/health
Package health provides some utility functions to health-check a server.
|
Package health provides some utility functions to health-check a server. |
|
_workspace/src/google.golang.org/grpc/health/grpc_health_v1alpha
Package grpc_health_v1alpha is a generated protocol buffer package.
|
Package grpc_health_v1alpha is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/grpc/interop/grpc_testing
Package grpc_testing is a generated protocol buffer package.
|
Package grpc_testing is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/grpc/metadata
Package metadata define the structure of the metadata supported by gRPC library.
|
Package metadata define the structure of the metadata supported by gRPC library. |
|
_workspace/src/google.golang.org/grpc/naming
Package naming defines the naming API and related data structures for gRPC.
|
Package naming defines the naming API and related data structures for gRPC. |
|
_workspace/src/google.golang.org/grpc/peer
Package peer defines various peer information associated with RPCs and corresponding utils.
|
Package peer defines various peer information associated with RPCs and corresponding utils. |
|
_workspace/src/google.golang.org/grpc/test/codec_perf
Package codec_perf is a generated protocol buffer package.
|
Package codec_perf is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/grpc/test/grpc_testing
Package grpc_testing is a generated protocol buffer package.
|
Package grpc_testing is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/grpc/transport
Package transport defines and implements message oriented communication channel to complete various transactions (e.g., an RPC).
|
Package transport defines and implements message oriented communication channel to complete various transactions (e.g., an RPC). |
|
Package client provides bindings for the etcd APIs.
|
Package client provides bindings for the etcd APIs. |
|
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. |
|
error package describes errors in etcd project.
|
error package describes errors in etcd project. |
|
etcdserverpb
Package etcdserverpb is a generated protocol buffer package.
|
Package etcdserverpb is a generated protocol buffer package. |
|
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. |
|
pkg
|
|
|
transport
Package netutil provides network utility functions, complementing the more common ones in the net package.
|
Package netutil provides network utility functions, complementing the more common ones in the net package. |
|
Package raft provides an implementation of the raft consensus algorithm.
|
Package raft provides an implementation of the raft consensus algorithm. |
|
raftpb
Package raftpb is a generated protocol buffer package.
|
Package raftpb is a generated protocol buffer package. |
|
snappb
Package snappb is a generated protocol buffer package.
|
Package snappb is a generated protocol buffer package. |
|
storagepb
Package storagepb is a generated protocol buffer package.
|
Package storagepb is a generated protocol buffer package. |
|
tools
|
|
|
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.