Merge pull request #106360 from ehashman/metrics-implementations-docs

Remove outdated metric IMPLEMENTATIONS, update links
This commit is contained in:
Kubernetes Prow Robot 2021-11-11 15:15:49 -08:00 committed by GitHub
commit de52812264
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 46 deletions

View File

@ -1,41 +0,0 @@
# Implementations
## Resource Metrics API
- [Heapster](https://github.com/kubernetes/heapster): a application which
gathers metrics, writes them to metrics storage "sinks", and exposes the
resource metrics API from in-memory storage.(Heapster is now deprecated. See the [deprecation timeline](https://github.com/kubernetes-retired/heapster/blob/master/docs/deprecation.md) for more information on support.)
- [Metrics Server](https://github.com/kubernetes-incubator/metrics-server):
a lighter-weight in-memory server specifically for the resource metrics
API.
## Custom Metrics API
***NB: None of the below implementations are officially part of Kubernetes.
They are listed here for convenience.***
- [Prometheus
Adapter](https://github.com/kubernetes-sigs/prometheus-adapter). An
implementation of the custom metrics API that attempts to support
arbitrary metrics following a set label and naming scheme.
- [Microsoft Azure Adapter](https://github.com/Azure/azure-k8s-metrics-adapter). An implementation of the custom metrics API that allows you to retrieve arbitrary metrics from Azure Monitor.
- [Google Stackdriver (coming
soon)](https://github.com/GoogleCloudPlatform/k8s-stackdriver)
- [Datadog Cluster Agent](https://github.com/DataDog/datadog-agent/blob/c4f38af1897bac294d8fed6285098b14aafa6178/docs/cluster-agent/CUSTOM_METRICS_SERVER.md).
Implementation of the external metrics provider, using Datadog as a backend for the metrics.
Coming soon: Implementation of the custom metrics provider to support in-cluster metrics collected by the Datadog Agents.
- [Kube Metrics Adapter](https://github.com/zalando-incubator/kube-metrics-adapter). A general purpose metrics adapter for Kubernetes that can collect and serve custom and external metrics for Horizontal Pod Autoscaling.
Provides the ability to scrape pods directly or from Prometheus through user defined queries.
Also capable of serving external metrics from a number of sources including AWS' SQS and [ZMON monitoring](https://github.com/zalando/zmon).
## External Metrics API
***NB: None of the below implementations are officially part of Kubernetes.
They are listed here for convenience.***
- [KEDA](https://github.com/kedacore/keda). A Kubernetes-based Event Driven Autoscaling component. It provides event driven scale for any container running in Kubernetes.

View File

@ -14,9 +14,7 @@ library when implementing their API servers.
## APIs ## APIs
This repository contains types and clients for several APIs. For more This repository contains types and clients for several APIs.
details on implementations of these apis, see
[IMPLEMENTATIONS.md](IMPLEMENTATIONS.md).
### Custom Metrics API ### Custom Metrics API
@ -27,7 +25,7 @@ The API is intended to be implemented by monitoring pipeline vendors, on
top of their metrics storage solutions. top of their metrics storage solutions.
If you want to implement this as an API server for this API, please see the If you want to implement this as an API server for this API, please see the
[kubernetes-incubator/custom-metrics-apiserver](https://github.com/kubernetes-incubator/custom-metrics-apiserver) [kubernetes-sigs/custom-metrics-apiserver](https://github.com/kubernetes-sigs/custom-metrics-apiserver)
library, which contains the basic infrastructure required to set up such library, which contains the basic infrastructure required to set up such
an API server. an API server.
@ -38,7 +36,7 @@ Import Path: `k8s.io/metrics/pkg/apis/custom_metrics`.
This API allows consumers to access resource metrics (CPU and memory) for This API allows consumers to access resource metrics (CPU and memory) for
pods and nodes. pods and nodes.
The API is implemented by [metrics-server](https://github.com/kubernetes-sigs/metrics-server). The API is implemented by [metrics-server](https://github.com/kubernetes-sigs/metrics-server) and [prometheus-adapter](https://github.com/kubernetes-sigs/prometheus-adapter).
Import Path: `k8s.io/metrics/pkg/apis/metrics`. Import Path: `k8s.io/metrics/pkg/apis/metrics`.