etcd

command module
v0.5.0-alpha.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 25, 2014 License: Apache-2.0 Imports: 14 Imported by: 0

README

etcd

Build Status

WARNING

The current master branch of etcd is under heavy development in anticipation of the forthcoming 0.5.0 release.

It is strongly recommended that users work with the latest 0.4.x release (0.4.6), which can be found on the releases page.

Unless otherwise noted, the etcd documentation refers to configuring and running 0.4.x releases.

README version 0.4.6

A highly-available key value store for shared configuration and service discovery. etcd is inspired by Apache ZooKeeper and doozer, 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 latest release and setup instructions are available at GitHub.

Running etcd

First start a single-machine cluster of etcd:

./bin/etcd

This will bring up etcd listening on port 4001 for client communication and on port 7001 for server-to-server communication.

Next, let's set a single key, and then retrieve it:

curl -L http://127.0.0.1:4001/v2/keys/mykey -XPUT -d value="this is awesome"
curl -L http://127.0.0.1:4001/v2/keys/mykey

You have successfully started an etcd on a single machine and written a key to the store. Now it's time to dig into the full etcd API and other guides.

Next Steps

Contact

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

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:4001/version
API Versioning

The v2 API responses should not change after the 0.2.0 release but new features will be added over time.

The v1 API has been deprecated and will not be supported.

During the pre-v1.0.0 series of releases we may break the API as we fix bugs and get feedback.

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

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Godeps
_workspace/src/code.google.com/p/go.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/code.google.com/p/gogoprotobuf/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/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.
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.
etcdserverpb
Package etcdserverpb is a generated protocol buffer package.
Package etcdserverpb is a generated protocol buffer package.
functional tests are built upon embeded etcd, and focus on etcd functional correctness.
functional tests are built upon embeded etcd, and focus on etcd functional correctness.
pkg
crc
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.
wal
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL