Chart version: 0.1.3
Api version: v1
App version: 0.1.1
A Helm chart for kube-metrics-adapter
Chart Type
Set me up:
helm repo add center
Install Chart:
helm install kube-metrics-adapter center/banzaicloud-stable/kube-metrics-adapter
Versions (0)

Kube Metrics Adapter

Installs the # Kube Metrics Adapter for the Custom Metrics API. Custom metrics are used in Kubernetes by Horizontal Pod Autoscalers to scale workloads based upon your own metric pulled from an external metrics provider like Prometheus. This chart complements the metrics-server chart that provides resource only metrics.


Kubernetes 1.12+

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release stable/kube-metrics-adapter

This command deploys the kube-metrics-adapter with the default configuration. The configuration section lists the parameters that can be configured during installation.

Using the Chart

kube-metrics-adapter can be configure to use several different collectors. Currently this chart supports only configuration of Prometheus collector. Ensure the prometheus.url and prometheus.port are configured with the correct Prometheus service endpoint. To configure your Horizontal Pod Autoscaler to use the custom metric, see the custom metrics section of the HPA walkthrough.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.


The following table lists the configurable parameters of the Prometheus Adapter chart and their default values.

Parameter Description Default
affinity Node affinity {}
image.repository Image repository banzaicloud/kube-metrics-adapter
image.tag Image tag 0.1.1-bzn
image.pullPolicy Image pull policy IfNotPresent
image.pullSecrets Image pull secrets []
logLevel Log level 4
nodeSelector Node labels for pod assignment {}
enableCustomMetricsApi Enable Custom Metrics APIService true
enableExternalMetricsApi Enable External Metrics APIService true
prometheus.url Url of where we can find the Prometheus service
rbac.create If true, create & use RBAC resources true
resources CPU/Memory resource requests/limits {}
service.annotations Annotations to add to the service {}
adapter.podAnnotations Annotations to add to the pods {}
enableHostNetwork Enable host network for adapter false
service.port Service port to expose 443
service.internalPort Service internal port 6443
service.type Type of service to create ClusterIP
serviceAccount.create If true, create & use Serviceaccount true If not set and create is true, a name is generated using the fullname template
sslCertPath Path on the pod where ssl ca cert exists (ignored if aws.enable=false) /etc/ssl/certs/ca-certificates.crt
sslCertHostPath Path on the host where ssl ca cert exists (ignored if aws.enable=false) /etc/ssl/certs/ca-certificates.crt
tls.enable If true, use the provided certificates. If false, generate self-signed certs false Public CA file that signed the APIService (ignored if tls.enable=false)
tls.key Private key of the APIService (ignored if tls.enable=false)
tls.certificate Public key of the APIService (ignored if tls.enable=false)
aws.enable If true, enable AWS external metrics (SQS) false
aws.region Comma separated list of AWS regions (ignored if aws.enable=false) us-west-2
tolerations List of node taints to tolerate []
pspEnabled enabel PSP resources false

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set logLevel=1 \

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml stable/kube-metrics-adapter