30 lines
2.0 KiB
Markdown
30 lines
2.0 KiB
Markdown
|
# 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://github.com/lekpamartin/uptimerobot_exporter/blob/master/docker-compose.yml) for more details. |
|
||
|
|
| env.TZ | string | `"UTC"` | Set the container timezone |
|
||
|
|
| env.UPTIMEROBOT_API_KEY | string | `""` | Set the uptimerobot API key |
|
||
|
|
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
|
||
|
|
| image.repository | string | `"billimek/prometheus-uptimerobot-exporter"` | image repository |
|
||
|
|
| image.tag | string | `"0.0.1"` | image tag |
|
||
|
|
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
|
||
|
|
| 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.rules | list | See prometheusrules.yaml | Configure additionial rules for the chart under this key. |
|
||
|
|
| metrics.serviceMonitor.interval | string | `"1m"` | |
|
||
|
|
| metrics.serviceMonitor.labels | object | `{}` | |
|
||
|
|
| metrics.serviceMonitor.scrapeTimeout | string | `"30s"` | |
|
||
|
|
| service | object | See values.yaml | Configures service settings for the chart. |
|
||
|
|
|
||
|
|
All Rights Reserved - The TrueCharts Project
|