diff --git a/README.md b/README.md index af4c72c..deb9b5e 100644 --- a/README.md +++ b/README.md @@ -38,16 +38,36 @@ Usage of ./falco-exporter: --timeout duration timeout for initial gRPC connection (default 2m0s) ``` +### Run with Docker + +To run **falco-exporter** in a container using Docker: + +```shell +docker run -v /path/to/falco.sock:/var/run/falco.sock falcosecurity/falco-exporter +``` + ### Deploy in Kubernetes -Using the [provided Helm chart](deploy/helm/falco-exporter/) is the easiest way to deploy **falco-exporter**. +### Using Helm + +Using the [falco-exporter Helm Chart](https://github.com/falcosecurity/charts/tree/master/falco-exporter) is the easiest way to deploy **falco-exporter**. + +Before installing the chart, add the `falcosecurity` charts repository: + +```shell +helm repo add falcosecurity https://falcosecurity.github.io/charts +helm repo update +``` + +Finally, to install the chart with the release name `falco-exporter` and default [configuration values](https://github.com/falcosecurity/charts/blob/master/falco-exporter/values.yaml): -To install the chart with the release name `falco-exporter` and default [configuration values](deploy/helm/falco-exporter/values.yaml): ```shell -helm install falco-exporter ./deploy/helm/falco-exporter +helm install falco-exporter falcosecurity/falco-exporter ``` -The command 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. +The full documentation of the Helm Chart is [here](https://github.com/falcosecurity/charts/tree/master/falco-exporter). + +### Using resource templates Alternatively, it is possible to deploy **falco-exporter** without using Helm. Templates for manual installation are [here](deploy/k8s/falco-exporter). @@ -61,6 +81,6 @@ You can find detailed Grafana importing instructions [here](https://grafana.com/ ## Connection options -**falco-exporter** uses gRPC over Unix socket by default. +**falco-exporter** uses gRPC over a Unix socket by default. You may change this behavior by setting `--client-hostname`. Note that the Falco gRPC server over the network works only with mutual TLS by design. Therefore, when `--client-hostname` is set you also need valid [certificate files](https://falco.org/docs/grpc/#certificates) to configure **falco-exporter** properly (see the *Command line usage* above). \ No newline at end of file