copy of etcd repository
 
 
 
 
 
 
Go to file
Jonathan Boulle fd9ad4fa2c docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 2014-04-04 10:58:34 -07:00
Documentation Merge pull request #646 from metaflow/api-doc-release-lock 2014-04-03 16:59:31 -07:00
bench feat(benchmark) fix of flag arguments and updated logging 2014-03-18 12:33:19 +07:00
config Merge branch 'master' of https://github.com/coreos/etcd into proxy 2014-03-24 15:30:14 -07:00
contrib feat(metrics): Add documentation and contrib scripts 2014-01-20 15:37:31 -08:00
discovery fix(discovery): use prevExist instead of prevValue=init 2014-02-05 15:14:57 -08:00
error refactor(errors): use map literal syntax 2014-03-25 20:17:21 -07:00
etcd fix(main): remove duplicate line in etcd.go 2014-04-01 14:22:07 -07:00
fixtures/ca chore(fixtures/ca): make all certificates generated by etcd-ca 2014-03-17 12:32:55 -07:00
http fix(v2): Use case-insensitive check on bool query params 2014-02-07 14:29:08 -08:00
log Making code formatting consistent. 2014-03-27 14:19:08 +01:00
metrics Making code formatting consistent. 2014-03-27 14:19:08 +01:00
mod Making code formatting consistent. 2014-03-27 14:19:08 +01:00
pkg fix(store): make NodeExtern.Value a *string 2014-02-18 00:50:44 -05:00
scripts Machine join/remove v2 API. 2014-03-18 16:25:21 -06:00
server Merge pull request #663 from tsenart/master 2014-03-27 17:08:12 -07:00
store Making code formatting consistent. 2014-03-27 14:19:08 +01:00
tests Merge pull request #667 from unihorn/53 2014-03-27 22:40:09 -04:00
third_party Merge branch 'master' of https://github.com/coreos/etcd into proxy 2014-03-24 15:30:14 -07:00
.gitignore ignore .etcd dirs 2014-03-26 12:19:20 -07:00
.header chore(*.go): add copyright notice 2013-10-07 09:48:28 -07:00
CHANGELOG doc(CHANGELOG): document v0.3.0 2014-02-07 15:54:45 -08:00
CONTRIBUTING.md docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 2014-04-04 10:58:34 -07:00
DCO docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 2014-04-04 10:58:34 -07:00
Dockerfile etcd is in the bin directory, fixes bug with the docker image not working 2014-01-15 12:46:09 -05:00
LICENSE License project under the Apache License Version 2.0 2013-07-31 17:39:03 +00:00
README.md docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 2014-04-04 10:58:34 -07:00
Vagrantfile feat(Vagrantfile): Add Vagrantfile for easy start 2014-03-15 12:48:48 -07:00
build chore(build): update gofmt target 2014-04-03 17:03:50 -07:00
go_version.go Download and build Go 1.2 in the Dockerfile. 2014-01-14 18:19:37 -08:00
main.go refactor(main): rename etcd.go to main.go 2014-04-01 12:54:38 -07:00
test.sh chore(test.sh): move gofmt check to the end of testing 2014-04-03 17:04:35 -07:00

README.md

etcd

README version 0.3.0

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.

Getting Started

Getting etcd

The latest release and setup instructions are available at GitHub.

Building

You can build etcd from source:

git clone https://github.com/coreos/etcd
cd etcd
./build

This will generate a binary called ./bin/etcd.

NOTE: you need go 1.2+. Please check your installation with

go version

See the development tools documentation for alternative build methods like using Vagrant.

Running

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

Clients are encouraged to use the v2 API. The v1 API will not change.

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

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

License

etcd is under the Apache 2.0 license. See the LICENSE file for details.