Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1020 from jonboulle/master

Browse Source 
docs: add note about version, remove old Vagrantfile
This commit is contained in:
Xiang Li 2014-09-08 15:09:27 -07:00
commit ffd198808e
3 changed files with 14 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/development-tools.md
View File

@ -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
```

39
README.md
View File

@ -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:
@ -30,28 +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
```
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
### Running etcd
First start a single-machine cluster of etcd:
@ -124,9 +111,11 @@ 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 due to a bug in the Go runtime. See #[358][358] for more information.
[358]: https://github.com/coreos/etcd/issues/358
### License

27
Vagrantfile vendored
View File

@ -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