Files
k8s-at-home-charts/charts/speedtest/README.md
Vegetto beaf1d697a [helm-docs] Addopt helm-docs for remaining charts (#660)
* homebridge -> helm-docs

* librespeed -> helmdocs

* node-feature-discovery -> helm-docs

* oauth2-proxy -> helm-docs

* sersock -> helmdocs

* speedtest -> helm-docs

* unifi -> helm-docs

* bump version

* uptimerobot -> helm-docs

* do not install test ser2sock

* Add influxdb dependency

* no default value for externalTrafficPolicy

Co-authored-by: angelnu <git@angelnucom>
2021-03-13 10:30:07 -05:00

4.4 KiB

speedtest

Version: 3.0.1 AppVersion: 1.0.0

periodic speedtest and save the results to InfluxDB

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Source Code

Requirements

Dependencies

Repository Name Version
https://charts.bitnami.com/bitnami influxdb 1.1.9

TL;DR

helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install speedtest k8s-at-home/speedtest

Installing the Chart

To install the chart with the release name speedtest

helm install speedtest k8s-at-home/speedtest

Uninstalling the Chart

To uninstall the speedtest deployment

helm uninstall speedtest

The command removes all the Kubernetes components associated with the chart including persistent volumes and deletes the release.

Configuration

Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.

Specify each parameter using the --set key=value[,key=value] argument to helm install.

helm install speedtest \
  --set env.TZ="America/New York" \
    k8s-at-home/speedtest

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

helm install speedtest k8s-at-home/speedtest -f values.yaml

Custom configuration

N/A

Values

Important: When deploying an application Helm chart you can add more values from our common library chart here

Key Type Default Description
config.delay int 3600 how many seconds to wait between checks
config.influxdb.database string "speedtests" InfluxDB database
config.influxdb.host string nil InfluxDB host @default - internal influxDB chart if not set
config.influxdb.password string nil InfluxDB password
config.influxdb.port int 8086 InfluxDB port
config.influxdb.ssl bool false enable TLS
config.influxdb.username string nil InfluxDB username
config.speedtest.server string nil server to use for speedtest - leave blank to auto-pick
debug bool false Display debugging output
image.pullPolicy string "IfNotPresent" speedtest image pull policy
image.repository string "atribe/speedtest-for-influxdb-and-grafana" speedtest image
image.tag string "latest" speedtest image tag
influxdb.architecture string "standalone"
influxdb.authEnabled bool false
influxdb.database string "speedtests"
influxdb.enabled bool true
influxdb.persistence.enabled bool false
nodeSelector object {}
podAnnotations object {} Key-value pairs to add as pod annotations
replicaCount int 1
resources object {}

Changelog

All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click here.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

3.0.1

Added

  • N/A

Changed

  • USe helm-docs

Removed

  • N/A

Support


Autogenerated from chart metadata using helm-docs v1.5.0