Fluent-Bit Chart

Fluent Bit is an open source and multi-platform Log Forwarder.

Chart Details

This chart will do the following:

• Install a configmap for Fluent Bit
• Install a daemonset that provisions Fluent Bit [per-host architecture]

Installing the Chart

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

$ helm install --name my-release stable/fluent-bit

When installing this chart on Minikube, it's required to specify that so the DaemonSet will be able to mount the log files properly, make sure to append the --set on_minikube=true option at the end of the helm command, e.g:

$ helm install --name my-release stable/fluent-bit --set on_minikube=true

Configuration

The following table lists the configurable parameters of the Fluent-Bit chart and the default values.

Parameter	Description	Default
Backend Selection
backend.type	Set the backend to which Fluent-Bit should flush the information it gathers	forward
Forward Backend
backend.forward.host	Target host where Fluent-Bit or Fluentd are listening for Forward messages	fluentd
backend.forward.port	TCP Port of the target service	24284
backend.forward.shared_key	A key string known by the remote Fluentd used for authorization.	``
backend.forward.tls	Enable or disable TLS support	off
backend.forward.tls_verify	Force certificate validation	on
backend.forward.tls_debug	Set TLS debug verbosity level. It accept the following values: 0-4	1
ElasticSearch Backend
backend.es.host	IP address or hostname of the target Elasticsearch instance	elasticsearch
backend.es.port	TCP port of the target Elasticsearch instance.	9200
backend.es.index	Elastic Index name	kubernetes_cluster
backend.es.type	Elastic Type name	flb_type
backend.es.time_key	Elastic Time Key	@timestamp
backend.es.logstash_prefix	Index Prefix. If Logstash_Prefix is equals to 'mydata' your index will become 'mydata-YYYY.MM.DD'.	kubernetes_cluster
backend.es.replace_dots	Enable/Disable Replace_Dots option.	On
backend.es.http_user	Optional username credential for Elastic X-Pack access.	``
backend.es.http_passwd:	Password for user defined in HTTP_User.	``
backend.es.tls	Enable or disable TLS support	off
backend.es.tls_verify	Force certificate validation	on
backend.es.tls_ca	TLS CA certificate for the Elastic instance (in PEM format). Specify if tls: on.	``
backend.es.tls_debug	Set TLS debug verbosity level. It accept the following values: 0-4	1
HTTP Backend
backend.http.host	IP address or hostname of the target HTTP Server	127.0.0.1
backend.http.port	TCP port of the target HTTP Server	80
backend.http.uri	Specify an optional HTTP URI for the target web server, e.g: /something	"/"
backend.http.http_user	Optional username credential for Basic Authentication.	``
backend.http.http_passwd:	Password for user defined in HTTP_User.	``
backend.http.format	Specify the data format to be used in the HTTP request body, by default it uses msgpack, optionally it can be set to json.	msgpack
backend.http.tls	Enable or disable TLS support	off
backend.http.tls_verify	Force certificate validation	on
backend.http.tls_debug	Set TLS debug verbosity level. It accept the following values: 0-4	1
Splunk Backend
backend.splunk.host	IP address or hostname of the target Splunk Server	127.0.0.1
backend.splunk.port	TCP port of the target Splunk Server	8088
backend.splunk.token	Specify the Authentication Token for the HTTP Event Collector interface.	``
backend.splunk.send_raw	If enabled, record keys and values are set in the main map.	off
backend.splunk.tls	Enable or disable TLS support	on
backend.splunk.tls_verify	Force TLS certificate validation	off
backend.splunk.tls_debug	Set TLS debug verbosity level. It accept the following values: 0-4	1
backend.splunk.message_key	Tag applied to all incoming logs	kubernetes
Parsers
parsers.enabled	Enable custom parsers	false
parsers.regex	List of regex parsers	NULL
parsers.json	List of json parsers	NULL
General
annotations	Optional deamonset set annotations	NULL
podAnnotations	Optional pod annotations	NULL
fullConfigMap	User has provided entire config (parsers + system)	false
existingConfigMap	ConfigMap override	``
extraEntries.input	Extra entries for existing [INPUT] section	``
extraEntries.filter	Extra entries for existing [FILTER] section	``
extraEntries.output	Extra entries for existing [OUPUT] section	``
extraPorts	List of extra ports
extraVolumeMounts	Mount an extra volume, required to mount ssl certificates when elasticsearch has tls enabled
extraVolume	Extra volume
filter.enableExclude	Enable the use of monitoring for a pod annotation of fluentbit.io/exclude: true. If present, discard logs from that pod.	true
filter.enableParser	Enable the use of monitoring for a pod annotation of fluentbit.io/parser: parser_name. parser_name must be the name of a parser contained within parsers.conf	true
filter.kubeURL	Optional custom configmaps	https://kubernetes.default.svc:443
filter.kubeCAFile	Optional custom configmaps	/var/run/secrets/kubernetes.io/serviceaccount/ca.crt
filter.kubeTokenFile	Optional custom configmaps	/var/run/secrets/kubernetes.io/serviceaccount/token
filter.kubeTag	Optional top-level tag for matching in filter	kube
filter.mergeJSONLog	If the log field content is a JSON string map, append the map fields as part of the log structure	true
image.fluent_bit.repository	Image	fluent/fluent-bit
image.fluent_bit.tag	Image tag	1.0.1
image.pullPolicy	Image pull policy	Always
image.pullSecrets	Specify image pull secrets	nil
input.tail.memBufLimit	Specify Mem_Buf_Limit in tail input	5MB
input.tail.path	Specify log file(s) through the use of common wildcards.	/var/log/containers/*.log
rbac.create	Specifies whether RBAC resources should be created.	true
serviceAccount.create	Specifies whether a ServiceAccount should be created.	true
serviceAccount.name	The name of the ServiceAccount to use.	NULL
rawConfig	Raw contents of fluent-bit.conf	@INCLUDE fluent-bit-service.conf @INCLUDE fluent-bit-input.conf @INCLUDE fluent-bit-filter.conf @INCLUDE fluent-bit-output.conf
resources	Pod resource requests & limits	{}
hostNetwork	Use host's network	false
dnsPolicy	Specifies the dnsPolicy to use	ClusterFirst
tolerations	Optional daemonset tolerations	NULL
nodeSelector	Node labels for fluent-bit pod assignment	NULL
metrics.enabled	Specifies whether a service for metrics should be exposed	false
metrics.service.annotations	Optional metrics service annotations	NULL
metrics.service.port	Port on where metrics should be exposed	2020
metrics.service.type	Service type for metrics	ClusterIP
trackOffsets	Specify whether to track the file offsets for tailing docker logs. This allows fluent-bit to pick up where it left after pod restarts but requires access to a hostPath	false

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,

$ helm install --name my-release -f values.yaml stable/fluent-bit

Tip: You can use the default values.yaml

Upgrading

From < 1.0.0 To 1.0.0

Values extraInputs, extraFilters and extraOutputs have been removed in version 1.0.0 of the fluent-bit chart. To add additional entries to the existing sections, please use the extraEntries.input, extraEntries.filter and extraEntries.output values. For entire sections, please use the rawConfig value, inserting blocks of text as desired.