github.com/mrgossett/heapster@v0.18.2/README.md (about)

     1  # Heapster
     2  
     3  [![GoDoc](https://godoc.org/k8s.io/heapster?status.svg)](https://godoc.org/k8s.io/heapster) [![Build Status](https://travis-ci.org/kubernetes/heapster.svg?branch=master)](https://travis-ci.org/kubernetes/heapster)
     4  
     5  Heapster enables Container Cluster Monitoring and Performance Analysis.
     6  
     7  Heapster currently supports [Kubernetes](https://github.com/kubernetes/kubernetes) and CoreOS natively.
     8  It can be extended to support other cluster management solutions easily.
     9  Heapster collects and interprets various signals like compute resource usage, lifecycle events, etc, and exports cluster metrics via [REST endpoints](docs/model.md).
    10  **Note: Some of the endpoints are only valid in Kubernetes clusters**
    11  
    12  Heapster supports multiple sources of data.
    13  More information [here](docs/source-configuration.md).
    14  
    15  Heapster supports a pluggable storage backend.
    16  It supports [InfluxDB](http://influxdb.com) with [Grafana](http://grafana.org/docs/features/influxdb), [Google Cloud Monitoring](https://cloud.google.com/monitoring/), [Google Cloud Logging](https://cloud.google.com/logging/), and [Hawkular](http://www.hawkular.org)
    17  We welcome patches that add additional storage backends.
    18  Documentation on storage sinks [here](docs/sink-configuration.md)
    19  The current version of Storage Schema is documented [here](docs/storage-schema.md).
    20  
    21  ### Running Heapster on Kubernetes
    22  
    23  To run Heapster on a Kubernetes cluster with,
    24  - InfluxDB use [this guide](docs/influxdb.md). 
    25  - Google Cloud Monitoring and Google Cloud Logging use [this guide](docs/google.md).
    26  
    27  ### Running Heapster on Openshift
    28  
    29  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 a combination of Heapster and Hawkular-Metrics, follow [this guide](https://github.com/hawkular/hawkular-metrics/blob/master/containers/README.adoc). 
    30  
    31  ### Running Heapster on CoreOS
    32  
    33  Heapster communicates with the local fleet server to get cluster information. It expected cAdvisor to be running on all the nodes. Refer to [this guide](docs/coreos.md).
    34  
    35  ### Running in other cluster management systems.
    36  
    37  Heapster can be used to enable cluster-wide monitoring on other cluster management solutions by running a simple cluster-specific buddy container that will help Heapster with discovery of hosts.
    38  
    39  ### Running in standalone mode.
    40  
    41  It is also possible to run Heapster standalone on a host with cAdvisor using [this guide](docs/standalone.md).
    42  
    43  #### Troubleshooting guide [here](docs/debugging.md)
    44  
    45  ### Community
    46  
    47  Contributions, questions, and comments are all welcomed and encouraged! Heapster and cAdvisor developers hang out in the [#google-containers](http://webchat.freenode.net/?channels=google-containers) room on freenode.net.  You can also reach us on the [google-containers Google Groups mailing list](https://groups.google.com/forum/#!forum/google-containers).