cadvisor/docs/development/build.md
Vishnu kannan 2eecea1353 Move presubmit to a make rule. Update docs to not use make all unless necessary.
Signed-off-by: Vishnu kannan <vishnuk@google.com>
2016-07-11 17:27:24 -07:00

41 lines
1.1 KiB
Markdown

# Building and Testing cAdvisor
**Note**: cAdvisor only builds on Linux since it uses Linux-only APIs.
## Installing Dependencies
cAdvisor is written in the [Go](http://golang.org) programming language. If you haven't set up a Go development environment, please follow [these instructions](http://golang.org/doc/code.html) to install go tool and set up GOPATH. Note that the version of Go in package repositories of some operating systems is outdated, so please [download](https://golang.org/dl/) the latest version.
**Note**: cAdvisor requires Go 1.6 to build.
After setting up Go, you should be able to `go get` cAdvisor as expected (we use `-d` to only download):
```
$ go get -d github.com/google/cadvisor
```
## Building from Source
At this point you can build cAdvisor from the source folder:
```
$GOPATH/src/github.com/google/cadvisor $ make build
```
or run only unit tests:
```
$GOPATH/src/github.com/google/cadvisor $ make test
```
For integration tests, see the [integration testing](integration_testing.md) page.
## Running Built Binary
Now you can run the built binary:
```
$GOPATH/src/github.com/google/cadvisor $ sudo ./cadvisor
```