From ec0d8c39ba29f2c12cac9ca4c3f8938ebc19a23f Mon Sep 17 00:00:00 2001 From: TrueCharts-Bot Date: Thu, 25 Nov 2021 13:08:30 +0000 Subject: [PATCH] Commit released Helm Chart and docs for TrueCharts Signed-off-by: TrueCharts-Bot --- charts/stable/unpoller/CHANGELOG.md | 9 ++++++ docs/apps/stable/unpoller/CHANGELOG.md | 28 +++++++++++++++++ docs/apps/stable/unpoller/CONFIG.md | 8 +++++ docs/apps/stable/unpoller/helm-values.md | 29 ++++++++++++++++++ docs/apps/stable/unpoller/index.md | 38 ++++++++++++++++++++++++ docs/index.yaml | 37 ++++++++++++++++++++++- 6 files changed, 148 insertions(+), 1 deletion(-) create mode 100644 docs/apps/stable/unpoller/CHANGELOG.md create mode 100644 docs/apps/stable/unpoller/CONFIG.md create mode 100644 docs/apps/stable/unpoller/helm-values.md create mode 100644 docs/apps/stable/unpoller/index.md diff --git a/charts/stable/unpoller/CHANGELOG.md b/charts/stable/unpoller/CHANGELOG.md index bf3d20572f6..6c2fba54bfe 100644 --- a/charts/stable/unpoller/CHANGELOG.md +++ b/charts/stable/unpoller/CHANGELOG.md @@ -1,6 +1,15 @@ # Changelog
+ +### unpoller-1.0.1 (2021-11-25) + +#### Chore + +* rename unifi-poller to unpoller + + + ### [unifi-poller-1.0.0](https://github.com/truecharts/apps/compare/unifi-poller-0.0.1...unifi-poller-1.0.0) (2021-11-24) diff --git a/docs/apps/stable/unpoller/CHANGELOG.md b/docs/apps/stable/unpoller/CHANGELOG.md new file mode 100644 index 00000000000..6c2fba54bfe --- /dev/null +++ b/docs/apps/stable/unpoller/CHANGELOG.md @@ -0,0 +1,28 @@ +# Changelog
+ + + +### unpoller-1.0.1 (2021-11-25) + +#### Chore + +* rename unifi-poller to unpoller + + + + +### [unifi-poller-1.0.0](https://github.com/truecharts/apps/compare/unifi-poller-0.0.1...unifi-poller-1.0.0) (2021-11-24) + +#### Chore + +* bump unifipoller +* move unifi-poller to stable + + + + +### unifi-poller-0.0.1 (2021-11-23) + +#### Feat + +* add some prometheus exporter-Apps ([#1388](https://github.com/truecharts/apps/issues/1388)) diff --git a/docs/apps/stable/unpoller/CONFIG.md b/docs/apps/stable/unpoller/CONFIG.md new file mode 100644 index 00000000000..fc9b2fa2d5f --- /dev/null +++ b/docs/apps/stable/unpoller/CONFIG.md @@ -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. diff --git a/docs/apps/stable/unpoller/helm-values.md b/docs/apps/stable/unpoller/helm-values.md new file mode 100644 index 00000000000..0394080c950 --- /dev/null +++ b/docs/apps/stable/unpoller/helm-values.md @@ -0,0 +1,29 @@ +# 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 | `{"UP_INFLUXDB_DISABLE":true}` | Environment variable configuration options for unifi-poller ([docs](https://unifipoller.com/docs/install/configuration)). Note: a [configuration file](https://github.com/unifi-poller/unifi-poller/blob/master/examples/up.conf.example) is also supported. | +| image.pullPolicy | string | `"IfNotPresent"` | Image [k8s pull policy](https://kubernetes.io/docs/concepts/containers/images/#updating-images). | +| image.repository | string | `"golift/unifi-poller"` | Image to deploy. | +| image.tag | string | `"2.1.3@sha256:8cd99d3eaeee316cbd9bb50c29a55b042fe1c7844f8e44ed19b7eaa6071e8df7"` | Image tag to deploy. | +| 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.main.enabled | bool | `false` | | +| service.main.ports.metrics.enabled | bool | `true` | | +| service.main.ports.metrics.port | int | `9130` | | +| service.main.ports.metrics.protocol | string | `"TCP"` | | + +All Rights Reserved - The TrueCharts Project diff --git a/docs/apps/stable/unpoller/index.md b/docs/apps/stable/unpoller/index.md new file mode 100644 index 00000000000..8fc9dbb9f79 --- /dev/null +++ b/docs/apps/stable/unpoller/index.md @@ -0,0 +1,38 @@ +# Introduction + +Collect ALL UniFi Controller, Site, Device & Client Data - Export to InfluxDB or Prometheus + +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 + +* +* + +## 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 diff --git a/docs/index.yaml b/docs/index.yaml index dbfc0c28f91..ae86a1f72fb 100644 --- a/docs/index.yaml +++ b/docs/index.yaml @@ -238837,6 +238837,41 @@ entries: urls: - https://github.com/truecharts/apps/releases/download/unpackerr-1.0.0/unpackerr-1.0.0.tgz version: 1.0.0 + unpoller: + - annotations: + truecharts.org/SCALE-support: "true" + truecharts.org/catagories: | + - metrics + truecharts.org/grade: U + apiVersion: v2 + appVersion: 2.1.3 + created: "2021-11-25T13:08:27.495653239Z" + dependencies: + - name: common + repository: https://truecharts.org + version: 8.9.3 + description: Collect ALL UniFi Controller, Site, Device & Client Data - Export + to InfluxDB or Prometheus + digest: 1a94251075b8c4e72edc0d9c7ea657de4c40ca46135a6cc72c87158c445ce773 + home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/unifi-poller + icon: https://raw.githubusercontent.com/wiki/unifi-poller/unifi-poller/images/unifi-poller-logo.png + keywords: + - unifi + - unifi-poller + - metrics + kubeVersion: '>=1.16.0-0' + maintainers: + - email: info@truecharts.org + name: TrueCharts + url: https://truecharts.org + name: unpoller + sources: + - https://github.com/unifi-poller/unifi-poller + - https://hub.docker.com/r/golift/unifi-poller + type: application + urls: + - https://github.com/truecharts/apps/releases/download/unpoller-1.0.1/unpoller-1.0.1.tgz + version: 1.0.1 uptime-kuma: - annotations: truecharts.org/SCALE-support: "true" @@ -251316,4 +251351,4 @@ entries: urls: - https://github.com/truecharts/apps/releases/download/zwavejs2mqtt-3.1.5/zwavejs2mqtt-3.1.5.tgz version: 3.1.5 -generated: "2021-11-24T23:20:05.052954198Z" +generated: "2021-11-25T13:08:27.567007724Z"