No Description

Yicheng Qin 654eaba5a1 *: bump to v0.4.9+git 9 years ago
Documentation 55263bc6b5 Revert "etcd: add -internal-dir flag" 9 years ago
bench 803aeb8fae feat(benchmark) fix of flag arguments and updated logging 10 years ago
config 55263bc6b5 Revert "etcd: add -internal-dir flag" 9 years ago
contrib 3e7c2dff96 feat(metrics): Add documentation and contrib scripts 11 years ago
discovery 6516cf854c chore(server): rename daemon to startRoutine 10 years ago
error db4c5e0eaa fix(server/v2): set correct content-type for etcdError response 10 years ago
etcd e1e2daa205 Revert "etcd: register usable versions when bootstrap" 9 years ago
fixtures 50d9e6a7fd chore(fixtures/ca): make all certificates generated by etcd-ca 10 years ago
http d9df58beb8 Added Access-Control-Allow-Headers to allow cors requests with those headers 10 years ago
log b6053d6a86 Making code formatting consistent. 10 years ago
metrics b6053d6a86 Making code formatting consistent. 10 years ago
mod d2f5934aa1 mod: remove defunct leader test 10 years ago
pkg b3c5ed60bd chore(pkg/btrfs): remove accidental swp file. 10 years ago
scripts 3c04f8b664 fix(scripts/build-release): put everything into a release dir 10 years ago
server 654eaba5a1 *: bump to v0.4.9+git 9 years ago
store 973bde9a07 feat(get): get from quorum 10 years ago
tests 494d2c67aa fix(peer_server) set content type to application/json in admin 10 years ago
third_party a451cf2333 fix(raft/protobuf): avoid panic on unexcepted data 10 years ago
.gitignore 84ad6ddd79 chore(build): set build path to gopath/ 10 years ago
.header 41b9051686 chore(*.go): add copyright notice 11 years ago
CHANGELOG 49e0dff2b8 CHANGELOG: v0.4.6 10 years ago
CONTRIBUTING.md ac7e6bb002 Merge https://github.com/coreos/template-project 10 years ago
DCO fd9ad4fa2c docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO 10 years ago
Dockerfile 9f5ec7732e Update to Go v1.3 10 years ago
LICENSE 3381177341 License project under the Apache License Version 2.0 11 years ago
NOTICE 054de85da2 feat(*): initial commit 11 years ago
README.md 2f6ea0a0e5 *: bump to v0.4.8 9 years ago
Vagrantfile 838a945862 feat(Vagrantfile): Add Vagrantfile for easy start 10 years ago
build 84ad6ddd79 chore(build): set build path to gopath/ 10 years ago
go_version.go 6b14fe7747 Download and build Go 1.2 in the Dockerfile. 11 years ago
main.go 1b59eacb72 refactor(main): rename etcd.go to main.go 10 years ago
test.sh a1a91ab75a chore(server): deprecate mod temporarily 10 years ago

README.md

etcd

README version 0.4.8

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.

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.

32bit systems

etcd has known issues on 32bit systems. We plan to address these issues after the 0.4 release.

License

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