diff --git a/README.md b/README.md index defc4f97..2fe1d97c 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/docs/build.md b/docs/build.md new file mode 100644 index 00000000..7d549cf4 --- /dev/null +++ b/docs/build.md @@ -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/... +```