From 56539c053bfdb68cc63b8dfb208716c29d05f970 Mon Sep 17 00:00:00 2001 From: Josh Baird Date: Fri, 18 Oct 2024 08:49:07 -0400 Subject: [PATCH] Add README to chart. Signed-off-by: Josh Baird --- charts/fluent-operator/README.md | 35 ++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 charts/fluent-operator/README.md diff --git a/charts/fluent-operator/README.md b/charts/fluent-operator/README.md new file mode 100644 index 000000000..73f7fbe0d --- /dev/null +++ b/charts/fluent-operator/README.md @@ -0,0 +1,35 @@ +# Fluent Operator Helm chart + +[Fluent Operator](https://github.com/fluent/fluent-operator/) provides a Kubernetes-native logging pipeline based on Fluent-Bit and Fluentd. + +## Installation + +To install or upgrade Fluent Operator using Helm: + +```shell +export FLUENT_OPERATOR_CONTAINER_RUNTIME="containerd" # or "cri-o", "docker" depending on the container runtime being used (see `values.yaml`) + +helm repo add fluent https://fluent.github.io/helm-charts +helm upgrade --install fluent-operator fluent/fluent-operator \ + --create-namespace \ + --set containerRuntime=${FLUENT_OPERATOR_CONTAINER_RUNTIME} +``` + +By default, all CRDs required for Fluent Operator will be installed. To prevent `helm install` from installing CRDs, you can set `fluent-bit.crdsEnable` or `fluentd.crdsEnable` to `false`. + +## Upgrading + +Helm [does not manage the lifecycle of CRDs](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/), so if the Fluent Operator CRDs already exist, subsequent +chart upgrades will not add or remove CRDs even if they have changed. During upgrades, users should manually update CRDs: + +``` +wget https://github.com/fluent/fluent-operator/releases/download//fluent-operator.tgz +tar -xf fluent-operator.tgz +kubectl replace -f fluent-operator/crds +``` + +## Chart Values + +``` +helm show values fluent/fluent-operator +``` \ No newline at end of file