vitalif
/
etcd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: install etcdctl with `go get` as well 

The documentation recommends using `etcdctl` to verify that etcd has
been built correctly, but the `go get` command provided does not install
it. This changes it so that it does, and also clarifies terminology
('using `go get`', referring to the command used to install it, rather
than 'using `$GOPATH`').
release-3.4
Rob Day 2018-12-29 23:42:22 +00:00
parent cc8d446a6e
commit 959d004bcc
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/dl_build.md
View File

@ -27,6 +27,7 @@ To build a vendored `etcd` from the `master` branch via `go get`:
$ echo $GOPATH $ echo $GOPATH
/Users/example/go /Users/example/go
$ go get -v go.etcd.io/etcd $ go get -v go.etcd.io/etcd
$ go get -v go.etcd.io/etcd/etcdctl
``` ```
## Test the installation ## Test the installation
@ -35,14 +36,14 @@ Check the etcd binary is built correctly by starting etcd and setting a key.
### Starting etcd ### Starting etcd
If etcd is built without using GOPATH, run the following: If etcd is built without using `go get`, run the following:
``` ```sh
$ ./bin/etcd $ ./bin/etcd
``` ```
If etcd is built using GOPATH, run the following: If etcd is built using `go get`, run the following:
``` ```sh
$ $GOPATH/bin/etcd $ $GOPATH/bin/etcd
``` ```
@ -50,11 +51,13 @@ $ $GOPATH/bin/etcd
Run the following: Run the following:
``` ```sh
$ ETCDCTL_API=3 ./bin/etcdctl put foo bar $ ETCDCTL_API=3 ./bin/etcdctl put foo bar
OK OK
``` ```
(or `ETCDCTL_API=3 $GOPATH/bin/etcdctl put foo bar` if etcdctl was installed with `go get`)
If OK is printed, then etcd is working! If OK is printed, then etcd is working!
[github-release]: https://github.com/etcd-io/etcd/releases/ [github-release]: https://github.com/etcd-io/etcd/releases/