Skip to content
This repository has been archived by the owner on May 28, 2024. It is now read-only.

Latest commit

 

History

History
228 lines (177 loc) · 17.4 KB

README.md

File metadata and controls

228 lines (177 loc) · 17.4 KB
Raw

Filebeat Helm Chart

This Helm chart is a lightweight way to configure and run our official Filebeat Docker image.

Warning: This functionality is in beta. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features (see supported configurations for more details).

Warning: This branch is used for development, please use [6.8.12][] release for released version.

Requirements

  • Helm >=2.8.0 and <3.0.0
  • Kubernetes >=1.9

See supported configurations for more details.

Installing

This chart is tested with the latest 6.8.13-SNAPSHOT version.

Install released version using Helm repository

  • Add the Elastic Helm charts repo: helm repo add elastic https://helm.elastic.co

  • Install it:

    • with Helm 2: helm install --name filebeat --version 6.8.12 elastic/filebeat
    • with Helm 3 (beta): helm install filebeat --version 6.8.12 elastic/filebeat

Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions

  • Clone the git repo: git clone git@github.com:elastic/helm-charts.git

  • Install it:

    • with Helm 2: helm install --name filebeat ./helm-charts/filebeat
    • with Helm 3 (beta): helm install filebeat ./helm-charts/filebeat

Upgrading

Please always check CHANGELOG.md and BREAKING_CHANGES.md before upgrading to a new chart version.

Usage notes

  • The default Filebeat configuration file for this chart is configured to use an Filebeat endpoint. Without any additional changes, Filebeat will send documents to the service URL that the Filebeat Helm chart sets up by default. You may either set the FILEBEAT_HOSTS environment variable in extraEnvs to override this endpoint or modify the default filebeatConfig to change this behavior.
  • The default Filebeat configuration file is also configured to capture container logs and enrich them with Kubernetes metadata by default. This will capture all container logs in the cluster.
  • This chart disables the HostNetwork setting by default for compatibility reasons with the majority of kubernetes providers and scenarios. Some kubernetes providers may not allow enabling hostNetwork and deploying multiple Filebeat pods on the same node isn't possible with hostNetwork However Filebeat does recommend activating it. If your kubernetes provider is compatible with hostNetwork and you don't need to run multiple Filebeat DaemonSets, you can activate it by setting hostNetworking: true in values.yaml.
  • This repo includes a number of examples configurations which can be used as a reference. They are also used in the automated testing of this chart.

Configuration

Parameter Description Default
affinity Configurable affinity {}
envFrom Templatable string of envFrom to be passed to the environment from variables which will be appended to the envFrom: definition for the container []
extraContainers List of additional init containers to be added at the DaemonSet ""
extraEnvs Extra environment variables which will be appended to the env: definition for the container []
extraInitContainers List of additional init containers to be added at the DaemonSet. It also accepts a templatable string of additional containers to be passed to the tpl function []
extraVolumeMounts List of additional volumeMounts to be mounted on the DaemonSet []
extraVolumes List of additional volumes to be mounted on the DaemonSet []
filebeatConfig Allows you to add any config files in /usr/share/filebeat such as filebeat.yml see values.yaml
fullnameOverride Overrides the full name of the resources. If not set the name will default to " .Release.Name - .Values.nameOverride or .Chart.Name " ""
hostNetworking Use host networking in the DaemonSet so that hostname is reported correctly false
dnsConfig Configurable dnsConfig {}
hostPathRoot Fully-qualified hostPath that will be used to persist Filebeat registry data /var/lib
imagePullPolicy The Kubernetes imagePullPolicy value IfNotPresent
imagePullSecrets Configuration for imagePullSecrets so that you can use a private registry for your image []
imageTag The Filebeat Docker image tag 6.8.13-SNAPSHOT
image The Filebeat Docker image docker.elastic.co/beats/filebeat
labels Configurable labels applied to all Filebeat pods {}
livenessProbe Parameters to pass to liveness probe checks for values such as timeouts and thresholds see values.yaml
managedServiceAccount Whether the serviceAccount should be managed by this Helm chart. Set this to false in order to manage your own service account and related roles true
nameOverride Overrides the chart name for resources. If not set the name will default to .Chart.Name ""
nodeSelector Configurable nodeSelector {}
podAnnotations Configurable annotations applied to all Filebeat pods {}
podSecurityContext Configurable podSecurityContext for Filebeat pod execution environment see values.yaml
priorityClassName The name of the PriorityClass. No default is supplied as the PriorityClass must be created first ""
readinessProbe Parameters to pass to readiness probe checks for values such as timeouts and thresholds see values.yaml
resources Allows you to set the resources for the DaemonSet see values.yaml
secretMounts Allows you easily mount a secret as a file inside the DaemonSet. Useful for mounting certificates and other secrets. See values.yaml for an example []
serviceAccount Custom serviceAccount that Filebeat will use during execution. By default will use the service account created by this chart ""
serviceAccountAnnotations Annotations to be added to the ServiceAccount that is created by this chart. {}
terminationGracePeriod Termination period (in seconds) to wait before killing Filebeat pod process on pod shutdown 30
tolerations Configurable tolerations []
updateStrategy The updateStrategy for the DaemonSet. By default Kubernetes will kill and recreate pods on updates. Setting this to OnDelete will require that pods be deleted manually RollingUpdate

FAQ

How to use Filebeat with Elasticsearch with security (authentication and TLS) enabled?

This Helm chart can use existing Kubernetes secrets to setup credentials or certificates for examples. These secrets should be created outside of this chart and accessed using environment variables and volumes.

An example can be found in examples/security.

How to install OSS version of Filebeat?

Deploying OSS version of Elasticsearch can be done by setting image value to Filebeat OSS Docker image

An example of Filebeat deployment using OSS version can be found in examples/oss.

Why is Filebeat host.name field set to Kubernetes pod name?

The default Filebeat configuration is using Filebeat pod name for agent.hostname and host.name fields. The hostname of the Kubernetes nodes can be find in kubernetes.node.name field. If you would like to have agent.hostname and host.name fields set to the hostname of the nodes, you'll need to set hostNetworking value to true.

Note that enabling hostNetwork make Filebeat pod use the host network namespace which gives it access to the host loopback device, services listening on localhost, could be used to snoop on network activity of other pods on the same node.

How to change readinessProbe for outputs which don't support testing

Some Filebeat outputs like Kafka output don't support testing using filebeat test output command which is used by Filebeat chart readiness probe.

This makes Filebeat pods crash before being ready with the following message: Readiness probe failed: kafka output doesn't support testing.

The workaround when using this kind of output is to override the readiness probe command to check Filebeat API instead (same as existing liveness probe).

readinessProbe:
  exec:
    command:
      - sh
      - -c
      - |
        #!/usr/bin/env bash -e
        curl --fail 127.0.0.1:5066

Contributing

Please check CONTRIBUTING.md before any contribution or for any questions about our development and testing process.