326 lines
3.8 KiB
Text
326 lines
3.8 KiB
Text
|
|
|
|
= speedtest-exporter
|
|
|
|
image::https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square[Version: 0.2.0]
|
|
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
|
|
image::https://img.shields.io/badge/AppVersion-3.5.4-informational?style=flat-square[AppVersion: 3.5.4]
|
|
== Maintainers
|
|
|
|
.Maintainers
|
|
|===
|
|
| Name | Email | Url
|
|
|
|
| WrenIX
|
|
|
|
|
| <https://wrenix.eu>
|
|
|===
|
|
|
|
== Usage
|
|
|
|
Helm must be installed and setup to your kubernetes cluster to use the charts.
|
|
Refer to Helm's https://helm.sh/docs[documentation] to get started.
|
|
Once Helm has been set up correctly, fetch the charts as follows:
|
|
|
|
[source,bash]
|
|
----
|
|
helm pull oci://codeberg.org/wrenix/helm-charts/speedtest-exporter
|
|
----
|
|
|
|
You can install a chart release using the following command:
|
|
|
|
[source,bash]
|
|
----
|
|
helm install speedtest-exporter-release oci://codeberg.org/wrenix/helm-charts/speedtest-exporter --values values.yaml
|
|
----
|
|
|
|
To uninstall a chart release use `helm`'s delete command:
|
|
|
|
[source,bash]
|
|
----
|
|
helm uninstall speedtest-exporter-release
|
|
----
|
|
|
|
== Values
|
|
|
|
.Values
|
|
|===
|
|
| Key | Type | Default | Description
|
|
|
|
| affinity
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| autoscaling.enabled
|
|
| bool
|
|
| `false`
|
|
|
|
|
|
|
| autoscaling.maxReplicas
|
|
| int
|
|
| `100`
|
|
|
|
|
|
|
| autoscaling.minReplicas
|
|
| int
|
|
| `1`
|
|
|
|
|
|
|
| autoscaling.targetCPUUtilizationPercentage
|
|
| int
|
|
| `80`
|
|
|
|
|
|
|
| config.cacheFor
|
|
| int
|
|
| `0`
|
|
| cache result for seconds
|
|
|
|
| config.server
|
|
| string
|
|
| `nil`
|
|
| speedtest-serverid
|
|
|
|
| config.timeout
|
|
| int
|
|
| `90`
|
|
| timeout of speedtest
|
|
|
|
| fullnameOverride
|
|
| string
|
|
| `""`
|
|
|
|
|
|
|
| global.image.pullPolicy
|
|
| string
|
|
| `nil`
|
|
| if set it will overwrite all pullPolicy
|
|
|
|
| global.image.registry
|
|
| string
|
|
| `nil`
|
|
| if set it will overwrite all registry entries
|
|
|
|
| grafana.dashboards.annotations
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| grafana.dashboards.enabled
|
|
| bool
|
|
| `false`
|
|
|
|
|
|
|
| grafana.dashboards.labels.grafana_dashboard
|
|
| string
|
|
| `"1"`
|
|
|
|
|
|
|
| image.pullPolicy
|
|
| string
|
|
| `"IfNotPresent"`
|
|
|
|
|
|
|
| image.registry
|
|
| string
|
|
| `"ghcr.io"`
|
|
|
|
|
|
|
| image.repository
|
|
| string
|
|
| `"miguelndecarvalho/speedtest-exporter"`
|
|
|
|
|
|
|
| image.tag
|
|
| string
|
|
| `""`
|
|
|
|
|
|
|
| imagePullSecrets
|
|
| list
|
|
| `[]`
|
|
|
|
|
|
|
| ingress.annotations
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| ingress.className
|
|
| string
|
|
| `""`
|
|
|
|
|
|
|
| ingress.enabled
|
|
| bool
|
|
| `false`
|
|
|
|
|
|
|
| ingress.hosts[0].host
|
|
| string
|
|
| `"chart-example.local"`
|
|
|
|
|
|
|
| ingress.hosts[0].paths[0].path
|
|
| string
|
|
| `"/"`
|
|
|
|
|
|
|
| ingress.hosts[0].paths[0].pathType
|
|
| string
|
|
| `"ImplementationSpecific"`
|
|
|
|
|
|
|
| ingress.tls
|
|
| list
|
|
| `[]`
|
|
|
|
|
|
|
| livenessProbe.httpGet.path
|
|
| string
|
|
| `"/"`
|
|
|
|
|
|
|
| livenessProbe.httpGet.port
|
|
| string
|
|
| `"http"`
|
|
|
|
|
|
|
| nameOverride
|
|
| string
|
|
| `""`
|
|
|
|
|
|
|
| networkPolicy.egress.enabled
|
|
| bool
|
|
| `false`
|
|
| activate egress no networkpolicy
|
|
|
|
| networkPolicy.egress.extra
|
|
| list
|
|
| `[]`
|
|
| egress rules
|
|
|
|
| networkPolicy.enabled
|
|
| bool
|
|
| `false`
|
|
|
|
|
|
|
| networkPolicy.ingress.http
|
|
| list
|
|
| `[]`
|
|
| ingress for http port (e.g. ingress-controller, prometheus)
|
|
|
|
| nodeSelector
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| podAnnotations
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| podLabels
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| podSecurityContext
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| prometheus.servicemonitor.enabled
|
|
| bool
|
|
| `false`
|
|
|
|
|
|
|
| prometheus.servicemonitor.interval
|
|
| string
|
|
| `"1h"`
|
|
| interval
|
|
|
|
| prometheus.servicemonitor.labels
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| prometheus.servicemonitor.scrapeTimeout
|
|
| string
|
|
| `"2m"`
|
|
| scrape timeout
|
|
|
|
| readinessProbe.httpGet.path
|
|
| string
|
|
| `"/"`
|
|
|
|
|
|
|
| readinessProbe.httpGet.port
|
|
| string
|
|
| `"http"`
|
|
|
|
|
|
|
| replicaCount
|
|
| int
|
|
| `1`
|
|
|
|
|
|
|
| resources
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| securityContext
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| service.port
|
|
| int
|
|
| `80`
|
|
|
|
|
|
|
| service.type
|
|
| string
|
|
| `"ClusterIP"`
|
|
|
|
|
|
|
| serviceAccount.annotations
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| serviceAccount.automount
|
|
| bool
|
|
| `true`
|
|
|
|
|
|
|
| serviceAccount.create
|
|
| bool
|
|
| `true`
|
|
|
|
|
|
|
| serviceAccount.name
|
|
| string
|
|
| `""`
|
|
|
|
|
|
|
| tolerations
|
|
| list
|
|
| `[]`
|
|
|
|
|
|
|
| volumeMounts
|
|
| list
|
|
| `[]`
|
|
|
|
|
|
|
| volumes
|
|
| list
|
|
| `[]`
|
|
|
|
|
|===
|
|
|
|
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]
|