Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.97 KB

build.md

File metadata and controls

53 lines (33 loc) · 1.97 KB
Raw

Building and Testing cAdvisor

Note: cAdvisor only builds on Linux since it uses Linux-only APIs.

Installing Dependencies

cAdvisor is written in the Go programming language. If you haven't set up a Go development environment, please follow these instructions 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 the latest version.

Note: cAdvisor requires Go 1.11 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 page.

Non-volatile Memory Support

cAdvisor can be linked against libipmctl library that allows to gather information about Intel® Optane™ DC Persistent memory. If you want to build cAdvisor with libipmctl support you must meet following requirements:

  • libimpctl-devel must be installed on build system.
  • libimpctl must be installed on all systems where cAdvisor is running.

Detailed information about building libipmctl can be found in the project's README. Make sure to use the most up to date released version. Functionality that relies on libipmctl was tested against version 02.00.00.3719 of the library.

To enable libimpctl support GO_FLAGS variable must be set:

$GOPATH/src/github.com/google/cadvisor $ GO_FLAGS="-tags=libipmctl,netgo" make build

Running Built Binary

Now you can run the built binary:

$GOPATH/src/github.com/google/cadvisor $ sudo ./cadvisor