This repository contains boilerplate code for setting up an implementation of the custom metrics API (https://github.com/kubernetes/metrics).
It includes the necessary boilerplate for setting up an implementation (generic API server setup, registration of resources, etc), plus a sample implementation backed by fake data.
In order to use this repository, you should vendor this repository at
k8s.io/custom-metrics-boilerplate
, and implement the
"k8s.io/custom-metrics-boilerplate/pkg/provider".CustomMetricsProvider
interface. You can then pass this to the main setup functions.
The pkg/cmd
package contains the building blocks of the actual API
server setup. You'll most likely want to wrap the existing options and
flags setup to add your own flags for configuring your provider.
A sample implementation of this can be found in the file sample-main.go
and pkg/sample-cmd
directory. You'll want to have the equivalent files
in your project.
The vendored directory currently contains a copy of k8s.io/apiserver
with a special patch applied to support the dynamic nature of the custom
metrics API server
(kubernetes/kubernetes#42845).
Until this functionality lands in the main k8s.io/apiserver
repository,
you should use the vendored copy here.
The APIs in this repository follow the standard guarantees for Kubernetes APIs, and will follow Kubernetes releases.
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this repository at:
- Slack: #sig-instrumention (on https://kubernetes.slack.com -- get an invite at slack.kubernetes.io)
- Mailing List: https://groups.google.com/forum/#!forum/kubernetes-sig-instrumentation
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
See CONTRIBUTING.md for more information.