Skip to content

Commit

Permalink
Add more detailed build docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
vmarmol committed Nov 6, 2014
1 parent 26921c3 commit 45be816
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
27 changes: 27 additions & 0 deletions docs/build.md
Original file line number Diff line number Diff line change
@@ -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/...
```

0 comments on commit 45be816

Please sign in to comment.