Install Vector via Helm

Helm is a package manager for Kubernetes that facilitates the deployment and management of applications and services on Kubernetes clusters. This page will cover installing and managing Vector through the Helm package repository.

Installation

Vector daemon deployment strategyVector daemon deployment strategy
1. Your service logs to STDOUT
STDOUT follows the 12 factor principles.
2. STDOUT is captured
STDOUT is captured by your platform.
3. Vector collects & fans-out data
Vector collects data from your platform.

The agent role is designed to collect all Kubernetes log data on each Node. Vector runs as a DaemonSet and tails logs for the entire Pod, automatically enriching them with Kubernetes metadata via the Kubernetes API. Collection is handled automatically, and it is intended for you to adjust your pipeline as necessary using Vector's sources, transforms, and sinks.


  1. Add the Vector repo

    helm repo add timberio https://packages.timber.io/helm/latest
  2. Check available Helm chart configuration options

    helm show values timberio/vector-agent
  3. Configure Vector

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

    helm install --namespace vector --create-namespace vector timberio/vector-agent --values values.yaml
  5. Observe Vector

    kubectl logs --namespace vector daemonset/vector-agent
    explain this command

Deployment

Vector is an end-to-end observability data pipeline designed to deploy under various roles. You mix and match these roles to create topologies. The intent is to make Vector as flexible as possible, allowing you to fluidly integrate Vector into your infrastructure over time. The deployment section demonstrates common Vector pipelines:

Common Deployment Topologies

Administration

Restart

kubectl rollout restart --namespace vector daemonset/vector-agent
explain this command

Observe

kubectl logs --namespace vector daemonset/vector-agent
explain this command

Upgrade

helm repo update && helm upgrade --namespace vector vector timberio/vector-agent --reuse-values
explain this command

Uninstall

helm uninstall --namespace vector vector
explain this command