Back to Charts

⚠️ Repo Archive Notice

stable/filebeat/README.md

latest10.1 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.

Filebeat

filebeat is used to ship Kubernetes and host logs to multiple outputs.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

Prerequisites

  • Kubernetes 1.10+
  • Filebeat 7.4.0+
    • If wanting to use a older version of filebeat you will need to modify the configuration to add back in the in_cluster configuration see this pull request.

Note

By default this chart only ships a single output to a file on the local system. Users should set config.output.file.enabled=false and configure their own outputs as documented

Installing the Chart

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

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

Configuration

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

ParameterDescriptionDefault
image.repositoryDocker image repodocker.elastic.co/beats/filebeat-oss
image.tagDocker image tag7.4.0
image.pullPolicyDocker image pull policyIfNotPresent
image.pullSecretsSpecify image pull secretsnil
config.filebeat.config.modules.path${path.config}/modules.d/*.yml
config.filebeat.config.modules.reload.enabledReload module configs as they changefalse
config.processors- add_cloud_metadata
config.filebeat.inputssee values.yaml
config.output.file.path"/usr/share/filebeat/data"
config.output.file.filenamefilebeat
config.output.file.rotate_every_kb10000
config.output.file.number_of_files5
config.http.enabledfalse
config.http.port5066
overrideConfigIf overrideConfig is not empty, filebeat chart's default config won't be used at all.{}
data.hostPathPath on the host to mount to /usr/share/filebeat/data in the container./var/lib/filebeat
indexTemplateLoadList of Elasticsearch hosts to load index template, when logstash output is used[]
commandCustom command (Docker Entrypoint)[]
argsCustom args (Docker Cmd)[]
pluginsList of beat plugins[]
extraVarsA list of additional environment variables[]
extraVolumesAdd additional volumes[]
extraVolumeMountsAdd additional mounts[]
extraInitContainersAdd additional initContainers[]
extraSecretsAdd additional secrets{}
resources{}
priorityClassNamepriorityClassNamenil
nodeSelector{}
annotations{}
tolerations[]
affinity{}
rbac.createSpecifies whether RBAC resources should be createdtrue
serviceAccount.createSpecifies whether a ServiceAccount should be createdtrue
serviceAccount.namethe name of the ServiceAccount to use""
podSecurityPolicy.enabledShould the PodSecurityPolicy be created. Depends on rbac.create being set to true.false
podSecurityPolicy.annotationsAnnotations to be added to the created PodSecurityPolicy:""
privilegedSpecifies wheter to run as privilegedfalse

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

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/filebeat