From 9b361f6d369ad8eb66bbe40daf9a33edd987ffa4 Mon Sep 17 00:00:00 2001 From: Alex Polvi Date: Tue, 23 Jul 2013 10:14:29 -0700 Subject: [PATCH 1/3] add a little intro --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index e45bf45ef..b1deb60fc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # etcd +A highly-available key value store for shared configuration and service discovery. etcd is inspired by zookeeper and doozer, with a focus on: + +* 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 paxos + +Etcd is written in go and uses the [raft][raft] paxos implementation for high availability. + +See [go-etcd][go-etcd] for a native go client. Or feel free to just use curl, as in the examples below. + +[raft]: https://github.com/coreos/go-raft +[go-etcd]: https://github.com/coreos/go-etcd + ## Getting Started ### Building From 48da4910b78e24d8d3a831839cc751700ddc6e10 Mon Sep 17 00:00:00 2001 From: Alex Polvi Date: Tue, 23 Jul 2013 10:43:29 -0700 Subject: [PATCH 2/3] updates to readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b1deb60fc..14dd7ad58 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ curl http://127.0.0.1:4001/v1/keys/message -X DELETE {"action":"DELETE","key":"/message","prevValue":"Hello etcd","index":5} ``` -#### Using time to live key +#### Using a TTL on a key Keys in etcd can be set to expire after a specified number of seconds. That is done by setting a TTL (time to live) on the key when you POST: @@ -124,7 +124,7 @@ Now you can try to get the key by sending: curl http://127.0.0.1:4001/v1/keys/foo ``` -If the TTL has passed then you will +If the TTL has expired, the key will be deleted, and you will be returned a 404. ```html 404 page not found From 88d042b7a6bb9b9599757e8e9c88225b4cd59ff7 Mon Sep 17 00:00:00 2001 From: Alex Polvi Date: Tue, 23 Jul 2013 11:01:02 -0700 Subject: [PATCH 3/3] change to raft --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 14dd7ad58..26ffee418 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A highly-available key value store for shared configuration and service discover * 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 paxos +* Reliable: Properly distributed using Raft Etcd is written in go and uses the [raft][raft] paxos implementation for high availability.