github.com/AliyunContainerService/heapster@v1.6.0-beta.1.0.20190403101729-c280e398e293/README.md (about)

     1  # Heapster
     2  
     3  ***DEPRECATED***: Heapster is deprecated.  Consider using [metrics-server](https://github.com/kubernetes-incubator/metrics-server)
     4  and a third party metrics pipeline to gather Prometheus-format metrics instead.  See the [deprecation timeline](docs/deprecation.md)
     5  for more information on support. We will not be adding any new features to Heapster.
     6  
     7  [![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)  [![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/heapster)](https://goreportcard.com/report/github.com/kubernetes/heapster)
     8  
     9  Heapster enables Container Cluster Monitoring and Performance Analysis for [Kubernetes](https://github.com/kubernetes/kubernetes) (versions v1.0.6 and higher), and platforms which include it.
    10  
    11  Heapster collects and interprets various signals like compute resource usage, lifecycle events, etc.
    12  Note that the model API, formerly used provide REST access to its collected metrics, is now deprecated.
    13  Please see [the model documentation](docs/model.md) for more details.
    14  
    15  Heapster supports multiple sources of data.
    16  More information [here](docs/source-configuration.md).
    17  
    18  Heapster supports the pluggable storage backends described [here](docs/sink-owners.md).
    19  We welcome patches that add additional storage backends.
    20  Documentation on storage sinks [here](docs/sink-configuration.md).
    21  The current version of Storage Schema is documented [here](docs/storage-schema.md).
    22  
    23  ### Running Heapster on Kubernetes
    24  
    25  Heapster can run on a Kubernetes cluster using a number of backends.  Some common choices:
    26  - [InfluxDB](docs/influxdb.md)
    27  - [Stackdriver Monitoring and Logging](docs/google.md) for Google Cloud Platform
    28  - [Other backends](docs/)
    29  
    30  ### Running Heapster on OpenShift
    31  
    32  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](https://github.com/openshift/origin-metrics).
    33  
    34  #### Troubleshooting guide [here](docs/debugging.md)
    35  
    36  
    37  ## Community
    38  
    39  Contributions, questions, and comments are all welcomed and encouraged! Developers hang out on [Slack](https://kubernetes.slack.com) in the #sig-instrumentation channel (get an invitation [here](http://slack.kubernetes.io/)). We also have the [kubernetes-dev Google Groups mailing list](https://groups.google.com/forum/#!forum/kubernetes-dev). If you are posting to the list please prefix your subject with "heapster: ".