tree: 34e59d1b6200e8ba698a74ddfb1f36376726e60a [path history] [tgz]
  1. ci/
  2. docs/
  3. examples/
  4. templates/
  5. .helmignore
  6. Chart.yaml
  7. README.md
  8. README.md.gotmpl
  9. requirements.lock
  10. values.yaml
charts/vector/README.md

Vector

Version: 0.32.0 Type: application AppVersion: 0.37.0-distroless-libc

Vector is a high-performance, end-to-end observability data pipeline that puts you in control of your observability data. Collect, transform, and route all your logs, metrics, and traces to any vendors you want today and any other vendors you may want tomorrow. Vector enables dramatic cost reduction, novel data enrichment, and data security where you need it, not where is most convenient for your vendors.

How to use Vector Helm repository

You need to add this repository to your Helm repositories:

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

Requirements

Kubernetes: >=1.15.0-0

Quick start

By default, Vector runs as a StatefulSet in the "Aggregator" role. It can alternatively run as a Deployment for the "Stateless-Aggregator" role or a DaemonSet for the "Agent" role.

Installing the Vector chart

To install the chart with the release name <RELEASE_NAME> run:

helm install --name <RELEASE_NAME> \
  vector/vector

Upgrading

From original charts

Uninstalling the chart

To uninstall/delete the <RELEASE_NAME> deployment:

helm delete <RELEASE_NAME>

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

Configuration

  1. Using our default-values.yaml configuration file as a reference, create your own values.yaml.
  2. Upgrade the Vector chart with your new values.yaml file:
helm upgrade -f values.yaml <RELEASE_NAME> vector/vector

Vector recommends that your values.yaml only contain values that need to be overridden, as it allows a smoother experience when upgrading chart versions.

See the configuration options section to discover all possibilities offered by the Vector chart.

Running on control plane nodes

Depending on your Kubernetes distribution, you may need to configure tolerations to run Vector on nodes acting as the control plane.

For example to run Vector on Openshift control plane nodes you can set:

tolerations:
  - effect: NoSchedule
    key: node-role.kubernetes.io/master
    operator: Exists
  - effect: NoSchedule
    key: node-role.kubernetes.io/infra
    operator: Exists

Or for RKE control plane nodes set:

tolerations:
  - effect: NoSchedule
    key: node-role.kubernetes.io/controlplane
    operator: Exists
  - effect: NoExecute
    key: node-role.kubernetes.io/etcd
    operator: Exists

Using template syntax in customConfig

As Vector's template syntax shares the same syntax as Helm templates, explicit handling is required if you are using Vector's template syntax in the customConfig option. To avoid Helm templating configuration intended for Vector you can supply configuration like so:

customConfig:
  #...
  sinks:
    loki:
      #...
      labels:
        foo: bar
        host: |-
          {{ print "{{ host }}" }}
        source: |-
          {{ print "{{ source_type }}" }}

All configuration options

The following table lists the configurable parameters of the Vector chart and their default values. Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install --name <RELEASE_NAME> \
  --set role=Agent \
  vector/vector

Values

Vector values

KeyTypeDefaultDescription
affinityobject{}Configure affinity rules for Vector Pods.
argslist["--config-dir","/etc/vector/"]Override Vector's default arguments.
autoscaling.annotationsobject{}Annotations to add to Vector's HPA.
autoscaling.behaviorobject{}Configure separate scale-up and scale-down behaviors.
autoscaling.customMetricobject{}Target a custom metric for autoscaling.
autoscaling.enabledboolfalseCreate a HorizontalPodAutoscaler for Vector. Valid for the "Aggregator" and "Stateless-Aggregator" roles.
autoscaling.maxReplicasint10Maximum replicas for Vector's HPA.
autoscaling.minReplicasint1Minimum replicas for Vector's HPA.
autoscaling.targetCPUUtilizationPercentageint80Target CPU utilization for Vector's HPA.
autoscaling.targetMemoryUtilizationPercentageintnilTarget memory utilization for Vector's HPA.
commandlist[]Override Vector's default command.
commonLabelsobject{}Add additional labels to all created resources.
containerPortslist[]Manually define Vector's containerPorts, overriding automated generation of containerPorts.
customConfigobject{}Override Vector's default configs, if used all options need to be specified. This section supports using helm templates to populate dynamic values. See Vector's configuration documentation for all options.
dataDirstring""Specify the path for Vector's data, only used when existingConfigMaps are used.
defaultVolumeMountslistSee values.yamlDefault volume mounts. Corresponds to volumes.
defaultVolumeslistSee values.yamlDefault volumes that are mounted into pods. In most cases, these should not be changed. Use extraVolumes/extraVolumeMounts for additional custom volumes.
dnsConfigobject{}Specify the dnsConfig options for Vector Pods.
dnsPolicystring"ClusterFirst"Specify the dnsPolicy for Vector Pods.
envlist[]Set environment variables for Vector containers.
envFromlist[]Define environment variables from Secrets or ConfigMaps.
existingConfigMapslist[]List of existing ConfigMaps for Vector's configuration instead of creating a new one. Requires dataDir to be set. Additionally, containerPorts, service.ports, and serviceHeadless.ports should be specified based on your supplied configuration. If set, this parameter takes precedence over customConfig and the chart's default configs.
extraContainerslist[]Extra Containers to be added to the Vector Pods.
extraObjectslist[]Create extra manifests via values. Would be passed through tpl for templating.
extraVolumeMountslist[]Additional Volume to mount into Vector Containers.
extraVolumeslist[]Additional Volumes to use with Vector Pods.
fullnameOverridestring""Override the full name of resources.
image.pullPolicystring"IfNotPresent"The pullPolicy for Vector's image.
image.pullSecretslist[]The imagePullSecrets to reference for the Vector Pods.
image.repositorystring"timberio/vector"Override default registry and name for Vector's image.
image.shastring""The SHA to use for Vector's image.
image.tagstringDerived from the Chart's appVersion.The tag to use for Vector's image.
ingress.annotationsobject{}Set annotations on the Ingress.
ingress.classNamestring""Specify the ingressClassName, requires Kubernetes >= 1.18
ingress.enabledboolfalseIf true, create and use an Ingress resource.
ingress.hostslist[]Configure the hosts and paths for the Ingress.
ingress.tlslist[]Configure TLS for the Ingress.
initContainerslist[]Init Containers to be added to the Vector Pods.
lifecycleobject{}Set lifecycle hooks for Vector containers.
livenessProbeobject{}Override default liveness probe settings. If customConfig is used, requires customConfig.api.enabled to be set to true.
logLevelstring"info"
minReadySecondsint0Specify the minimum number of seconds a newly spun up pod should wait to pass healthchecks before it is considered available.
nameOverridestring""Override the name of resources.
nodeSelectorobject{}Configure a nodeSelector for Vector Pods.
persistence.accessModeslist["ReadWriteOnce"]Specifies the accessModes for PersistentVolumeClaims. Valid for the "Aggregator" role.
persistence.enabledboolfalseIf true, create and use PersistentVolumeClaims.
persistence.existingClaimstring""Name of an existing PersistentVolumeClaim to use. Valid for the "Aggregator" role.
persistence.finalizerslist["kubernetes.io/pvc-protection"]Specifies the finalizers of PersistentVolumeClaims. Valid for the "Aggregator" role.
persistence.hostPath.enabledbooltrueIf true, use hostPath persistence. Valid for the "Agent" role, if it's disabled the "Agent" role will use emptyDir.
persistence.hostPath.pathstring"/var/lib/vector"Override path used for hostPath persistence. Valid for the "Agent" role, persistence is always used for the "Agent" role.
persistence.selectorsobject{}Specifies the selectors for PersistentVolumeClaims. Valid for the "Aggregator" role.
persistence.sizestring"10Gi"Specifies the size of PersistentVolumeClaims. Valid for the "Aggregator" role.
podAnnotationsobject{}Set annotations on Vector Pods.
podDisruptionBudget.enabledboolfalseEnable a PodDisruptionBudget for Vector.
podDisruptionBudget.maxUnavailableintnilThe number of Pods that can be unavailable after an eviction.
podDisruptionBudget.minAvailableint1The number of Pods that must still be available after an eviction.
podHostNetworkboolfalseConfigure hostNetwork on Vector Pods.
podLabelsobject{"vector.dev/exclude":"true"}Set labels on Vector Pods.
podManagementPolicystring"OrderedReady"Specify the podManagementPolicy for the StatefulSet. Valid for the "Aggregator" role.
podMonitor.additionalLabelsobject{}Adds additional labels to the PodMonitor.
podMonitor.enabledboolfalseIf true, create a PodMonitor for Vector.
podMonitor.honorLabelsboolfalseIf true, honor_labels is set to true in the scrape config.
podMonitor.honorTimestampsbooltrueIf true, honor_timestamps is set to true in the scrape config.
podMonitor.intervalstringnilOverride the interval at which metrics should be scraped.
podMonitor.jobLabelstring"app.kubernetes.io/name"Override the label to retrieve the job name from.
podMonitor.metricRelabelingslist[]MetricRelabelConfigs to apply to samples before ingestion.
podMonitor.pathstring"/metrics"Override the path to scrape.
podMonitor.podTargetLabelslist[]podTargetLabels transfers labels on the Kubernetes Pod onto the target.
podMonitor.portstring"prom-exporter"Override the port to scrape.
podMonitor.relabelingslist[]RelabelConfigs to apply to samples before scraping.
podMonitor.scrapeTimeoutstringnilOverride the timeout after which the scrape is ended.
podPriorityClassNamestring""Set the priorityClassName on Vector Pods.
podSecurityContextobject{}Allows you to overwrite the default PodSecurityContext for Vector Pods.
psp.createboolfalseIf true, create a PodSecurityPolicy resource. PodSecurityPolicy is deprecated as of Kubernetes v1.21, and will be removed in v1.25. Intended for use with the "Agent" role.
rbac.createbooltrueIf true, create and use RBAC resources. Only valid for the "Agent" role.
readinessProbeobject{}Override default readiness probe settings. If customConfig is used, requires customConfig.api.enabled to be set to true.
replicasint1Specify the number of Pods to create. Valid for the "Aggregator" and "Stateless-Aggregator" roles.
resourcesobject{}Set Vector resource requests and limits.
rolestring"Aggregator"Role for this Vector instance, valid options are: "Agent", "Aggregator", and "Stateless-Aggregator".
rollWorkloadbooltrueAdd a checksum of the generated ConfigMap to workload annotations.
secrets.genericobject{}Each Key/Value will be added to the Secret's data key, each value should be raw and NOT base64 encoded. Any secrets can be provided here. It's commonly used for credentials and other access related values. NOTE: Don't commit unencrypted secrets to git!
securityContextobject{}Specify securityContext on Vector containers.
service.annotationsobject{}Set annotations on Vector's Service.
service.enabledbooltrueIf true, create and provide a Service resource for Vector.
service.externalTrafficPolicystring""Specify the externalTrafficPolicy.
service.internalTrafficPolicystring""Specify the [internalTrafficPolicy]https://kubernetes.io/docs/concepts/services-networking/service-traffic-policy).
service.ipFamilieslist[]Configure IPv4/IPv6 dual-stack.
service.ipFamilyPolicystring""Configure IPv4/IPv6 dual-stack.
service.loadBalancerIPstring""Specify the loadBalancerIP.
service.portslist[]Manually set the Service ports, overriding automated generation of Service ports.
service.topologyKeyslist[]Specify the topologyKeys field on Vector's Service.
service.typestring"ClusterIP"Set the type for Vector's Service.
serviceAccount.annotationsobject{}Annotations to add to Vector's ServiceAccount.
serviceAccount.automountTokenbooltrueAutomount API credentials for Vector's ServiceAccount.
serviceAccount.createbooltrueIf true, create a ServiceAccount for Vector.
serviceAccount.namestringnilThe name of the ServiceAccount to use. If not set and serviceAccount.create is true, a name is generated using the fullname template.
serviceHeadless.enabledbooltrueIf true, create and provide a Headless Service resource for Vector.
shareProcessNamespaceboolfalseSpecify the shareProcessNamespace options for Vector Pods.
terminationGracePeriodSecondsint60Override Vector's terminationGracePeriodSeconds.
tolerationslist[]Configure Vector Pods to be scheduled on tainted nodes.
topologySpreadConstraintslist[]Configure topology spread constraints for Vector Pods. Valid for the "Aggregator" and "Stateless-Aggregator" roles.
updateStrategyobject{}Customize the updateStrategy used to replace Vector Pods, this is also used for the DeploymentStrategy for the "Stateless-Aggregators". Valid options depend on the chosen role.
workloadResourceAnnotationsobject{}Set annotations on the Vector DaemonSet, Deployment or StatefulSet.

HAProxy values

KeyTypeDefaultDescription
haproxy.affinityobject{}Configure affinity rules for HAProxy Pods.
haproxy.autoscaling.customMetricobject{}Target a custom metric for autoscaling.
haproxy.autoscaling.enabledboolfalseCreate a HorizontalPodAutoscaler for HAProxy.
haproxy.autoscaling.maxReplicasint10Maximum replicas for HAProxy's HPA.
haproxy.autoscaling.minReplicasint1Minimum replicas for HAProxy's HPA.
haproxy.autoscaling.targetCPUUtilizationPercentageint80Target CPU utilization for HAProxy's HPA.
haproxy.autoscaling.targetMemoryUtilizationPercentageintnilTarget memory utilization for HAProxy's HPA.
haproxy.containerPortslist[]Manually define HAProxy's containerPorts, overrides automated generation of containerPorts.
haproxy.customConfigstring""Override HAProxy's default configs, if used all options need to be specified. This parameter supports using Helm templates to insert values dynamically. By default, this chart will parse Vector's configuration from customConfig to generate HAProxy's config, which can be overwritten with haproxy.customConfig.
haproxy.enabledboolfalseIf true, create a HAProxy load balancer.
haproxy.existingConfigMapstring""Use this existing ConfigMap for HAProxy's configuration instead of creating a new one. Additionally, haproxy.containerPorts and haproxy.service.ports should be specified based on your supplied configuration. If set, this parameter takes precedence over customConfig and the chart's default configs.
haproxy.extraContainerslist[]Extra Containers to be added to the HAProxy Pods.
haproxy.extraVolumeMountslist[]Additional Volume to mount into HAProxy Containers.
haproxy.extraVolumeslist[]Additional Volumes to use with HAProxy Pods.
haproxy.image.pullPolicystring"IfNotPresent"HAProxy image pullPolicy.
haproxy.image.pullSecretslist[]The imagePullSecrets to reference for the HAProxy Pods.
haproxy.image.repositorystring"haproxytech/haproxy-alpine"Override default registry and name for HAProxy.
haproxy.image.tagstring"2.6.12"The tag to use for HAProxy's image.
haproxy.initContainerslist[]Init Containers to be added to the HAProxy Pods.
haproxy.livenessProbeobject{"tcpSocket":{"port":1024}}Override default HAProxy liveness probe settings.
haproxy.nodeSelectorobject{}Configure a nodeSelector for HAProxy Pods
haproxy.podAnnotationsobject{}Set annotations on HAProxy Pods.
haproxy.podLabelsobject{}Set labels on HAProxy Pods.
haproxy.podPriorityClassNamestring""Set the priorityClassName on HAProxy Pods.
haproxy.podSecurityContextobject{}Allows you to overwrite the default PodSecurityContext for HAProxy.
haproxy.readinessProbeobject{"tcpSocket":{"port":1024}}Override default HAProxy readiness probe settings.
haproxy.replicasint1Set the number of HAProxy Pods to create.
haproxy.resourcesobject{}Set HAProxy resource requests and limits.
haproxy.rollWorkloadbooltrueAdd a checksum of the generated ConfigMap to the HAProxy Deployment.
haproxy.securityContextobject{}Specify securityContext on HAProxy containers.
haproxy.service.annotationsobject{}Set annotations on HAProxy's Service.
haproxy.service.externalTrafficPolicystring""Specify the externalTrafficPolicy.
haproxy.service.ipFamilieslist[]Configure IPv4/IPv6 dual-stack.
haproxy.service.ipFamilyPolicystring""Configure IPv4/IPv6 dual-stack.
haproxy.service.loadBalancerIPstring""Specify the loadBalancerIP.
haproxy.service.portslist[]Manually set HAPRoxy's Service ports, overrides automated generation of Service ports.
haproxy.service.topologyKeyslist[]Specify the topologyKeys field on HAProxy's Service spec.
haproxy.service.typestring"ClusterIP"Set type of HAProxy's Service.
haproxy.serviceAccount.annotationsobject{}Annotations to add to the HAProxy ServiceAccount.
haproxy.serviceAccount.automountTokenbooltrueAutomount API credentials for the HAProxy ServiceAccount.
haproxy.serviceAccount.createbooltrueIf true, create a HAProxy ServiceAccount.
haproxy.serviceAccount.namestringnilThe name of the HAProxy ServiceAccount to use. If not set and create is true, a name is generated using the fullname template.
haproxy.strategyobject{}Customize the strategy used to replace HAProxy Pods.
haproxy.terminationGracePeriodSecondsint60Override HAProxy's terminationGracePeriodSeconds.
haproxy.tolerationslist[]Configure HAProxy Pods to be scheduled on tainted nodes.