Install Vector using Helm

Helm is a package manager for Kubernetes that facilitates the deployment and management of applications and services on Kubernetes clusters. This page covers installing and managing the Vector agent chart and the Vector aggregator chart from the Helm package repository. The agent chart and the aggregator chart are made available by adding the Vector Helm repository but are installed and configured separately.

{{< warning title="Aggregator role in public beta" >}} Helm support for the aggregator role is currently in public beta. We're seeking beta testers! If deploying the aggregator chart, please join our chat and let us know how it went.

{{< /warning >}}

linkAdding the Helm repo

If you haven't already, start by adding the Vector repo:

1helm repo add vector https://helm.vector.dev
2helm repo update

linkAgent

The Vector Agent lets you collect data from your sources and then deliver it to a variety of destinations with sinks.

linkConfiguring

To check available Helm chart configuration options:

1helm show values vector/vector-agent

This example configuration file lets you use Vector as an Agent to send logs to standard output. For more information about configuration options, see the configuration docs page.

1cat <<-'VALUES' > values.yaml
2# The Vector Kubernetes integration automatically defines a
3# kubernetes_logs source that is made available to you.
4# You do not need to define a log source.
5sinks:
6  # Adjust as necessary. By default we use the console sink
7  # to print all data. This allows you to see Vector working.
8  # /docs/reference/sinks/
9  stdout:
10    type: console
11    inputs: ["kubernetes_logs"]
12    target: "stdout"
13    encoding: "json"
14VALUES

linkInstalling

Once you add the Vector Helm repo, and added a Vector configuration file, install the Vector Agent:

1helm install vector vector/vector-agent \
2  --namespace vector \
3  --create-namespace \
4  --values values.yaml

linkUpdating

Or to update the Vector Agent:

1helm repo update && \
2helm upgrade vector vector/vector-agent \
3  --namespace vector \
4  --reuse-values

linkAggregator

The Vector Aggregator lets you transform and ship data collected by other agents. For example, it can insure that the data you are collecting is scrubbed of sensitive information, properly formatted for downstream consumers, sampled to reduce volume, and more.

linkConfiguring

To check available Helm chart configuration options:

1helm show values vector/vector-aggregator

This example configuration file lets you use Vector as an Aggregator to parse events to make them human-readable. For more information about configuration options, see the Configuration docs page.

1cat <<-'VALUES' > values.yaml
2# The Vector Aggregator chart defines a
3# vector source that is made available to you.
4# You do not need to define a log source.
5transforms:
6  # Adjust as necessary. This remap transform parses a JSON
7  # formatted log message, emitting a log if the contents are
8  # not valid JSON
9  # /docs/reference/transforms/
10  remap:
11    type: remap
12    inputs: ["vector"]
13    source: |
14      structured, err = parse_json(.message)
15      if err != null {
16        log("Unable to parse JSON: " + err, level: "error")
17      } else {
18        . = merge(., object!(structured))
19      }
20sinks:
21  # Adjust as necessary. By default we use the console sink
22  # to print all data. This allows you to see Vector working.
23  # /docs/reference/sinks/
24  stdout:
25    type: console
26    inputs: ["remap"]
27    target: "stdout"
28    encoding: "json"
29VALUES

linkInstalling

Once you add the Vector Helm repo, and add a Vector configuration file, install the Vector Aggregator:

1helm install vector vector/vector-aggregator \
2  --namespace vector \
3  --create-namespace \
4  --values values.yaml

linkUpdating

Or to update the Vector Aggregator:

1helm repo update && \
2helm upgrade vector vector/vector-aggregator \
3  --namespace vector \
4  --reuse-values

linkUninstalling Vector

To uninstall the Vector helm chart:

1helm uninstall vector --namespace vector

linkManagement

{{< jump "/docs/administration/management" "helm" >}}