etsangsplk / custom-metrics-apiserver

Framework for implementing custom metrics support for Kubernetes

Custom Metrics Adapter Server Boilerplate

Purpose

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.

How to use this repository

In order to use this repository, you should vendor this repository at github.com/kubernetes-incubator/custom-metrics-apiserver, and implement the "github.com/kubernetes-incubator/custom-metrics-apiserver/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.

Building your own Custom Metric Server

See getting-started.md for a walk through on creating your own custom metric server api.

Development for boilerplate project

Pre-reqs

• glide to install dependencies before you can use this project.
• Go same version of Go as Kubernetes
• Mercurial - one of dependencies requires hg
• git

Clone and Build boilerplate project

There is a sample adapter in this repository that can be used for testing changes to the repository, and also acts as an example implementations.

To build and deploy it:

export REGISTRY=<your registory name>
make sample-container

docker push $REGISTRY/k8s-custom-metric-adapter-sample
kubectl create namespace custom-metrics
kubectl apply -f sample-deploy/manifests

After the deployment you can query the sample adapter with:

kubectl get --raw "/apis/custom.metrics.k8s.io/v1beta1" | jq .

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.

Contribution Guidelines

See CONTRIBUTING.md for more information.