Back to Charts

⚠️ Repo Archive Notice

stable/metricbeat/README.md

latest20.0 KB
Original Source

⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

Metricbeat

metricbeat is used to ship Kubernetes and host metrics to multiple outputs.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

Prerequisites

  • Kubernetes 1.9+

Installing the Chart

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

bash
$ helm install --name my-release stable/metricbeat

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

bash
$ helm delete my-release

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

Configuration

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

ParameterDescriptionDefault
image.repositoryThe image repository to pull fromdocker.elastic.co/beats/metricbeat
image.tagThe image tag to pull6.7.0
image.pullPolicyImage pull policyIfNotPresent
rbac.createIf true, create & use RBAC resourcestrue
rbac.pspEnabledIf true, create & use PSP resourcesfalse
serviceAccount.createIf true, create & use ServiceAccounttrue
serviceAccount.nameThe name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template
configThe content of the configuration file consumed by metricbeat. See the metricbeat.reference.yml for full details
pluginsList of beat plugins
extraEnvAdditional environment
extraVolumes, extraVolumeMountsAdditional volumes and mounts, for example to provide other configuration files
extraSecretsAdditional secrets for save private data
resources.requests.cpuCPU resource requests
resources.limits.cpuCPU resource limits
resources.requests.memoryMemory resource requests
resources.limits.memoryMemory resource limits
daemonset.enabledIf true, enable daemonset
daemonset.argsCustom arguments for the docker command
daemonset.overrideConfigIf overrideConfig is not empty, metricbeat chart's default config won't be used at all.{}
daemonset.modules.<name>.configThe content of the modules configuration file consumed by metricbeat deployed as daemonset, which is assumed to collect metrics in each nodes. See the metricbeat.reference.yml for full details
daemonset.modules.<name>.enabledIf true, enable configuration
daemonset.overrideModulesIf overrideModules is not empty, metricbeat chart's default modules won't be used at all.{}
daemonset.podAnnotationsPod annotations for daemonset
daemonset.priorityClassNamePod priority class name for daemonset (e.g system-node-critical)""
daemonset.nodeSelectorPod node selector for daemonset{}
daemonset.tolerationsPod taint tolerations for daemonset[{"key": "node-role.kubernetes.io/master", "operator": "Exists", "effect": "NoSchedule"}]
daemonset.resources.requests.cpuCPU resource requests for daemonset
daemonset.resources.limits.cpuCPU resource limits for daemonset
daemonset.hostNetworkLeverage host network interfacestrue
daemonset.capabilitiesAdd security capabilities to the daemonset[]
daemonset.dnsPolicyPod DNS PolicyClusterFirstWithHostNet
deployment.enabledIf true, enable deployment
deployment.argsCustom arguments for the docker command
deployment.overrideConfigIf overrideConfig is not empty, metricbeat chart's default config won't be used at all.{}
deployment.modules.<name>.configThe content of the modules configuration file consumed by metricbeat deployed as deployment, which is assumed to collect cluster-level metrics. See the metricbeat.reference.yml for full details
deployment.modules.<name>.enabledIf true, enable configuration
deployment.overrideModulesIf overrideModules is not empty, metricbeat chart's default modules won't be used at all.{}
deployment.podAnnotationsPod annotations for deployment
deployment.priorityClassNamePod priority class name for deployment (e.g system-cluster-critical)""
deployment.nodeSelectorPod node selector for deployment{}
deployment.tolerationsPod taint tolerations for deployment[]
deployment.resources.requests.cpuCPU resource requests for daemonset
deployment.resources.limits.cpuCPU resource limits for daemonset

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

bash
$ helm install --name my-release \
    --set rbac.create=true \
    stable/metricbeat

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

bash
$ helm install --name my-release -f values.yaml stable/metricbeat

Tip: You can use the default values.yaml