Commit 7880c021 authored by Nicolas Steinmetz's avatar Nicolas Steinmetz Committed by David McKay

Improve documentation and fix some helm commands to be compatible with helm 3

parent 38b2697b
apiVersion: v1
name: telegraf-ds
version: 1.0.0
version: 1.0.1
appVersion: 1.13
deprecated: false
description: Telegraf is an agent written in Go for collecting, processing, aggregating, and writing metrics.
......
......@@ -2,7 +2,7 @@
[Telegraf](https://github.com/influxdata/telegraf) is a plugin-driven server agent written by the folks over at [InfluxData](https://influxdata.com) for collecting & reporting metrics. This chart runs a DaemonSet of Telegraf instances to collect host level metrics for your cluster. If you need to poll individual instances of infrastructure or APIs there is a `telegraf` chart that is more suited to that usecase.
Telegraf input cannot be customised as it aims to provide an opinionated configuration to monitor kubernetes nodes and global kubernetes monitoring.
For this chart, Telegraf inputs cannot be customised as it aims to provide an opinionated configuration to monitor kubernetes nodes and global kubernetes monitoring.
## TL;DR
......@@ -13,7 +13,7 @@ helm install influxdata/telegraf-ds
## Introduction
This chart bootstraps a `telegraf-ds` daemonset on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
This chart bootstraps a `telegraf-ds` DaemonSet on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
## Prerequisites
......@@ -24,10 +24,10 @@ This chart bootstraps a `telegraf-ds` daemonset on a [Kubernetes](http://kuberne
To install the chart with the release name `my-release`:
```console
helm install --name my-release influxdata/telegraf-ds
helm install my-release influxdata/telegraf-ds
```
The command deploys a Telegraf daemonset on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section as well as the [values.yaml](/values.yaml) file lists the parameters that can be configured during installation.
The command deploys a Telegraf DaemonSet on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section as well as the [values.yaml](/values.yaml) file lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list`
......@@ -46,7 +46,7 @@ The command removes all the Kubernetes components associated with the chart and
The default configuration parameters are listed in `values.yaml`. To change the defaults, specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console
helm install --name my-release \
helm install my-release \
--set config.outputs.influxdb.url=http://foo.bar:8086 \
influxdata/telegraf-ds
```
......@@ -56,14 +56,14 @@ The above command allows the chart to deploy by setting the InfluxDB URL for tel
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
```console
helm install --name my-release -f values.yaml influxdata/telegraf-ds
helm install my-release -f values.yaml influxdata/telegraf-ds
```
## Telegraf Configuration
This chart deploys the following by default:
- `telegraf` (`telegraf-ds`) running in a daemonset with the following plugins enabled
- `telegraf` running as a DaemonSet (`telegraf-ds`) with the following plugins enabled
* [`cpu`](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/cpu)
* [`disk`](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/disk)
* [`diskio`](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/diskio)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment