Back to Charts

DEPRECATED - Kapacitor

stable/kapacitor/README.md

latest4.3 KB
Original Source

DEPRECATED - Kapacitor

This chart has been deprecated and moved to its new home:

An Open-Source Time Series ETL and Alerting Engine

Kapacitor is an open-source framework built by the folks over at InfluxData and written in Go for processing, monitoring, and alerting on time series data

QuickStart

bash
$ helm install stable/kapacitor --name foo --namespace bar

Introduction

This chart bootstraps A Kapacitor deployment and service on a Kubernetes cluster using the Helm Package manager.

Prerequisites

  • Kubernetes 1.4+
  • PV provisioner support in the underlying infrastructure (optional)

Installing the Chart

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

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

The command deploys Kapacitor on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

bash
$ helm delete my-release --purge

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 Kapacitor chart and their default values.

ParameterDescriptionDefault
image.repositoryKapacitor imagekapacitor
image.tagKapacitor image version1.5.2-alpine
image.pullPolicyKapacitor image pull policyIfNotPresent
service.typeKapacitor web service typeClusterIP
persistence.enabledEnable Kapacitor persistence using Persistent Volume Claimsfalse
persistence.storageClassKapacitor Persistent Volume Storage Classdefault
persistence.accessModeKapacitor Persistent Volume Access ModeReadWriteOnce
persistence.sizeKapacitor Persistent Volume Storage Size8Gi
persistence.existingClaimKapacitor existing PVC namenil
resources.request.memoryKapacitor memory request256Mi
resources.request.cpuKapacitor cpu request0.1
resources.limits.memoryKapacitor memory limit2Gi
resources.limits.cpuKapacitor cpu limit2
envVarsEnvironment variables to set initial Kapacitor configuration (https://hub.docker.com/_/kapacitor/){}
influxURLInfluxDB url used to interact with Kapacitor (also can be set with envVars.KAPACITOR_INFLUXDB_0_URLS_0)http://influxdb-influxdb.tick:8086
existingSecretName of an existing Secrect used to set the environment variables for the InfluxDB user and password. The expected keys in the secret are influxdb-user and influxdb-password.

The configurable parameters of the Kapacitor chart and the default values are listed in values.yaml.

The full image documentation contains more information about running Kapacitor in docker.

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

bash
$ helm install --name my-release \
  --set influxURL=http://myinflux.mytld:8086,persistence.enabled=true \
    stable/kapacitor

The above command enables persistence and changes the size of the requested data volume to 200GB.

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/kapacitor

Tip: You can use the default values.yaml

Persistence

The Kapacitor image stores data in the /var/lib/kapacitor directory in the container.

The chart optionally mounts a Persistent Volume at this location. The volume is created using dynamic volume provisioning.