diff --git a/charts/librespeed/.helmignore b/charts/librespeed/.helmignore new file mode 100644 index 00000000..46fd8996 --- /dev/null +++ b/charts/librespeed/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +# OWNERS file for Kubernetes +OWNERS diff --git a/charts/librespeed/Chart.yaml b/charts/librespeed/Chart.yaml new file mode 100644 index 00000000..29e702e6 --- /dev/null +++ b/charts/librespeed/Chart.yaml @@ -0,0 +1,16 @@ +apiVersion: v1 +appVersion: 1.0.6-12 +description: Librespeed is a HTML5 webpage to test upload and download speeds +name: librespeed +version: 1.0.0 +keywords: + - librespeed +home: https://github.com/billimek/billimek-charts/tree/master/charts/librespeed +icon: https://github.com/librespeed/speedtest/blob/master/.logo/logo3.png?raw=true +sources: + - https://github.com/librespeed/speedtest + - https://hub.docker.com/r/linuxserver/librespeed + - https://github.com/billimek/billimek-charts/tree/master/charts/librespeed +maintainers: + - name: billimek + email: jeff@billimek.com diff --git a/charts/librespeed/OWNERS b/charts/librespeed/OWNERS new file mode 100644 index 00000000..b90909f4 --- /dev/null +++ b/charts/librespeed/OWNERS @@ -0,0 +1,4 @@ +approvers: +- billimek +reviewers: +- billimek diff --git a/charts/librespeed/README.md b/charts/librespeed/README.md new file mode 100644 index 00000000..349df63b --- /dev/null +++ b/charts/librespeed/README.md @@ -0,0 +1,96 @@ +# 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](https://github.com/billimek/billimek-charts/issues/new)** + +## TL;DR; + +```shell +helm repo add billimek https://billimek.com/billimek-charts/ +helm install billimek/librespeed +``` + +## Introduction + +This code is adopted from the [Linuxserver Librespeed docker image](https://hub.docker.com/r/linuxserver/librespeed) which runs the [Librespeed application](https://github.com/librespeed/speedtest) + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```shell +helm install --name my-release billimek/librespeed +``` +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```shell +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, + +```shell +helm install --name my-release \ + --set config.timezone="America/New_York" \ + billimek/librespeed +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +```shell +helm install --name my-release -f values.yaml billimek/librespeed +``` + +Read through the [values.yaml](values.yaml) file. It has several commented out suggested values. diff --git a/charts/librespeed/templates/NOTES.txt b/charts/librespeed/templates/NOTES.txt new file mode 100644 index 00000000..25f281f9 --- /dev/null +++ b/charts/librespeed/templates/NOTES.txt @@ -0,0 +1,19 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range .Values.ingress.hosts }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ . }}{{ $.Values.ingress.path }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "librespeed.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get svc -w {{ include "librespeed.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "librespeed.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "librespeed.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl port-forward $POD_NAME 8080:80 +{{- end }} diff --git a/charts/librespeed/templates/_helpers.tpl b/charts/librespeed/templates/_helpers.tpl new file mode 100644 index 00000000..121857a5 --- /dev/null +++ b/charts/librespeed/templates/_helpers.tpl @@ -0,0 +1,32 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "librespeed.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "librespeed.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "librespeed.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} diff --git a/charts/librespeed/templates/deployment.yaml b/charts/librespeed/templates/deployment.yaml new file mode 100644 index 00000000..a1e0294d --- /dev/null +++ b/charts/librespeed/templates/deployment.yaml @@ -0,0 +1,102 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "librespeed.fullname" . }} + {{- if .Values.deploymentAnnotations }} + annotations: + {{- range $key, $value := .Values.deploymentAnnotations }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} + labels: + app.kubernetes.io/name: {{ include "librespeed.name" . }} + helm.sh/chart: {{ include "librespeed.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +spec: + replicas: 1 + strategy: + type: {{ .Values.strategyType }} + selector: + matchLabels: + app.kubernetes.io/name: {{ include "librespeed.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + template: + metadata: + labels: + app.kubernetes.io/name: {{ include "librespeed.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + {{- if .Values.podAnnotations }} + annotations: + {{- range $key, $value := .Values.podAnnotations }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} + spec: + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: 80 + protocol: TCP + livenessProbe: + httpGet: + path: {{ .Values.livenessProbePath }} + port: http + readinessProbe: + httpGet: + path: {{ .Values.readinessProbePath }} + port: http + env: + - name: TZ + value: "{{ .Values.timezone }}" + - name: PUID + value: "{{ .Values.puid }}" + - name: GUID + value: "{{ .Values.pgid }}" + {{ if .Values.telemetry }} + - name: TELEMETRY + value: "{{ .Values.telemetry }}" + - name: PASSWORD + value: "{{ .Values.password }}" + - name: ENABLE_ID_OBFUSCATION + value: "{{ .Values.idObfuscation }}" + - name: REDACT_IP_ADDRESSES + value: "{{ .Values.redactIPAddresses }}" + - name: EMAIL + value: "{{ .Values.email }}" + {{ end }} + - name: TITLE + value: "{{ .Values.title }}" + - name: DISTANCE + value: "{{ .Values.distance }}" + volumeMounts: + - name: config + mountPath: /config +{{- if .Values.persistence.subPath }} + subPath: {{ .Values.persistence.subPath }} +{{- end }} + resources: +{{ toYaml .Values.resources | indent 12 }} + volumes: + - name: config + {{- if .Values.persistence.enabled }} + persistentVolumeClaim: + claimName: {{ if .Values.persistence.existingClaim }}{{ .Values.persistence.existingClaim }}{{- else }}{{ template "librespeed.fullname" . }}{{- end }} + {{- else }} + emptyDir: {} + {{ end }} + {{- with .Values.nodeSelector }} + nodeSelector: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: +{{ toYaml . | indent 8 }} + {{- end }} diff --git a/charts/librespeed/templates/ingress.yaml b/charts/librespeed/templates/ingress.yaml new file mode 100644 index 00000000..229985b3 --- /dev/null +++ b/charts/librespeed/templates/ingress.yaml @@ -0,0 +1,38 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "librespeed.fullname" . -}} +{{- $ingressPath := .Values.ingress.path -}} +apiVersion: extensions/v1beta1 +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + app.kubernetes.io/name: {{ include "librespeed.name" . }} + helm.sh/chart: {{ include "librespeed.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- with .Values.ingress.annotations }} + annotations: +{{ toYaml . | indent 4 }} +{{- end }} +spec: +{{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} +{{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ . | quote }} + http: + paths: + - path: {{ $ingressPath }} + backend: + serviceName: {{ $fullName }} + servicePort: http + {{- end }} +{{- end }} diff --git a/charts/librespeed/templates/pvc.yaml b/charts/librespeed/templates/pvc.yaml new file mode 100644 index 00000000..d17918d7 --- /dev/null +++ b/charts/librespeed/templates/pvc.yaml @@ -0,0 +1,24 @@ +{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }} +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: {{ template "librespeed.fullname" . }} + labels: + app.kubernetes.io/name: {{ include "librespeed.name" . }} + helm.sh/chart: {{ include "librespeed.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +spec: + accessModes: + - {{ .Values.persistence.accessMode | quote }} + resources: + requests: + storage: {{ .Values.persistence.size | quote }} +{{- if .Values.persistence.storageClass }} +{{- if (eq "-" .Values.persistence.storageClass) }} + storageClassName: "" +{{- else }} + storageClassName: "{{ .Values.persistence.storageClass }}" +{{- end }} +{{- end }} +{{- end -}} diff --git a/charts/librespeed/templates/service.yaml b/charts/librespeed/templates/service.yaml new file mode 100644 index 00000000..740ec36f --- /dev/null +++ b/charts/librespeed/templates/service.yaml @@ -0,0 +1,42 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "librespeed.fullname" . }} + {{- if .Values.service.annotations }} + annotations: + {{- toYaml .Values.service.annotations | nindent 4 }} + {{- end }} + labels: + app.kubernetes.io/name: {{ include "librespeed.name" . }} + helm.sh/chart: {{ include "librespeed.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +spec: +{{- if (or (eq .Values.service.type "ClusterIP") (empty .Values.service.type)) }} + type: ClusterIP +{{- else if eq .Values.service.type "LoadBalancer" }} + type: {{ .Values.service.type }} + {{- if .Values.service.loadBalancerIP }} + loadBalancerIP: {{ .Values.service.loadBalancerIP }} + {{- end }} + {{- if .Values.service.loadBalancerSourceRanges }} + loadBalancerSourceRanges: +{{ toYaml .Values.service.loadBalancerSourceRanges | indent 4 }} + {{- end -}} +{{- else }} + type: {{ .Values.service.type }} +{{- end }} + {{- if .Values.service.externalTrafficPolicy }} + externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }} + {{- end }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http +{{ if (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort))) }} + nodePort: {{.Values.service.nodePort}} +{{ end }} + selector: + app.kubernetes.io/name: {{ include "librespeed.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} diff --git a/charts/librespeed/values.yaml b/charts/librespeed/values.yaml new file mode 100644 index 00000000..a75d6ab2 --- /dev/null +++ b/charts/librespeed/values.yaml @@ -0,0 +1,113 @@ +# Default values for librespeed +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# upgrade strategy type (e.g. Recreate or RollingUpdate) +strategyType: Recreate + +image: + repository: adolfintel/speedtest + tag: latest + pullPolicy: IfNotPresent + +nameOverride: "" +fullnameOverride: "" + +livenessProbePath: / +readinessProbePath: / + +timezone: "UTC" +puid: "1000" +pgid: "1000" + +## Store results? If enabled, password is required +telemetry: false +## The following are required when telemetry is enabled +## If telemetry is enabled, a stats page will be available at http://your.server/results/stats.php +# password: "ChangeMe" +# email: "fake@fake.com" + +## The following are optional. The defaults are listed +# title: LibreSpeed +## Test IDs are obfuscated, to avoid exposing the database internal sequential IDs +# idObfuscation: false +## IP addresses and hostnames are redacted from the collected telemetry, for better privacy +# redactIPAddresses: false +## Specifies how the distance from the server is measured. Can be either km for kilometers, mi for miles, or an empty string to disable distance measurement. +# distance: "km" + + +service: + type: ClusterIP + port: 80 + ## Specify the nodePort value for the LoadBalancer and NodePort service types. + ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + ## + # nodePort: + ## Provide any additional annotations which may be required. This can be used to + ## set the LoadBalancer service type to internal only. + ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer + ## + annotations: {} + labels: {} + ## Use loadBalancerIP to request a specific static IP, + ## otherwise leave blank + ## + loadBalancerIP: + # loadBalancerSourceRanges: [] + ## Set the externalTrafficPolicy in the Service to either Cluster or Local + # externalTrafficPolicy: Cluster + +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + path: / + hosts: + - chart-example.local + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +persistence: + enabled: false + ## node-red data Persistent Volume Storage Class + ## If defined, storageClassName: + ## If set to "-", storageClassName: "", which disables dynamic provisioning + ## If undefined (the default) or set to null, no storageClassName spec is + ## set, choosing the default provisioner. (gp2 on AWS, standard on + ## GKE, AWS & OpenStack) + ## + # storageClass: "-" + ## + ## If you want to reuse an existing claim, you can pass the name of the PVC using + ## the existingClaim variable + # existingClaim: your-claim + accessMode: ReadWriteOnce + size: 1Gi + ## When mounting the data volume you may specify a subPath + # subPath: /configs/node-red + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +podAnnotations: {} + +deploymentAnnotations: {}