From 7caa33d819509e52a259c76660876ed35755b6ac Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Mon, 8 Sep 2014 14:43:36 -0700 Subject: [PATCH 1/4] docs: update README to warn about master branch --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3824fba2b..1e926f0b3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # etcd -README version 0.4.6 +## 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](https://github.com/coreos/etcd/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][zookeeper] and [doozer][doozer], with a focus on being: @@ -47,12 +55,6 @@ _NOTE_: etcd requires go 1.2+. Please check your installation with go version ``` -See the [development tools documentation][development-tools] for alternative build methods like using Vagrant. - -[development-tools]: https://github.com/coreos/etcd/blob/master/Documentation/development-tools.md - -### Running - First start a single-machine cluster of etcd: ```sh @@ -124,9 +126,9 @@ 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. -#### 32bit systems +#### 32-bit systems -etcd has known issues on 32bit systems. We plan to address these issues after the 0.4 release. +etcd has known issues on 32-bit systems. ### License From 8cd1b3a4f282d6f66904de5b638c354230d31d81 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Mon, 8 Sep 2014 14:46:25 -0700 Subject: [PATCH 2/4] docs: remove nonfunctional Vagrantfile and instructions --- Documentation/development-tools.md | 12 ------------ README.md | 2 +- Vagrantfile | 27 --------------------------- 3 files changed, 1 insertion(+), 40 deletions(-) delete mode 100644 Documentation/development-tools.md delete mode 100644 Vagrantfile diff --git a/Documentation/development-tools.md b/Documentation/development-tools.md deleted file mode 100644 index 08473988e..000000000 --- a/Documentation/development-tools.md +++ /dev/null @@ -1,12 +0,0 @@ -# Development tools - -## Vagrant - -For fast start you can use Vagrant. `vagrant up` will make etcd build and running on virtual machine. Required Vagrant version is 1.5.0. - -Next lets 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 -``` diff --git a/README.md b/README.md index 1e926f0b3..48f46756f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # etcd -## WARNING ## +### WARNING ### The current `master` branch of etcd is under heavy development in anticipation of the forthcoming 0.5.0 release. diff --git a/Vagrantfile b/Vagrantfile deleted file mode 100644 index c41a26ef5..000000000 --- a/Vagrantfile +++ /dev/null @@ -1,27 +0,0 @@ -# -*- mode: ruby -*- -# vi: set ft=ruby : -# -Vagrant.require_version '>= 1.5.0' -Vagrant.configure("2") do |config| - config.vm.box = "precise64" - config.vm.box_url = "http://files.vagrantup.com/precise64.box" - - config.vm.network :forwarded_port, host: 4001, guest: 4001 - config.vm.network :forwarded_port, host: 7001, guest: 7001 - - # Fix docker not being able to resolve private registry in VirtualBox - config.vm.provider :virtualbox do |vb, override| - vb.customize ["modifyvm", :id, "--natdnshostresolver1", "on"] - vb.customize ["modifyvm", :id, "--natdnsproxy1", "on"] - end - - config.vm.provision "docker" do |d| - d.build_image "/vagrant", args: '-t etcd' - d.run "etcd", args: "-p 4001:4001 -p 7001:7001", demonize: true - end - - # plugin conflict - if Vagrant.has_plugin?("vagrant-vbguest") - config.vbguest.auto_update = false - end -end From 9180919a3076c0d67b3dda0a682a31a2592e6752 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Mon, 8 Sep 2014 14:57:16 -0700 Subject: [PATCH 3/4] docs: remove build instructions from README --- README.md | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/README.md b/README.md index 48f46756f..d4ff8efad 100644 --- a/README.md +++ b/README.md @@ -38,22 +38,7 @@ The latest release and setup instructions are available at [GitHub][github-relea [github-release]: https://github.com/coreos/etcd/releases/ - -### Building - -You can build etcd using the standard go workflow - ensure `GOPATH` is set appropriately, and then: - -```sh -go get github.com/coreos/etcd -``` - -which will generate a binary at `$GOPATH/bin/etcd` - -_NOTE_: etcd requires go 1.2+. Please check your installation with - -``` -go version -``` +### Running etcd First start a single-machine cluster of etcd: From 26a5aaec341e97f12380abcfeb6790d28431bcb0 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Mon, 8 Sep 2014 15:05:43 -0700 Subject: [PATCH 4/4] docs: add link to 32-bit issue --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d4ff8efad..69ac01626 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,9 @@ During the pre-v1.0.0 series of releases we may break the API as we fix bugs and #### 32-bit systems -etcd has known issues on 32-bit systems. +etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #[358][358] for more information. + +[358]: https://github.com/coreos/etcd/issues/358 ### License