# Chronograf
## An Open-Source Time Series Visualization Tool
[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.
## 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 upgrade --install my-release influxdata/chronograf
```
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.
> **Tip**: List all releases using `helm list`
## Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
```bash
helm uninstall my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
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.
The following table lists the configurable parameters of the chronograf chart and their default values.
| Parameter | Description | Default |
|:-----------------------------|:----------------------------------------------------------------------------------------------------------|:--------------------------------------------|
| `image.repository` | controller container image repository | quay.io/influxdb/chronograf |
| `image.tag` | controller container image tag | 1.8.0 |
| `image.pullPolicy` | controller container image pull policy | IfNotPresent |
| `service.type` | ClusterIP, NodePort, or LoadBalancer | ClusterIP |
| `persistence.enabled` | Use a PVC to persist data | `true` |
| `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` |
| `ingress.enabled` | Enable ingress controller resource | false |
| `ingress.hostname` | Ingress resource hostnames | chronograf.foobar.com |
| `ingress.tls` | Ingress TLS configuration | false |
| `ingress.annotations` | Ingress annotations configuration | null |
| `oauth.enabled` | Need to set to true to use any of the oauth options | false |
| `oauth.token_secret` | Used for JWT to support running multiple copies of Chronograf | CHANGE_ME |
| `oauth.github.enabled` | Enable oauth github | false |
| `oauth.github.client_id` | oauth github client_id | CHANGE_ME |
| `oauth.github.client_secret` | This is a comma separated list of GH organizations | CHANGE_ME |
| `oauth.github.gh_orgs` | oauth github | "" |
| `oauth.google.enabled` | Enable oauth google | false |
| `oauth.google.client_id` | oauth google | CHANGE_ME |
| `oauth.google.client_secret` | This is a comma separated list of GH organizations | CHANGE_ME |
| `oauth.google.public_url` | oauth google | "" |
| `oauth.google.domains` | This is a comma separated list of Google Apps domains | "" |
| `oauth.heroku.enabled` | Enable oauth heroku | false |
| `oauth.heroku.client_id` | oauth heroku client_id | CHANGE_ME |
| `oauth.heroku.client_secret` | This is a comma separated list of Heroku organizations | CHANGE_ME |
| `oauth.heroku.gh_orgs` | oauth github | "" |
| `env` | Extra environment variables that will be passed onto deployment pods | {} |
| `envFromSecret` | The name of a secret in the same kubernetes namespace which contain values to be added to the environment | {} |
| `nodeSelector` | Node labels for pod assignment | {} |
| `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,
```bash
helm upgrade --install my-release \
--set ingress.enabled=true,ingress.hostname=chronograf.foobar.com \
influxdata/chronograf
```
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 upgrade --install my-release -f values.yaml influxdata/chronograf
```
> **Tip**: You can use the default [values.yaml](values.yaml)
## Persistence
The [Chronograf](https://quay.io/influxdb/chronograf) image stores data in the `/var/lib/chronograf` directory in the container.
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, 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
Taking Google as an example, to use an existing Kubernetes Secret that contains sensitive information (`GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`), e.g.:
```
apiVersion: v1
kind: Secret
metadata:
name: chronograf-google-env-secrets
namespace: tick
type: Opaque
data:
GOOGLE_CLIENT_ID: <BASE64_ENCODED_GOOGLE_CLIENT_ID>
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:
```
[...]
env:
GOOGLE_DOMAINS: "yourdomain.com"
PUBLIC_URL: "https://chronograf.yourdomain.com"
envFromSecret: chronograf-google-env-secrets
[...]
```