Introducing our new CEO Don Johnson - Read More

bitnamicharts/metrics-server

Verified Publisher

By VMware

Updated 1 day ago

Bitnami Helm chart for Metrics Server

Helm
Image
Integration & Delivery
Monitoring & Observability
0

500K+

Bitnami package for Metrics Server

Metrics Server aggregates resource usage data, such as container CPU and memory usage, in a Kubernetes cluster and makes it available via the Metrics API.

Overview of Metrics Server

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

helm install my-release oci://registry-1.docker.io/bitnamicharts/metrics-server

Looking to use Metrics Server in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

Introduction

This chart bootstraps a Metrics Server deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.0+

Installing the Chart

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

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/metrics-server

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

These commands deploy Metrics Server on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Configuration and installation details

Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.

Rolling vs Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Enable RBAC security

In order to enable Role-Based Access Control (RBAC) for Metrics Server, use the following parameter: rbac.create=true.

Configure certificates

If you are providing your own certificates for the API Service, set insecureSkipTLSVerify to "false", and provide a caBundle consisting of the base64-encoded certificate chain.

Set Pod affinity

This chart allows you to set custom Pod affinity using the affinity parameter. Find more information about Pod affinity in the Kubernetes documentation.

As an alternative, you can use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Backup and restore

To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.

Parameters

Global parameters
NameDescriptionValue
global.imageRegistryGlobal Docker image registry""
global.imagePullSecretsGlobal Docker registry secret names as an array[]
global.security.allowInsecureImagesAllows skipping image verificationfalse
global.compatibility.openshift.adaptSecurityContextAdapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation)auto
Common parameters
NameDescriptionValue
kubeVersionForce target Kubernetes version (using Helm capabilities if not set)""
nameOverrideString to partially override common.names.fullname template (will maintain the release name)""
fullnameOverrideString to fully override common.names.fullname template""
namespaceOverrideString to fully override common.names.namespace""
commonLabelsAdd labels to all the deployed resources{}
commonAnnotationsAdd annotations to all the deployed resources{}
extraDeployArray of extra objects to deploy with the release[]
diagnosticMode.enabledEnable diagnostic mode (all probes will be disabled and the command will be overridden)false
diagnosticMode.commandCommand to override all containers in the the deployment(s)/statefulset(s)["sleep"]
diagnosticMode.argsArgs to override all containers in the the deployment(s)/statefulset(s)["infinity"]
Metrics Server parameters
NameDescriptionValue
image.registryMetrics Server image registryREGISTRY_NAME
image.repositoryMetrics Server image repositoryREPOSITORY_NAME/metrics-server
image.digestMetrics Server image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag""
image.pullPolicyMetrics Server image pull policyIfNotPresent
image.pullSecretsMetrics Server image pull secrets[]
automountServiceAccountTokenMount Service Account token in podtrue
hostAliasesAdd deployment host aliases[]
replicasNumber of metrics-server nodes to deploy1
updateStrategy.typeSet up update strategy for metrics-server installation.RollingUpdate
rbac.createEnable RBAC authenticationtrue
serviceAccount.createSpecifies whether a ServiceAccount should be createdtrue
serviceAccount.nameThe name of the ServiceAccount to create""
serviceAccount.automountServiceAccountTokenAutomount API credentials for a service accountfalse
serviceAccount.annotationsAnnotations for service account. Evaluated as a template. Only used if create is true.{}
apiService.createSpecifies whether the v1beta1.metrics.k8s.io API service should be created. You can check if it is needed with kubectl get --raw "/apis/metrics.k8s.io/v1beta1/nodes".false
apiService.insecureSkipTLSVerifySpecifies whether to skip self-verifying self-signed TLS certificates. Set to "false" if you are providing your own certificates.true
apiService.caBundleA base64-encoded string of concatenated certificates for the CA chain for the APIService.""
containerPorts.httpsPort where metrics-server will be running8443
hostNetworkEnable hostNetwork modefalse
dnsPolicyDefault dnsPolicy settingClusterFirst
commandOverride default container command (useful when using custom images)[]
argsOverride default container args (useful when using custom images)[]
lifecycleHooksfor the metrics-server container(s) to automate configuration before or after startup{}
extraEnvVarsArray with extra environment variables to add to metrics-server nodes[]
extraEnvVarsCMName of existing ConfigMap containing extra env vars for metrics-server nodes""
extraEnvVarsSecretName of existing Secret containing extra env vars for metrics-server nodes""
extraArgsExtra arguments to pass to metrics-server on start up[]
sidecarsAdd additional sidecar containers to the metrics-server pod(s)[]
initContainersAdd additional init containers to the metrics-server pod(s)[]
podLabelsPod labels{}
podAnnotationsPod annotations{}
priorityClassNamePriority class for pod scheduling""
schedulerNameName of the k8s scheduler (other than default)""
terminationGracePeriodSecondsIn seconds, time the given to the metrics-server pod needs to terminate gracefully""
podAffinityPresetPod affinity preset. Ignored if affinity is set. Allowed values: soft or hard""
podAntiAffinityPresetPod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hardsoft
pdb.createCreate a PodDisruptionBudgettrue
pdb.minAvailableMinimum available instances""
pdb.maxUnavailableMaximum unavailable instances""
nodeAffinityPreset.typeNode affinity preset type. Ignored if affinity is set. Allowed values: soft or hard""
nodeAffinityPreset.keyNode label key to match. Ignored if affinity is set.""
nodeAffinityPreset.valuesNode label values to match. Ignored if affinity is set.[]
affinityAffinity for pod assignment{}
topologySpreadConstraintsTopology spread constraints for pod[]
nodeSelectorNode labels for pod assignment{}
tolerationsTolerations for pod assignment[]
service.typeKubernetes Service typeClusterIP
service.ports.httpsKubernetes Service port443
service.nodePorts.httpsKubernetes Service port""
service.clusterIPmetrics-server service Cluster IP

Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/metrics-server/README.md

Docker Pull Command

docker pull bitnamicharts/metrics-server
Bitnami