Commit released Helm Chart and docs for TrueCharts

Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2021-11-24 23:20:07 +00:00
parent 16dd3f3ded
commit ebe222e2ce
35 changed files with 814 additions and 28 deletions
@@ -0,0 +1,27 @@
+# Changelog<br>
+
+
+<a name="speedtest-exporter-1.0.0"></a>
+### [speedtest-exporter-1.0.0](https://github.com/truecharts/apps/compare/speedtest-exporter-0.0.2...speedtest-exporter-1.0.0) (2021-11-24)
+
+#### Fix
+
+* allow write to filesystem and move to stable
+
+
+
+<a name="speedtest-exporter-0.0.2"></a>
+### [speedtest-exporter-0.0.2](https://github.com/truecharts/apps/compare/speedtest-exporter-0.0.1...speedtest-exporter-0.0.2) (2021-11-23)
+
+#### Chore
+
+* update non-major ([#1390](https://github.com/truecharts/apps/issues/1390))
+
+
+
+<a name="speedtest-exporter-0.0.1"></a>
+### speedtest-exporter-0.0.1 (2021-11-23)
+
+#### Feat
+
+* add some prometheus exporter-Apps ([#1388](https://github.com/truecharts/apps/issues/1388))
@@ -0,0 +1,8 @@
+# Configuration Options
+
+##### Connecting to other apps
+If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
+https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.
@@ -0,0 +1,32 @@
+# Default Helm-Values
+
+TrueCharts is primarily build to supply TrueNAS SCALE Apps.
+However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
+
+Most of our Apps also consume our "common" Helm Chart.
+If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
+You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| env | object | See below | environment variables. See [application docs](https://docs.miguelndecarvalho.pt/projects/speedtest-exporter/) for more details. |
+| env.TZ | string | `"UTC"` | Set the container timezone |
+| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
+| image.repository | string | `"ghcr.io/miguelndecarvalho/speedtest-exporter"` | image repository |
+| image.tag | string | `"v3.3.4"` | image tag |
+| metrics.enabled | bool | See values.yaml | Enable and configure a Prometheus serviceMonitor for the chart under this key. |
+| metrics.prometheusRule | object | See values.yaml | Enable and configure Prometheus Rules for the chart under this key. |
+| metrics.prometheusRule.downloadLimit | int | `400` | Download speed you want alerts to be triggered in Mbps |
+| metrics.prometheusRule.jitterLimit | int | `30` | Jitter latency you want alerts to be triggered in ms |
+| metrics.prometheusRule.pingLimit | int | `10` | Ping latency you want alerts to be triggered in ms |
+| metrics.prometheusRule.rules | list | See prometheusrules.yaml | Configure additionial rules for the chart under this key. |
+| metrics.prometheusRule.uploadLimit | int | `400` | Upload speed you want alerts to be triggered in Mbps |
+| metrics.serviceMonitor.interval | string | `"60m"` | The interval field must use minutes for the padding to calculate properly. |
+| metrics.serviceMonitor.labels | object | `{}` |  |
+| metrics.serviceMonitor.scrapeTimeout | string | `"1m"` |  |
+| securityContext.readOnlyRootFilesystem | bool | `false` |  |
+| service | object | See values.yaml | Configures service settings for the chart. |
+
+All Rights Reserved - The TrueCharts Project
@@ -0,0 +1,37 @@
+# Introduction
+
+Speedtest Exporter made in python using the official speedtest bin
+
+TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
+
+## Source Code
+
+* <https://github.com/MiguelNdeCarvalho/speedtest-exporter/>
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://truecharts.org | common | 8.9.3 |
+
+## Installing the Chart
+
+To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
+
+## Uninstalling the Chart
+
+To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
+
+## Support
+
+- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
+- See the [Wiki](https://truecharts.org)
+- Check our [Discord](https://discord.gg/tVsPTHWTtr)
+- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
+---
+All Rights Reserved - The TrueCharts Project