Heapster enables Container Cluster Monitoring and Performance Analysis.
This repo is to support building containers for internal wavefront and client testing hosted at docker.io/wavefronthq. This allows us to support patches and features without having to rely on PRs being accepted by the upstream Kubernetes project at github.com/kubernetes/heapster.git
We recommend that if you wish to use kubernetes labels that you use docker.io/wavefronthq/heapster:latest If you do not need labels, you may use the upstream grc.io heapster container. When the PR kubernetes-retired#1713 has been merged and new upstream containers with the fix are publically available from the upstream project, we will recommend going back to upstream latest for heapster.
When creating a new PR to upstream, work on a feature branch and be sure to
git checkout upstream/master README.md along with the feature change.
Heapster currently supports Kubernetes and CoreOS natively. Heapster is compatible with kubernetes versions starting from v1.0.6 only
It can be extended to support other cluster management solutions easily.
Heapster collects and interprets various signals like compute resource usage, lifecycle events, etc, and exports cluster metrics via REST endpoints. Note: Some of the endpoints are only valid in Kubernetes clusters
Heapster supports multiple sources of data. More information here.
Heapster supports the pluggable storage backends described here. We welcome patches that add additional storage backends. Documentation on storage sinks here. The current version of Storage Schema is documented here.
To run Heapster on a Kubernetes cluster with,
- InfluxDB use this guide.
- Google Cloud Monitoring and Google Cloud Logging use this guide.
Using Heapster to monitor an OpenShift cluster requires some additional changes to the Kubernetes instructions to allow communication between the Heapster instance and OpenShift's secured endpoints. To run standalone Heapster or a combination of Heapster and Hawkular-Metrics in OpenShift, follow this guide.
Troubleshooting guide here
Contributions, questions, and comments are all welcomed and encouraged! minkube developers hang out on Slack in the #sig-instrumentation channel (get an invitation here). We also have the kubernetes-dev Google Groups mailing list. If you are posting to the list please prefix your subject with "heapster: ".
At the moment, you can build the container on mac, but you will get a runtime error if you run that container on linux.
Heapster can be slow at landing 3rd party PR's We currently have an open PR kubernetes-retired#1713 Until it lands, we need to build our own container, and encourage customers to deploy with our heapster container at https://hub.docker.com/r/wavefronthq/heapster install go according to https://golang.org/doc/install
~> export GOPATH=~/go && cd $GOPATH
go> mkdir -p src/k8s.io && cd !$
k8s.io> git clone github.com/sunnylabs/heapster.git && cd heapster
heapster> make test-unit
heapster> make
heapster> mv eventer heapster deploy/docker && cd !$
docker> cp /etc/ssl/certs/ca-certificates.crt .
docker> version=v1.4.0.1 sudo docker build -t ${version}-g$(git rev-parse --short HEAD) .
docker> docker login
docker> docker push wavefronthq/heapster:${version}-g$(git rev-parse --short HEAD)
Then update heapster.yml in sunnylabs/k8s/clusters tree