README.md 2.08 KB
Newer Older
kelseiv's avatar
kelseiv committed
1
# Telegraf Helm chart
Jack Zampolin's avatar
Jack Zampolin committed
2

kelseiv's avatar
kelseiv committed
3
[Telegraf](https://github.com/influxdata/telegraf) is a plugin-driven server agent used for collecting and reporting metrics.
Jack Zampolin's avatar
Jack Zampolin committed
4

kelseiv's avatar
kelseiv committed
5
The Telegraf Helm chart uses the [Helm](https://helm.sh) package manager to bootstrap a Telegraf (`telegraf`) deployment on a [Kubernetes](http://kubernetes.io) cluster.
Jack Zampolin's avatar
Jack Zampolin committed
6

kelseiv's avatar
kelseiv committed
7
To see a list of available Telegraf plugins, see https://github.com/influxdata/telegraf/tree/master/plugins/.
Jack Zampolin's avatar
Jack Zampolin committed
8

kelseiv's avatar
kelseiv committed
9
## Prerequisites
Jack Zampolin's avatar
Jack Zampolin committed
10

kelseiv's avatar
kelseiv committed
11 12
- Helm v2 or later
- Kubernetes 1.4+ with beta APIs enabled
Jack Zampolin's avatar
Jack Zampolin committed
13

kelseiv's avatar
kelseiv committed
14
## Install the chart
Jack Zampolin's avatar
Jack Zampolin committed
15

kelseiv's avatar
kelseiv committed
16
1. Add the InfluxData Helm repository:
Jack Zampolin's avatar
Jack Zampolin committed
17

kelseiv's avatar
kelseiv committed
18 19 20
   ```bash
   helm repo add influxdata https://helm.influxdata.com/
   ```
Jack Zampolin's avatar
Jack Zampolin committed
21

kelseiv's avatar
kelseiv committed
22
2. Run the following command, providing a name for your Telegraf release:
Jack Zampolin's avatar
Jack Zampolin committed
23

kelseiv's avatar
kelseiv committed
24 25 26
   ```bash
   helm upgrade --install my-release influxdata/telegraf
   ```
Jack Zampolin's avatar
Jack Zampolin committed
27

kelseiv's avatar
kelseiv committed
28
   > **Tip**: `--install` can be shortened to `-i`.
Jack Zampolin's avatar
Jack Zampolin committed
29

kelseiv's avatar
kelseiv committed
30
   This command deploys Telegraf on the Kubernetes cluster using the default configuration. To find parameters you can configure during installation, see [Configure the chart](#configure-the-chart).
Jack Zampolin's avatar
Jack Zampolin committed
31

kelseiv's avatar
kelseiv committed
32
  > **Tip**: To view all Helm chart releases, run `helm list`.
Jack Zampolin's avatar
Jack Zampolin committed
33

kelseiv's avatar
kelseiv committed
34
## Uninstall the chart
Jack Zampolin's avatar
Jack Zampolin committed
35

kelseiv's avatar
kelseiv committed
36 37 38 39
To uninstall the `my-release` deployment, use the following command:

```bash
helm uninstall my-release
Jack Zampolin's avatar
Jack Zampolin committed
40 41
```

kelseiv's avatar
kelseiv committed
42
This command removes all Kubernetes components associated with the chart and deletes the release.
43

kelseiv's avatar
kelseiv committed
44
## Configure the chart
Jack Zampolin's avatar
Jack Zampolin committed
45

kelseiv's avatar
kelseiv committed
46
Plugins are configured as arrays of key/value dictionaries. Find configurable parameters, their descriptions, and their default values stored in `values.yaml`.
Jack Zampolin's avatar
Jack Zampolin committed
47

kelseiv's avatar
kelseiv committed
48
To configure the chart, do either of the following:
Jack Zampolin's avatar
Jack Zampolin committed
49

kelseiv's avatar
kelseiv committed
50
- Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade --install`. For example:
51

kelseiv's avatar
kelseiv committed
52 53 54 55 56
  ```bash
  helm upgrade --install my-release \
    --set persistence.enabled=true \
      influxdata/telegraf
  ```
57

kelseiv's avatar
kelseiv committed
58
  This command enables persistence.
59

kelseiv's avatar
kelseiv committed
60
- Provide a YAML file that specifies the parameter values while installing the chart. For example, use the following command:
Jack Zampolin's avatar
Jack Zampolin committed
61

kelseiv's avatar
kelseiv committed
62 63 64
  ```bash
  helm upgrade --install my-release -f values.yaml influxdata/telegraf
  ```
Jack Zampolin's avatar
Jack Zampolin committed
65

kelseiv's avatar
kelseiv committed
66
  > **Tip**: Use the default [values.yaml](values.yaml).