.. | ||
templates | ||
.helmignore | ||
Chart.yaml | ||
README_CHANGELOG.md.gotmpl | ||
README_CONFIG.md.gotmpl | ||
README.md | ||
README.md.gotmpl | ||
values.yaml |
unifi-poller
Collect ALL UniFi Controller, Site, Device & Client Data - Export to InfluxDB or Prometheus
This chart is not maintained by the upstream project and any issues with the chart should be raised here
Source Code
Requirements
Kubernetes: >=1.16.0-0
Dependencies
Repository | Name | Version |
---|---|---|
https://charts.bitnami.com/bitnami | influxdb | 1.1.9 |
https://library-charts.k8s-at-home.com | common | 4.0.1 |
TL;DR
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install unifi-poller k8s-at-home/unifi-poller
Installing the Chart
To install the chart with the release name unifi-poller
helm install unifi-poller k8s-at-home/unifi-poller
Uninstalling the Chart
To uninstall the unifi-poller
deployment
helm uninstall unifi-poller
The command removes all the Kubernetes components associated with the chart including persistent volumes and deletes the release.
Configuration
Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.
Specify each parameter using the --set key=value[,key=value]
argument to helm install
.
helm install unifi-poller \
--set env.TZ="America/New York" \
k8s-at-home/unifi-poller
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
helm install unifi-poller k8s-at-home/unifi-poller -f values.yaml
Custom configuration
N/A
Values
Important: When deploying an application Helm chart you can add more values from our common library chart here
Key | Type | Default | Description |
---|---|---|---|
env | object | {} |
Environment variable configuration options for unifi-poller (docs). Note: a configuration file is also supported. |
image.pullPolicy | string | "IfNotPresent" |
Image k8s pull policy. |
image.repository | string | "golift/unifi-poller" |
Image to deploy. |
image.tag | string | "2.1.3" |
Image tag to deploy. |
influxdb.architecture | string | "standalone" |
InfluxDB cluster deployment architecture. |
influxdb.authEnabled | bool | false |
Enable InfluxDB authentication, supported by unifi-poller. Be sure to match in unifi-poller's influxdb config. |
influxdb.database | string | "unifi" |
Database name to automatically initialize. Be sure to match in unifi-poller's influxdb config. |
influxdb.enabled | bool | false |
Create an InfluxDB instance as a unifi-poller storage backend. See bitnami/influxdb for more options. |
influxdb.persistence.enabled | bool | false |
Enable persistence to store in a PV so data survives pod restarts. |
ingress.main.enabled | bool | false |
Expose unifi-poller's web interface (if enabled in the configuration) via the k8s ingress by setting this true. |
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.main.ports.http.enabled | bool | false |
|
service.main.ports.metrics.enabled | bool | true |
|
service.main.ports.metrics.port | int | 9130 |
|
service.main.ports.metrics.protocol | string | "TCP" |
Changelog
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click here.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
10.0.0
Changed
- BREAKING: Refactored Prometheus metrics section to add rules. Enabling metrics automatically enables the serviceMonitor.
9.0.0
Changed
- Upgraded the common library dependency to version 4.0.0. This introduced (potentially) breaking changes to
initContainers
andadditionalContainers
. Be sure to check out the library chart for the up-to-date values.
8.0.0
Changed
- BREAKING: Upgraded the common library dependency to version 3.2.0. This introduces several breaking changes (
service
,ingress
andpersistence
keys have been refactored). Be sure to check out the library chart for the up-to-date values. - BREAKING: Change the default influxdb database name to match unifi-poller's default
- Updates default unifi-poller version from 2.0.1 to 2.1.3
Support
Autogenerated from chart metadata using helm-docs v1.5.0