diff --git a/stable/fluent-bit/README.md b/stable/fluent-bit/README.md index 884a865097..a1cf6daf81 100644 --- a/stable/fluent-bit/README.md +++ b/stable/fluent-bit/README.md @@ -1,12 +1,13 @@ -# fluent-bit Chart +# Fluent-Bit Chart [Fluent Bit](http://fluentbit.io/) 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 the fluent bit [per-host architecture] +* Install a configmap for Fluent Bit +* Install a daemonset that provisions Fluent Bit [per-host architecture] ## Installing the Chart @@ -16,6 +17,12 @@ To install the chart with the release name `my-release`: $ helm install --name my-release stable/fluent-bit ``` +When installing this chart on [Minikube](https://kubernetes.io/docs/getting-started-guides/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: + +```bash +$ helm install --name my-release stable/fluent-bit --set on_minikube=true +``` + ## Configuration Configurable values are documented in the `values.yaml`.