README
¶
metrics
Kubernetes metrics API type definitions and clients.
Purpose
This repository contains type definitions and client code for the metrics APIs that Kubernetes makes use of. Depending on the API, the actual implementations live elsewhere.
Consumers of the metrics APIs can make use of this repository to access implementations of the APIs, while implementors should make use of this library when implementing their API servers.
APIs
This repository contains types and clients for several APIs. For more details on implementations of these apis, see IMPLEMENTATIONS.md.
Custom Metrics API
This API allows consumers to access arbitrary metrics which describe Kubernetes resources.
The API is intended to be implemented by monitoring pipeline vendors, on top of their metrics storage solutions.
If you want to implement this an API server for this API, please see the kubernetes-incubator/custom-metrics-apiserver library, which contains the basic infrastructure required to set up such an API server.
Import Path: k8s.io/metrics/pkg/apis/custom_metrics.
Resource Metrics API
This API allows consumers to access resource metrics (CPU and memory) for pods and nodes.
The API is implemented by Heapster (https://github.com/kubernetes/heapster) and metrics-server (https://github.com/kubernetes-incubator/metrics-server).
Import Path: k8s.io/metrics/pkg/apis/metrics.
Compatibility
The APIs in this repository follow the standard guarantees for Kubernetes APIs, and will follow Kubernetes releases.
Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this repository at:
- Slack: #sig-instrumentation (on https://kubernetes.slack.com -- get an invite at slack.kubernetes.io)
- Mailing List: https://groups.google.com/forum/#!forum/kubernetes-sig-instrumentation
Code of Conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Contibution Guidelines
See CONTRIBUTING.md for more information.
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
apis/custom_metrics/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/custom_metrics/v1beta1
Package v1beta1 is a generated protocol buffer package.
|
Package v1beta1 is a generated protocol buffer package. |
|
apis/custom_metrics/v1beta2
Package v1beta2 is a generated protocol buffer package.
|
Package v1beta2 is a generated protocol buffer package. |
|
apis/external_metrics/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/external_metrics/v1beta1
Package v1beta1 is a generated protocol buffer package.
|
Package v1beta1 is a generated protocol buffer package. |
|
apis/metrics/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/metrics/v1alpha1
Package v1alpha1 is a generated protocol buffer package.
|
Package v1alpha1 is a generated protocol buffer package. |
|
apis/metrics/v1beta1
Package v1beta1 is a generated protocol buffer package.
|
Package v1beta1 is a generated protocol buffer package. |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/metrics/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/metrics/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/metrics/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/metrics/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |