Introducing our new CEO Don Johnson - Read More

bitnamicharts/node-exporter

Verified Publisher

By VMware

Updated 1 day ago

Bitnami Helm chart for Node Exporter

Image
Helm
Monitoring & Observability
0

100K+

Bitnami package for Node Exporter

Prometheus exporter for hardware and OS metrics exposed by UNIX kernels, with pluggable metric collectors.

Overview of Node Exporter

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/node-exporter

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

Introduction

This chart bootstraps Node Exporter on Kubernetes 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/node-exporter

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.

The command deploys Node Exporter on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

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.

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.

Set Pod affinity

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

As an alternative, you can use 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.

Resource Type

This chart, by default, installs Node Exporter as a DaemonSet. There are some cases where you may need to run Node Exporter as a Deployment (e.g., when using its textfile collector exclusively). In these instances, you can install the helm chart by setting the resourceType parameter to Deployment.

Installing the Node Exporter chart in Deployment mode will overwrite hostNetwork and hostPid to false and will not mount /proc and /sys from the host to the container. You can control this behavior by setting the isolatedDeployment parameter.

Parameters

Global parameters
NameDescriptionValue
global.imageRegistryGlobal Docker image registry""
global.imagePullSecretsGlobal Docker registry secret names as an array[]
global.defaultStorageClassGlobal default StorageClass for Persistent Volume(s)""
global.storageClassDEPRECATED: use global.defaultStorageClass instead""
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 with a string""
namespaceOverrideString to fully override common.names.namespace""
commonAnnotationsAnnotations to add to all deployed objects{}
commonLabelsLabels to add to all deployed objects{}
extraDeployArray of extra objects to deploy with the release[]
clusterDomainKubernetes cluster domain namecluster.local
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"]
Node Exporter parameters
NameDescriptionValue
resourceTypeSpecify how to deploy Node Exporter (allowed values: daemonset and deployment)daemonset
replicaCountNumber of replicas to deploy (when resourceType is deployment)1
isolatedDeploymentSpecify whether to deploy the Node Exporter in an isolated deployment without access to host network, host PID and /proc and /sys of the host. (when resourceType is deployment)true
automountServiceAccountTokenMount Service Account token in podfalse
hostAliasesDeployment pod host aliases[]
rbac.createWhether to create and use RBAC resources or nottrue
rbac.pspEnabledWhether to create a PodSecurityPolicy and bound it with RBAC. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or latertrue
serviceAccount.createSpecifies whether a ServiceAccount should be createdtrue
serviceAccount.nameName of the service account to use. If not set and create is true, a name is generated using the fullname template.""
serviceAccount.automountServiceAccountTokenAutomount service account token for the server service accountfalse
serviceAccount.annotationsAnnotations for service account. Evaluated as a template. Only used if create is true.{}
image.registryNode Exporter image registryREGISTRY_NAME
image.repositoryNode Exporter image repositoryREPOSITORY_NAME/node-exporter
image.digestNode Exporter image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag""
image.pullPolicyNode Exporter image pull policyIfNotPresent
image.pullSecretsSpecify docker-registry secret names as an array[]
containerPorts.metricsNode Exporter container port9100
sidecarsAdd additional sidecar containers to the Node exporter pod(s)[]
initContainersAdd additional init containers to the Node exporter pod(s)[]
pdb.createEnable/disable a Pod Disruption Budget creationtrue
pdb.minAvailableMinimum number/percentage of pods that should remain scheduled""
pdb.maxUnavailableMaximum number/percentage of pods that may be made unavailable. Defaults to 1 if both pdb.minAvailable and pdb.maxUnavailable are empty.""
extraArgsAdditional command line arguments to pass to node-exporter{}
commandOverride default container command (useful when using custom images)[]
argsOverride default container args (useful when using custom images)[]
lifecycleHooksfor the Node exporter container(s) to automate configuration before or after startup{}
extraEnvVarsArray with extra environment variables to add to Node exporter container[]
extraEnvVarsCMName of existing ConfigMap containing extra env vars for Node exporter container""
extraEnvVarsSecretName of existing Secret containing extra env vars for Node exporter container""
extraVolumesAdditional volumes to the node-exporter pods[]
extraVolumeMountsAdditional volumeMounts to the node-exporter container[]
podSecurityContext.enabledEnabled Node exporter pods' Security Contexttrue
podSecurityContext.fsGroupChangePolicySet filesystem group change policyAlways
podSecurityContext.sysctlsSet kernel settings using the sysctl interface[]
podSecurityContext.supplementalGroupsSet filesystem extra groups[]
podSecurityContext.fsGroupSet Node exporter pod's Security Context fsGroup1001
containerSecurityContext.enabledEnabled containers' Security Contexttrue
containerSecurityContext.seLinuxOptionsSet SELinux options in container{}
containerSecurityContext.runAsUserSet containers' Security Context runAsUser1001
containerSecurityContext.runAsGroupSet containers' Security Context runAsGroup1001
containerSecurityContext.runAsNonRootSet container's Security Context runAsNonRoottrue
containerSecurityContext.privilegedSet container's Security Context privilegedfalse
containerSecurityContext.readOnlyRootFilesystemSet container's Security Context readOnlyRootFilesystemtrue
containerSecurityContext.allowPrivilegeEscalationSet container's Security Context allowPrivilegeEscalationfalse
containerSecurityContext.capabilities.dropList of capabilities to be dropped["ALL"]
containerSecurityContext.seccompProfile.typeSet container's Security Context seccomp profile

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/node-exporter/README.md

Docker Pull Command

docker pull bitnamicharts/node-exporter
Bitnami