charts/charts/librespeed
Jeff Billimek bed22d6551
mass-rename of chart repo (#3)
* 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>
2020-08-29 11:22:37 -04:00
..
templates [librespeed] New Chart (#335) 2020-08-20 08:07:31 -04:00
.helmignore [librespeed] New Chart (#335) 2020-08-20 08:07:31 -04:00
Chart.yaml mass-rename of chart repo (#3) 2020-08-29 11:22:37 -04:00
OWNERS [librespeed] New Chart (#335) 2020-08-20 08:07:31 -04:00
README.md mass-rename of chart repo (#3) 2020-08-29 11:22:37 -04:00
values.yaml [librespeed] New Chart (#335) 2020-08-20 08:07:31 -04:00

Librespeed

HTML5 based speedtest with password protected history

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

TL;DR;

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

Introduction

This code is adopted from the Linuxserver Librespeed docker image which runs the Librespeed application

Installing the Chart

To install the chart with the release name my-release:

helm install --name my-release k8s-at-home/librespeed

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete my-release --purge

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

Configuration

The following tables lists the configurable parameters of the Librespeed chart and their default values.

Parameter Description Default
image.repository Librespeed image linuxserver/librespeed
image.tag Librespeed image tag 5.2-ls25
image.pullPolicy Librespeed image pull policy IfNotPresent
strategyType Specifies the strategy used to replace old Pods by new ones Recreate
livenessProbePath Default livenessProbe path /
readinessProbePath Default readinessProbe path /
timezone Default timezone UTC
puid Default UID 1000
pgid Default GID 1000
telemetry Enable/Disable history false
title Title of your speedtest LibreSpeed
idObfuscation Test IDs are obfuscated, avoids exposing database internal sequential IDs false
redactIPAddresses IP addresses/hostnames are redacted from the collected telemetry false
email Email address for GDPR requests. Must be specified when telemetry=true `fake@fake.com
distance how the distance from the server is measured. Options km, mi, or `` km
service.type Kubernetes service type for the GUI ClusterIP
service.port Kubernetes port where the GUI is exposed 1880
service.nodePort Kubernetes nodePort where the GUI is exposed ``
service.annotations Service annotations for the GUI {}
service.labels Custom labels {}
service.loadBalancerIP Loadbalance IP for the GUI {}
service.loadBalancerSourceRanges List of IP CIDRs allowed access to load balancer (if supported) None
service.externalTrafficPolicy Set the externalTrafficPolicy in the Service to either Cluster or Local Cluster
ingress.enabled Enables Ingress false
ingress.annotations Ingress annotations {}
ingress.path Ingress path /
ingress.hosts Ingress accepted hostnames chart-example.local
ingress.tls Ingress TLS configuration []
persistence.enabled Use persistent volume to store data false
persistence.size Size of persistent volume claim 5Gi
persistence.existingClaim Use an existing PVC to persist data nil
persistence.storageClass Type of persistent volume claim -
persistence.accessModes Persistence access modes ReadWriteOnce
persistence.subPath Mount a sub dir of the persistent volume nil
resources CPU/Memory resource requests/limits {}
nodeSelector Node labels for pod assignment {}
tolerations Toleration labels for pod assignment []
affinity Affinity settings for pod assignment {}
podAnnotations Key-value pairs to add as pod annotations {}
deploymentAnnotations Key-value pairs to add as deployment annotations {}

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

helm install --name my-release \
  --set config.timezone="America/New_York" \
    k8s-at-home/librespeed

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

helm install --name my-release -f values.yaml k8s-at-home/librespeed

Read through the values.yaml file. It has several commented out suggested values.