Back to Charts

⚠️ Repo Archive Notice

stable/auditbeat/README.md

latest6.4 KB
Original Source

⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

Auditbeat

Auditbeat is a lightweight shipper to audit the activities of users and processes on your systems, so that you can identify potential security policy violations. You can use Auditbeat to collect audit events from the Linux Audit Framework. You can also use Auditbeat for file integrity check, that is to detect changes to critical files, like binaries and configuration files.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

Introduction

This chart deploys auditbeat agents to all the nodes in your cluster via a DaemonSet.

By default this chart only ships a single output to a file on the local system. Users should set config.output.file.enabled=false and configure their own outputs as documented

Prerequisites

  • Kubernetes 1.9+

Installing the Chart

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

bash
$ helm install --name my-release stable/auditbeat

After a few minutes, you should see service statuses being written to the configured output, which is a log file inside the auditbeat container.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

bash
$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the auditbeat chart and their default values.

ParameterDescriptionDefault
image.repositoryThe image repository to pull fromdocker.elastic.co/beats/auditbeat
image.tagThe image tag to pull6.7.0
image.pullPolicyImage pull policyIfNotPresent
rbac.createIf true, create & use RBAC resourcestrue
rbac.serviceAccountexisting ServiceAccount to use (ignored if rbac.create=true)default
configThe content of the configuration file consumed by auditbeat. See the auditbeat documentation for full details
pluginsList of beat plugins
extraVarsA map of additional environment variables
extraVolumes, extraVolumeMountsAdditional volumes and mounts, for example to provide other configuration files
resources.requests.cpuCPU resource requests
resources.limits.cpuCPU resource limits
resources.requests.memoryMemory resource requests
resources.limits.memoryMemory resource limits

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

bash
$ helm install --name my-release \
    --set rbac.create=true \
    stable/auditbeat

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

bash
$ helm install --name my-release -f values.yaml stable/auditbeat

Tip: You can use the default values.yaml