Add more detailed build docs.
This commit is contained in:
parent
26921c3643
commit
45be8162c7
@ -57,6 +57,10 @@ cAdvisor now also supports [InfluxDB](http://influxdb.com) to store stats. To us
|
||||
|
||||
[Heapster](https://github.com/GoogleCloudPlatform/heapster) enables cluster wide monitoring of containers using cAdvisor.
|
||||
|
||||
## Building and Testing cAdvisor
|
||||
|
||||
See the more detailed instructions in the [build page](docs/build.md).
|
||||
|
||||
## Web UI
|
||||
|
||||
cAdvisor exposes a web UI at its port:
|
||||
|
27
docs/build.md
Normal file
27
docs/build.md
Normal file
@ -0,0 +1,27 @@
|
||||
# Building and Testing cAdvisor
|
||||
|
||||
**Note**: cAdvisor only builds on Linux since it uses Linux-only APIs.
|
||||
|
||||
You should be able to `go get` cAdvisor as expected (we use `-d` to only download):
|
||||
|
||||
```
|
||||
$ go get -d github.com/google/cadvisor
|
||||
```
|
||||
|
||||
We use `godep` so you will need to get that as well:
|
||||
|
||||
```
|
||||
$ go get github.com/tools/godep
|
||||
```
|
||||
|
||||
At this point you can build cAdvisor:
|
||||
|
||||
```
|
||||
$ godep go build github.com/google/cadvisor
|
||||
```
|
||||
|
||||
or run unit tests:
|
||||
|
||||
```
|
||||
$ godep go test github.com/google/cadvisor/...
|
||||
```
|
Loading…
Reference in New Issue
Block a user