mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-24 16:09:08 +00:00
bed22d6551
* mass-rename of chart repo * update all Chart.yaml files to replace references from old repo to new repo * update all Chart.yaml files to set apiVersion to v2 where necessary * update all README.md files to replace references from old repo to new repo * fix teslamate dependencies for v2 Signed-off-by: Jeff Billimek <jeff@billimek.com>
74 lines
3.9 KiB
Markdown
74 lines
3.9 KiB
Markdown
# A tool to get statistics from Uptime Robot and log it into InfluxDB
|
|
|
|
|
|
|
|
This tool allows you to run periodic uptimerobot data usage checks and save the results to Influxdb
|
|
|
|
## TL;DR;
|
|
|
|
```console
|
|
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
$ helm install k8s-at-home/uptimerobot
|
|
```
|
|
|
|
## Introduction
|
|
|
|
This code is adopted from [this original repo](https://github.com/trojanc/node-influx-uptimerobot)
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `my-release`:
|
|
|
|
```console
|
|
$ helm install --name my-release k8s-at-home/uptimerobot
|
|
```
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall/delete the `my-release` deployment:
|
|
|
|
```console
|
|
$ helm delete my-release --purge
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
|
|
## Configuration
|
|
|
|
The configuration is set as a block of text through a configmap and mounted as a file in /src/config.ini Any value in this text block should match the defined uptimerobot configuration. There are several values here that will have to match our kubernetes configuration.
|
|
|
|
## Configuration
|
|
|
|
The following tables lists the configurable parameters of the Sentry chart and their default values.
|
|
|
|
| Parameter | Description | Default |
|
|
| ------------------------------- | ------------------------------- | ---------------------------------------------------------- |
|
|
| `image.repository` | uptimerobot image | `billimek/uptimerobotusage-for-influxdb` |
|
|
| `image.tag` | uptimerobot image tag | `latest` |
|
|
| `image.pullPolicy` | uptimerobot image pull policy | `IfNotPresent` |
|
|
| `delay` | number of seconds to wait between collections | `300` |
|
|
| `config.influxdb.host` | InfluxDB hostname | `influxdb-influxdb` |
|
|
| `config.influxdb.port` | InfluxDB port | `8086` |
|
|
| `config.influxdb.database` | InfluxDB database | `uptimerobot` |
|
|
| `config.influxdb.protocol` | InfluxDB protocol | `http` |
|
|
| `config.influxdb.username` | InfluxDB username | `` |
|
|
| `config.influxdb.password` | InfluxDB password | `` |
|
|
| `config.uptimerobot.apikey` | uptimerobot API key (REQUIRED) | `someapikey` |
|
|
| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` |
|
|
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
|
|
```console
|
|
$ helm install --name my-release \
|
|
--set config.uptimerobot.apikey=thisismyapikey \
|
|
k8s-at-home/uptimerobot
|
|
```
|
|
|
|
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 k8s-at-home/uptimerobot
|
|
```
|
|
|
|
Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/uptimerobot/values.yaml) file. It has several commented out suggested values.
|