Kcl/update docs ci

.github/workflows/docs.yml

@@ -13,7 +13,7 @@ jobs:
 
       - name: Run Helm Docs and check the outcome
         run: |
-          for chart in event-generator falco k8s-metacollector; do
+          for chart in $(ls ./charts); do
             docker run \
               --rm \
               --workdir=/helm-docs \
@@ -27,9 +27,9 @@ jobs:
 
       - name: Print a comment in case of failure
         run: |
-          echo "The README.md filer are not up to date.
+          echo "The README.md files are not up to date.
 
-          Please, run make docs before pushing."
+          Please, run \"make docs\" before pushing."
           exit 1
         if: |
           failure() && github.event.pull_request.head.repo.full_name == github.repository

Makefile

@@ -22,7 +22,7 @@ lint-%:
 	ct lint --config ./ct.yaml --charts ./charts/$*
 
 .PHONY: docs
-docs: $(addprefix docs-, $(filter-out falco-exporter,$(CHARTS_NAMES)))
+docs: $(addprefix docs-, $(CHARTS_NAMES))
 
 docs-%:
 	@docker run \

charts/falco-exporter/CHANGELOG.md

@@ -3,6 +3,11 @@
 This file documents all notable changes to `falco-exporter` Helm Chart. The release
 numbering uses [semantic versioning](http://semver.org).
 
+## v0.9.10
+
+* update configuration values in README.md
+* introduce helm docs for the chart
+
 ## v0.9.9
 
 * update tolerations

charts/falco-exporter/Chart.yaml

@@ -14,7 +14,7 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 0.9.9
+version: 0.9.10
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.

charts/falco-exporter/README.gotmpl

@@ -0,0 +1,75 @@
+# falco-exporter Helm Chart
+
+[falco-exporter](https://github.com/falcosecurity/falco-exporter) is a Prometheus Metrics Exporter for Falco output events.
+
+Before using this chart, you need [Falco installed](https://falco.org/docs/installation/) and running with the [gRPC Output](https://falco.org/docs/grpc/) enabled (over Unix socket by default).
+
+This chart is compatible with the [Falco Chart](https://github.com/falcosecurity/charts/tree/master/falco) version `v1.2.0` or greater. Instructions to enable the gRPC Output in the Falco Helm Chart can be found [here](https://github.com/falcosecurity/charts/tree/master/falco#enabling-grpc). We also strongly recommend using [gRPC over Unix socket](https://github.com/falcosecurity/charts/tree/master/falco#grpc-over-unix-socket-default).
+
+## Introduction
+
+The chart deploys **falco-exporter** as Daemon Set on your the Kubernetes cluster. If a [Prometheus installation](https://github.com/helm/charts/tree/master/stable/prometheus) is running within your cluster, metrics provided by **falco-exporter** will be automatically discovered.
+
+## Adding `falcosecurity` repository
+
+Prior to installing the chart, add the `falcosecurity` charts repository:
+
+```bash
+helm repo add falcosecurity https://falcosecurity.github.io/charts
+helm repo update
+```
+
+## Installing the Chart
+
+To install the chart with the release name `falco-exporter` run:
+
+```bash
+helm install falco-exporter falcosecurity/falco-exporter
+```
+
+After a few seconds, **falco-exporter** should be running.
+
+> **Tip**: List all releases using `helm list`, a release is a name used to track a specific deployment
+
+## Uninstalling the Chart
+
+To uninstall the `falco-exporter` deployment:
+
+```bash
+helm uninstall falco-exporter
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+```bash
+helm install falco-exporter --set falco.grpcTimeout=3m falcosecurity/falco-exporter
+```
+
+Alternatively, a YAML file that specifies the parameters' values can be provided while installing the chart. For example,
+
+```bash
+helm install falco-exporter -f values.yaml falcosecurity/falco-exporter
+```
+
+### Enable Mutual TLS
+
+Mutual TLS for `/metrics` endpoint can be enabled to prevent alerts content from being consumed by unauthorized components.
+
+To install falco-exporter with Mutual TLS enabled, you have to:
+
+```shell
+helm install falco-exporter \
+  --set service.mTLS.enabled=true \
+  --set-file service.mTLS.server.key=/path/to/server.key \
+  --set-file service.mTLS.server.crt=/path/to/server.crt \
+  --set-file service.mTLS.ca.crt=/path/to/ca.crt \
+  falcosecurity/falco-exporter
+```
+
+> **Tip**: You can use the default [values.yaml](values.yaml)
+
+## Configuration
+
+The following table lists the main configurable parameters of the {{ template "chart.name" . }} chart v{{ template "chart.version" . }} and their default values. Please, refer to [values.yaml](./values.yaml) for the full list of configurable parameters.
+
+{{ template "chart.valuesSection" . }}