@helm-charts/banzaicloud-stable-kube-metrics-adapter v0.0.2-0.1.0
@helm-charts/banzaicloud-stable-kube-metrics-adapter
A Helm chart for kube-metrics-adapter
| Field | Value | 
|---|---|
| Repository Name | banzaicloud-stable | 
| Chart Name | kube-metrics-adapter | 
| Chart Version | 0.0.2 | 
| NPM Package Version | 0.1.0 | 
image:
  repository: banzaicloud/kube-metrics-adapter
  tag: 0.1.1
  pullPolicy: IfNotPresent
logLevel: 9
# Url to access prometheus
prometheus:
  url: http://prometheus.default.svc
replicas: 1
rbac:
  # Specifies whether RBAC resources should be created
  create: true
serviceAccount:
  # Specifies whether a service account should be created
  create: true
  # The name of the service account to use.
  # If not set and create is true, a name is generated using the fullname template
  name:
resources:
  limits:
    cpu: 100m
    memory: 100Mi
  requests:
    cpu: 100m
    memory: 100Mi
service:
  annotations: {}
  port: 443
  internalPort: 8443
affinity: {}
tolerations: []
tls:
  enable: false
  ca: |-
    # Public CA file that signed the APIService
  key: |-
    # Private key of the APIService
  certificate: |-
    # Public key of the APIServiceKube 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.
Prerequisites
Kubernetes 1.9+
Installing the Chart
To install the chart with the release name my-release:
$ helm install --name my-release stable/kube-metrics-adapterThis 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-releaseThe command removes all the Kubernetes components associated with the chart and deletes the release.
Configuration
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 | 
| image.pullPolicy | Image pull policy | IfNotPresent | 
| image.pullSecrets | Image pull secrets | {} | 
| logLevel | Log level | 4 | 
| nodeSelector | Node labels for pod assignment | {} | 
| prometheus.url | Url of where we can find the Prometheus service | http://prometheus.default.svc | 
| rbac.create | If true, create & use RBAC resources | true | 
| resources | CPU/Memory resource requests/limits | {} | 
| service.annotations | Annotations to add to the service | {} | 
| 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 | 
| serviceAccount.name | If not set and create is true, a name is generated using the fullname template |  | 
| tls.enable | If true, use the provided certificates. If false, generate self-signed certs | false | 
| tls.ca | 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) |  | 
| tolerations | List of node taints to tolerate | [] | 
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
$ helm install --name my-release \
  --set logLevel=1 \
 stable/kube-metrics-adapterAlternatively, 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-adapter6 years ago