From 4c55e8a7c09d4b16e93d1ba3d823a68909556af3 Mon Sep 17 00:00:00 2001 From: Yicheng Qin Date: Mon, 26 Jan 2015 13:54:26 -0800 Subject: [PATCH] README: add doc about easy etcd cluster bootstrap --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0ecbb2ef0..ceb68ed46 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ The latest release and setup instructions are available at [GitHub][github-relea ### Running etcd -First start a single-machine cluster of etcd: +First start a single-member cluster of etcd: ```sh ./bin/etcd @@ -55,10 +55,26 @@ 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. +You have successfully started an etcd and written a key to the store. + +### Running local etcd cluster + +First install [goreman](https://github.com/mattn/goreman), which manages Procfile-based applications. + +Our [Profile script](./Procfile) will set up a local example cluster. You can start it with: + +```sh +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][api]. - Set up a [multi-machine cluster][clustering]. - Learn the [config format, env variables and flags][configuration].