diff --git a/speedtest-exporter/Chart.yaml b/speedtest-exporter/Chart.yaml index 869ba45..6f0c203 100644 --- a/speedtest-exporter/Chart.yaml +++ b/speedtest-exporter/Chart.yaml @@ -3,7 +3,7 @@ name: speedtest-exporter description: icon: https://b.cdnst.net/images/favicons/favicon-180.png type: application -version: 0.2.0 +version: "0.2.1" # renovate: image=ghcr.io/miguelndecarvalho/speedtest-exporter appVersion: "3.5.4" maintainers: diff --git a/speedtest-exporter/README.adoc b/speedtest-exporter/README.adoc index 18c62b9..3c767c6 100644 --- a/speedtest-exporter/README.adoc +++ b/speedtest-exporter/README.adoc @@ -2,7 +2,7 @@ = 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-0.2.1-informational?style=flat-square[Version: 0.2.1] 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 diff --git a/speedtest-exporter/README.md b/speedtest-exporter/README.md new file mode 100644 index 0000000..0c88a0f --- /dev/null +++ b/speedtest-exporter/README.md @@ -0,0 +1,98 @@ +--- +title: "speedtest-exporter" + +--- + +# speedtest-exporter + +![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.5.4](https://img.shields.io/badge/AppVersion-3.5.4-informational?style=flat-square) + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| WrenIX | | | + +## Usage + +Helm must be installed and setup to your kubernetes cluster to use the charts. +Refer to Helm's [documentation](https://helm.sh/docs) to get started. +Once Helm has been set up correctly, fetch the charts as follows: + +```bash +helm pull oci://codeberg.org/wrenix/helm-charts/speedtest-exporter +``` + +You can install a chart release using the following command: + +```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: + +```bash +helm uninstall speedtest-exporter-release +``` + +## 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 [helm-docs](https://github.com/norwoodj/helm-docs)