Unverified Commit 13ed7796 authored by kelseiv's avatar kelseiv Committed by GitHub

Readme edits (#76)

* InfluxData Helm charts readme updates * spell out terms * edits for style, standardization, and consistency * Update CONTRIBUTING.md * Update CONTRIBUTING.md * fix alignment * update beta not covered note * chronograf readme updates * edits * add Slack channel note to all readmes * update release Tip * updated helm install to helm upgrade --install * drop more * remove telegraf * rmv -namespace monitoring * spell out PV * update note about disruption * update intro sentence * upd Kapacitor RM for consistency * misc edits * update Telegraf readme for consistency * upd contribution guidelines * upd Telegraf-operator title * upd sections in telegraf-operator for consistency * fix alignment * add edits from David * more edits f David * add edit f Russ * fix: version bump * fix: version bump * fix: version bump * fix: version bump * fix: version bump * fix: version bump * fix: remove trailing spaces * fix: version bump Co-authored-by: 's avatarDavid McKay <david@rawkode.com>
parent d4cea0bf
# Contributing to InfluxData Helm charts
## Filing issues
Filing issues on GitHub is one of the easiest ways to contribute. We value your contributions!
Before you file an issue, please search existing issues to verify the issue hasn't already been filed or resolved.
### Bug reports
When submitting a bug report, please include the following:
- Full details of your operating system (or distribution), for example, `64bit Ubuntu 18.04`
- InfluxData Helm chart product and version you're using
- Clear steps to reproduce the issue described, if possible
The easier it is for us to reproduce the bug, the faster we can fix it.
If you have never written a bug report before, or if you want to brush up on your bug reporting skills, we recommend reading [Simon Tatham's essay "How to Report Bugs Effectively."](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
Sharing your test cases is also helpful. If writing the data is too difficult, please zip up your data directory and include a link to it in your bug report.
Please note that issues are *not the place to file general support requests* such as "how do I use something?"
Questions of this nature should be sent to the [InfluxData Community](https://community.influxdata.com/), not filed as issues.
## Feature requests
We really like to receive feature requests as it helps us prioritize our work.
Please clarify your requirements and goals to help us to understand what you would like to see added with examples and the reasons why it is important to you.
If you find your feature request already exists as a Github issue, please indicate your support for that feature by using the "thumbs up" reaction.
## Submitting a pull request
1. Fork the InfluxDB repository, and then make your change on a feature branch of your fork.
2. Generate a pull request (PR) from your branch against *master* of the InfluxDB repository.
3. In your PR, include details of your change (why *and* how) and any tests you performed.
> **Note:** There may be some back and forth as we finalize the change, but after that, we'll merge changes as soon as possible.
To assist in review for the PR, please add the following to your pull request comment:
```md
- [ ] CHANGELOG.md updated
- [ ] Rebased/mergable
- [ ] Tests pass
- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)
```
# Signing the CLA
If you are going to be contributing back to InfluxDB please take a second to sign our CLA, which can be found on our [website](https://influxdata.com/community/cla/).
Before contributing to InfluxDB, please sign our [CLA](https://influxdata.com/community/cla/).
# InfluxData Helm Charts
# InfluxData Helm charts
[![License](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
[![](https://github.com/influxdata/helm-charts/workflows/helm-charts%2Frelease/badge.svg?branch=master)](https://github.com/influxdata/helm-charts/actions)
This functionality is in beta and is subject to change. The code is provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.influxdata.com/slack)
## Usage
[Helm](https://helm.sh) must be installed to use the charts.
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
1. Install [Helm](https://helm.sh). For more information, see [Helm documentation](https://helm.sh/docs/).
Once Helm is set up properly, add the repo as follows:
2. Add the InfluxData Helm repository:
```console
helm repo add influxdata https://helm.influxdata.com/
```
```console
helm repo add influxdata https://helm.influxdata.com/
```
You can then run `helm search repo influxdata` to see the charts.
3. View InfluxData Helm charts:
```console
helm search repo influxdata
```
## Contributing
......@@ -26,3 +27,5 @@ We'd love to have you contribute! Please refer to our [contribution guidelines](
## License
[MIT License](./LICENSE)
Check out our [Slack channel](https://www.influxdata.com/slack) for support and information.
apiVersion: v1
name: chronograf
version: 1.1.13
version: 1.1.14
appVersion: 1.8.0
description: Open-source web application written in Go and React.js that provides
the tools to visualize your monitoring data and easily create alerting and automation
......
# Chronograf
# Chronograf Helm chart
## An Open-Source Time Series Visualization Tool
[Chronograf](https://github.com/influxdata/chronograf) is an open-source web application used to visualize your monitoring data and easily create alerting and automation rules.
[Chronograf](https://github.com/influxdata/chronograf) is an open-source web application built by the folks over at [InfluxData](https://influxdata.com) and written in Go and React.js that provides the tools to visualize your monitoring data and easily create alerting and automation rules.
## QuickStart
```bash
helm repo add influxdata https://helm.influxdata.com/
helm upgrade --install chronograf influxdata/chronograf --namespace monitoring
```
## Introduction
This chart bootstraps a Chronograf deployment and service on a Kubernetes cluster using the Helm Package manager.
The Chronograf Helm chart uses the [Helm](https://helm.sh) package manager to bootstrap a Chronograf deployment and service on a [Kubernetes](http://kubernetes.io) cluster.
## Prerequisites
- Helm v2 or later
- Kubernetes 1.4+
- PV provisioner support in the underlying infrastructure (optional)
- (Optional) PersistentVolume (PV) provisioner support in the underlying infrastructure
## Installing the Chart
## Install the chart
To install the chart with the release name `my-release`:
1. Add the InfluxData Helm repository:
```bash
helm upgrade --install my-release influxdata/chronograf
```
```bash
helm repo add influxdata https://helm.influxdata.com/
```
2. Run the following command, providing a name for your Chronograf release:
The command deploys Chronograf on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
```bash
helm upgrade --install my-release influxdata/chronograf
```
> **Tip**: `--install` can be shortened to `-i`.
> **Tip**: List all releases using `helm list`
This command deploys Chronograf on the Kubernetes cluster using the default configuration. To find parameters you can configure during installation, see [Configure the chart](#configure-the-chart).
## Uninstalling the Chart
> **Tip**: To view all Helm chart releases, run `helm list`.
To uninstall/delete the `my-release` deployment:
## Uninstall the chart
To uninstall the `my-release` deployment, use the following command:
```bash
helm uninstall my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
This command removes all Kubernetes components associated with the chart and deletes the release.
The configurable parameters of the Chronograf chart and
their descriptions can be seen in `values.yaml`. The [full image documentation](https://quay.io/influxdb/chronograf) contains more information about running Chronograf in docker.
## Configure the chart
The following table lists the configurable parameters of the chronograf chart and their default values.
The following table lists configurable parameters, their descriptions, and their default values stored in `values.yaml`.
| Parameter | Description | Default |
|:-----------------------------|:----------------------------------------------------------------------------------------------------------|:--------------------------------------------|
| `image.repository` | controller container image repository | quay.io/influxdb/chronograf |
| `image.tag` | controller container image tag | 1.8.0 |
| `image.repository` | image repository url | quay.io/influxdb/chronograf |
| `image.tag` | controller container image tag | 1.8.0 |
| `image.pullPolicy` | controller container image pull policy | IfNotPresent |
| `service.replicas` | number of replicas for the specified service.type | 1 |
| `service.type` | ClusterIP, NodePort, or LoadBalancer | ClusterIP |
| `persistence.enabled` | Use a PVC to persist data | `true` |
| `persistence.enabled` | Use a PVC to persist data | `false` |
| `persistence.storageClass` | Storage class of backing PVC | `nil` (uses alpha storage class annotation) |
| `persistence.accessModes` | Use volume as ReadOnly or ReadWrite | `[ReadWriteOnce]` |
| `persistence.size` | Size of data volume | `8Gi` |
| `resources.requests.memory` | Memory used for resource requests | `256Mi` |
| `resources.requests.cpu` | CPU used for resource requests | `0.1` |
| `resources.limits.memory` | Maximum memory that can be used for resource requests | `2Gi` |
| `resources.limits.cpu` | Maximum CPU that can be used for resource requests | `2` |
| `ingress.enabled` | Enable ingress controller resource | false |
| `ingress.hostname` | Ingress resource hostnames | chronograf.foobar.com |
| `ingress.tls` | Ingress TLS configuration | false |
......@@ -84,23 +84,25 @@ The following table lists the configurable parameters of the chronograf chart an
| `tolerations` | Toleration labels for pod assignment | [] |
| `affinity` | Affinity settings for pod assignment | {} |
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
To configure the chart, do either of the following:
```bash
helm upgrade --install my-release \
--set ingress.enabled=true,ingress.hostname=chronograf.foobar.com \
influxdata/chronograf
```
- Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade --install`. For example, use the following command:
The above command enables persistence and changes the size of the requested data volume to 200GB.
```bash
helm upgrade --install my-release \
--set ingress.enabled=true,ingress.hostname=chronograf.foobar.com \
influxdata/chronograf
```
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
- Provide a YAML file that specifies parameter values while installing the chart. For example, use the following command:
```bash
helm upgrade --install my-release -f values.yaml influxdata/chronograf
```
```bash
helm upgrade --install my-release -f values.yaml influxdata/chronograf
```
> **Tip**: You can use the default [values.yaml](values.yaml)
> **Tip**: Use the default [values.yaml](values.yaml).
For information about running Chronograf in Docker, see the [full image documentation](https://quay.io/influxdb/chronograf).
## Persistence
......@@ -108,11 +110,11 @@ The [Chronograf](https://quay.io/influxdb/chronograf) image stores data in the `
The chart optionally mounts a [Persistent Volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) at this location. The volume is created using dynamic volume provisioning.
## OAuth Using Kubernetes Secret
## OAuth using Kubernetes Secret
OAuth, among other things, can be configured in Chronograf using environment variables. For more information please see https://docs.influxdata.com/chronograf/latest/administration/managing-security
Use environment variables to configure OAuth in Chronograf. For more information, see https://docs.influxdata.com/chronograf/latest/administration/managing-security.
Taking Google as an example, to use an existing Kubernetes Secret that contains sensitive information (`GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`), e.g.:
The following example snippet shows a Kubernetes Secret that contains sensitive information (`GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`):
```
apiVersion: v1
......@@ -126,7 +128,7 @@ data:
GOOGLE_CLIENT_SECRET: <BASE64_ENCODED_GOOGLE_CLIENT_SECRET>
```
in conjunction with less sensitive information such as `GOOGLE_DOMAINS` and `PUBLIC_URL`, one can make use of the chart's `envFromSecret` and `env` values, e.g. a values file can have the following:
With less sensitive information, such as `GOOGLE_DOMAINS` and `PUBLIC_URL`, use the chart's `envFromSecret` and `env` values. For example, include the following in a values file:
```
[...]
......@@ -136,3 +138,5 @@ env:
envFromSecret: chronograf-google-env-secrets
[...]
```
Check out our [Slack channel](https://www.influxdata.com/slack) for support and information.
\ No newline at end of file
......@@ -2,6 +2,7 @@
##
image:
repository: "chronograf"
## default: quay.io/influxdb/chronograf
tag: 1.8.0
pullPolicy: IfNotPresent
......@@ -25,7 +26,7 @@ persistence:
## GKE, AWS & OpenStack)
##
# storageClass: "-"
accessMode: ReadWriteOnce
accessModes: ReadWriteOnce
size: 8Gi
## Configure resource requests and limits
......
apiVersion: v1
name: influxdb
version: 4.4.11
version: 4.4.12
appVersion: 1.7.10
description: Scalable datastore for metrics, events, and real-time analytics.
keywords:
......
# InfluxDB
# InfluxDB Helm chart
## An Open-Source Time Series Database
[InfluxDB](https://github.com/influxdata/influxdb) is an open source time series database with no external dependencies. It's useful for recording metrics, events, and performing analytics.
[InfluxDB](https://github.com/influxdata/influxdb) is an open source time series database built by the folks over at [InfluxData](https://influxdata.com) with no external dependencies. It's useful for recording metrics, events, and performing analytics.
The InfluxDB Helm chart uses the [Helm](https://helm.sh) package manager to bootstrap an InfluxDB StatefulSet and service on a [Kubernetes](http://kubernetes.io) cluster.
## QuickStart
> **Note:** ### If you're using the InfluxDB Enterprise Helm chart, check out [InfluxDB Enterprise Helm chart](#influxdb-enterprise-helm-chart).
```bash
helm repo add influxdata https://helm.influxdata.com/
helm upgrade --install influxdb influxdata/influxdb --namespace monitoring
```
## Prerequisites
> **Tip**: `helm upgrade --install [RELEASE] [CHART] [FLAGS]` can be shortened : `helm upgrade -i [RELEASE] [CHART] [FLAGS]`
- Helm v2 or later
- Kubernetes 1.4+
- (Optional) PersistentVolume (PV) provisioner support in the underlying infrastructure
## Introduction
## Install the chart
This chart bootstraps an InfluxDB statefulset and service on a Kubernetes cluster using the Helm Package manager.
1. Add the InfluxData Helm repository:
## Prerequisites
```bash
helm repo add influxdata https://helm.influxdata.com/
```
- Kubernetes 1.4+
- PV provisioner support in the underlying infrastructure (optional)
2. Run the following command, providing a name for your release:
## Installing the Chart
```bash
helm upgrade --install my-release influxdata/influxdb
```
To install the chart with the release name `my-release`:
> **Tip**: `--install` can be shortened to `-i`.
```bash
helm upgrade --install my-release influxdata/influxdb
```
The command deploys InfluxDB on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
This command deploys InfluxDB on the Kubernetes cluster using the default configuration. To find parameters you can configure during installation, see [Configure the chart](#configure-the-chart).
> **Tip**: List all releases using `helm list`
> **Tip**: To view all Helm chart releases, run `helm list`.
## Uninstalling the Chart
## Uninstall the chart
To uninstall/delete the `my-release` deployment:
To uninstall the `my-release` deployment, use the following command:
```bash
helm uninstall my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
This command removes all the Kubernetes components associated with the chart and deletes the release.
## Configure the chart
## Configuration
The following table lists configurable parameters, their descriptions, and their default values stored in `values.yaml`.
| Parameter | Description | Default |
|---|---|---|
......@@ -105,30 +105,34 @@ The command removes all the Kubernetes components associated with the chart and
| backup.annotations | Annotations for backup cronjob | {} |
| backup.podAnnotations | Annotations for backup cronjob pods | {} |
The [full image documentation](https://hub.docker.com/_/influxdb/) contains more information about running InfluxDB in docker.
To configure the chart, do either of the following:
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
- Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade --install`. For example:
```bash
helm upgrade --install my-release \
--set persistence.enabled=true,persistence.size=200Gi \
influxdata/influxdb
```
```bash
helm upgrade --install my-release \
--set persistence.enabled=true,persistence.size=200Gi \
influxdata/influxdb
```
The above command enables persistence and changes the size of the requested data volume to 200GB.
This 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,
- Provide a YAML file that specifies the parameter values while installing the chart. For example, use the following command:
```bash
helm upgrade --install my-release -f values.yaml influxdata/influxdb
```
```bash
helm upgrade --install my-release -f values.yaml influxdata/influxdb
```
> **Tip**: Use the default [values.yaml](values.yaml).
For information about running InfluxDB in Docker, see the [full image documentation](https://hub.docker.com/_/influxdb/).
> **Tip**: You can use the default [values.yaml](values.yaml)
### InfluxDB Enterprise Helm chart
### Enterprise
[InfluxDB Enterprise](https://www.influxdata.com/products/influxdb-enterprise/) is a hardened version of the open source core InfluxDB that includes additional closed source features designed for production workloads, featuring high availability and horizontal scaling. InfluxDB Enterprise features require a InfluxDB Enterprise license.
[InfluxDB Enterprise](https://www.influxdata.com/products/influxdb-enterprise/) includes features designed for production workloads, including high availability and horizontal scaling. InfluxDB Enterprise requires an InfluxDB Enterprise license.
#### Configure the InfluxDB Enterprise chart
#### Configuration
To enable InfluxDB Enterprise, set the following keys and values in a values file provided to Helm.
| Key | Description | Recommended value |
......@@ -145,38 +149,45 @@ To enable InfluxDB Enterprise, set the following keys and values in a values fil
| `enterprise.meta.resources` | Resources requests and limits for meta `influxdb-meta` pods | See `values.yaml` |
#### Join pods to InfluxDB Enterprise cluster
Meta and data pods need to be joined together using the command `influxd-ctl` found on meta pods.
It is recommended you run `influxd-ctl` on one and only one meta pod, and to join meta pods together before data pods.
For each meta pod, run `influxd-ctl`. With default settings it should look something like this:
Meta and data pods must be joined using the command `influxd-ctl` found on meta pods.
We recommend running `influxd-ctl` on one and only one meta pod and joining meta pods together before data pods. For each meta pod, run `influxd-ctl`.
In the following examples, we use the pod names `influxdb-meta-0` and `influxdb-0` and the service name `influxdb`.
For example, using the default settings, your script should look something like this:
```shell script
kubectl exec influxdb-meta-0 influxd-ctl add-meta influxdb-meta-0.influxdb-meta:8091
```
From the same meta pod, for each data pod, run `influxd-ctl`. With default settings it should look something like this:
From the same meta pod, for each data pod, run `influxd-ctl`. With default settings, your script should look something like this:
```shell script
kubectl exec influxdb-meta-0 influxd-ctl add-data influxdb-0.influxdb:8088
```
When using `influxd-ctl` be sure to use the appropriate DNS name for your pods, following the naming scheme of `pod.service`.
In the above examples, the pod names were `influxdb-meta-0` and `influxdb-0` respectively, and the service name was `influxdb`
When using `influxd-ctl`, use the appropriate DNS name for your pods, following the naming scheme of `pod.service`.
## Persistence
The [InfluxDB](https://hub.docker.com/_/influxdb/) image stores data in the `/var/lib/influxdb` directory in the container.
If persistence is enabled, a [Persistent Volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) associated with Statefulset will be provisioned. The volume is created using dynamic volume provisioning. In case of a disruption e.g. a node drain, kubernetes ensures that the same volume will be reatached to the Pod, preventing any data loss. Althought, when persistence is not enabled, InfluxDB data will be stored in an empty directory thus, in a Pod restart, data will be lost.
If persistence is enabled, a [Persistent Volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) associated with StatefulSet is provisioned. The volume is created using dynamic volume provisioning. In case of a disruption (for example, a node drain), Kubernetes ensures that the same volume is reattached to the Pod, preventing any data loss. However, when persistence is **not enabled**, InfluxDB data is stored in an empty directory, so if a Pod restarts, data is lost.
## Starting with authentication
## Start with authentication
In `values.yaml` change `.Values.config.http.auth_enabled` to `true`.
In `values.yaml`, change `.Values.config.http.auth_enabled` to `true`.
Influxdb requires also a user to be set in order for authentication to be enforced. See more details [here](https://docs.influxdata.com/influxdb/v1.2/query_language/authentication_and_authorization/#set-up-authentication).
> **Note:** To enforce authentication, InfluxDB requires an admin user to be set up. For details, see [Set up authentication](https://docs.influxdata.com/influxdb/v1.2/query_language/authentication_and_authorization/#set-up-authentication).
To handle this setup on startup, a job can be enabled in `values.yaml` by setting `.Values.setDefaultUser.enabled` to `true`.
To handle this set up during startup, enable a job in `values.yaml` by setting `.Values.setDefaultUser.enabled` to `true`.
Make sure to uncomment or configure the job settings after enabling it. If a password is not set, a random password will be generated.
Alternatively, if `.Values.setDefaultUser.user.existingSecret` is set the user and password are obtained from an existing Secret, the expected keys are `influxdb-user` and `influxdb-password`. Use this variable if you need to check in the `values.yaml` in a repository to avoid exposing your secrets.
Alternatively, if `.Values.setDefaultUser.user.existingSecret` is set the user and password are obtained from an existing Secret, the expected keys are `influxdb-user` and `influxdb-password`. Use this variable if you need to check in the `values.yaml` in a repository to avoid exposing your secrets.
## Backing up and restoring
## Back up and restore
Before proceeding, please read [Backing up and restoring in InfluxDB OSS](https://docs.influxdata.com/influxdb/v1.7/administration/backup_and_restore/). While the chart offers backups by means of the [`backup-cronjob`](./templates/backup-cronjob.yaml), restores do not fall under the chart's scope today but can be achieved by one-off kubernetes jobs.
......@@ -253,7 +264,7 @@ spec:
At which point the data from the new `<db name>_bak` dbs would have to be side loaded into the original dbs.
Please see [InfluxDB documentation for more restore examples](https://docs.influxdata.com/influxdb/v1.7/administration/backup_and_restore/#restore-examples).
## Mounting extra volumes
## Mounting Extra Volumes
Extra volumes can be mounted by providing the `volumes` and `mountPoints` keys, consistent
with the behavior of other charts provided by Influxdata.
......@@ -285,6 +296,8 @@ Since version 3.0.0 this chart uses a StatefulSet instead of a Deployment. As pa
### From < 4.0.0 to >= 4.0.0
Labels are changed to those in accordance with [kubernetes recommended labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/\#labels). This change also removes the ability to configure clusterIP value as to avoid `Error: UPGRADE FAILED: failed to replace object: Service "my-influxdb" is invalid: spec.clusterIP: Invalid value: "": field is immutable` type errors. For more info on this error and why it should be avoided at all costs, please see [this github issue](https://github.com/helm/helm/issues/6378#issuecomment-582764215).
Labels are changed in accordance with [Kubernetes recommended labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/\#labels). This change also removes the ability to configure clusterIP value to avoid `Error: UPGRADE FAILED: failed to replace object: Service "my-influxdb" is invalid: spec.clusterIP: Invalid value: "": field is immutable` type errors. For more information on this error and why it's important to avoid this error, please see [this Github issue](https://github.com/helm/helm/issues/6378#issuecomment-582764215).
Due to the significance of the changes, we recommend uninstalling and reinstalling the chart (although the PVC shouldn't be deleted during this process, we highly recommended backing up your data beforehand).
Due to the significance of the changes. The recommended approach is to uninstall and reinstall the chart (the PVC *should* not be deleted during this process, but it is highly recommended to backup your data before).
Check out our [Slack channel](https://www.influxdata.com/slack) for support and information.
\ No newline at end of file
......@@ -5,7 +5,7 @@ name: influxdb2
description: A Helm chart for InfluxDB v2
home: https://www.influxdata.com/products/influxdb-overview/influxdb-2-0/
type: application
version: 1.0.3
version: 1.0.4
maintainers:
- name: rawkode
email: rawkode@influxdata.com
......
# InfluxDB
# InfluxDB v2 Helm chart
**Warning**: This chart, as well as the software it deploys, is in a BETA phase.
**Warning**: This InfluxDB Helm chart and the software it deploys are in a beta phase.
If you're considering deploying this, please also consider using our [Slack channel](https://www.influxdata.com/slack) to get support when needed.
[InfluxDB](https://github.com/influxdata/influxdb) is an open source time series database with no external dependencies. It's useful for recording metrics, events, and performing analytics.
## An Open-Source Time Series Database
The InfluxDB v2 Helm chart uses the [Helm](https://helm.sh) package manager to bootstrap an InfluxDB v2 StatefulSet and service on a [Kubernetes](http://kubernetes.io) cluster.
[InfluxDB](https://github.com/influxdata/influxdb) is an open source time series database built by the folks over at [InfluxData](https://influxdata.com) with no external dependencies. It's useful for recording metrics, events, and performing analytics.
## Prerequisites
## QuickStart
- Helm v3 or later
- Kubernetes 1.4+
- (Optional) PersistentVolume (PV) provisioner support in the underlying infrastructure
```bash
helm repo add influxdata https://helm.influxdata.com/
helm upgrade --install influxdb influxdata/influxdb2 --namespace monitoring
```
## Install the chart
> **Tip**: `helm upgrade --install [RELEASE] [CHART] [FLAGS]` can be shortened : `helm upgrade -i [RELEASE] [CHART] [FLAGS]`
1. Add the InfluxData Helm repository:
## Introduction
```bash
helm repo add influxdata https://helm.influxdata.com/
```
This chart bootstraps an InfluxDB v2 statefulset and service on a Kubernetes cluster using the Helm Package manager.
2. Run the following command, providing a name for your InfluxDB release:
## Prerequisites
```bash
helm upgrade --install my-release influxdata/influxdb2
```
- Kubernetes 1.4+
- PV provisioner support in the underlying infrastructure (optional)
> **Tip**: `--install` can be shortened to `-i`.
## Installing the Chart
This command deploys InfluxDB v2 on the Kubernetes cluster using the default configuration.
To install the chart with the release name `my-release`:
> **Tip**: To view all Helm chart releases, run `helm list`.
```bash
helm upgrade --install my-release influxdata/influxdb2
```
The command deploys InfluxDB on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list`
## Uninstall the chart
## Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
To uninstall the `my-release` deployment, use the following command:
```bash
helm uninstall my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
This command removes all Kubernetes components associated with the chart and deletes the release.
## Persistence
The [InfluxDB](https://quay.io/influxdb/influxdb:2.0.0-beta) image stores data in the `/root/.influxdbv2` directory in the container.
If persistence is enabled, a [Persistent Volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) associated with Statefulset will be provisioned. The volume is created using dynamic volume provisioning. In case of a disruption e.g. a node drain, kubernetes ensures that the same volume will be reatached to the Pod, preventing any data loss. Althought, when persistence is not enabled, InfluxDB data will be stored in an empty directory thus, in a Pod restart, data will be lost.
If persistence is enabled, a [Persistent Volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) associated with StatefulSet is provisioned. The volume is created using dynamic volume provisioning. In case of a disruption (for example, a node drain), Kubernetes ensures that the same volume is reattached to the Pod, preventing any data loss. However, when persistence is **not enabled**, InfluxDB data is stored in an empty directory, so if a Pod restarts, data is lost.
Check out our [Slack channel](https://www.influxdata.com/slack) for support and information.
\ No newline at end of file
apiVersion: v1
name: kapacitor
version: 1.3.0
version: 1.3.1
appVersion: 1.5.4
description: InfluxDB's native data processing engine. It can process both stream
and batch data from InfluxDB.
......
# Kapacitor
# Kapacitor Helm chart
## An Open-Source Time Series ETL and Alerting Engine
[Kapacitor](https://github.com/influxdata/kapacitor) is an open-source framework used for processing, monitoring, and alerting on time series data.
[Kapacitor](https://github.com/influxdata/kapacitor) is an open-source framework built by the folks over at [InfluxData](https://influxdata.com) and written in Go for processing, monitoring, and alerting on time series data
The Kapacitor Helm chart uses the [Helm](https://helm.sh) package manager to bootstrap a Kapacitor deployment and service on a [Kubernetes](http://kubernetes.io) cluster.
## QuickStart
```bash
helm repo add influxdata https://helm.influxdata.com/
helm upgrade --install kapacitor influxdata/kapacitor --namespace monitoring
```
> **Tip**: `helm upgrade --install [RELEASE] [CHART] [FLAGS]` can be shortened : `helm upgrade -i [RELEASE] [CHART] [FLAGS]`
## Prerequisites
## Introduction
- Helm v2 or later
- Kubernetes 1.4+
- PersistentVolume (PV) provisioner support in the underlying infrastructure (optional)
This chart bootstraps A Kapacitor deployment and service on a Kubernetes cluster using the Helm Package manager.
## Install the chart
## Prerequisites
1. Add the InfluxData Helm repository:
- Kubernetes 1.4+
- PV provisioner support in the underlying infrastructure (optional)
```bash
helm repo add influxdata https://helm.influxdata.com/
```
## Installing the Chart
2. Run the following command, providing a name for your release:
To install the chart with the release name `my-release`:
```bash
helm upgrade --install my-release influxdata/kapacitor
```
```bash
helm upgrade --install my-release influxdata/kapacitor
```
> **Tip**: `--install` can be shortened to `-i`.
The command deploys Kapacitor on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
This command deploys Kapacitor on the Kubernetes cluster using the default configuration. To find parameters you can configure during installation, see [Configure the chart](#configure-the-chart).
> **Tip**: List all releases using `helm list`
> **Tip**: To view all Helm chart releases, run `helm list`.
## Uninstalling the Chart
## Uninstall the chart
To uninstall/delete the `my-release` deployment:
To uninstall the `my-release` deployment, use the following command:
```bash
helm uninstall my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
This command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
## Configure the chart
The following table lists the configurable parameters of the Kapacitor chart and their default values.
The following table lists configurable parameters, their descriptions, and their default values stored in `values.yaml`.
| Parameter | Description | Default |
| ----------------------- | ---------------------------------- | ---------------------------------------------------------- |
| `image.repository` | Kapacitor image | `kapacitor` |
| `image.repository` | image repository url | Kapacitor image | `kapacitor` |
| `image.tag` | Kapacitor image version | `1.5.2-alpine` |
| `image.pullPolicy` | Kapacitor image pull policy | `IfNotPresent` |
| `service.type` | Kapacitor web service type | `ClusterIP` |
......@@ -81,27 +77,27 @@ The following table lists the configurable parameters of the Kapacitor chart and
| `sidecar.sideload.folder` | Folder in the pod that should hold the collected sideloads. This path will be mounted. | `/var/lib/kapacitor/sideload` |
| `namespaceOverride` | Override the deployment namespace | `""` (`Release.Namespace`) |
The configurable parameters of the Kapacitor chart and the default values are listed in `values.yaml`.
The [full image documentation](https://hub.docker.com/_/kapacitor/) contains more information about running Kapacitor in docker.
To configure the chart, do either of the following:
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
- Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade --install`. For example, use the following command:
```bash
helm upgrade --install my-release \
```bash
helm upgrade --install my-release \
--set influxURL=http://myinflux.mytld:8086,persistence.enabled=true \
influxdata/kapacitor
```
```
This command enables persistence.
The above command enables persistence and changes the size of the requested data volume to 200GB.
- Provide a YAML file that specifies parameter values while installing the chart. For example, use the following command:
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
```bash
helm upgrade --install my-release -f values.yaml influxdata/kapacitor
```
```bash
helm upgrade --install my-release -f values.yaml influxdata/kapacitor
```
> **Tip**: Use the default [values.yaml](values.yaml).
> **Tip**: You can use the default [values.yaml](values.yaml)
For information about running Kapacitor in Docker, see the [full image documentation](https://hub.docker.com/_/kapacitor/).
## Persistence
......@@ -128,4 +124,8 @@ metadata:
data:
influxdb-httpd-clienterror.yml: |
[...]
```
\ No newline at end of file
```
---
Check out our [Slack channel](https://www.influxdata.com/slack) for support and information.
apiVersion: v1
name: telegraf-ds
version: 1.0.9
version: 1.0.10
appVersion: 1.14
deprecated: false
description: Telegraf is an agent written in Go for collecting, processing, aggregating, and writing metrics.
......
# Telegraf-DS (DaemonSet)
# Telegraf-DS (DaemonSet) Helm chart
[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](https://github.com/influxdata/telegraf) is a plugin-driven server agent used for collecting and reporting metrics. This chart runs a DaemonSet of Telegraf instances to collect host-level metrics for your cluster. To poll individual instances of infrastructure or APIs, use the [Telegraf chart](https://github.com/influxdata/helm-charts/tree/master/charts/telegraf).
For this chart, Telegraf inputs cannot be customised as it aims to provide an opinionated configuration to monitor kubernetes nodes and global kubernetes monitoring.
The Telegraf-DS Helm chart uses the [Helm](https://helm.sh) package manager to bootstrap a Telegraf-DS (DaemonSet) on a [Kubernetes](http://kubernetes.io) cluster. You cannot customize Telegraf inputs for this chart being the goal is to provide an opinionated configuration for monitoring Kubernetes nodes and global Kubernetes monitoring.
## TL;DR
## Prerequisites
- Helm v2 or later
- Kubernetes 1.11+ with Beta APIs enabled
## QuickStart
```console
helm repo add influxdata https://helm.influxdata.com/
helm upgrade --install telegraf-ds influxdata/telegraf-ds
```
> **Tip**: `helm upgrade --install [RELEASE] [CHART] [FLAGS]` is idempotent and can be run multiple times. If chart was not previously installed, helm will install it. If present, it will redeploy the same version or upgrade it if a new version is available.
## Introduction
This chart bootstraps a `telegraf-ds` DaemonSet on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
## Prerequisites
- Kubernetes 1.11+ with Beta APIs enabled
> **Tip**: `helm upgrade --install [RELEASE] [CHART] [FLAGS]` is idempotent and can be run multiple times. If chart hasn't been installed, Helm installs it. If chart is installed, Helm redeploys the same version or upgrades the chart if a new version is available.
## Installing the Chart
## Install the chart
To install the chart with the release name `my-release`:
......@@ -31,9 +28,9 @@ helm upgrade --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.
> **Tip**: List all releases using `helm list`
> **Tip**: To view all Helm chart releases, run `helm list`.
## Uninstalling the Chart
## Uninstall the chart
To uninstall/delete the `my-release` deployment:
......@@ -43,9 +40,9 @@ helm uninstall my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
## Configure the chart
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,
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 upgrade --install my-release \
......@@ -53,7 +50,7 @@ helm upgrade --install my-release \
influxdata/telegraf-ds
```
The above command allows the chart to deploy by setting the InfluxDB URL for telegraf to write to.
This command lets the chart deploy by setting the InfluxDB URL for Telegraf to write to.
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
......@@ -63,7 +60,7 @@ helm upgrade --install my-release -f values.yaml influxdata/telegraf-ds
> **Tip**: `helm upgrade --install [RELEASE] [CHART] [FLAGS]` can be shortened : `helm upgrade -i [RELEASE] [CHART] [FLAGS]`
## Telegraf Configuration
## Telegraf configuration
This chart deploys the following by default:
......
......@@ -31,7 +31,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
version: 1.0.1
version: 1.0.2
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application.
......
# Telegraf-operator
# Telegraf-operator Helm chart
## Usage
> Default installation expects `cert-manager` to be running in the cluster.
```console
helm repo add influxdata https://helm.influxdata.com
## Prerequisites
helm install telegraf-operator influxdata/telegraf-operator
- Helm v2 or later
- Kubernetes 1.11+ with Beta APIs enabled
## Install the chart
1. Add the InfluxData Helm repository:
```bash
helm repo add influxdata https://helm.influxdata.com/
```
2. Run the following command, providing a name for your release:
```bash
helm upgrade --install my-release influxdata/telegraf-operator
```
> **Tip**: `--install` can be shortened to `-i`.
This command deploys Telegraf-operator on the Kubernetes cluster using the default configuration. To find parameters you can configure during installation, see [Configure the chart](#configure-the-chart).
> **Tip**: To view all Helm chart releases, run `helm list`.
## Uninstall the chart
To uninstall the `my-release` deployment, use the following command:
```bash
helm uninstall my-release
```
## Contributing & Developing
This command removes all the Kubernetes components associated with the chart and deletes the release.
## Configure the chart
Configurable parameters, their descriptions, and their default values are stored in `values.yaml`.
To configure the chart, do either of the following:
- Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade --install`. For example, use the following command:
```bash
helm upgrade --install my-release \
--set persistence.enabled=true \
influxdata/telegraf-operator
```
This command enables persistence.
- Provide a YAML file that specifies parameter values while installing the chart. For example, use the following command:
```bash
helm upgrade --install my-release -f values.yaml influxdata/telegraf-operator
```
> **Tip**: Use the default [values.yaml](values.yaml).
For information about running Telegraf-operator in Docker, see the [full image documentation](https://hub.docker.com/_/kapacitor/).
## Contribute to the chart
```shell
helm template --namespace=telegraf-operator telegraf-operator .
```
Test installation with Kind
### Test installation with Kind
```shell
kind create cluster --name=telegraf-operator-test
kubectl config use-context kind-telegraf-operator-test
......
apiVersion: v1
name: telegraf
version: 1.7.14
version: 1.7.15
appVersion: 1.14
deprecated: false
description: Telegraf is an agent written in Go for collecting, processing, aggregating, and writing metrics.
......
# Telegraf
# Telegraf Helm chart
[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.
[Telegraf](https://github.com/influxdata/telegraf) is a plugin-driven server agent used for collecting and reporting metrics.
## TL;DR
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.
```console
helm repo add influxdata https://helm.influxdata.com/
helm upgrade --install telegraf influxdata/telegraf --namespace monitoring
```
To see a list of available Telegraf plugins, see https://github.com/influxdata/telegraf/tree/master/plugins/.
## Introduction
## Prerequisites
This chart bootstraps a `telegraf` deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
- Helm v2 or later
- Kubernetes 1.4+ with beta APIs enabled
## Prerequisites
## Install the chart
- Kubernetes 1.4+ with Beta APIs enabled
1. Add the InfluxData Helm repository:
## Installing the Chart
```bash
helm repo add influxdata https://helm.influxdata.com/
```
To install the chart with the release name `telegraf`:
2. Run the following command, providing a name for your Telegraf release:
```console
helm upgrade --install telegraf influxdata/telegraf --namespace monitoring
```
```bash
helm upgrade --install my-release influxdata/telegraf
```
The command deploys Telegraf on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
> **Tip**: `--install` can be shortened to `-i`.
> **Tip**: List all releases using `helm list`
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).
## Uninstalling the Chart
> **Tip**: To view all Helm chart releases, run `helm list`.
To uninstall/delete the `telegraf` deployment:
## Uninstall the chart
```console
helm uninstall telegraf
To uninstall the `my-release` deployment, use the following command:
```bash
helm uninstall my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
This command removes all Kubernetes components associated with the chart and deletes the release.
## Configuration
## Configure the chart
The default configuration parameters are listed in `values.yaml`.
Plugins are configured as arrays of key/value dictionaries. Find configurable parameters, their descriptions, and their default values stored in `values.yaml`.
```console
helm upgrade --install telegraf influxdata/telegraf
```
To configure the chart, do either of the following:
> **Tip**: `helm upgrade --install [RELEASE] [CHART] [FLAGS]` can be shortened : `helm upgrade -i [RELEASE] [CHART] [FLAGS]`
- Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade --install`. For example:
Outputs and inputs are configured as arrays of key/value dictionaries. Additional examples and defaults can be found in [values.yaml](values.yaml)
```bash
helm upgrade --install my-release \
--set persistence.enabled=true \
influxdata/telegraf
```
Example:
This command enables persistence.
```yaml
outputs:
- influxdb:
urls: []
# - "http://influxdb.monitoring:8086"
database: "telegraf"
inputs:
- cpu:
percpu: false
totalcpu: true
- system:
```
- Provide a YAML file that specifies the parameter values while installing the chart. For example, use the following command:
> **Tip**: You can use the default [values.yaml](values.yaml)
```bash
helm upgrade --install my-release -f values.yaml influxdata/telegraf
```
Please see https://github.com/influxdata/telegraf/tree/master/plugins/ and checkout the contents of the `inputs` and `outputs` folders.
> **Tip**: Use the default [values.yaml](values.yaml).
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