Skip to content

Commit

Permalink
Mark Heapster as Deprecated
Browse files Browse the repository at this point in the history
This marks Heapster as deprecated, adding a deprecation timeline that
culminates in the retirement of the Heapster project for the Kubernetes
1.13 release.
  • Loading branch information
DirectXMan12 committed Apr 24, 2018
1 parent afb24a4 commit 801cea9
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Heapster

***DEPRECATED***: Heapster is deprecated. Consider using [metrics-server](https://github.com/kubernetes-incubator/metrics-server)
and a third party metrics pipeline to gather Prometheus-format metrics instead. See the [deprecation timeline](docs/deprecation.md)
for more information on support. We will not be adding any new features to Heapster.

[![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)

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.
Expand Down
48 changes: 48 additions & 0 deletions docs/deprecation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Heapster Deprecation Timeline

This is the (proposed) timeline for Heapster deprecation. Any changes
made to the timeline will be reflected here. Note that this is the
timeline for the official Heapster repository. Individual distributions
are encouraged to follow suit in deprecating Heapster, but may continue to
support it on their own.

## Summary

| Kubernetes Release | Action | Policy/Support |
|---------------------|---------------------|----------------------------------------------------------------------------------|
| Kubernetes 1.11 | Initial Deprecation | No new features or sinks are added. Bugfixes may be made. |
| Kubernetes 1.12 | Setup Removal | The optional to install Heapster via the Kubernetes setup script is removed. |
| Kubernetes 1.13 | Removal | No new bugfixes will be made. Move to kubernetes-retired organization. |

## Milestones

### Initial Deprecation (Kubernetes 1.11)

Heapster is marked deprecated as of Kubernetes 1.11. Users are encoraged
to use
[metrics-server](https://github.com/kubernetes-incubator/metrics-server)
instead, potentially supplemented by a third-party monitoring solution,
such as Prometheus.

No new features will be added (including, but not limitted to, new sinks,
enhancements to existing sinks, enhancements to sources, and enhancements
to processing).

The Heapster maintainers will continue to accept bugfixes for critical
bugs. People filing bugs will be encouraged to reproduce with
metrics-server, and file there.

Similarly, **the legacy HPA clients and setup flags in Kubernetes should
be marked as deprecated.**

### Setup Removal (Kubernetes 1.12)

Support for installing Heapster will be removed from the Kubernetes setup
scripts.

Additional warnings will be made in the Kubernetes release notes.

### Removal (Kubernetes 1.13)

Heapster will be migrated to the kubernetes-retired organization. No new
code will be merged by the Heapster maintainers.

0 comments on commit 801cea9

Please sign in to comment.