From 5ba6779f0e805fd1368c31e91a11f840591e54f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=97=AA=D1=94=CE=BD=CE=B9=CE=B7=20=E1=97=B7=CF=85=D0=BD?= =?UTF-8?q?=CA=9F?= Date: Wed, 17 Feb 2021 17:43:56 -0500 Subject: [PATCH] Add Helm Docs (#595) --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/ct.yaml | 10 +- .github/stale.yml | 4 +- .github/workflows/charts-lint-test.yaml | 147 +++---- .github/workflows/charts-release.yaml | 75 ++-- .helmdocsignore | 29 ++ .taskfiles/Taskfile_chart.yml | 1 - CODE_OF_CONDUCT.md | 132 ++++++ charts/README.templates.md.gotmpl | 72 ---- charts/adguard-home/README.md | 228 +++++++--- charts/alertmanager-bot/.helmignore | 2 + charts/alertmanager-bot/README.md | 112 +++-- charts/alertmanager-bot/README.md.gotmpl | 143 +++++++ .../README_CHANGELOG.md.gotmpl | 27 ++ .../alertmanager-bot/README_CONFIG.md.gotmpl | 9 + charts/appdaemon/.helmignore | 2 + charts/appdaemon/README.md | 111 +++-- charts/appdaemon/README.md.gotmpl | 143 +++++++ charts/appdaemon/README_CHANGELOG.md.gotmpl | 27 ++ charts/appdaemon/README_CONFIG.md.gotmpl | 9 + charts/bazarr/.helmignore | 3 + charts/bazarr/README.md | 117 ++++-- charts/bazarr/README.md.gotmpl | 143 +++++++ charts/bazarr/README_CHANGELOG.md.gotmpl | 27 ++ charts/bazarr/README_CONFIG.md.gotmpl | 9 + charts/bitwardenrs/README.md | 140 ++++--- charts/blocky/README.md | 126 +++--- charts/booksonic-air/.helmignore | 26 ++ charts/booksonic-air/README.md | 135 ++++-- charts/booksonic-air/README.md.gotmpl | 143 +++++++ .../booksonic-air/README_CHANGELOG.md.gotmpl | 27 ++ charts/booksonic-air/README_CONFIG.md.gotmpl | 11 + charts/calibre-web/.helmignore | 2 + charts/calibre-web/README.md | 123 ++++-- charts/calibre-web/README.md.gotmpl | 143 +++++++ charts/calibre-web/README_CHANGELOG.md.gotmpl | 27 ++ charts/calibre-web/README_CONFIG.md.gotmpl | 9 + charts/comcast/README.md | 105 ++--- charts/common-test/.helmignore | 26 ++ charts/common-test/README.md | 34 ++ charts/common/README.md | 393 ++++++++++++++++-- charts/common/README.md.gotmpl | 147 +++++++ ...HANGELOG.md => README_CHANGELOG.md.gotmpl} | 89 ++-- charts/common/README_CONFIG.md.gotmpl | 82 ++++ charts/ddclient/.helmignore | 2 + charts/ddclient/README.md | 113 +++-- charts/ddclient/README.md.gotmpl | 143 +++++++ charts/ddclient/README_CHANGELOG.md.gotmpl | 27 ++ charts/ddclient/README_CONFIG.md.gotmpl | 9 + charts/deconz/README.md | 164 ++++---- charts/deluge/.helmignore | 4 +- charts/deluge/README.md | 131 ++++-- charts/deluge/README.md.gotmpl | 143 +++++++ charts/deluge/README_CHANGELOG.md.gotmpl | 27 ++ charts/deluge/README_CONFIG.md.gotmpl | 11 + charts/digitalocean-dyndns/README.md | 80 ++-- charts/dsmr-reader/.helmignore | 2 + charts/dsmr-reader/README.md | 121 ++++-- charts/dsmr-reader/README.md.gotmpl | 143 +++++++ charts/dsmr-reader/README_CHANGELOG.md.gotmpl | 27 ++ charts/dsmr-reader/README_CONFIG.md.gotmpl | 9 + charts/duplicati/README.md | 161 +++---- charts/esphome/.helmignore | 2 + charts/esphome/README.md | 112 +++-- charts/esphome/README.md.gotmpl | 143 +++++++ charts/esphome/README_CHANGELOG.md.gotmpl | 27 ++ charts/esphome/README_CONFIG.md.gotmpl | 9 + charts/flaresolverr/.helmignore | 2 + charts/flaresolverr/README.md | 111 +++-- charts/flaresolverr/README.md.gotmpl | 143 +++++++ .../flaresolverr/README_CHANGELOG.md.gotmpl | 27 ++ charts/flaresolverr/README_CONFIG.md.gotmpl | 9 + charts/flood/.helmignore | 2 + charts/flood/README.md | 112 +++-- charts/flood/README.md.gotmpl | 143 +++++++ charts/flood/README_CHANGELOG.md.gotmpl | 27 ++ charts/flood/README_CONFIG.md.gotmpl | 9 + charts/freshrss/.helmignore | 4 +- charts/freshrss/README.md | 113 +++-- charts/freshrss/README.md.gotmpl | 143 +++++++ charts/freshrss/README_CHANGELOG.md.gotmpl | 27 ++ charts/freshrss/README_CONFIG.md.gotmpl | 9 + charts/gaps/.helmignore | 2 + charts/gaps/README.md | 114 +++-- charts/gaps/README.md.gotmpl | 143 +++++++ charts/gaps/README_CHANGELOG.md.gotmpl | 27 ++ charts/gaps/README_CONFIG.md.gotmpl | 9 + charts/gonic/.helmignore | 2 + charts/gonic/README.md | 120 ++++-- charts/gonic/README.md.gotmpl | 143 +++++++ charts/gonic/README_CHANGELOG.md.gotmpl | 27 ++ charts/gonic/README_CONFIG.md.gotmpl | 9 + charts/grocy/.helmignore | 4 +- charts/grocy/README.md | 111 +++-- charts/grocy/README.md.gotmpl | 143 +++++++ charts/grocy/README_CHANGELOG.md.gotmpl | 27 ++ charts/grocy/README_CONFIG.md.gotmpl | 9 + charts/heimdall/.helmignore | 4 +- charts/heimdall/README.md | 112 +++-- charts/heimdall/README.md.gotmpl | 143 +++++++ charts/heimdall/README_CHANGELOG.md.gotmpl | 27 ++ charts/heimdall/README_CONFIG.md.gotmpl | 9 + charts/home-assistant/.helmignore | 2 + charts/home-assistant/README.md | 207 ++++++--- charts/home-assistant/README.md.gotmpl | 143 +++++++ ...HANGELOG.md => README_CHANGELOG.md.gotmpl} | 9 +- charts/home-assistant/README_CONFIG.md.gotmpl | 55 +++ charts/homebridge/README.md | 155 +++---- charts/homer/.helmignore | 2 + charts/homer/README.md | 112 +++-- charts/homer/README.md.gotmpl | 143 +++++++ charts/homer/README_CHANGELOG.md.gotmpl | 27 ++ charts/homer/README_CONFIG.md.gotmpl | 9 + charts/hyperion-ng/.helmignore | 4 +- charts/hyperion-ng/README.md | 126 ++++-- charts/hyperion-ng/README.md.gotmpl | 143 +++++++ charts/hyperion-ng/README_CHANGELOG.md.gotmpl | 27 ++ charts/hyperion-ng/README_CONFIG.md.gotmpl | 9 + charts/icantbelieveitsnotvaletudo/README.md | 88 ++-- charts/intel-gpu-plugin/README.md | 94 ++--- charts/jackett/.helmignore | 3 + charts/jackett/README.md | 117 ++++-- charts/jackett/README.md.gotmpl | 143 +++++++ charts/jackett/README_CHANGELOG.md.gotmpl | 27 ++ charts/jackett/README_CONFIG.md.gotmpl | 9 + charts/jellyfin/.helmignore | 2 + charts/jellyfin/README.md | 117 ++++-- charts/jellyfin/README.md.gotmpl | 143 +++++++ charts/jellyfin/README_CHANGELOG.md.gotmpl | 27 ++ charts/jellyfin/README_CONFIG.md.gotmpl | 9 + charts/lazylibrarian/.helmignore | 5 +- charts/lazylibrarian/README.md | 118 ++++-- charts/lazylibrarian/README.md.gotmpl | 143 +++++++ .../lazylibrarian/README_CHANGELOG.md.gotmpl | 27 ++ charts/lazylibrarian/README_CONFIG.md.gotmpl | 9 + charts/librespeed/README.md | 134 +++--- charts/lidarr/.helmignore | 26 ++ charts/lidarr/README.md | 117 ++++-- charts/lidarr/README.md.gotmpl | 143 +++++++ charts/lidarr/README_CHANGELOG.md.gotmpl | 27 ++ charts/lidarr/README_CONFIG.md.gotmpl | 9 + charts/lychee/.helmignore | 5 +- charts/lychee/README.md | 120 ++++-- charts/lychee/README.md.gotmpl | 143 +++++++ charts/lychee/README_CHANGELOG.md.gotmpl | 27 ++ charts/lychee/README_CONFIG.md.gotmpl | 9 + charts/modem-stats/README.md | 89 ++-- charts/monica/.helmignore | 26 ++ charts/monica/README.md | 123 ++++-- charts/monica/README.md.gotmpl | 143 +++++++ charts/monica/README_CHANGELOG.md.gotmpl | 27 ++ charts/monica/README_CONFIG.md.gotmpl | 9 + charts/mosquitto/README.md | 91 ++-- charts/navidrome/.helmignore | 4 +- charts/navidrome/README.md | 123 ++++-- charts/navidrome/README.md.gotmpl | 143 +++++++ charts/navidrome/README_CHANGELOG.md.gotmpl | 27 ++ charts/navidrome/README_CONFIG.md.gotmpl | 9 + charts/neolink/.helmignore | 5 +- charts/neolink/README.md | 104 ++++- charts/neolink/README.md.gotmpl | 143 +++++++ charts/neolink/README_CHANGELOG.md.gotmpl | 27 ++ charts/neolink/README_CONFIG.md.gotmpl | 9 + charts/network-ups-tools/.helmignore | 4 +- charts/network-ups-tools/README.md | 114 +++-- charts/network-ups-tools/README.md.gotmpl | 143 +++++++ .../README_CHANGELOG.md.gotmpl | 27 ++ .../network-ups-tools/README_CONFIG.md.gotmpl | 9 + charts/node-feature-discovery/README.md | 115 +++-- charts/node-red/.helmignore | 2 + charts/node-red/README.md | 116 ++++-- charts/node-red/README.md.gotmpl | 143 +++++++ charts/node-red/README_CHANGELOG.md.gotmpl | 27 ++ charts/node-red/README_CONFIG.md.gotmpl | 9 + charts/nzbget/.helmignore | 3 + charts/nzbget/README.md | 138 +++--- charts/nzbget/README.md.gotmpl | 143 +++++++ charts/nzbget/README_CHANGELOG.md.gotmpl | 27 ++ charts/nzbget/README_CONFIG.md.gotmpl | 12 + charts/nzbhydra2/.helmignore | 3 + charts/nzbhydra2/README.md | 138 ++++-- charts/nzbhydra2/README.md.gotmpl | 143 +++++++ charts/nzbhydra2/README_CHANGELOG.md.gotmpl | 27 ++ charts/nzbhydra2/README_CONFIG.md.gotmpl | 9 + charts/oauth2-proxy/README.md | 232 +++-------- charts/octoprint/.helmignore | 26 ++ charts/octoprint/README.md | 119 ++++-- charts/octoprint/README.md.gotmpl | 143 +++++++ charts/octoprint/README_CHANGELOG.md.gotmpl | 27 ++ charts/octoprint/README_CONFIG.md.gotmpl | 9 + charts/omada-controller/.helmignore | 26 ++ charts/omada-controller/README.md | 112 +++-- charts/omada-controller/README.md.gotmpl | 143 +++++++ .../README_CHANGELOG.md.gotmpl | 27 ++ .../omada-controller/README_CONFIG.md.gotmpl | 9 + charts/ombi/.helmignore | 3 + charts/ombi/README.md | 114 +++-- charts/ombi/README.md.gotmpl | 143 +++++++ charts/ombi/README_CHANGELOG.md.gotmpl | 27 ++ charts/ombi/README_CONFIG.md.gotmpl | 9 + charts/organizr/.helmignore | 3 + charts/organizr/README.md | 114 +++-- charts/organizr/README.md.gotmpl | 143 +++++++ charts/organizr/README_CHANGELOG.md.gotmpl | 27 ++ charts/organizr/README_CONFIG.md.gotmpl | 9 + charts/overseerr/.helmignore | 2 + charts/overseerr/README.md | 114 +++-- charts/overseerr/README.md.gotmpl | 143 +++++++ charts/overseerr/README_CHANGELOG.md.gotmpl | 27 ++ charts/overseerr/README_CONFIG.md.gotmpl | 9 + charts/paperless/.helmignore | 2 + charts/paperless/README.md | 122 ++++-- charts/paperless/README.md.gotmpl | 143 +++++++ charts/paperless/README_CHANGELOG.md.gotmpl | 27 ++ charts/paperless/README_CONFIG.md.gotmpl | 9 + charts/photoprism/.helmignore | 26 ++ charts/photoprism/README.md | 118 ++++-- charts/photoprism/README.md.gotmpl | 143 +++++++ charts/photoprism/README_CHANGELOG.md.gotmpl | 27 ++ charts/photoprism/README_CONFIG.md.gotmpl | 9 + charts/piaware/.helmignore | 2 + charts/piaware/README.md | 132 +++--- charts/piaware/README.md.gotmpl | 143 +++++++ charts/piaware/README_CHANGELOG.md.gotmpl | 27 ++ charts/piaware/README_CONFIG.md.gotmpl | 38 ++ charts/plex-media-server/.helmignore | 2 + charts/plex-media-server/README.md | 117 +++++- charts/plex-media-server/README.md.gotmpl | 143 +++++++ .../README_CHANGELOG.md.gotmpl | 27 ++ .../plex-media-server/README_CONFIG.md.gotmpl | 13 + charts/plex/README.md | 153 +++++-- charts/powerdns/README.md | 84 ++++ charts/prometheus-nut-exporter/README.md | 83 ++-- charts/protonmail-bridge/.helmignore | 26 ++ charts/protonmail-bridge/README.md | 125 ++++-- charts/protonmail-bridge/README.md.gotmpl | 143 +++++++ .../README_CHANGELOG.md.gotmpl | 27 ++ .../protonmail-bridge/README_CONFIG.md.gotmpl | 17 + charts/pyload/.helmignore | 4 +- charts/pyload/README.md | 113 +++-- charts/pyload/README.md.gotmpl | 143 +++++++ charts/pyload/README_CHANGELOG.md.gotmpl | 27 ++ charts/pyload/README_CONFIG.md.gotmpl | 9 + charts/qbittorrent/.helmignore | 3 + charts/qbittorrent/README.md | 139 +++++-- charts/qbittorrent/README.md.gotmpl | 143 +++++++ charts/qbittorrent/README_CHANGELOG.md.gotmpl | 27 ++ charts/qbittorrent/README_CONFIG.md.gotmpl | 9 + charts/radarr/.helmignore | 3 + charts/radarr/README.md | 117 ++++-- charts/radarr/README.md.gotmpl | 143 +++++++ charts/radarr/README_CHANGELOG.md.gotmpl | 27 ++ charts/radarr/README_CONFIG.md.gotmpl | 9 + charts/readarr/.helmignore | 4 +- charts/readarr/README.md | 113 +++-- charts/readarr/README.md.gotmpl | 143 +++++++ charts/readarr/README_CHANGELOG.md.gotmpl | 27 ++ charts/readarr/README_CONFIG.md.gotmpl | 11 + charts/recipes/.helmignore | 5 +- charts/recipes/README.md | 159 ++++--- charts/recipes/README.md.gotmpl | 143 +++++++ charts/recipes/README_CHANGELOG.md.gotmpl | 27 ++ charts/recipes/README_CONFIG.md.gotmpl | 9 + charts/resilio-sync/.helmignore | 2 + charts/resilio-sync/README.md | 142 +++++-- charts/resilio-sync/README.md.gotmpl | 143 +++++++ .../resilio-sync/README_CHANGELOG.md.gotmpl | 27 ++ charts/resilio-sync/README_CONFIG.md.gotmpl | 9 + charts/rtorrent-flood/README.md | 81 +++- charts/sabnzbd/.helmignore | 3 + charts/sabnzbd/README.md | 138 +++--- charts/sabnzbd/README.md.gotmpl | 143 +++++++ charts/sabnzbd/README_CHANGELOG.md.gotmpl | 27 ++ charts/sabnzbd/README_CONFIG.md.gotmpl | 15 + charts/samba/.helmignore | 4 +- charts/samba/README.md | 117 ++++-- charts/samba/README.md.gotmpl | 143 +++++++ charts/samba/README_CHANGELOG.md.gotmpl | 27 ++ charts/samba/README_CONFIG.md.gotmpl | 9 + charts/searx/.helmignore | 4 +- charts/searx/README.md | 173 ++++++-- charts/searx/README.md.gotmpl | 143 +++++++ charts/searx/README_CHANGELOG.md.gotmpl | 27 ++ charts/searx/README_CONFIG.md.gotmpl | 9 + charts/ser2sock/README.md | 112 ++--- charts/smarter-device-manager/.helmignore | 2 + charts/smarter-device-manager/README.md | 140 ++++--- .../smarter-device-manager/README.md.gotmpl | 143 +++++++ .../README_CHANGELOG.md.gotmpl | 27 ++ .../README_CONFIG.md.gotmpl | 50 +++ charts/sonarr/.helmignore | 26 ++ charts/sonarr/README.md | 117 ++++-- charts/sonarr/README.md.gotmpl | 143 +++++++ charts/sonarr/README_CHANGELOG.md.gotmpl | 27 ++ charts/sonarr/README_CONFIG.md.gotmpl | 9 + charts/speedtest-prometheus/README.md | 77 ++-- charts/speedtest/README.md | 92 ++-- charts/statping/README.md | 126 ++++-- charts/tautulli/.helmignore | 3 + charts/tautulli/README.md | 114 +++-- charts/tautulli/README.md.gotmpl | 143 +++++++ charts/tautulli/README_CHANGELOG.md.gotmpl | 27 ++ charts/tautulli/README_CONFIG.md.gotmpl | 9 + charts/teedy/.helmignore | 2 + charts/teedy/README.md | 119 ++++-- charts/teedy/README.md.gotmpl | 143 +++++++ charts/teedy/README_CHANGELOG.md.gotmpl | 27 ++ charts/teedy/README_CONFIG.md.gotmpl | 9 + charts/teslamate/README.md | 101 +++-- charts/traccar/.helmignore | 2 + charts/traccar/README.md | 123 ++++-- charts/traccar/README.md.gotmpl | 143 +++++++ charts/traccar/README_CHANGELOG.md.gotmpl | 27 ++ charts/traccar/README_CONFIG.md.gotmpl | 9 + charts/traefik-forward-auth/README.md | 53 +-- charts/tvheadend/.helmignore | 5 +- charts/tvheadend/README.md | 107 ++++- charts/tvheadend/README.md.gotmpl | 143 +++++++ charts/tvheadend/README_CHANGELOG.md.gotmpl | 27 ++ charts/tvheadend/README_CONFIG.md.gotmpl | 9 + charts/unifi-poller/.helmignore | 2 + charts/unifi-poller/README.md | 119 ++++-- charts/unifi-poller/README.md.gotmpl | 143 +++++++ .../unifi-poller/README_CHANGELOG.md.gotmpl | 27 ++ charts/unifi-poller/README_CONFIG.md.gotmpl | 9 + charts/unifi/README.md | 336 ++++++--------- charts/unpackerr/.helmignore | 2 + charts/unpackerr/README.md | 117 ++++-- charts/unpackerr/README.md.gotmpl | 143 +++++++ charts/unpackerr/README_CHANGELOG.md.gotmpl | 27 ++ charts/unpackerr/README_CONFIG.md.gotmpl | 9 + charts/uptimerobot-prometheus/README.md | 78 ++-- charts/uptimerobot/README.md | 92 ++-- charts/xbackbone/.helmignore | 2 + charts/xbackbone/README.md | 114 +++-- charts/xbackbone/README.md.gotmpl | 143 +++++++ charts/xbackbone/README_CHANGELOG.md.gotmpl | 27 ++ charts/xbackbone/README_CONFIG.md.gotmpl | 9 + charts/xteve/.helmignore | 2 + charts/xteve/README.md | 112 +++-- charts/xteve/README.md.gotmpl | 143 +++++++ charts/xteve/README_CHANGELOG.md.gotmpl | 27 ++ charts/xteve/README_CONFIG.md.gotmpl | 9 + charts/zigbee2mqtt/.helmignore | 2 + charts/zigbee2mqtt/README.md | 161 ++++--- charts/zigbee2mqtt/README.md.gotmpl | 143 +++++++ charts/zigbee2mqtt/README_CHANGELOG.md.gotmpl | 27 ++ charts/zigbee2mqtt/README_CONFIG.md.gotmpl | 38 ++ charts/zwave2mqtt/.helmignore | 2 + charts/zwave2mqtt/README.md | 135 +++--- charts/zwave2mqtt/README.md.gotmpl | 143 +++++++ charts/zwave2mqtt/README_CHANGELOG.md.gotmpl | 27 ++ charts/zwave2mqtt/README_CONFIG.md.gotmpl | 38 ++ charts/zwavejs2mqtt/.helmignore | 2 + charts/zwavejs2mqtt/README.md | 134 ++++-- charts/zwavejs2mqtt/README.md.gotmpl | 143 +++++++ .../zwavejs2mqtt/README_CHANGELOG.md.gotmpl | 27 ++ charts/zwavejs2mqtt/README_CONFIG.md.gotmpl | 38 ++ hack/gen-helm-docs.sh | 35 ++ hack/gen-helmdocsignore.sh | 16 + hack/gen-helmignore.sh | 21 + hack/templates/.helmignore | 26 ++ hack/templates/README.md.gotmpl | 143 +++++++ hack/templates/README_CHANGELOG.md.gotmpl | 27 ++ hack/templates/README_CONFIG.md.gotmpl | 9 + templates/chart/.helmignore | 26 ++ templates/chart/README.md | 110 +++-- templates/chart/README.md.gotmpl | 143 +++++++ templates/chart/README_CHANGELOG.md.gotmpl | 27 ++ templates/chart/README_CONFIG.md.gotmpl | 9 + 370 files changed, 20542 insertions(+), 4385 deletions(-) create mode 100644 .helmdocsignore create mode 100644 CODE_OF_CONDUCT.md delete mode 100644 charts/README.templates.md.gotmpl create mode 100644 charts/alertmanager-bot/README.md.gotmpl create mode 100644 charts/alertmanager-bot/README_CHANGELOG.md.gotmpl create mode 100644 charts/alertmanager-bot/README_CONFIG.md.gotmpl create mode 100644 charts/appdaemon/README.md.gotmpl create mode 100644 charts/appdaemon/README_CHANGELOG.md.gotmpl create mode 100644 charts/appdaemon/README_CONFIG.md.gotmpl create mode 100644 charts/bazarr/README.md.gotmpl create mode 100644 charts/bazarr/README_CHANGELOG.md.gotmpl create mode 100644 charts/bazarr/README_CONFIG.md.gotmpl create mode 100644 charts/booksonic-air/.helmignore create mode 100644 charts/booksonic-air/README.md.gotmpl create mode 100644 charts/booksonic-air/README_CHANGELOG.md.gotmpl create mode 100644 charts/booksonic-air/README_CONFIG.md.gotmpl create mode 100644 charts/calibre-web/README.md.gotmpl create mode 100644 charts/calibre-web/README_CHANGELOG.md.gotmpl create mode 100644 charts/calibre-web/README_CONFIG.md.gotmpl create mode 100644 charts/common-test/.helmignore create mode 100644 charts/common-test/README.md create mode 100644 charts/common/README.md.gotmpl rename charts/common/{CHANGELOG.md => README_CHANGELOG.md.gotmpl} (74%) create mode 100644 charts/common/README_CONFIG.md.gotmpl create mode 100644 charts/ddclient/README.md.gotmpl create mode 100644 charts/ddclient/README_CHANGELOG.md.gotmpl create mode 100644 charts/ddclient/README_CONFIG.md.gotmpl create mode 100644 charts/deluge/README.md.gotmpl create mode 100644 charts/deluge/README_CHANGELOG.md.gotmpl create mode 100644 charts/deluge/README_CONFIG.md.gotmpl create mode 100644 charts/dsmr-reader/README.md.gotmpl create mode 100644 charts/dsmr-reader/README_CHANGELOG.md.gotmpl create mode 100644 charts/dsmr-reader/README_CONFIG.md.gotmpl create mode 100644 charts/esphome/README.md.gotmpl create mode 100644 charts/esphome/README_CHANGELOG.md.gotmpl create mode 100644 charts/esphome/README_CONFIG.md.gotmpl create mode 100644 charts/flaresolverr/README.md.gotmpl create mode 100644 charts/flaresolverr/README_CHANGELOG.md.gotmpl create mode 100644 charts/flaresolverr/README_CONFIG.md.gotmpl create mode 100644 charts/flood/README.md.gotmpl create mode 100644 charts/flood/README_CHANGELOG.md.gotmpl create mode 100644 charts/flood/README_CONFIG.md.gotmpl create mode 100644 charts/freshrss/README.md.gotmpl create mode 100644 charts/freshrss/README_CHANGELOG.md.gotmpl create mode 100644 charts/freshrss/README_CONFIG.md.gotmpl create mode 100644 charts/gaps/README.md.gotmpl create mode 100644 charts/gaps/README_CHANGELOG.md.gotmpl create mode 100644 charts/gaps/README_CONFIG.md.gotmpl create mode 100644 charts/gonic/README.md.gotmpl create mode 100644 charts/gonic/README_CHANGELOG.md.gotmpl create mode 100644 charts/gonic/README_CONFIG.md.gotmpl create mode 100644 charts/grocy/README.md.gotmpl create mode 100644 charts/grocy/README_CHANGELOG.md.gotmpl create mode 100644 charts/grocy/README_CONFIG.md.gotmpl create mode 100644 charts/heimdall/README.md.gotmpl create mode 100644 charts/heimdall/README_CHANGELOG.md.gotmpl create mode 100644 charts/heimdall/README_CONFIG.md.gotmpl create mode 100644 charts/home-assistant/README.md.gotmpl rename charts/home-assistant/{CHANGELOG.md => README_CHANGELOG.md.gotmpl} (94%) create mode 100644 charts/home-assistant/README_CONFIG.md.gotmpl create mode 100644 charts/homer/README.md.gotmpl create mode 100644 charts/homer/README_CHANGELOG.md.gotmpl create mode 100644 charts/homer/README_CONFIG.md.gotmpl create mode 100644 charts/hyperion-ng/README.md.gotmpl create mode 100644 charts/hyperion-ng/README_CHANGELOG.md.gotmpl create mode 100644 charts/hyperion-ng/README_CONFIG.md.gotmpl create mode 100644 charts/jackett/README.md.gotmpl create mode 100644 charts/jackett/README_CHANGELOG.md.gotmpl create mode 100644 charts/jackett/README_CONFIG.md.gotmpl create mode 100644 charts/jellyfin/README.md.gotmpl create mode 100644 charts/jellyfin/README_CHANGELOG.md.gotmpl create mode 100644 charts/jellyfin/README_CONFIG.md.gotmpl create mode 100644 charts/lazylibrarian/README.md.gotmpl create mode 100644 charts/lazylibrarian/README_CHANGELOG.md.gotmpl create mode 100644 charts/lazylibrarian/README_CONFIG.md.gotmpl create mode 100644 charts/lidarr/.helmignore create mode 100644 charts/lidarr/README.md.gotmpl create mode 100644 charts/lidarr/README_CHANGELOG.md.gotmpl create mode 100644 charts/lidarr/README_CONFIG.md.gotmpl create mode 100644 charts/lychee/README.md.gotmpl create mode 100644 charts/lychee/README_CHANGELOG.md.gotmpl create mode 100644 charts/lychee/README_CONFIG.md.gotmpl create mode 100644 charts/monica/.helmignore create mode 100644 charts/monica/README.md.gotmpl create mode 100644 charts/monica/README_CHANGELOG.md.gotmpl create mode 100644 charts/monica/README_CONFIG.md.gotmpl create mode 100644 charts/navidrome/README.md.gotmpl create mode 100644 charts/navidrome/README_CHANGELOG.md.gotmpl create mode 100644 charts/navidrome/README_CONFIG.md.gotmpl create mode 100644 charts/neolink/README.md.gotmpl create mode 100644 charts/neolink/README_CHANGELOG.md.gotmpl create mode 100644 charts/neolink/README_CONFIG.md.gotmpl create mode 100644 charts/network-ups-tools/README.md.gotmpl create mode 100644 charts/network-ups-tools/README_CHANGELOG.md.gotmpl create mode 100644 charts/network-ups-tools/README_CONFIG.md.gotmpl create mode 100644 charts/node-red/README.md.gotmpl create mode 100644 charts/node-red/README_CHANGELOG.md.gotmpl create mode 100644 charts/node-red/README_CONFIG.md.gotmpl create mode 100644 charts/nzbget/README.md.gotmpl create mode 100644 charts/nzbget/README_CHANGELOG.md.gotmpl create mode 100644 charts/nzbget/README_CONFIG.md.gotmpl create mode 100644 charts/nzbhydra2/README.md.gotmpl create mode 100644 charts/nzbhydra2/README_CHANGELOG.md.gotmpl create mode 100644 charts/nzbhydra2/README_CONFIG.md.gotmpl create mode 100644 charts/octoprint/.helmignore create mode 100644 charts/octoprint/README.md.gotmpl create mode 100644 charts/octoprint/README_CHANGELOG.md.gotmpl create mode 100644 charts/octoprint/README_CONFIG.md.gotmpl create mode 100644 charts/omada-controller/.helmignore create mode 100644 charts/omada-controller/README.md.gotmpl create mode 100644 charts/omada-controller/README_CHANGELOG.md.gotmpl create mode 100644 charts/omada-controller/README_CONFIG.md.gotmpl create mode 100644 charts/ombi/README.md.gotmpl create mode 100644 charts/ombi/README_CHANGELOG.md.gotmpl create mode 100644 charts/ombi/README_CONFIG.md.gotmpl create mode 100644 charts/organizr/README.md.gotmpl create mode 100644 charts/organizr/README_CHANGELOG.md.gotmpl create mode 100644 charts/organizr/README_CONFIG.md.gotmpl create mode 100644 charts/overseerr/README.md.gotmpl create mode 100644 charts/overseerr/README_CHANGELOG.md.gotmpl create mode 100644 charts/overseerr/README_CONFIG.md.gotmpl create mode 100644 charts/paperless/README.md.gotmpl create mode 100644 charts/paperless/README_CHANGELOG.md.gotmpl create mode 100644 charts/paperless/README_CONFIG.md.gotmpl create mode 100644 charts/photoprism/.helmignore create mode 100644 charts/photoprism/README.md.gotmpl create mode 100644 charts/photoprism/README_CHANGELOG.md.gotmpl create mode 100644 charts/photoprism/README_CONFIG.md.gotmpl create mode 100644 charts/piaware/README.md.gotmpl create mode 100644 charts/piaware/README_CHANGELOG.md.gotmpl create mode 100644 charts/piaware/README_CONFIG.md.gotmpl create mode 100644 charts/plex-media-server/README.md.gotmpl create mode 100644 charts/plex-media-server/README_CHANGELOG.md.gotmpl create mode 100644 charts/plex-media-server/README_CONFIG.md.gotmpl create mode 100644 charts/powerdns/README.md create mode 100644 charts/protonmail-bridge/.helmignore create mode 100644 charts/protonmail-bridge/README.md.gotmpl create mode 100644 charts/protonmail-bridge/README_CHANGELOG.md.gotmpl create mode 100644 charts/protonmail-bridge/README_CONFIG.md.gotmpl create mode 100644 charts/pyload/README.md.gotmpl create mode 100644 charts/pyload/README_CHANGELOG.md.gotmpl create mode 100644 charts/pyload/README_CONFIG.md.gotmpl create mode 100644 charts/qbittorrent/README.md.gotmpl create mode 100644 charts/qbittorrent/README_CHANGELOG.md.gotmpl create mode 100644 charts/qbittorrent/README_CONFIG.md.gotmpl create mode 100644 charts/radarr/README.md.gotmpl create mode 100644 charts/radarr/README_CHANGELOG.md.gotmpl create mode 100644 charts/radarr/README_CONFIG.md.gotmpl create mode 100644 charts/readarr/README.md.gotmpl create mode 100644 charts/readarr/README_CHANGELOG.md.gotmpl create mode 100644 charts/readarr/README_CONFIG.md.gotmpl create mode 100644 charts/recipes/README.md.gotmpl create mode 100644 charts/recipes/README_CHANGELOG.md.gotmpl create mode 100644 charts/recipes/README_CONFIG.md.gotmpl create mode 100644 charts/resilio-sync/README.md.gotmpl create mode 100644 charts/resilio-sync/README_CHANGELOG.md.gotmpl create mode 100644 charts/resilio-sync/README_CONFIG.md.gotmpl create mode 100644 charts/sabnzbd/README.md.gotmpl create mode 100644 charts/sabnzbd/README_CHANGELOG.md.gotmpl create mode 100644 charts/sabnzbd/README_CONFIG.md.gotmpl create mode 100644 charts/samba/README.md.gotmpl create mode 100644 charts/samba/README_CHANGELOG.md.gotmpl create mode 100644 charts/samba/README_CONFIG.md.gotmpl create mode 100644 charts/searx/README.md.gotmpl create mode 100644 charts/searx/README_CHANGELOG.md.gotmpl create mode 100644 charts/searx/README_CONFIG.md.gotmpl create mode 100644 charts/smarter-device-manager/README.md.gotmpl create mode 100644 charts/smarter-device-manager/README_CHANGELOG.md.gotmpl create mode 100644 charts/smarter-device-manager/README_CONFIG.md.gotmpl create mode 100644 charts/sonarr/.helmignore create mode 100644 charts/sonarr/README.md.gotmpl create mode 100644 charts/sonarr/README_CHANGELOG.md.gotmpl create mode 100644 charts/sonarr/README_CONFIG.md.gotmpl create mode 100644 charts/tautulli/README.md.gotmpl create mode 100644 charts/tautulli/README_CHANGELOG.md.gotmpl create mode 100644 charts/tautulli/README_CONFIG.md.gotmpl create mode 100644 charts/teedy/README.md.gotmpl create mode 100644 charts/teedy/README_CHANGELOG.md.gotmpl create mode 100644 charts/teedy/README_CONFIG.md.gotmpl create mode 100644 charts/traccar/README.md.gotmpl create mode 100644 charts/traccar/README_CHANGELOG.md.gotmpl create mode 100644 charts/traccar/README_CONFIG.md.gotmpl create mode 100644 charts/tvheadend/README.md.gotmpl create mode 100644 charts/tvheadend/README_CHANGELOG.md.gotmpl create mode 100644 charts/tvheadend/README_CONFIG.md.gotmpl create mode 100644 charts/unifi-poller/README.md.gotmpl create mode 100644 charts/unifi-poller/README_CHANGELOG.md.gotmpl create mode 100644 charts/unifi-poller/README_CONFIG.md.gotmpl create mode 100644 charts/unpackerr/README.md.gotmpl create mode 100644 charts/unpackerr/README_CHANGELOG.md.gotmpl create mode 100644 charts/unpackerr/README_CONFIG.md.gotmpl create mode 100644 charts/xbackbone/README.md.gotmpl create mode 100644 charts/xbackbone/README_CHANGELOG.md.gotmpl create mode 100644 charts/xbackbone/README_CONFIG.md.gotmpl create mode 100644 charts/xteve/README.md.gotmpl create mode 100644 charts/xteve/README_CHANGELOG.md.gotmpl create mode 100644 charts/xteve/README_CONFIG.md.gotmpl create mode 100644 charts/zigbee2mqtt/README.md.gotmpl create mode 100644 charts/zigbee2mqtt/README_CHANGELOG.md.gotmpl create mode 100644 charts/zigbee2mqtt/README_CONFIG.md.gotmpl create mode 100644 charts/zwave2mqtt/README.md.gotmpl create mode 100644 charts/zwave2mqtt/README_CHANGELOG.md.gotmpl create mode 100644 charts/zwave2mqtt/README_CONFIG.md.gotmpl create mode 100644 charts/zwavejs2mqtt/README.md.gotmpl create mode 100644 charts/zwavejs2mqtt/README_CHANGELOG.md.gotmpl create mode 100644 charts/zwavejs2mqtt/README_CONFIG.md.gotmpl create mode 100755 hack/gen-helm-docs.sh create mode 100755 hack/gen-helmdocsignore.sh create mode 100755 hack/gen-helmignore.sh create mode 100644 hack/templates/.helmignore create mode 100644 hack/templates/README.md.gotmpl create mode 100644 hack/templates/README_CHANGELOG.md.gotmpl create mode 100644 hack/templates/README_CONFIG.md.gotmpl create mode 100644 templates/chart/.helmignore create mode 100644 templates/chart/README.md.gotmpl create mode 100644 templates/chart/README_CHANGELOG.md.gotmpl create mode 100644 templates/chart/README_CONFIG.md.gotmpl diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7c15d444..4414b93b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -34,7 +34,7 @@ Also don't be worried if the request is closed or not integrated sometimes our p **Checklist** - [ ] Chart version bumped in `Chart.yaml` according to [semver](http://semver.org/). - [ ] Title of the PR starts with chart name (e.g. `[home-assistant]`) -- [ ] Chart is using our [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library as a dependency. +- [ ] (optional) Chart is using our [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library as a dependency. - [ ] (optional) Variables are documented in the README.md diff --git a/.github/ct.yaml b/.github/ct.yaml index 284f9074..367c4cb3 100644 --- a/.github/ct.yaml +++ b/.github/ct.yaml @@ -2,10 +2,10 @@ remote: origin target-branch: master helm-extra-args: --timeout 600s chart-dirs: - - charts +- charts excluded-charts: - - common - - common-test +- common +- common-test chart-repos: - - bitnami=https://charts.bitnami.com/bitnami - - k8s-at-home=https://k8s-at-home.com/charts +- bitnami=https://charts.bitnami.com/bitnami +- k8s-at-home=https://k8s-at-home.com/charts diff --git a/.github/stale.yml b/.github/stale.yml index 9e001538..616be956 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -8,8 +8,8 @@ daysUntilClose: 5 # Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable exemptLabels: - - on-hold - - pinned +- on-hold +- pinned # Label to use when marking as stale staleLabel: stale diff --git a/.github/workflows/charts-lint-test.yaml b/.github/workflows/charts-lint-test.yaml index de158314..0a3e1c05 100644 --- a/.github/workflows/charts-lint-test.yaml +++ b/.github/workflows/charts-lint-test.yaml @@ -4,7 +4,10 @@ on: pull_request: paths: - 'charts/**' + - '!charts/**/CHANGELOG.md.gotmpl' + - '!charts/**/CUSTOM_CONFIG.md.gotmpl' - '!charts/**/README.md' + - '!charts/**/README.md.gotmpl' jobs: lint: @@ -13,102 +16,102 @@ jobs: changed: ${{ steps.list-changed.outputs.changed }} common: ${{ steps.list-changed.outputs.common }} steps: - - name: Checkout - uses: actions/checkout@v2 - with: - fetch-depth: 0 + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 - - name: Install Helm - uses: azure/setup-helm@v1 - with: - version: v3.4.0 + - name: Install Helm + uses: azure/setup-helm@v1 + with: + version: v3.4.0 - - uses: actions/setup-python@v2 - with: - python-version: 3.7 + - uses: actions/setup-python@v2 + with: + python-version: 3.7 - - name: Set up chart-testing - uses: helm/chart-testing-action@v2.0.1 + - name: Set up chart-testing + uses: helm/chart-testing-action@v2.0.1 - - name: Run chart-testing (list-changed) - id: list-changed - run: | - changed=$(ct list-changed --config .github/ct.yaml) - if [[ -n "$changed" ]]; then - echo "::set-output name=changed::true" - fi + - name: Run chart-testing (list-changed) + id: list-changed + run: | + changed=$(ct list-changed --config .github/ct.yaml) + if [[ -n "$changed" ]]; then + echo "::set-output name=changed::true" + fi - changed_unfiltered=$(ct list-changed --config .github/ct.yaml --excluded-charts "") - if [[ $(grep -E "^charts/common(-test)?$" <<< "$changed_unfiltered") ]]; then - echo "::set-output name=common::true" - fi + changed_unfiltered=$(ct list-changed --config .github/ct.yaml --excluded-charts "") + if [[ $(grep -E "^charts/common(-test)?$" <<< "$changed_unfiltered") ]]; then + echo "::set-output name=common::true" + fi - - name: Run chart-testing (lint) - id: lint - run: ct lint --config .github/ct.yaml --excluded-charts "" - if: steps.list-changed.outputs.changed == 'true' || steps.list-changed.outputs.common == 'true' + - name: Run chart-testing (lint) + id: lint + run: ct lint --config .github/ct.yaml --excluded-charts "" + if: steps.list-changed.outputs.changed == 'true' || steps.list-changed.outputs.common == 'true' unittest: runs-on: ubuntu-latest needs: lint steps: - - name: Checkout - uses: actions/checkout@v2 - with: - fetch-depth: 0 + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 - - name: Install Dev tools - run: sudo apt-get update && sudo apt-get install -y jq libjq-dev + - name: Install Dev tools + run: sudo apt-get update && sudo apt-get install -y jq libjq-dev - - name: Install Helm - uses: azure/setup-helm@v1 - with: - version: v3.4.0 + - name: Install Helm + uses: azure/setup-helm@v1 + with: + version: v3.4.0 - - name: Install Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: 2.7 + - name: Install Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.7 - - name: Install dependencies - run: | - export RUBYJQ_USE_SYSTEM_LIBRARIES=1 - bundle install + - name: Install dependencies + run: | + export RUBYJQ_USE_SYSTEM_LIBRARIES=1 + bundle install - - name: Run tests - run: | - bundle exec m -r test/charts + - name: Run tests + run: | + bundle exec m -r test/charts install: runs-on: ubuntu-latest needs: lint steps: - - name: Checkout - uses: actions/checkout@v2 - with: - fetch-depth: 0 + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 - - name: Install Helm - uses: azure/setup-helm@v1 - with: - version: v3.4.0 + - name: Install Helm + uses: azure/setup-helm@v1 + with: + version: v3.4.0 - - uses: actions/setup-python@v2 - with: - python-version: 3.7 + - uses: actions/setup-python@v2 + with: + python-version: 3.7 - - name: Set up chart-testing - uses: helm/chart-testing-action@v2.0.1 + - name: Set up chart-testing + uses: helm/chart-testing-action@v2.0.1 - - name: Create kind cluster - uses: helm/kind-action@v1.1.0 - if: needs.lint.outputs.changed == 'true' || needs.lint.outputs.common == 'true' + - name: Create kind cluster + uses: helm/kind-action@v1.1.0 + if: needs.lint.outputs.changed == 'true' || needs.lint.outputs.common == 'true' - - name: Run chart-testing (install) - run: ct install --config .github/ct.yaml --excluded-charts "" - if: needs.lint.outputs.changed == 'true' + - name: Run chart-testing (install) + run: ct install --config .github/ct.yaml --excluded-charts "" + if: needs.lint.outputs.changed == 'true' - - name: Run chart-testing (common-test) - run: | - ct install --config .github/ct.yaml --charts 'charts/common-test' - if: needs.lint.outputs.common == 'true' + - name: Run chart-testing (common-test) + run: | + ct install --config .github/ct.yaml --charts 'charts/common-test' + if: needs.lint.outputs.common == 'true' diff --git a/.github/workflows/charts-release.yaml b/.github/workflows/charts-release.yaml index 74c70169..a73cdbb0 100644 --- a/.github/workflows/charts-release.yaml +++ b/.github/workflows/charts-release.yaml @@ -3,54 +3,57 @@ name: "Charts: Release" on: push: branches: - - master + - master paths: - - 'charts/**' - - '!charts/**/README.md' + - 'charts/**' + - '!charts/**/CHANGELOG.md.gotmpl' + - '!charts/**/CUSTOM_CONFIG.md.gotmpl' + - '!charts/**/README.md' + - '!charts/**/README.md.gotmpl' jobs: pre-release: runs-on: ubuntu-latest timeout-minutes: 5 steps: - - name: Block concurrent jobs - uses: softprops/turnstyle@v1 - with: - continue-after-seconds: 180 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Block concurrent jobs + uses: softprops/turnstyle@v1 + with: + continue-after-seconds: 180 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} release: needs: pre-release runs-on: ubuntu-latest steps: - - name: Block concurrent jobs - uses: softprops/turnstyle@v1 - with: - continue-after-seconds: 180 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Block concurrent jobs + uses: softprops/turnstyle@v1 + with: + continue-after-seconds: 180 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Checkout - uses: actions/checkout@v2 - with: - fetch-depth: 0 + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 - - name: Configure Git - run: | - git config user.name "$GITHUB_ACTOR" - git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" - - name: Install Helm - uses: azure/setup-helm@v1 - with: - version: v3.4.0 - - # Waiting on new version to be released that supports updating the genereated timestamp field - # https://github.com/helm/chart-releaser/issues/103 - - name: Run chart-releaser - uses: helm/chart-releaser-action@v1.1.0 - with: - charts_repo_url: https://k8s-at-home.com/charts/ - env: - CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" + - name: Install Helm + uses: azure/setup-helm@v1 + with: + version: v3.4.0 + + # Waiting on new version to be released that supports updating the genereated timestamp field + # https://github.com/helm/chart-releaser/issues/103 + - name: Run chart-releaser + uses: helm/chart-releaser-action@v1.1.0 + with: + charts_repo_url: https://k8s-at-home.com/charts/ + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.helmdocsignore b/.helmdocsignore new file mode 100644 index 00000000..fd7adb42 --- /dev/null +++ b/.helmdocsignore @@ -0,0 +1,29 @@ +charts/adguard-home +charts/bitwardenrs +charts/blocky +charts/comcast +charts/deconz +charts/digitalocean-dyndns +charts/duplicati +charts/homebridge +charts/icantbelieveitsnotvaletudo +charts/intel-gpu-plugin +charts/librespeed +charts/modem-stats +charts/mosquitto +charts/node-feature-discovery +charts/oauth2-proxy +charts/plex +charts/powerdns +charts/prometheus-nut-exporter +charts/rtorrent-flood +charts/ser2sock +charts/speedtest-prometheus +charts/speedtest +charts/statping +charts/teslamate +charts/traefik-forward-auth +charts/unifi +charts/uptimerobot-prometheus +charts/uptimerobot +charts/common-test diff --git a/.taskfiles/Taskfile_chart.yml b/.taskfiles/Taskfile_chart.yml index 80dd632f..b19d497e 100644 --- a/.taskfiles/Taskfile_chart.yml +++ b/.taskfiles/Taskfile_chart.yml @@ -17,7 +17,6 @@ tasks: - check-chart silent: true - dependency: cmds: - test -d {{.GIT_ROOT}}/charts/{{.CHART}}/Chart.lock && rm {{.GIT_ROOT}}/charts/{{.CHART}}/Chart.lock || exit 0 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..b8a3c883 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/charts/README.templates.md.gotmpl b/charts/README.templates.md.gotmpl deleted file mode 100644 index 70832077..00000000 --- a/charts/README.templates.md.gotmpl +++ /dev/null @@ -1,72 +0,0 @@ -{{- define "repository.organization" -}} - k8s-at-home -{{- end -}} - -{{- define "repository.url" -}} - https://github.com/k8s-at-home/charts -{{- end -}} - -{{- define "helm.url" -}} - https://k8s-at-home.com/charts/ -{{- end -}} - -{{- define "helm.path" -}} - {{ template "repository.organization" . }}/{{ template "chart.name" . }} -{{- end -}} -{{- define "badge.artifactHub" -}} - [![ArtifactHub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/{{ template "chart.name" . }})](https://artifacthub.io/packages/helm/k8s-at-home/{{ template "chart.name" . }}) -{{- end -}} -{{- define "description.multiarch" -}} -The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64) -{{- end -}} - -{{- define "install.tldr" -}} -## TL;DR -```console -$ helm repo add {{ template "repository.organization" . }} {{ template "helm.url" . }} -$ helm install {{ template "helm.path" . }} -``` -{{- end -}} - -{{- define "install" -}} -## Installing the Chart -To install the chart with the release name `{{ template "chart.name" . }}`: -```console -helm install {{ template "chart.name" . }} {{ template "helm.path" . }} -``` -{{- end -}} - -{{- define "uninstall" -}} -## Uninstalling the Chart -To uninstall the `{{ template "chart.name" . }}` deployment: -```console -helm uninstall {{ template "chart.name" . }} -``` -The command removes all the Kubernetes components associated with the chart and deletes the release. -{{- end -}} - -{{- define "configuration.header" -}} -## Configuration -{{- end -}} - -{{- define "configuration.readValues" -}} -Read through the [values.yaml]({{ template "repository.url" . }}/blob/master/charts/{{ template "chart.name" . }}/values.yaml) -file. It has several commented out suggested values. -{{- end -}} - -{{- define "configuration.example.set" -}} -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install {{ template "chart.name" . }} \ - --set env.TZ="America/New York" \ - {{ template "helm.path" . }} -``` -{{- end -}} - -{{- define "configuration.example.file" -}} -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. -For example, -```console -helm install {{ template "chart.name" . }} {{ template "helm.path" . }} --values values.yaml -``` -{{- end -}} diff --git a/charts/adguard-home/README.md b/charts/adguard-home/README.md index d3c9dc80..1023dd25 100644 --- a/charts/adguard-home/README.md +++ b/charts/adguard-home/README.md @@ -1,64 +1,184 @@ -# DNS proxy as ad-blocker for local network +# adguard-home -This is an opinionated helm chart for [adguard-home](https://github.com/AdguardTeam/AdGuardHome) +![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.0-informational?style=flat-square) ![AppVersion: v0.102.0](https://img.shields.io/badge/AppVersion-v0.102.0-informational?style=flat-square) -The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64) +DNS proxy as ad-blocker for local network -## TL;DR +**Homepage:** -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/adguard-home -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | | | -To install the chart with the release name `my-release`: +## Source Code -```console -helm install --name adguard-home k8s-at-home/adguard-home -``` +* -## Uninstalling the Chart +## Values -To uninstall/delete the `adguard-home` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| configAsCode.config.bind_host | string | `"0.0.0.0"` | | +| configAsCode.config.bind_port | int | `3000` | | +| configAsCode.config.clients | list | `[]` | | +| configAsCode.config.debug_pprof | bool | `false` | | +| configAsCode.config.dhcp.enabled | bool | `false` | | +| configAsCode.config.dhcp.gateway_ip | string | `""` | | +| configAsCode.config.dhcp.icmp_timeout_msec | int | `1000` | | +| configAsCode.config.dhcp.interface_name | string | `""` | | +| configAsCode.config.dhcp.lease_duration | int | `86400` | | +| configAsCode.config.dhcp.range_end | string | `""` | | +| configAsCode.config.dhcp.range_start | string | `""` | | +| configAsCode.config.dhcp.subnet_mask | string | `""` | | +| configAsCode.config.dns.aaaa_disabled | bool | `false` | | +| configAsCode.config.dns.all_servers | bool | `false` | | +| configAsCode.config.dns.allowed_clients | list | `[]` | | +| configAsCode.config.dns.anonymize_client_ip | bool | `false` | | +| configAsCode.config.dns.bind_host | string | `"0.0.0.0"` | | +| configAsCode.config.dns.blocked_hosts | list | `[]` | | +| configAsCode.config.dns.blocked_response_ttl | int | `10` | | +| configAsCode.config.dns.blocked_services | list | `[]` | | +| configAsCode.config.dns.blocking_ipv4 | string | `""` | | +| configAsCode.config.dns.blocking_ipv6 | string | `""` | | +| configAsCode.config.dns.blocking_mode | string | `"default"` | | +| configAsCode.config.dns.bogus_nxdomain | list | `[]` | | +| configAsCode.config.dns.bootstrap_dns[0] | string | `"9.9.9.10"` | | +| configAsCode.config.dns.bootstrap_dns[1] | string | `"149.112.112.10"` | | +| configAsCode.config.dns.bootstrap_dns[2] | string | `"2620:fe::10"` | | +| configAsCode.config.dns.bootstrap_dns[3] | string | `"2620:fe::fe:10"` | | +| configAsCode.config.dns.cache_size | int | `4194304` | | +| configAsCode.config.dns.cache_time | int | `30` | | +| configAsCode.config.dns.cache_ttl_max | int | `0` | | +| configAsCode.config.dns.cache_ttl_min | int | `0` | | +| configAsCode.config.dns.disallowed_clients | list | `[]` | | +| configAsCode.config.dns.edns_client_subnet | bool | `false` | | +| configAsCode.config.dns.enable_dnssec | bool | `false` | | +| configAsCode.config.dns.fastest_addr | bool | `false` | | +| configAsCode.config.dns.filtering_enabled | bool | `true` | | +| configAsCode.config.dns.filters_update_interval | int | `24` | | +| configAsCode.config.dns.parental_block_host | string | `"family-block.dns.adguard.com"` | | +| configAsCode.config.dns.parental_cache_size | int | `1048576` | | +| configAsCode.config.dns.parental_enabled | bool | `false` | | +| configAsCode.config.dns.port | int | `53` | | +| configAsCode.config.dns.protection_enabled | bool | `true` | | +| configAsCode.config.dns.querylog_enabled | bool | `true` | | +| configAsCode.config.dns.querylog_interval | int | `90` | | +| configAsCode.config.dns.querylog_size_memory | int | `1000` | | +| configAsCode.config.dns.ratelimit | int | `0` | | +| configAsCode.config.dns.ratelimit_whitelist | list | `[]` | | +| configAsCode.config.dns.refuse_any | bool | `true` | | +| configAsCode.config.dns.rewrites | list | `[]` | | +| configAsCode.config.dns.safebrowsing_block_host | string | `"standard-block.dns.adguard.com"` | | +| configAsCode.config.dns.safebrowsing_cache_size | int | `1048576` | | +| configAsCode.config.dns.safebrowsing_enabled | bool | `false` | | +| configAsCode.config.dns.safesearch_cache_size | int | `1048576` | | +| configAsCode.config.dns.safesearch_enabled | bool | `false` | | +| configAsCode.config.dns.statistics_interval | int | `1` | | +| configAsCode.config.dns.upstream_dns[0] | string | `"https://dns10.quad9.net/dns-query"` | | +| configAsCode.config.filters[0].enabled | bool | `true` | | +| configAsCode.config.filters[0].id | int | `1` | | +| configAsCode.config.filters[0].name | string | `"AdGuard DNS filter"` | | +| configAsCode.config.filters[0].url | string | `"https://adguardteam.github.io/AdGuardSDNSFilter/Filters/filter.txt"` | | +| configAsCode.config.filters[1].enabled | bool | `false` | | +| configAsCode.config.filters[1].id | int | `2` | | +| configAsCode.config.filters[1].name | string | `"AdAway"` | | +| configAsCode.config.filters[1].url | string | `"https://adaway.org/hosts.txt"` | | +| configAsCode.config.filters[2].enabled | bool | `false` | | +| configAsCode.config.filters[2].id | int | `4` | | +| configAsCode.config.filters[2].name | string | `"MalwareDomainList.com Hosts List"` | | +| configAsCode.config.filters[2].url | string | `"https://www.malwaredomainlist.com/hostslist/hosts.txt"` | | +| configAsCode.config.http_proxy | string | `""` | | +| configAsCode.config.language | string | `"en"` | | +| configAsCode.config.log_file | string | `""` | | +| configAsCode.config.rlimit_nofile | int | `0` | | +| configAsCode.config.schema_version | int | `6` | | +| configAsCode.config.tls.allow_unencrypted_doh | bool | `false` | | +| configAsCode.config.tls.certificate_chain | string | `""` | | +| configAsCode.config.tls.certificate_path | string | `""` | | +| configAsCode.config.tls.enabled | bool | `false` | | +| configAsCode.config.tls.force_https | bool | `false` | | +| configAsCode.config.tls.port_dns_over_tls | int | `853` | | +| configAsCode.config.tls.port_https | int | `443` | | +| configAsCode.config.tls.private_key | string | `""` | | +| configAsCode.config.tls.private_key_path | string | `""` | | +| configAsCode.config.tls.server_name | string | `""` | | +| configAsCode.config.tls.strict_sni_check | bool | `false` | | +| configAsCode.config.user_rules | list | `[]` | | +| configAsCode.config.users | list | `[]` | | +| configAsCode.config.verbose | bool | `false` | | +| configAsCode.config.web_session_ttl | int | `720` | | +| configAsCode.config.whitelist_filters | list | `[]` | | +| configAsCode.enabled | bool | `false` | | +| configAsCode.image.pullPolicy | string | `"Always"` | | +| configAsCode.image.repository | string | `"busybox"` | | +| configAsCode.image.tag | string | `"latest"` | | +| configAsCode.resources | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"adguard/adguardhome"` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.enabled | bool | `true` | | +| persistence.config.size | string | `"20Mi"` | | +| persistence.config.skipuninstall | bool | `false` | | +| persistence.work.accessMode | string | `"ReadWriteOnce"` | | +| persistence.work.enabled | bool | `true` | | +| persistence.work.size | string | `"10Gi"` | | +| persistence.work.skipuninstall | bool | `false` | | +| podAnnotations."prometheus.io/port" | string | `"api"` | | +| podAnnotations."prometheus.io/scrape" | string | `"true"` | | +| podSecurityContext | object | `{}` | | +| probes.liveness.enabled | bool | `true` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.initialDelaySeconds | int | `5` | | +| probes.liveness.periodSeconds | int | `10` | | +| probes.readiness.enabled | bool | `false` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.initialDelaySeconds | int | `5` | | +| probes.readiness.periodSeconds | int | `10` | | +| probes.startup.enabled | bool | `false` | | +| probes.startup.failureThreshold | int | `30` | | +| probes.startup.initialDelaySeconds | int | `5` | | +| probes.startup.periodSeconds | int | `10` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.annotations | object | `{}` | | +| service.type | string | `"ClusterIP"` | | +| serviceDHCP.annotations | object | `{}` | | +| serviceDHCP.enabled | bool | `false` | | +| serviceDHCP.loadBalancerIP | string | `""` | | +| serviceDHCP.type | string | `"NodePort"` | | +| serviceDNSOverTLS.annotations | object | `{}` | | +| serviceDNSOverTLS.enabled | bool | `false` | | +| serviceDNSOverTLS.loadBalancerIP | string | `""` | | +| serviceDNSOverTLS.type | string | `"NodePort"` | | +| serviceMonitor.additionalLabels | object | `{}` | | +| serviceMonitor.enabled | bool | `false` | | +| serviceTCP.annotations | object | `{}` | | +| serviceTCP.enabled | bool | `false` | | +| serviceTCP.loadBalancerIP | string | `""` | | +| serviceTCP.type | string | `"NodePort"` | | +| serviceUDP.annotations | object | `{}` | | +| serviceUDP.enabled | bool | `true` | | +| serviceUDP.loadBalancerIP | string | `""` | | +| serviceUDP.type | string | `"NodePort"` | | +| strategyType | string | `"Recreate"` | | +| timezone | string | `"UTC"` | | +| tlsSecretName | string | `""` | | +| tolerations | list | `[]` | | +| volumePermissions.image.pullPolicy | string | `"Always"` | | +| volumePermissions.image.repository | string | `"busybox"` | | +| volumePermissions.image.tag | string | `"latest"` | | +| volumePermissions.resources | object | `{}` | | -```console -helm delete adguard-home --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/adguard-home/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name adguard-home \ - --set timeZone="America/New York" \ - k8s-at-home/adguard-home -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name adguard-home -f values.yaml k8s-at-home/adguard-home -``` - -#### Helm force upgrade - -```sh -helm upgrade --force -``` - -#### Delete the existing `adguard-home` services prior to upgrading - -```sh -kubectl delete svc/adguard-home -``` - -#### Remove the existing adguard-home chart first - -This is the 'easiest' approach, but will incur downtime which can be problematic if you rely on adguard-home for DNS +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/alertmanager-bot/.helmignore b/charts/alertmanager-bot/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/alertmanager-bot/.helmignore +++ b/charts/alertmanager-bot/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/alertmanager-bot/README.md b/charts/alertmanager-bot/README.md index 4d7e3a96..6a08e993 100644 --- a/charts/alertmanager-bot/README.md +++ b/charts/alertmanager-bot/README.md @@ -1,61 +1,115 @@ # alertmanager-bot -This is a helm chart for [alertmanager-bot](https://github.com/metalmatze/alertmanager-bot). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 0.4.2](https://img.shields.io/badge/AppVersion-0.4.2-informational?style=flat-square) + +Bot for Prometheus Alertmanager **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/alertmanager-bot +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install alertmanager-bot k8s-at-home/alertmanager-bot ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `alertmanager-bot` ```console -helm install --name my-release k8s-at-home/alertmanager-bot +helm install alertmanager-bot k8s-at-home/alertmanager-bot ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `alertmanager-bot` deployment ```console -helm delete my-release --purge +helm uninstall alertmanager-bot ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/alertmanager-bot/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install alertmanager-bot \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/alertmanager-bot ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install alertmanager-bot k8s-at-home/alertmanager-bot --values values.yaml +helm install alertmanager-bot k8s-at-home/alertmanager-bot -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env.BOLT_PATH | string | `"/data/bot.db"` | | +| env.STORE | string | `"bolt"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"metalmatze/alertmanager-bot"` | | +| image.tag | string | `"0.4.2"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| service.enabled | bool | `false` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/alertmanager-bot/README.md.gotmpl b/charts/alertmanager-bot/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/alertmanager-bot/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/alertmanager-bot/README_CHANGELOG.md.gotmpl b/charts/alertmanager-bot/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/alertmanager-bot/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/alertmanager-bot/README_CONFIG.md.gotmpl b/charts/alertmanager-bot/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/alertmanager-bot/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/appdaemon/.helmignore b/charts/appdaemon/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/appdaemon/.helmignore +++ b/charts/appdaemon/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/appdaemon/README.md b/charts/appdaemon/README.md index 9eca4afd..97ab150b 100644 --- a/charts/appdaemon/README.md +++ b/charts/appdaemon/README.md @@ -1,67 +1,114 @@ # appdaemon -This is a helm chart for [appdaemon](https://github.com/AppDaemon/appdaemon). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 4.0.5](https://img.shields.io/badge/AppVersion-4.0.5-informational?style=flat-square) + +AppDaemon is a loosely coupled, multi-threaded, sandboxed python execution environment for writing automation apps for various types of Home Automation Software including Home Assistant and MQTT. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/appdaemon +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install appdaemon k8s-at-home/appdaemon ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `appdaemon` ```console -helm install --name my-release k8s-at-home/appdaemon +helm install appdaemon k8s-at-home/appdaemon ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `appdaemon` deployment ```console -helm delete my-release --purge +helm uninstall appdaemon ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/appdaemon/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install appdaemon \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/appdaemon ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install appdaemon k8s-at-home/appdaemon --values values.yaml +helm install appdaemon k8s-at-home/appdaemon -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"k8sathome/appdaemon"` | | +| image.tag | string | `"v4.0.5"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `5050` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/appdaemon/README.md.gotmpl b/charts/appdaemon/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/appdaemon/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/appdaemon/README_CHANGELOG.md.gotmpl b/charts/appdaemon/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/appdaemon/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/appdaemon/README_CONFIG.md.gotmpl b/charts/appdaemon/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/appdaemon/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/bazarr/.helmignore b/charts/bazarr/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/bazarr/.helmignore +++ b/charts/bazarr/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/bazarr/README.md b/charts/bazarr/README.md index 7e64ac39..28814c18 100644 --- a/charts/bazarr/README.md +++ b/charts/bazarr/README.md @@ -1,78 +1,117 @@ -# Bazarr +# bazarr -This is a helm chart for [Bazarr](https://github.com/morpheus65535/bazarr). +![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![AppVersion: v0.9.0.5](https://img.shields.io/badge/AppVersion-v0.9.0.5-informational?style=flat-square) + +Bazarr is a companion application to Sonarr and Radarr. It manages and downloads subtitles based on your requirements **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/bazarr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install bazarr k8s-at-home/bazarr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `bazarr` ```console -helm install --name my-release k8s-at-home/bazarr +helm install bazarr k8s-at-home/bazarr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `bazarr` deployment ```console -helm delete my-release --purge +helm uninstall bazarr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/bazarr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install bazarr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/bazarr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install bazarr k8s-at-home/bazarr --values values.yaml +helm install bazarr k8s-at-home/bazarr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/bazarr"` | | +| image.tag | string | `"version-v0.9.0.5"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `6767` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 3.x.x to 4.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/bazarr/README.md.gotmpl b/charts/bazarr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/bazarr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/bazarr/README_CHANGELOG.md.gotmpl b/charts/bazarr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/bazarr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/bazarr/README_CONFIG.md.gotmpl b/charts/bazarr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/bazarr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/bitwardenrs/README.md b/charts/bitwardenrs/README.md index 350ad331..cdd5424b 100644 --- a/charts/bitwardenrs/README.md +++ b/charts/bitwardenrs/README.md @@ -1,58 +1,102 @@ -# Unofficial Bitwarden compatible server written in Rust +# bitwardenrs -This is an opinionated helm chart for [bitwarden_rs](https://github.com/dani-garcia/bitwarden_rs) +![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.18.0](https://img.shields.io/badge/AppVersion-1.18.0-informational?style=flat-square) -The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64) +Unofficial Bitwarden compatible server written in Rust -## TL;DR +**Homepage:** -```console -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/bitwardenrs -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| DirtyCajunRice | nick@cajun.pro | | -To install the chart with the release name `bitwarden`: +## Source Code -```console -helm install bitwarden k8s-at-home/bitwardenrs -``` +* -## Uninstalling the Chart +## Values -To uninstall/delete the `bitwarden` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| bitwardenrs.admin.disableAdminToken | bool | `false` | | +| bitwardenrs.admin.enabled | bool | `true` | | +| bitwardenrs.admin.existingSecret.enabled | bool | `false` | | +| bitwardenrs.admin.existingSecret.name | string | `""` | | +| bitwardenrs.admin.existingSecret.tokenKey | string | `""` | | +| bitwardenrs.domain | string | `""` | | +| bitwardenrs.externalDatabase.database | string | `""` | | +| bitwardenrs.externalDatabase.enabled | bool | `false` | | +| bitwardenrs.externalDatabase.existingSecret.enabled | bool | `false` | | +| bitwardenrs.externalDatabase.existingSecret.name | string | `""` | | +| bitwardenrs.externalDatabase.existingSecret.passwordKey | string | `""` | | +| bitwardenrs.externalDatabase.existingSecret.userKey | string | `""` | | +| bitwardenrs.externalDatabase.host | string | `""` | | +| bitwardenrs.externalDatabase.password | string | `""` | | +| bitwardenrs.externalDatabase.port | string | `""` | | +| bitwardenrs.externalDatabase.type | string | `""` | | +| bitwardenrs.externalDatabase.user | string | `""` | | +| bitwardenrs.gui.port | int | `80` | | +| bitwardenrs.signupsAllowed | bool | `false` | | +| bitwardenrs.smtp.enabled | bool | `false` | | +| bitwardenrs.smtp.existingSecret.enabled | bool | `false` | | +| bitwardenrs.smtp.existingSecret.name | string | `""` | | +| bitwardenrs.smtp.existingSecret.passwordKey | string | `""` | | +| bitwardenrs.smtp.existingSecret.userKey | string | `""` | | +| bitwardenrs.smtp.from | string | `""` | | +| bitwardenrs.smtp.fromName | string | `""` | | +| bitwardenrs.smtp.host | string | `""` | | +| bitwardenrs.smtp.password | string | `""` | | +| bitwardenrs.smtp.port | int | `587` | | +| bitwardenrs.smtp.ssl | bool | `true` | | +| bitwardenrs.smtp.user | string | `""` | | +| bitwardenrs.websockets.enabled | bool | `true` | | +| bitwardenrs.websockets.port | int | `3012` | | +| bitwardenrs.yubico.clientId | string | `""` | | +| bitwardenrs.yubico.enabled | bool | `false` | | +| bitwardenrs.yubico.existingSecret.clientIdKey | string | `""` | | +| bitwardenrs.yubico.existingSecret.enabled | bool | `false` | | +| bitwardenrs.yubico.existingSecret.name | string | `""` | | +| bitwardenrs.yubico.existingSecret.secretKeyKey | string | `""` | | +| bitwardenrs.yubico.secretKey | string | `""` | | +| bitwardenrs.yubico.server | string | `""` | | +| env | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"bitwardenrs/server"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths | list | `[]` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.enabled | bool | `false` | | +| persistence.size | string | `"1Gi"` | | +| persistence.type | string | `"statefulset"` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.additionalSpec | object | `{}` | | +| service.annotations | object | `{}` | | +| service.labels | object | `{}` | | +| service.port | int | `80` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | -```console -helm uninstall bitwarden -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/bitwardenrs/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install bitwarden \ - --set timeZone="America/New York" \ - k8s-at-home/bitwardenrs -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install bitwarden k8s-at-home/bitwardenrs --values values.yaml -``` - -## Upgrading an existing Release to a new major version - -A major chart version change (like 1.1.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. - -### Upgrading from 1.x.x to 2.x.x - -Chart version 2.0.0 introduces external database support. - * No actions required to continue with the default sqlite backend. - * Refer to the `bitwardenrs.externalDatabase` section of [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/bitwardenrs/values.yaml) to configure MySQL or PostgreSQL database backends. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/blocky/README.md b/charts/blocky/README.md index 03a83223..827fe928 100644 --- a/charts/blocky/README.md +++ b/charts/blocky/README.md @@ -1,79 +1,67 @@ -# DNS proxy as ad-blocker for local network +# blocky -This is an opinionated helm chart for [blocky](https://github.com/0xERR0R/blocky) +![Version: 5.0.0](https://img.shields.io/badge/Version-5.0.0-informational?style=flat-square) ![AppVersion: v0.12](https://img.shields.io/badge/AppVersion-v0.12-informational?style=flat-square) -The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64) +DNS proxy as ad-blocker for local network -## TL;DR +**Homepage:** -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/blocky -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `my-release`: +## Source Code -```console -helm install --name blocky k8s-at-home/blocky -``` +* -## Uninstalling the Chart +## Values -To uninstall/delete the `blocky` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| config | string | `"upstream:\n # these external DNS resolvers will be used. Blocky picks 2 random resolvers from the list for each query\n # format for resolver: [net:]host:[port][/path]. net could be empty (default, shortcut for tcp+udp), tcp+udp, tcp, udp, tcp-tls or https (DoH). If port is empty, default port will be used (53 for udp and tcp, 853 for tcp-tls, 443 for https (Doh))\n externalResolvers:\n - 46.182.19.48\n - 80.241.218.68\n - tcp-tls:fdns1.dismail.de:853\n - https://dns.digitale-gesellschaft.ch/dns-query\n\n# optional: custom IP address for domain name (with all sub-domains)\n# example: query \"printer.lan\" or \"my.printer.lan\" will return 192.168.178.3\ncustomDNS:\n mapping:\n printer.lan: 192.168.178.3\n\n# optional: definition, which DNS resolver(s) should be used for queries to the domain (with all sub-domains). Multiple resolvers must be separated by comma\n# Example: Query client.fritz.box will ask DNS server 192.168.178.1. This is necessary for local network, to resolve clients by host name\nconditional:\n mapping:\n fritz.box: udp:192.168.178.1\n lan.net: udp:192.168.178.1,udp:192.168.178.2\n\n# optional: use black and white lists to block queries (for example ads, trackers, adult pages etc.)\nblocking:\n # definition of blacklist groups. Can be external link (http/https) or local file\n blackLists:\n ads:\n - https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt\n - https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts\n - https://mirror1.malwaredomains.com/files/justdomains\n - http://sysctl.org/cameleon/hosts\n - https://zeustracker.abuse.ch/blocklist.php?download=domainblocklist\n - https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt\n special:\n - https://raw.githubusercontent.com/StevenBlack/hosts/master/alternates/fakenews/hosts\n # definition of whitelist groups. Attention: if the same group has black and whitelists, whitelists will be used to disable particular blacklist entries. If a group has only whitelist entries -> this means only domains from this list are allowed, all other domains will be blocked\n whiteLists:\n ads:\n - whitelist.txt\n # definition: which groups should be applied for which client\n clientGroupsBlock:\n # default will be used, if no special definition for a client name exists\n default:\n - ads\n - special\n # use client name (with wildcard support: * - sequence of any characters, [0-9] - range)\n # or single ip address / client subnet as CIDR notation\n laptop*:\n - ads\n 192.168.178.1/24:\n - special\n # which response will be sent, if query is blocked:\n # zeroIp: 0.0.0.0 will be returned (default)\n # nxDomain: return NXDOMAIN as return code\n # comma separated list of destination IP adresses (for example: 192.100.100.15, 2001:0db8:85a3:08d3:1319:8a2e:0370:7344). Should contain ipv4 and ipv6 to cover all query types. Useful with running web server on this address to display the \"blocked\" page.\n blockType: zeroIp\n # optional: automatically list refresh period in minutes. Default: 4h.\n # Negative value -> deactivate automatically refresh.\n # 0 value -> use default\n refreshPeriod: 0\n\n# optional: configuration for caching of DNS responses\ncaching:\n # amount in minutes, how long a response must be cached (min value).\n # If <=0, use response's TTL, if >0 use this value, if TTL is smaller\n # Default: 0\n minTime: 5\n # amount in minutes, how long a response must be cached (max value).\n # If <0, do not cache responses\n # If 0, use TTL\n # If > 0, use this value, if TTL is greater\n # Default: 0\n maxTime: -1\n # if true, will preload DNS results for often used queries (names queried more than 5 times in a 2 hour time window)\n # this improves the response time for often used queries, but significantly increases external traffic\n # default: false\n prefetching: true\n\n# optional: configuration of client name resolution\nclientLookup:\n # optional: this DNS resolver will be used to perform reverse DNS lookup (typically local router)\n upstream: udp:192.168.178.1\n # optional: some routers return multiple names for client (host name and user defined name). Define which single name should be used.\n # Example: take second name if present, if not take first name\n singleNameOrder:\n - 2\n - 1\n # optional: custom mapping of client name to IP addresses. Useful if reverse DNS does not work properly or just to have custom client names.\n clients:\n laptop:\n - 192.168.178.29\n\n# optional: configuration for prometheus metrics endpoint\n# prometheus:\n# # enabled if true\n# enable: true\n# # url path, optional (default '/metrics')\n# path: /metrics\n\n# optional: write query information (question, answer, client, duration etc) to daily csv file\n# queryLog:\n# # directory (should be mounted as volume in docker)\n# dir: /logs\n# # if true, write one file per client. Writes all queries to single file otherwise\n# perClient: true\n# # if > 0, deletes log files which are older than ... days\n# logRetentionDays: 7\n\n# optional: DNS listener port and bind ip address, default 53 (UDP and TCP). Example: 53, :53, 127.0.0.1:53\nport: 53\n# optional: HTTP listener port, default 0 = no http listener. If > 0, will be used for prometheus metrics, pprof, REST API, DoH ...\nhttpPort: 4000\n# optional: HTTPS listener port, default 0 = no http listener. If > 0, will be used for prometheus metrics, pprof, REST API, DoH...\n#httpsPort: 443\n# mandatory, if https port > 0: path to cert and key file for SSL encryption\n#httpsCertFile: server.crt\n#httpsKeyFile: server.key\n# optional: use this DNS server to resolve blacklist urls and upstream DNS servers (DOH). Useful if no DNS resolver is configured and blocky needs to resolve a host name. Format net:IP:port, net must be udp or tcp\nbootstrapDns: tcp:1.1.1.1\n# optional: Log level (one from debug, info, warn, error). Default: info\nlogLevel: info\n# optional: Log format (text or json). Default: text\nlogFormat: text\n"` | | +| extraLists | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"spx01/blocky"` | | +| image.tag | string | `"v0.12"` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.accessModes[0] | string | `"ReadWriteOnce"` | | +| persistence.enabled | bool | `false` | | +| persistence.finalizers[0] | string | `"kubernetes.io/pvc-protection"` | | +| persistence.size | string | `"10Gi"` | | +| podAnnotations."prometheus.io/port" | string | `"api"` | | +| podAnnotations."prometheus.io/scrape" | string | `"true"` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.periodSeconds | int | `10` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.periodSeconds | int | `10` | | +| probes.startup.failureThreshold | int | `30` | | +| probes.startup.initialDelaySeconds | int | `5` | | +| probes.startup.periodSeconds | int | `10` | | +| replicas | int | `1` | | +| resources | object | `{}` | | +| service.annotations | object | `{}` | | +| service.type | string | `"ClusterIP"` | | +| serviceMonitor.additionalLabels | object | `{}` | | +| serviceMonitor.enabled | bool | `false` | | +| serviceTCP.annotations | object | `{}` | | +| serviceTCP.enabled | bool | `false` | | +| serviceTCP.externalIPs | list | `[]` | | +| serviceTCP.externalTrafficPolicy | string | `"Local"` | | +| serviceTCP.loadBalancerIP | string | `""` | | +| serviceTCP.type | string | `"NodePort"` | | +| serviceUDP.annotations | object | `{}` | | +| serviceUDP.enabled | bool | `true` | | +| serviceUDP.externalIPs | list | `[]` | | +| serviceUDP.externalTrafficPolicy | string | `"Local"` | | +| serviceUDP.loadBalancerIP | string | `""` | | +| serviceUDP.type | string | `"NodePort"` | | +| timeZone | string | `"UTC"` | | +| tolerations | list | `[]` | | -```console -helm delete blocky --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/blocky/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name blocky \ - --set timeZone="America/New York" \ - k8s-at-home/blocky -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name blocky -f values.yaml k8s-at-home/blocky -``` - ---- - -## Upgrading an existing Release to a new major version - -A major chart version change (like 2.2.2 -> 3.0.0) indicates that there is an -incompatible breaking change needing manual actions. - -### Upgrading from 2.x.x to 3.x.x - -Due to the renaming of the service port, an upgrade-in-place will not work. The following are possible approaches to solve this: - -#### Helm force upgrade - -```sh -helm upgrade --force -``` - -#### Delete the existing `blocky` service prior to upgrading - -```sh -kubectl delete svc/blocky -``` - -#### Remove the existing blocky chart first - -This is the 'easiest' approach, but will incur downtime which can be problematic if you rely on blocky for DNS - -### Upgrading from 4.x.x to 5.x.x - -Configuration inside `config` is no longer a yaml object, it is now a multiline string \ No newline at end of file +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/booksonic-air/.helmignore b/charts/booksonic-air/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/booksonic-air/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/booksonic-air/README.md b/charts/booksonic-air/README.md index b73ac454..a5a8c6df 100644 --- a/charts/booksonic-air/README.md +++ b/charts/booksonic-air/README.md @@ -1,78 +1,125 @@ -# Booksonic-air +# booksonic-air -This is a helm chart for [Booksonic-air](https://github.com/popeen/Booksonic-Air). -Booksonic-air is the successor to [Booksonic](https://github.com/popeen/Booksonic-Air#history). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: v2009.1.0](https://img.shields.io/badge/AppVersion-v2009.1.0-informational?style=flat-square) + +Booksonic is a platform for accessing the audibooks you own wherever you are **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -This chart leverages the [linuxserver.io](https://hub.docker.com/r/linuxserver/booksonic-air) image. To specify a specific version, or to use a different image (not recommended), -see [configuration](#configuration) +## Requirements -## TL;DR; +Kubernetes: `>=1.16.0-0` -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/booksonic-air +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install booksonic-air k8s-at-home/booksonic-air ``` -## Storage - -If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the -Fast Access option in the Booksonic settings. This will help improve the perfomance of the application -by not constantly monitoring media folders. - ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `booksonic-air` ```console -helm install --name my-release k8s-at-home/booksonic-air +helm install booksonic-air k8s-at-home/booksonic-air ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `booksonic-air` deployment ```console -helm delete my-release --purge +helm uninstall booksonic-air ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/booksonic-air/values.yaml) -file. It has several commented out suggested values. Most notably, these include several environment variables used to -customize the container. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console -helm install booksonic \ - --set env.TZ="America/New_York" \ +helm install booksonic-air \ + --set env.TZ="America/New York" \ k8s-at-home/booksonic-air ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install booksonic k8s-at-home/booksonic-air -f values.yaml +helm install booksonic-air k8s-at-home/booksonic-air -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the +Fast Access option in the Booksonic settings. This will help improve the performance of the application +by not constantly monitoring media folders. -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/booksonic-air"` | | +| image.tag | string | `"v2009.1.0-ls2"` | | +| ingress.enabled | bool | `false` | | +| persistence.audiobooks.emptyDir | bool | `false` | | +| persistence.audiobooks.enabled | bool | `false` | | +| persistence.audiobooks.mountPath | string | `"/audiobooks"` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.othermedia.emptyDir | bool | `false` | | +| persistence.othermedia.enabled | bool | `false` | | +| persistence.othermedia.mountPath | string | `"/othermedia"` | | +| persistence.podcasts.emptyDir | bool | `false` | | +| persistence.podcasts.enabled | bool | `false` | | +| persistence.podcasts.mountPath | string | `"/podcasts"` | | +| service.port.port | int | `4040` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/booksonic-air/README.md.gotmpl b/charts/booksonic-air/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/booksonic-air/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/booksonic-air/README_CHANGELOG.md.gotmpl b/charts/booksonic-air/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/booksonic-air/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/booksonic-air/README_CONFIG.md.gotmpl b/charts/booksonic-air/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e676aad6 --- /dev/null +++ b/charts/booksonic-air/README_CONFIG.md.gotmpl @@ -0,0 +1,11 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the +Fast Access option in the Booksonic settings. This will help improve the performance of the application +by not constantly monitoring media folders. +{{- end -}} diff --git a/charts/calibre-web/.helmignore b/charts/calibre-web/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/calibre-web/.helmignore +++ b/charts/calibre-web/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/calibre-web/README.md b/charts/calibre-web/README.md index 0d7dcd13..820b87eb 100644 --- a/charts/calibre-web/README.md +++ b/charts/calibre-web/README.md @@ -1,85 +1,116 @@ -# Calibre-Web +# calibre-web -This is a helm chart for [Calibre-Web](https://github.com/janeczku/calibre-web). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: 0.6.9](https://img.shields.io/badge/AppVersion-0.6.9-informational?style=flat-square) + +Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/calibre-web +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install calibre-web k8s-at-home/calibre-web ``` -## Storage - -If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the -Fast Access option in the Booksonic settings. This will help improve the perfomance of the application -by not constantly monitoring media folders. - ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `calibre-web` ```console -helm install --name my-release k8s-at-home/calibre-web +helm install calibre-web k8s-at-home/calibre-web ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `calibre-web` deployment ```console -helm delete my-release --purge +helm uninstall calibre-web ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/calibre-web/values.yaml) -file. It has several commented out suggested values. Most notably, these include several environment variables used to -customize the container. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install calibre-web \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/calibre-web ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install calibre-web k8s-at-home/calibre-web -f values.yaml +helm install calibre-web k8s-at-home/calibre-web -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/calibre-web"` | | +| image.tag | string | `"version-0.6.9"` | | +| ingress.enabled | bool | `false` | | +| persistence.books.emptyDir | bool | `false` | | +| persistence.books.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `8083` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 2.x.x to 3.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/calibre-web/README.md.gotmpl b/charts/calibre-web/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/calibre-web/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/calibre-web/README_CHANGELOG.md.gotmpl b/charts/calibre-web/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/calibre-web/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/calibre-web/README_CONFIG.md.gotmpl b/charts/calibre-web/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/calibre-web/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/comcast/README.md b/charts/comcast/README.md index fd282d55..4c29ff42 100644 --- a/charts/comcast/README.md +++ b/charts/comcast/README.md @@ -1,84 +1,41 @@ -# Comcast Data Cap Usage Collector For InfluxDB and Grafana +# comcast -![Screenshot](https://github.com/billimek/comcastUsage-for-influxdb/raw/master/images/comcast_grafana_example.png) +![Version: 3.0.0](https://img.shields.io/badge/Version-3.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) -This tool allows you to run periodic comcast data usage checks and save the results to Influxdb +periodic comcast data usage checks and save the results to InfluxDB -## TL;DR; +**Homepage:** -```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/comcast -``` +## Maintainers -## Introduction +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -This code is adopted from the work done by [barrycarey](https://github.com/barrycarey) in the [similar thing for capturing speedtest data](https://github.com/barrycarey/Speedtest-for-InfluxDB-and-Grafana) as well as [jantman's](https://github.com/jantman) [xfinity-usage python example](https://github.com/jantman/xfinity-usage) +## Source Code -## Installing the Chart +* +* -To install the chart with the release name `my-release`: +## Values -```console -$ helm install --name my-release k8s-at-home/comcast -``` -## Uninstalling the Chart +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config.comcast.password | string | `"somepassword"` | | +| config.comcast.username | string | `"someuser"` | | +| config.delay | int | `3600` | | +| config.influxdb.database | string | `"comcast"` | | +| config.influxdb.host | string | `"influxdb-influxdb"` | | +| config.influxdb.port | int | `8086` | | +| config.influxdb.ssl | bool | `false` | | +| debug | bool | `false` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"billimek/comcastusage-for-influxdb"` | | +| image.tag | string | `"latest"` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | -To uninstall/delete the `my-release` deployment: - -```console -$ helm delete my-release --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The configuration is set as a block of text through a configmap and mounted as a file in /src/config.ini Any value in this text block should match the defined Comcast configuration. There are several values here that will have to match our kubernetes configuration. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -| ------------------------------- | ------------------------------- | ---------------------------------------------------------- | -| `image.repository` | Comcast image | `billimek/comcastusage-for-influxdb` | -| `image.tag` | Comcast image tag | `latest` | -| `image.pullPolicy` | Comcast image pull policy | `IfNotPresent` | -| `debug` | Display debugging output | `false` | -| `config.delay` | how many seconds to wait between checks | `3600` | -| `config.influxdb.host` | InfluxDB hostname | `influxdb-influxdb` | -| `config.influxdb.port` | InfluxDB port | `8086` | -| `config.influxdb.database` | InfluxDB database | `comcast` | -| `config.influxdb.username` | InfluxDB username | `` | -| `config.influxdb.password` | InfluxDB password | `` | -| `config.influxdb.ssl` | InfluxDB connection using SSL | `false` | -| `config.comcast.username` | Comcast website login usernma | `someuser` | -| `config.comcast.password` | Comcast website login password | `somepassword` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name my-release \ - --set config.comcast.username=tonystark,config.comcast.password=mypassword \ - k8s-at-home/comcast -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name my-release -f values.yaml k8s-at-home/comcast -``` - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/comcast/values.yaml) file. It has several commented out suggested values. - -## InfluxDB metrics -``` -'measurement': 'comcast_data_usage', -'fields': { - 'used', - 'total', - 'unit' -} -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/common-test/.helmignore b/charts/common-test/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/common-test/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/common-test/README.md b/charts/common-test/README.md new file mode 100644 index 00000000..be1f0726 --- /dev/null +++ b/charts/common-test/README.md @@ -0,0 +1,34 @@ +# common-test + +![Version: 1.0.4](https://img.shields.io/badge/Version-1.0.4-informational?style=flat-square) + +Helper chart to test different use cases of the common library + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| bjw-s | me@bjw-s.dev | | + +## Requirements + +Kubernetes: `>=1.16.0-0` + +| Repository | Name | Version | +|------------|------|---------| +| file://../common | common | n/a | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"b4bz/homer"` | | +| image.tag | string | `"latest"` | | +| ingress.enabled | bool | `true` | | +| service.port.port | int | `8080` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/common/README.md b/charts/common/README.md index 9291a820..eeec51b3 100644 --- a/charts/common/README.md +++ b/charts/common/README.md @@ -1,48 +1,67 @@ -# Library chart for k8s@home media charts +# common + +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) + +Function library for k8s-at-home charts **WARNING: THIS CHART IS NOT MEANT TO BE INSTALLED DIRECTLY** -This is a [Helm Library Chart](https://helm.sh/docs/topics/library_charts/#helm). It's purpose is for grouping common logic between the k8s@home charts. +This is a [Helm Library Chart](https://helm.sh/docs/topics/library_charts/#helm). It's purpose is for grouping common logic between the k8s@home charts. Since a lot of charts follow the same pattern this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY. -## Introduction +## Requirements -This chart provides common template helpers which can be used to develop new charts using [Helm](https://helm.sh) package manager. +Kubernetes: `>=1.16.0-0` -## :star2: Changelog +## Dependencies -Please refer to [CHANGELOG.md](CHANGELOG.md) for an overview of notable changes to the chart. **This is especially important for major version updates!** +| Repository | Name | Version | +|------------|------|---------| ## TL;DR -When using one of the many charts that uses this library be sure to view this [values.yaml](./values.yaml) for configuration options. Any setting here can be used to define what values your helm deployment will use. - -For example using the helm CLI tool - -```bash -helm install node-red \ - --set image.repository="nodered/node-red" \ - --set image.tag="1.2.5" \ - --set env.TZ="America/New_York" \ - k8s-at-home/node-red +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install common k8s-at-home/common ``` -or +## Installing the Chart -```yaml -# node-red-values.yaml -image: - repository: nodered/node-red - tag: 1.2.5 -env: - TZ: America/New_York +To install the chart with the release name `common` + +```console +helm install common k8s-at-home/common ``` -```bash -helm install node-red \ - --values=./node-red-values.yaml \ - k8s-at-home/node-red +## Uninstalling the Chart + +To uninstall the `common` deployment + +```console +helm uninstall common +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install common \ + --set env.TZ="America/New York" \ + k8s-at-home/common +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install common k8s-at-home/common -f values.yaml ``` ## Creating a new chart @@ -54,15 +73,19 @@ Include this chart as a dependency in your `Chart.yaml` e.g. ```yaml # Chart.yaml dependencies: - - name: common - version: x.x.x - repository: https://k8s-at-home.com/charts/ +- name: common + version: 3.0.1 + repository: https://k8s-at-home.com/charts/ ``` - Write a `values.yaml` with some basic defaults you want to present to the user e.g. ```yaml -# Default values for node-red. +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/charts/tree/master/charts/common/values.yaml +# image: repository: nodered/node-red @@ -72,7 +95,7 @@ image: strategy: type: Recreate -# See more environment varaibles in the node-red documentation +# See more environment variables in the node-red documentation # https://nodered.org/docs/getting-started/docker env: {} # TZ: @@ -85,6 +108,9 @@ service: port: port: 1880 +ingress: + enabled: false + persistence: data: enabled: false @@ -92,8 +118,307 @@ persistence: mountPath: /data ``` +If not using a service, set the `service.enabled` to `false`. +```yaml +... +service: + enabled: false +... +``` + +Add files to the `templates` folder. +```yaml +# templates/common.yaml +{{ include "common.all . }} + +# templates/NOTES.txt +{{ include "common.notes.defaultNotes" . }} +``` + If testing locally make sure you update the dependencies with: ```bash helm dependency update ``` + +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalContainers | list | `[]` | | +| additionalVolumeMounts | list | `[]` | | +| additionalVolumes | list | `[]` | | +| addons.codeserver.args[0] | string | `"--auth"` | | +| addons.codeserver.args[1] | string | `"none"` | | +| addons.codeserver.enabled | bool | `false` | | +| addons.codeserver.env | object | `{}` | | +| addons.codeserver.image.pullPolicy | string | `"IfNotPresent"` | | +| addons.codeserver.image.repository | string | `"codercom/code-server"` | | +| addons.codeserver.image.tag | string | `"3.7.4"` | | +| addons.codeserver.ingress.annotations | object | `{}` | | +| addons.codeserver.ingress.enabled | bool | `false` | | +| addons.codeserver.ingress.hosts[0].host | string | `"code.chart-example.local"` | | +| addons.codeserver.ingress.hosts[0].paths[0].path | string | `"/"` | | +| addons.codeserver.ingress.hosts[0].paths[0].pathType | string | `"Prefix"` | | +| addons.codeserver.ingress.labels | object | `{}` | | +| addons.codeserver.ingress.nameSuffix | string | `"codeserver"` | | +| addons.codeserver.ingress.tls | list | `[]` | | +| addons.codeserver.securityContext.runAsUser | int | `0` | | +| addons.codeserver.service.annotations | object | `{}` | | +| addons.codeserver.service.enabled | bool | `true` | | +| addons.codeserver.service.labels | object | `{}` | | +| addons.codeserver.service.port.name | string | `"codeserver"` | | +| addons.codeserver.service.port.port | int | `12321` | | +| addons.codeserver.service.port.protocol | string | `"TCP"` | | +| addons.codeserver.service.port.targetPort | string | `"codeserver"` | | +| addons.codeserver.service.type | string | `"ClusterIP"` | | +| addons.codeserver.volumeMounts | list | `[]` | | +| addons.codeserver.workingDir | string | `""` | | +| addons.vpn.additionalVolumeMounts | list | `[]` | | +| addons.vpn.configFile | string | `nil` | | +| addons.vpn.enabled | bool | `false` | | +| addons.vpn.env | object | `{}` | | +| addons.vpn.livenessProbe | object | `{}` | | +| addons.vpn.networkPolicy.egress | string | `nil` | | +| addons.vpn.networkPolicy.enabled | bool | `false` | | +| addons.vpn.openvpn.auth | string | `nil` | | +| addons.vpn.openvpn.authSecret | string | `nil` | | +| addons.vpn.openvpn.image.pullPolicy | string | `"IfNotPresent"` | | +| addons.vpn.openvpn.image.repository | string | `"dperson/openvpn-client"` | | +| addons.vpn.openvpn.image.tag | string | `"latest"` | | +| addons.vpn.scripts.down | string | `nil` | | +| addons.vpn.scripts.up | string | `nil` | | +| addons.vpn.securityContext.capabilities.add[0] | string | `"NET_ADMIN"` | | +| addons.vpn.securityContext.capabilities.add[1] | string | `"SYS_MODULE"` | | +| addons.vpn.type | string | `"openvpn"` | | +| addons.vpn.wireguard.image.pullPolicy | string | `"IfNotPresent"` | | +| addons.vpn.wireguard.image.repository | string | `"k8sathome/wireguard"` | | +| addons.vpn.wireguard.image.tag | string | `"1.0.20200827"` | | +| affinity | object | `{}` | | +| args | list | `[]` | | +| command | list | `[]` | | +| controllerAnnotations | object | `{}` | | +| controllerLabels | object | `{}` | | +| controllerType | string | `"deployment"` | | +| dnsPolicy | string | `"ClusterFirst"` | | +| enableServiceLinks | bool | `true` | | +| env | object | `{}` | | +| envFrom | list | `[]` | | +| envTpl | object | `{}` | | +| envValueFrom | object | `{}` | | +| fullnameOverride | string | `""` | | +| hostAliases | list | `[]` | | +| hostNetwork | bool | `false` | | +| ingress.additionalIngresses | list | `[]` | | +| ingress.annotations | object | `{}` | | +| 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 | `"Prefix"` | | +| ingress.labels | object | `{}` | | +| ingress.tls | list | `[]` | | +| initContainers | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/config"` | | +| persistence.config.size | string | `"1Gi"` | | +| persistence.config.skipuninstall | bool | `false` | | +| persistence.shared.emptyDir | bool | `true` | | +| persistence.shared.enabled | bool | `false` | | +| persistence.shared.mountPath | string | `"/shared"` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| probes.liveness.custom | bool | `false` | | +| probes.liveness.enabled | bool | `true` | | +| probes.liveness.spec.failureThreshold | int | `3` | | +| probes.liveness.spec.initialDelaySeconds | int | `0` | | +| probes.liveness.spec.periodSeconds | int | `10` | | +| probes.liveness.spec.timeoutSeconds | int | `1` | | +| probes.readiness.custom | bool | `false` | | +| probes.readiness.enabled | bool | `true` | | +| probes.readiness.spec.failureThreshold | int | `3` | | +| probes.readiness.spec.initialDelaySeconds | int | `0` | | +| probes.readiness.spec.periodSeconds | int | `10` | | +| probes.readiness.spec.timeoutSeconds | int | `1` | | +| probes.startup.custom | bool | `false` | | +| probes.startup.enabled | bool | `true` | | +| probes.startup.spec.failureThreshold | int | `30` | | +| probes.startup.spec.initialDelaySeconds | int | `0` | | +| probes.startup.spec.periodSeconds | int | `5` | | +| probes.startup.spec.timeoutSeconds | int | `1` | | +| replicas | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.additionalPorts | list | `[]` | | +| service.additionalServices | list | `[]` | | +| service.annotations | object | `{}` | | +| service.enabled | bool | `true` | | +| service.labels | object | `{}` | | +| service.port.name | string | `nil` | | +| service.port.port | string | `nil` | | +| service.port.protocol | string | `"TCP"` | | +| service.port.targetPort | string | `nil` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `false` | | +| serviceAccount.name | string | `""` | | +| strategy.type | string | `"RollingUpdate"` | | +| tolerations | list | `[]` | | +| volumeClaimTemplates | list | `[]` | | + +## 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](../common/README.md). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [3.0.1] + +#### Fixed + +- Fixed `kubeVersion` in `Chart.yaml` not working with people running k8s pre-releases +- Added `ingressClassName` to `values.yaml` + +### [3.0.0] + +#### Changed + +- `probes.startupProbe` is now enabled by default. This will allow for quicker `Ready` states on Pods. It will precede the liveness and readiness Probes. *Note:* This requires that you are running [Kubernetes 1.16](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/) +- Aligned our default values for liveness and readiness Probes with the Kubernetes defaults: + - `initialDelaySeconds` is now `0` + - `timeoutSeconds` is now `1` + - `failureThreshold` is now `3` + +### [2.5.1] + +#### Added + +- Fixed a small typo in `values.yaml`: `ingress.tls.hostTpl` -> `ingress.tls.hostsTpl` + +### [2.5.0] + +#### Added + +- Allow setting ingress values through Helm templates: + - `ingress.hosts.hostTpl` + - `ingress.tls.secretNameTpl` + - `ingress.tls.hostsTpl` + +### [2.4.0] + +#### Added + +- Allow setting environment variables from Downward API via `envValueFrom`. See [the Kubernetes docs](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/) for more information. + +### [2.3.0] + +#### Added + +- Allow overriding the main container command. +- Allow setting Helm templates as environment variables via `envTpl`. The given value is parsed through Helm's `tpl` function, allowing for powerful variable substitution. +- Support for defining volumeClaimTemplates for StatefulSet. +- Allow the following Pod spec fields to be configurable: + - `priorityClassName` + - `schedulerName` + - `hostname` + +#### Fixed + +- `values.yaml` now contains the following sections, these were already functional but were previously undocumented: + - `podSecurityContext` + - `securityContext` + - `resources` + +### [2.2.1] + +#### Fixed + +- Made explicit that `service.port.targetPort` cannot be a named port. + +### [2.2.0] + +#### Added + +- Allow serviceLinks to be enabled/disabled. +- Support for ingressClassName on apiVersion `networking.k8s.io/v1` by setting `ingress.ingressClassName`. +- Added some initial proper unit tests for the `common` chart. + +#### Changed + +- `service.port.targetPort` is now used in the container spec instead of `service.port.port` if specified. This allows for different service and container ports. (Implements [#465](https://github.com/k8s-at-home/charts/issues/465)). + +#### Fixed + +- Document setting environment variables for code-server add-on in `values.yaml` (Fixes [#436](https://github.com/k8s-at-home/charts/issues/436)). +- Set service targetPort to the service port name first if no `targetPort` value is given. + +### [2.1.0] + +#### Added + +- Allow for additional arguments to be added to code-server runtime via `addons.codeserver.args` + +### [2.0.4] + +#### Fixed + +- `periodSeconds` now works for all probe types. + +### [2.0.0] + +#### Changed + +- :warning: Updated `probes` logic to support custom probes, it is now possible to set your own custom probes by setting the `probes.[liveness|readiness|startup].custom` value to `true` and configuring them. Default is `false`. +- :warning: `addon.vpn.imagePullPolicy` is now `addon.vpn.[openvpn|wireguard].image.pullPolicy`. Default is `IfNotPresent` +- [code-server](https://github.com/cdr/code-server) is now an `addon` like `vpn`. This enables a code-server container inside the pod which allows you to modify a configuration in a volume attached to the pod. Default for `addons.codeserver.enabled` is `false` +- Added `envFrom` for more configuration with environment variables +- Added `dnsConfig` to be configurable +- Added support for 1.19+ ingress spec +- Added this [CHANGELOG.md](CHANGELOG.md) + +#### Fixed + +- `nameOverride` and `fullNameOverride` not in `values.yaml` + +### [1.7.0] + +This is the last version before starting this changelog. All sorts of cool stuff was changed, but only `git log` remembers what that was :slightly_frowning_face: + +[3.0.1]: #3.0.1 + +[3.0.0]: #3.0.0 + +[2.5.1]: #2.5.1 + +[2.5.0]: #2.5.0 + +[2.4.0]: #2.4.0 + +[2.3.0]: #2.3.0 + +[2.2.1]: #2.2.1 + +[2.2.0]: #2.2.0 + +[2.1.0]: #2.1.0 + +[2.0.4]: #2.0.4 + +[2.0.0]: #2.0.0 + +[1.7.0]: #1.7.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/common/README.md.gotmpl b/charts/common/README.md.gotmpl new file mode 100644 index 00000000..47563133 --- /dev/null +++ b/charts/common/README.md.gotmpl @@ -0,0 +1,147 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**WARNING: THIS CHART IS NOT MEANT TO BE INSTALLED DIRECTLY** + +This is a [Helm Library Chart](https://helm.sh/docs/topics/library_charts/#helm). It's purpose is for grouping common logic between the k8s@home charts. + +Since a lot of charts follow the same pattern this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY. +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/common/CHANGELOG.md b/charts/common/README_CHANGELOG.md.gotmpl similarity index 74% rename from charts/common/CHANGELOG.md rename to charts/common/README_CHANGELOG.md.gotmpl index 3b9434bb..7f384333 100644 --- a/charts/common/CHANGELOG.md +++ b/charts/common/README_CHANGELOG.md.gotmpl @@ -1,19 +1,25 @@ -# Changelog -All notable changes to this project will be documented in this file. +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](../common/README.md). The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [3.0.1] +### [3.0.1] -### Fixed +#### Fixed - Fixed `kubeVersion` in `Chart.yaml` not working with people running k8s pre-releases - Added `ingressClassName` to `values.yaml` -## [3.0.0] +### [3.0.0] -### Changed +#### Changed - `probes.startupProbe` is now enabled by default. This will allow for quicker `Ready` states on Pods. It will precede the liveness and readiness Probes. *Note:* This requires that you are running [Kubernetes 1.16](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/) - Aligned our default values for liveness and readiness Probes with the Kubernetes defaults: @@ -21,30 +27,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `timeoutSeconds` is now `1` - `failureThreshold` is now `3` -## [2.5.1] +### [2.5.1] -### Added +#### Added - Fixed a small typo in `values.yaml`: `ingress.tls.hostTpl` -> `ingress.tls.hostsTpl` -## [2.5.0] +### [2.5.0] -### Added +#### Added - Allow setting ingress values through Helm templates: - `ingress.hosts.hostTpl` - `ingress.tls.secretNameTpl` - `ingress.tls.hostsTpl` -## [2.4.0] +### [2.4.0] -### Added +#### Added - Allow setting environment variables from Downward API via `envValueFrom`. See [the Kubernetes docs](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/) for more information. -## [2.3.0] +### [2.3.0] -### Added +#### Added - Allow overriding the main container command. - Allow setting Helm templates as environment variables via `envTpl`. The given value is parsed through Helm's `tpl` function, allowing for powerful variable substitution. @@ -54,51 +60,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `schedulerName` - `hostname` -### Fixed +#### Fixed - `values.yaml` now contains the following sections, these were already functional but were previously undocumented: - `podSecurityContext` - `securityContext` - `resources` -## [2.2.1] +### [2.2.1] -### Fixed +#### Fixed - Made explicit that `service.port.targetPort` cannot be a named port. -## [2.2.0] +### [2.2.0] -### Added +#### Added - Allow serviceLinks to be enabled/disabled. - Support for ingressClassName on apiVersion `networking.k8s.io/v1` by setting `ingress.ingressClassName`. - Added some initial proper unit tests for the `common` chart. -### Changed +#### Changed - `service.port.targetPort` is now used in the container spec instead of `service.port.port` if specified. This allows for different service and container ports. (Implements [#465](https://github.com/k8s-at-home/charts/issues/465)). -### Fixed +#### Fixed - Document setting environment variables for code-server add-on in `values.yaml` (Fixes [#436](https://github.com/k8s-at-home/charts/issues/436)). - Set service targetPort to the service port name first if no `targetPort` value is given. -## [2.1.0] +### [2.1.0] -### Added +#### Added - Allow for additional arguments to be added to code-server runtime via `addons.codeserver.args` -## [2.0.4] +### [2.0.4] -### Fixed +#### Fixed - `periodSeconds` now works for all probe types. -## [2.0.0] +### [2.0.0] -### Changed +#### Changed - :warning: Updated `probes` logic to support custom probes, it is now possible to set your own custom probes by setting the `probes.[liveness|readiness|startup].custom` value to `true` and configuring them. Default is `false`. - :warning: `addon.vpn.imagePullPolicy` is now `addon.vpn.[openvpn|wireguard].image.pullPolicy`. Default is `IfNotPresent` @@ -108,34 +114,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added support for 1.19+ ingress spec - Added this [CHANGELOG.md](CHANGELOG.md) -### Fixed +#### Fixed - `nameOverride` and `fullNameOverride` not in `values.yaml` -## [1.7.0] +### [1.7.0] This is the last version before starting this changelog. All sorts of cool stuff was changed, but only `git log` remembers what that was :slightly_frowning_face: -[3.0.1]: https://github.com/k8s-at-home/charts/tree/common-3.0.1/charts/common +[3.0.1]: #3.0.1 -[3.0.0]: https://github.com/k8s-at-home/charts/tree/common-3.0.0/charts/common +[3.0.0]: #3.0.0 -[2.5.1]: https://github.com/k8s-at-home/charts/tree/common-2.5.1/charts/common +[2.5.1]: #2.5.1 -[2.5.0]: https://github.com/k8s-at-home/charts/tree/common-2.5.0/charts/common +[2.5.0]: #2.5.0 -[2.4.0]: https://github.com/k8s-at-home/charts/tree/common-2.4.0/charts/common +[2.4.0]: #2.4.0 -[2.3.0]: https://github.com/k8s-at-home/charts/tree/common-2.3.0/charts/common +[2.3.0]: #2.3.0 -[2.2.1]: https://github.com/k8s-at-home/charts/tree/common-2.2.1/charts/common +[2.2.1]: #2.2.1 -[2.2.0]: https://github.com/k8s-at-home/charts/tree/common-2.2.0/charts/common +[2.2.0]: #2.2.0 -[2.1.0]: https://github.com/k8s-at-home/charts/tree/common-2.1.0/charts/common +[2.1.0]: #2.1.0 -[2.0.4]: https://github.com/k8s-at-home/charts/tree/common-2.0.4/charts/common +[2.0.4]: #2.0.4 -[2.0.0]: https://github.com/k8s-at-home/charts/tree/common-2.0.0/charts/common +[2.0.0]: #2.0.0 -[1.7.0]: https://github.com/k8s-at-home/charts/tree/common-1.7.0/charts/common +[1.7.0]: #1.7.0 +{{- end -}} diff --git a/charts/common/README_CONFIG.md.gotmpl b/charts/common/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..4d921964 --- /dev/null +++ b/charts/common/README_CONFIG.md.gotmpl @@ -0,0 +1,82 @@ +{{- define "custom.custom.configuration.header" -}} +## Creating a new chart +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +First be sure to checkout the many charts that already use this like [qBittorrent](../qbittorrent/), [node-red](../node-red/) or the many others in this repository. + +Include this chart as a dependency in your `Chart.yaml` e.g. + +```yaml +# Chart.yaml +dependencies: +- name: common + version: {{ template "chart.version" . }} + repository: {{ template "custom.helm.url" . }} +``` +Write a `values.yaml` with some basic defaults you want to present to the user e.g. + +```yaml +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/charts/tree/master/charts/common/values.yaml +# + +image: + repository: nodered/node-red + pullPolicy: IfNotPresent + tag: 1.2.5 + +strategy: + type: Recreate + +# See more environment variables in the node-red documentation +# https://nodered.org/docs/getting-started/docker +env: {} + # TZ: + # NODE_OPTIONS: + # NODE_RED_ENABLE_PROJECTS: + # NODE_RED_ENABLE_SAFE_MODE: + # FLOWS: + +service: + port: + port: 1880 + +ingress: + enabled: false + +persistence: + data: + enabled: false + emptyDir: false + mountPath: /data +``` + +If not using a service, set the `service.enabled` to `false`. +```yaml +... +service: + enabled: false +... +``` + +Add files to the `templates` folder. +```yaml +# templates/common.yaml +{{"{{"}} include "common.all . {{"}}"}} + +# templates/NOTES.txt +{{"{{"}} include "common.notes.defaultNotes" . {{"}}"}} +``` + +If testing locally make sure you update the dependencies with: + +```bash +helm dependency update +``` +{{- end -}} diff --git a/charts/ddclient/.helmignore b/charts/ddclient/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/ddclient/.helmignore +++ b/charts/ddclient/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/ddclient/README.md b/charts/ddclient/README.md index 99784760..bb862b53 100644 --- a/charts/ddclient/README.md +++ b/charts/ddclient/README.md @@ -1,61 +1,116 @@ # ddclient -This is a helm chart for [ddclient](https://github.com/ddclient/ddclient). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 3.9.1](https://img.shields.io/badge/AppVersion-3.9.1-informational?style=flat-square) + +Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Providers **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/ddclient +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install ddclient k8s-at-home/ddclient ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `ddclient` ```console -helm install --name my-release k8s-at-home/ddclient +helm install ddclient k8s-at-home/ddclient ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `ddclient` deployment ```console -helm delete my-release --purge +helm uninstall ddclient ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/ddclient/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install ddclient \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/ddclient ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install ddclient k8s-at-home/ddclient --values values.yaml +helm install ddclient k8s-at-home/ddclient -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config | string | `"# This is the configuration for ddclient\n# Inorder for it to function you need to set it up\n# e.g. this is the config for Cloudflare\nuse=web\nweb=dynamicdns.park-your-domain.com/getip\nprotocol=cloudflare\nssl=yes\nttl=1\nlogin=${CF_EMAIL}\npassword=${CF_GLOBAL_APIKEY}\nzone=${DOMAIN}.${TLD}\n${DOMAIN}.${TLD}\n"` | | +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/ddclient"` | | +| image.tag | string | `"version-v3.9.1"` | | +| ingress.enabled | bool | `false` | | +| probes.liveness.enabled | bool | `false` | | +| probes.readiness.enabled | bool | `false` | | +| probes.startup.enabled | bool | `false` | | +| service.enabled | bool | `false` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/ddclient/README.md.gotmpl b/charts/ddclient/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/ddclient/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/ddclient/README_CHANGELOG.md.gotmpl b/charts/ddclient/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/ddclient/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/ddclient/README_CONFIG.md.gotmpl b/charts/ddclient/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/ddclient/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/deconz/README.md b/charts/deconz/README.md index d621067a..10d4277f 100644 --- a/charts/deconz/README.md +++ b/charts/deconz/README.md @@ -1,102 +1,82 @@ -# deCONZ helm chart +# deconz -This is a helm chart for [deCONZ](https://www.dresden-elektronik.de/funk/software/deconz.html) based on the [container image provided by marthoc](https://hub.docker.com/r/marthoc/deconz/). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 2.05.80](https://img.shields.io/badge/AppVersion-2.05.80-informational?style=flat-square) -## TL;DR +A Helm chart for deploying deCONZ -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/deconz -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -```shell -helm install my-release k8s-at-home/deconz -``` +## Source Code -## Uninstalling the Chart +* +* -To uninstall/delete the `my-release` deployment: +## Values -```shell -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `1` | | +| autoscaling.minReplicas | int | `1` | | +| extraVolumes | list | `[]` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"marthoc/deconz"` | | +| image.tag | string | `"amd64-2.05.80"` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"deconz.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.annotations | object | `{}` | | +| persistence.enabled | bool | `false` | | +| persistence.size | string | `"1Gi"` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| probes.liveness.enabled | bool | `true` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.initialDelaySeconds | int | `30` | | +| probes.liveness.timeoutSeconds | int | `10` | | +| probes.readiness.enabled | bool | `true` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.initialDelaySeconds | int | `30` | | +| probes.readiness.timeoutSeconds | int | `10` | | +| probes.startup.enabled | bool | `false` | | +| probes.startup.failureThreshold | int | `30` | | +| probes.startup.periodSeconds | int | `10` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext.privileged | bool | `true` | | +| service.clusterIP | string | `""` | | +| service.externalIPs | list | `[]` | | +| service.externalTrafficPolicy | string | `"Local"` | | +| service.httpPort | int | `80` | | +| service.loadBalancerIP | string | `""` | | +| service.type | string | `"ClusterIP"` | | +| service.vncPort | int | `5900` | | +| service.websocketPort | int | `443` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| strategyType | string | `"Recreate"` | | +| timezone | string | `"UTC"` | | +| tolerations | list | `[]` | | +| vnc.enabled | bool | `true` | | +| vnc.existingSecret | string | `""` | | +| vnc.password | string | `"changeme"` | | +| zigbeeDevice.enabled | bool | `false` | | +| zigbeeDevice.hostPath | string | `"/dev/ttyUSB1"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/deconz/values.yaml) file. It has several commented out suggested values. - -| Parameter | Description | Default | -| ------------------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| `replicaCount` | Number of replicas to scale to | `1` | -| `autoscaling.enabled` | Enables Pod auto-scaling | `false` | -| `autoscaling.minReplicas` | Minimum number of replicas to auto-scale to | `1` | -| `autoscaling.maxReplicas` | Maximum number of replicas to auto-scale to | `1` | -| `image.repository` | Image repository | `marthoc/deconz` | -| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/marthoc/deconz/tags/). | `amd64-2.05.79` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `timezone` | Timezone the instance should run as, e.g. 'America/New_York' | `UTC` | -| `zigbeeDevice.enabled` | Enables passing through a Zigbee device | `false` | -| `zigbeeDevice.hostPath` | HostPath of the Zigbee device that should be passed through | `/dev/ttyUSB1` | -| `vnc.enabled` | Enabled the built-in VNC server to access the application | `true` | -| `vnc.password` | VNC server password | `changeme` | -| `vnc.existingSecret` | Existing Kubernetes secret containing the VNC password | `nil` | -| `probes.liveness.enabled` | Enables liveness probe for the Pod | `true` | -| `probes.liveness.failureThreshold` | Specify liveness `failureThreshold` parameter for the Pod | `5` | -| `probes.liveness.initialDelaySeconds` | Specify liveness `initialDelaySeconds` parameter for the Pod | `60` | -| `probes.liveness.timeoutSeconds` | Specify liveness `timeoutSeconds` parameter for the Pod | `10` | -| `probes.readiness.enabled` | Enables readiness probe for the Pod | `true` | -| `probes.readiness.initialDelaySeconds` | Specify readiness `initialDelaySeconds` parameter for the Pod | `60` | -| `probes.readiness.failureThreshold` | Specify readiness `failureThreshold` parameter for the Pod | `5` | -| `probes.readiness.timeoutSeconds` | Specify readiness `timeoutSeconds` parameter for the Pod | `10` | -| `probes.startup.enabled` | Enables startup probe for the Pod | `false` | -| `probes.startup.failureThreshold` | Specify startup `failureThreshold` parameter for the Pod | `30` | -| `probes.startup.timeoutSeconds` | Specify startup `periodSeconds` parameter for the Pod | `10` | -| `service.type` | Kubernetes service type for the GUI | `ClusterIP` | -| `service.httpPort` | Kubernetes port where the GUI is exposed | `80` | -| `service.websocketPort` | Kubernetes port where the Websocket is exposed | `443` | -| `service.vncPort` | Kubernetes port where the VNC server is exposed | `5900` | -| `service.annotations` | Service annotations for the GUI | `{}` | -| `service.labels` | Custom labels | `{}` | -| `service.loadBalancerIP` | Loadbalancer IP for the GUI | `{}` | -| `service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | `nil` | -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.labels` | Custom labels | `{}` | -| `ingress.path` | Ingress path | `/` | -| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `persistence.enabled` | Use persistent volume to store configuration data | `true` | -| `persistence.annotations` | Key-value pairs to add as persistent volume claim annotations | `{}` | -| `persistence.storageClass` | Type of persistent volume claim | `-` | -| `persistence.existingClaim` | Use an existing PVC to persist data | `nil` | -| `persistence.accessMode` | Persistence access mode | `ReadWriteOnce` | -| `persistence.size` | Size of persistent volume claim | `1Gi` | -| `persistence.subPath` | Mount a sub dir of the persistent volume | `nil` | -| `extraVolumes` | Optionally add additional Volumes | `[]` | -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Toleration labels for pod assignment | `[]` | -| `affinity` | Affinity settings for pod assignment | `{}` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install my-release \ - --set timezone="Europe/Amsterdam" \ - k8s-at-home/deconz -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install my-release -f values.yaml k8s-at-home/deconz -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/deluge/.helmignore b/charts/deluge/.helmignore index bb3b20ac..4379e2b3 100644 --- a/charts/deluge/.helmignore +++ b/charts/deluge/.helmignore @@ -19,6 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS -.vscode/ +# helm-docs templates +*.gotmpl diff --git a/charts/deluge/README.md b/charts/deluge/README.md index db78b4f3..ad5c0049 100644 --- a/charts/deluge/README.md +++ b/charts/deluge/README.md @@ -1,57 +1,120 @@ -# Deluge +# deluge -This is a helm chart for [Deluge](https://deluge-torrent.org/). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v2.0.3-2201906121747](https://img.shields.io/badge/AppVersion-v2.0.3--2201906121747-informational?style=flat-square) + +Deluge is a torrent download client **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/deluge +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install deluge k8s-at-home/deluge ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `deluge` ```console -helm install --name my-release k8s-at-home/deluge +helm install deluge k8s-at-home/deluge ``` +## Uninstalling the Chart + +To uninstall the `deluge` deployment + +```console +helm uninstall deluge +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install deluge \ + --set env.TZ="America/New York" \ + k8s-at-home/deluge +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install deluge k8s-at-home/deluge -f values.yaml +``` + +## Custom configuration + The default login details (change ASAP) are: * password:deluge -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/deluge"` | | +| image.tag | string | `"version-2.0.3-2201906121747ubuntu18.04.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/config"` | | +| persistence.downloads.emptyDir | bool | `false` | | +| persistence.downloads.enabled | bool | `false` | | +| persistence.downloads.mountPath | string | `"/downloads"` | | +| service.port.port | int | `8112` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/deluge/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install deluge \ - --set env.TZ="America/New_York" \ - k8s-at-home/deluge -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install deluge k8s-at-home/deluge --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -These values will be nested as it is a dependency, for example -```yaml -image: - tag: ... -``` +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/deluge/README.md.gotmpl b/charts/deluge/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/deluge/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/deluge/README_CHANGELOG.md.gotmpl b/charts/deluge/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/deluge/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/deluge/README_CONFIG.md.gotmpl b/charts/deluge/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..831898cc --- /dev/null +++ b/charts/deluge/README_CONFIG.md.gotmpl @@ -0,0 +1,11 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +The default login details (change ASAP) are: + +* password:deluge +{{- end -}} diff --git a/charts/digitalocean-dyndns/README.md b/charts/digitalocean-dyndns/README.md index 79d2618a..a9dbe0ed 100644 --- a/charts/digitalocean-dyndns/README.md +++ b/charts/digitalocean-dyndns/README.md @@ -1,62 +1,38 @@ -# Dynamic DNS using DigitalOcean's DNS Services +# digitalocean-dyndns -A script that pushes the public IP address of the running machine to DigitalOcean's DNS API's. It requires an existing A record to update. The resulting container image is roughly around 7 MB (thanks to Alpine Linux). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 1.0](https://img.shields.io/badge/AppVersion-1.0-informational?style=flat-square) -## TL;DR; +Dynamic DNS using DigitalOcean's DNS Services -```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/digitalocean-dyndns -``` +**Homepage:** -## Introduction +## Maintainers -This code is adopted from [this original repo](https://github.com/tunix/digitalocean-dyndns) +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -## Installing the Chart +## Source Code -To install the chart with the release name `my-release`: +* +* -```console -$ helm install --name my-release k8s-at-home/digitalocean-dyndns -``` -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| digitialocean.domain | string | `"somedomain"` | | +| digitialocean.name | string | `"@"` | | +| digitialocean.sleep_interval | int | `300` | | +| digitialocean.token | string | `"sometoken"` | | +| image.pullPolicy | string | `"Always"` | | +| image.repository | string | `"tunix/digitalocean-dyndns"` | | +| image.tag | string | `"latest"` | | +| nodeSelector | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| tolerations | list | `[]` | | -```console -$ helm delete my-release --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -| ------------------------------- | ------------------------------- | ---------------------------------------------------------- | -| `image.repository` | digitalocean-dyndns image | `tunix/digitalocean-dyndns` | -| `image.tag` | digitalocean-dyndns image tag | `latest` | -| `image.pullPolicy` | digitalocean-dyndns image pull policy | `Always` | -| `digitialocean.token` | The token you generate in DigitalOcean's API settings. | `` | -| `digitialocean.domain` | The domain your subdomain is registered at. (i.e. foo.com for home.foo.com) | `` | -| `digitialocean.name` | Subdomain to use. (name in A record) (i.e. home for home.foo.com or @ for no subdomain) | `@` | -| `digitialocean.sleep_interval` | Polling time in seconds | `300` | - - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name my-release \ - --set config.digitalocean.token=thisismyapikey \ - k8s-at-home/digitalocean-dyndns -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name my-release -f values.yaml k8s-at-home/digitalocean-dyndns -``` - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/digitalocean-dyndns/values.yaml) file. It has several commented out suggested values. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/dsmr-reader/.helmignore b/charts/dsmr-reader/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/dsmr-reader/.helmignore +++ b/charts/dsmr-reader/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/dsmr-reader/README.md b/charts/dsmr-reader/README.md index f55654d4..dac20a25 100644 --- a/charts/dsmr-reader/README.md +++ b/charts/dsmr-reader/README.md @@ -1,67 +1,122 @@ -# DSMR-reader +# dsmr-reader -This is a helm chart for [DSMR-reader](https://github.com/dsmrreader/dsmr-reader). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v4.9.0](https://img.shields.io/badge/AppVersion-v4.9.0-informational?style=flat-square) + +DSMR-protocol reader, telegram data storage and energy consumption visualizer. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/dsmr-reader +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | postgresql | 10.2.7 | +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install dsmr-reader k8s-at-home/dsmr-reader ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `dsmr-reader` ```console -helm install --name my-release k8s-at-home/dsmr-reader +helm install dsmr-reader k8s-at-home/dsmr-reader ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `dsmr-reader` deployment ```console -helm delete my-release --purge +helm uninstall dsmr-reader ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/dsmr-reader/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install dsmr-reader \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/dsmr-reader ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install dsmr-reader k8s-at-home/dsmr-reader --values values.yaml +helm install dsmr-reader k8s-at-home/dsmr-reader -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env.DJANGO_DATABASE_NAME | string | `"dsmr-reader"` | | +| env.DJANGO_DATABASE_PASSWORD | string | `"dsmr-reader-pass"` | | +| env.DJANGO_DATABASE_PORT | int | `5432` | | +| env.DJANGO_DATABASE_USER | string | `"dsmr-reader"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"xirixiz/dsmr-reader-docker"` | | +| image.tag | string | `"latest-v4.9.0-amd64"` | | +| ingress.enabled | bool | `false` | | +| postgresql.enabled | bool | `false` | | +| postgresql.persistence.enabled | bool | `false` | | +| postgresql.postgresqlDatabase | string | `"dsmr-reader"` | | +| postgresql.postgresqlPassword | string | `"dsmr-reader-pass"` | | +| postgresql.postgresqlUsername | string | `"dsmr-reader"` | | +| securityContext.privileged | bool | `true` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/dsmr-reader/README.md.gotmpl b/charts/dsmr-reader/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/dsmr-reader/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/dsmr-reader/README_CHANGELOG.md.gotmpl b/charts/dsmr-reader/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/dsmr-reader/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/dsmr-reader/README_CONFIG.md.gotmpl b/charts/dsmr-reader/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/dsmr-reader/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/duplicati/README.md b/charts/duplicati/README.md index f5b409db..0d87baef 100644 --- a/charts/duplicati/README.md +++ b/charts/duplicati/README.md @@ -1,109 +1,72 @@ -# Duplicati Backup Client +# duplicati -This is a helm chart for [duplicati](https://github.com/duplicati/duplicati) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/duplicati/) +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v2.0.5.1](https://img.shields.io/badge/AppVersion-v2.0.5.1-informational?style=flat-square) -## TL;DR; +Store securely encrypted backups on cloud storage services! -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/duplicati -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| skaro13 | simon.caron@protonmail.com | | -```console -helm install my-release k8s-at-home/duplicati -``` +## Source Code -## Uninstalling the Chart +* +* -To uninstall/delete the `my-release` deployment: +## Values -```console -helm delete my-release -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| cliArgs | string | `""` | | +| deploymentAnnotations | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/duplicati"` | | +| image.tag | string | `"v2.0.5.1-2.0.5.1_beta_2020-01-18-ls72"` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.labels | object | `{}` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.backups.accessMode | string | `"ReadWriteOnce"` | | +| persistence.backups.enabled | bool | `true` | | +| persistence.backups.size | string | `"1Gi"` | | +| persistence.backups.skipuninstall | bool | `false` | | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.enabled | bool | `true` | | +| persistence.config.size | string | `"1Gi"` | | +| persistence.config.skipuninstall | bool | `false` | | +| persistence.extraExistingClaimMounts | list | `[]` | | +| persistence.source.accessMode | string | `"ReadWriteOnce"` | | +| persistence.source.enabled | bool | `true` | | +| persistence.source.size | string | `"1Gi"` | | +| persistence.source.skipuninstall | bool | `false` | | +| pgid | int | `1001` | | +| podAnnotations | object | `{}` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.initialDelaySeconds | int | `60` | | +| probes.liveness.timeoutSeconds | int | `10` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.initialDelaySeconds | int | `60` | | +| probes.readiness.timeoutSeconds | int | `10` | | +| puid | int | `1001` | | +| resources | object | `{}` | | +| service.annotations | object | `{}` | | +| service.labels | object | `{}` | | +| service.loadBalancerIP | string | `nil` | | +| service.port | int | `8200` | | +| service.type | string | `"ClusterIP"` | | +| strategyType | string | `"Recreate"` | | +| timezone | string | `"UTC"` | | +| tolerations | list | `[]` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -|----------------------------|-------------------------------------|---------------------------------------------------------| -| `image.repository` | Image repository | `linuxserver/duplicati` | -| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/duplicati/tags/).| `v2.0.5.1-2.0.5.1_beta_2020-01-18-ls58`| -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `timezone` | Timezone the duplicati instance should run as, e.g. 'America/New_York' | `UTC` | -| `puid` | process userID the duplicati instance should run as | `1001` | -| `pgid` | process groupID the duplicati instance should run as | `1001` | -| `cliArgs` | optionally specify any CLI variables you want to launch the app with | `nil` | -| `probes.liveness.initialDelaySeconds` | Specify liveness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.liveness.failureThreshold` | Specify liveness `failureThreshold` parameter for the deployment | `5` | -| `probes.liveness.timeoutSeconds` | Specify liveness `timeoutSeconds` parameter for the deployment | `10` | -| `probes.readiness.initialDelaySeconds` | Specify readiness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.readiness.failureThreshold` | Specify readiness `failureThreshold` parameter for the deployment | `5` | -| `probes.readiness.timeoutSeconds` | Specify readiness `timeoutSeconds` parameter for the deployment | `10` | -| `Service.type` | Kubernetes service type for the duplicati GUI | `ClusterIP` | -| `Service.port` | Kubernetes port where the duplicati GUI is exposed| `8200` | -| `Service.annotations` | Service annotations for the duplicati GUI | `{}` | -| `Service.labels` | Custom labels | `{}` | -| `Service.loadBalancerIP` | Loadbalance IP for the duplicati GUI | `{}` | -| `Service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.labels` | Custom labels | `{}` -| `ingress.path` | Ingress path | `/` | -| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `persistence.config.enabled` | Use persistent volume to store configuration data | `true` | -| `persistence.config.size` | Size of persistent volume claim | `1Gi` | -| `persistence.config.existingClaim`| Use an existing PVC to persist data | `nil` | -| `persistence.config.storageClass` | Type of persistent volume claim | `-` | -| `persistence.config.accessMode` | Persistence access mode | `ReadWriteOnce` | -| `persistence.config.skipuninstall` | Do not delete the pvc upon helm uninstall | `false` | -| `persistence.source.enabled` | Use persistent volume to store source data | `true` | -| `persistence.source.size` | Size of persistent volume claim | `10Gi` | -| `persistence.source.existingClaim`| Use an existing PVC to persist data | `nil` | -| `persistence.source.storageClass` | Type of persistent volume claim | `-` | -| `persistence.source.accessMode` | Persistence access mode | `ReadWriteOnce` | -| `persistence.source.skipuninstall` | Do not delete the pvc upon helm uninstall | `false` | -| `persistence.backups.enabled` | Use persistent volume to store backups data | `true` | -| `persistence.backups.size` | Size of persistent volume claim | `10Gi` | -| `persistence.backups.existingClaim`| Use an existing PVC to persist data | `nil` | -| `persistence.backups.storageClass` | Type of persistent volume claim | `-` | -| `persistence.backups.accessMode` | Persistence access mode | `ReadWriteOnce` | -| `persistence.backups.skipuninstall` | Do not delete the pvc upon helm uninstall | `false` | -| `persistence.extraExistingClaimMounts` | Optionally add multiple existing claims | `[]` | -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Toleration labels for pod assignment | `[]` | -| `affinity` | Affinity settings for pod assignment | `{}` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | -| `deploymentAnnotations` | Key-value pairs to add as deployment annotations | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install my-release \ - --set timezone="America/New York" \ - k8s-at-home/duplicati -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install my-release -f values.yaml k8s-at-home/duplicati -``` - ---- -**NOTE** - -If you get `Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. - ---- - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/duplicati/values.yaml) file. It has several commented out suggested values. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/esphome/.helmignore b/charts/esphome/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/esphome/.helmignore +++ b/charts/esphome/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/esphome/README.md b/charts/esphome/README.md index c97f58e5..97372cb8 100644 --- a/charts/esphome/README.md +++ b/charts/esphome/README.md @@ -1,78 +1,114 @@ # esphome -This is a helm chart for [esphome](https://github.com/esphome/esphome). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: 1.15.3](https://img.shields.io/badge/AppVersion-1.15.3-informational?style=flat-square) + +ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/esphome +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install esphome k8s-at-home/esphome ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `esphome` ```console -helm install --name my-release k8s-at-home/esphome +helm install esphome k8s-at-home/esphome ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `esphome` deployment ```console -helm delete my-release --purge +helm uninstall esphome ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/esphome/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install esphome \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/esphome ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install esphome k8s-at-home/esphome --values values.yaml +helm install esphome k8s-at-home/esphome -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"esphome/esphome"` | | +| image.tag | string | `"1.15.3"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `6052` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 2.x.x to 3.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/esphome/README.md.gotmpl b/charts/esphome/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/esphome/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/esphome/README_CHANGELOG.md.gotmpl b/charts/esphome/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/esphome/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/esphome/README_CONFIG.md.gotmpl b/charts/esphome/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/esphome/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/flaresolverr/.helmignore b/charts/flaresolverr/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/flaresolverr/.helmignore +++ b/charts/flaresolverr/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/flaresolverr/README.md b/charts/flaresolverr/README.md index 3377b0e8..76d1069d 100644 --- a/charts/flaresolverr/README.md +++ b/charts/flaresolverr/README.md @@ -1,67 +1,112 @@ -# FlareSolverr +# flaresolverr -This is a helm chart for [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v1.2.3](https://img.shields.io/badge/AppVersion-v1.2.3-informational?style=flat-square) + +FlareSolverr is a proxy server to bypass Cloudflare protection **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/flaresolverr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install flaresolverr k8s-at-home/flaresolverr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `flaresolverr` ```console -helm install --name my-release k8s-at-home/flaresolverr +helm install flaresolverr k8s-at-home/flaresolverr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `flaresolverr` deployment ```console -helm delete my-release --purge +helm uninstall flaresolverr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/flaresolverr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install flaresolverr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/flaresolverr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install flaresolverr k8s-at-home/flaresolverr --values values.yaml +helm install flaresolverr k8s-at-home/flaresolverr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"flaresolverr/flaresolverr"` | | +| image.tag | string | `"v1.2.3"` | | +| ingress.enabled | bool | `false` | | +| service.port.port | int | `8191` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/flaresolverr/README.md.gotmpl b/charts/flaresolverr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/flaresolverr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/flaresolverr/README_CHANGELOG.md.gotmpl b/charts/flaresolverr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/flaresolverr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/flaresolverr/README_CONFIG.md.gotmpl b/charts/flaresolverr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/flaresolverr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/flood/.helmignore b/charts/flood/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/flood/.helmignore +++ b/charts/flood/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/flood/README.md b/charts/flood/README.md index 9e4ef733..49b9cc3e 100644 --- a/charts/flood/README.md +++ b/charts/flood/README.md @@ -1,61 +1,115 @@ # flood -This is a helm chart for [flood](https://github.com/jesec/flood). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 4.1.1](https://img.shields.io/badge/AppVersion-4.1.1-informational?style=flat-square) + +Flood is a monitoring service for various torrent clients **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/flood +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install flood k8s-at-home/flood ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `flood` ```console -helm install --name my-release k8s-at-home/flood +helm install flood k8s-at-home/flood ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `flood` deployment ```console -helm delete my-release --purge +helm uninstall flood ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/flood/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install flood \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/flood ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install flood k8s-at-home/flood --values values.yaml +helm install flood k8s-at-home/flood -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env.FLOOD_OPTION_RUNDIR | string | `"/data"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"jesec/flood"` | | +| image.tag | string | `"4.1.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/data"` | | +| service.port.port | int | `3000` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/flood/README.md.gotmpl b/charts/flood/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/flood/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/flood/README_CHANGELOG.md.gotmpl b/charts/flood/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/flood/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/flood/README_CONFIG.md.gotmpl b/charts/flood/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/flood/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/freshrss/.helmignore b/charts/freshrss/.helmignore index ede8444e..4379e2b3 100644 --- a/charts/freshrss/.helmignore +++ b/charts/freshrss/.helmignore @@ -18,7 +18,9 @@ # Various IDEs .project .idea/ -.vscode/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/freshrss/README.md b/charts/freshrss/README.md index 9e9a098d..11583852 100644 --- a/charts/freshrss/README.md +++ b/charts/freshrss/README.md @@ -1,67 +1,114 @@ -# FreshRSS +# freshrss -This is a helm chart for [FreshRSS](https://github.com/FreshRSS/FreshRSS). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 1.17.0](https://img.shields.io/badge/AppVersion-1.17.0-informational?style=flat-square) + +FreshRSS is a self-hosted RSS feed aggregator **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/freshrss +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install freshrss k8s-at-home/freshrss ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `freshrss` ```console -helm install --name my-release k8s-at-home/freshrss +helm install freshrss k8s-at-home/freshrss ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `freshrss` deployment ```console -helm delete my-release --purge +helm uninstall freshrss ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/freshrss/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install freshrss \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/freshrss ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install freshrss k8s-at-home/freshrss --values values.yaml +helm install freshrss k8s-at-home/freshrss -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/freshrss"` | | +| image.tag | string | `"version-1.17.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/freshrss/README.md.gotmpl b/charts/freshrss/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/freshrss/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/freshrss/README_CHANGELOG.md.gotmpl b/charts/freshrss/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/freshrss/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/freshrss/README_CONFIG.md.gotmpl b/charts/freshrss/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/freshrss/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/gaps/.helmignore b/charts/gaps/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/gaps/.helmignore +++ b/charts/gaps/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/gaps/README.md b/charts/gaps/README.md index cf41ee92..8d09b945 100644 --- a/charts/gaps/README.md +++ b/charts/gaps/README.md @@ -1,67 +1,115 @@ -# Gaps +# gaps -This is a helm chart for [Gaps](https://github.com/JasonHHouse/gaps). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) + +Gaps searches through your Plex Server or local folders for all movies, then queries for known movies in the same collection. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/gaps +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install gaps k8s-at-home/gaps ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `gaps` ```console -helm install --name my-release k8s-at-home/gaps +helm install gaps k8s-at-home/gaps ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `gaps` deployment ```console -helm delete my-release --purge +helm uninstall gaps ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/gaps/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install gaps \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/gaps ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install gaps k8s-at-home/gaps --values values.yaml +helm install gaps k8s-at-home/gaps -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"housewrecker/gaps"` | | +| image.tag | string | `"latest"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/usr/data"` | | +| service.port.port | int | `8484` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/gaps/README.md.gotmpl b/charts/gaps/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/gaps/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/gaps/README_CHANGELOG.md.gotmpl b/charts/gaps/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/gaps/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/gaps/README_CONFIG.md.gotmpl b/charts/gaps/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/gaps/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/gonic/.helmignore b/charts/gonic/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/gonic/.helmignore +++ b/charts/gonic/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/gonic/README.md b/charts/gonic/README.md index 20a0b92c..52948085 100644 --- a/charts/gonic/README.md +++ b/charts/gonic/README.md @@ -1,67 +1,121 @@ -# Gonic +# gonic -This is a helm chart for [Gonic](https://github.com/sentriz/gonic). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: v0.12.0](https://img.shields.io/badge/AppVersion-v0.12.0-informational?style=flat-square) + +Music streaming server / subsonic server API implementation **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/gonic +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install gonic k8s-at-home/gonic ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `gonic` ```console -helm install --name my-release k8s-at-home/gonic +helm install gonic k8s-at-home/gonic ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `gonic` deployment ```console -helm delete my-release --purge +helm uninstall gonic ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/gonic/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install gonic \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/gonic ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install gonic k8s-at-home/gonic --values values.yaml +helm install gonic k8s-at-home/gonic -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"sentriz/gonic"` | | +| image.tag | string | `"v0.12.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.cache.emptyDir | bool | `false` | | +| persistence.cache.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.music.emptyDir | bool | `false` | | +| persistence.music.enabled | bool | `false` | | +| persistence.music.mountPath | string | `"/music"` | | +| persistence.podcasts.emptyDir | bool | `false` | | +| persistence.podcasts.enabled | bool | `false` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/gonic/README.md.gotmpl b/charts/gonic/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/gonic/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/gonic/README_CHANGELOG.md.gotmpl b/charts/gonic/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/gonic/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/gonic/README_CONFIG.md.gotmpl b/charts/gonic/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/gonic/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/grocy/.helmignore b/charts/grocy/.helmignore index fcf9212f..4379e2b3 100644 --- a/charts/grocy/.helmignore +++ b/charts/grocy/.helmignore @@ -19,6 +19,8 @@ .project .idea/ *.tmproj -.vscode +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/grocy/README.md b/charts/grocy/README.md index 7e6cd752..ea70e25b 100644 --- a/charts/grocy/README.md +++ b/charts/grocy/README.md @@ -1,69 +1,114 @@ # grocy -This is a helm chart for [grocy](https://grocy.info/). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: v2.7.1](https://img.shields.io/badge/AppVersion-v2.7.1-informational?style=flat-square) + +ERP beyond your fridge - grocy is a web-based self-hosted groceries & household management solution for your home **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/grocy +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install grocy k8s-at-home/grocy ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `grocy` ```console -helm install --name my-release k8s-at-home/grocy +helm install grocy k8s-at-home/grocy ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `grocy` deployment ```console -helm delete my-release --purge +helm uninstall grocy ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/grocy/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install grocy \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/grocy ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install grocy k8s-at-home/grocy --values values.yaml +helm install grocy k8s-at-home/grocy -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/grocy"` | | +| image.tag | string | `"version-v2.7.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -Refer to the library values.yaml for more configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/grocy/README.md.gotmpl b/charts/grocy/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/grocy/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/grocy/README_CHANGELOG.md.gotmpl b/charts/grocy/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/grocy/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/grocy/README_CONFIG.md.gotmpl b/charts/grocy/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/grocy/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/heimdall/.helmignore b/charts/heimdall/.helmignore index fcf9212f..4379e2b3 100644 --- a/charts/heimdall/.helmignore +++ b/charts/heimdall/.helmignore @@ -19,6 +19,8 @@ .project .idea/ *.tmproj -.vscode +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/heimdall/README.md b/charts/heimdall/README.md index bd64ccc9..b9ade0d9 100644 --- a/charts/heimdall/README.md +++ b/charts/heimdall/README.md @@ -1,69 +1,115 @@ # heimdall -This is a helm chart for [heimdall](https://github.com/heimdall/heimdall). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: 2.2.2](https://img.shields.io/badge/AppVersion-2.2.2-informational?style=flat-square) + +An Application dashboard and launcher **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/heimdall +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install heimdall k8s-at-home/heimdall ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `heimdall` ```console -helm install --name my-release k8s-at-home/heimdall +helm install heimdall k8s-at-home/heimdall ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `heimdall` deployment ```console -helm delete my-release --purge +helm uninstall heimdall ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/heimdall/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install heimdall \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/heimdall ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install heimdall k8s-at-home/heimdall --values values.yaml +helm install heimdall k8s-at-home/heimdall -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/heimdall"` | | +| image.tag | string | `"version-2.2.2"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| probes.startup.enabled | bool | `true` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -Refer to the library values.yaml for more configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/heimdall/README.md.gotmpl b/charts/heimdall/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/heimdall/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/heimdall/README_CHANGELOG.md.gotmpl b/charts/heimdall/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/heimdall/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/heimdall/README_CONFIG.md.gotmpl b/charts/heimdall/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/heimdall/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/home-assistant/.helmignore b/charts/home-assistant/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/home-assistant/.helmignore +++ b/charts/home-assistant/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/home-assistant/README.md b/charts/home-assistant/README.md index 8fd4ff90..2b0f5ed0 100644 --- a/charts/home-assistant/README.md +++ b/charts/home-assistant/README.md @@ -1,28 +1,71 @@ -# Home Assistant +# home-assistant -This is a helm chart for [Home Assistant](https://www.home-assistant.io/). +![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![AppVersion: 2021.1.5](https://img.shields.io/badge/AppVersion-2021.1.5-informational?style=flat-square) + +Home Assistant **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/home-assistant +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | influxdb | 1.1.9 | +| https://charts.bitnami.com/bitnami | mariadb | 9.2.5 | +| https://charts.bitnami.com/bitnami | postgresql | 10.2.7 | +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install home-assistant k8s-at-home/home-assistant ``` -## :star2: Changelog - -Please refer to [CHANGELOG.md](CHANGELOG.md) for an overview of notable changes to the chart. **This is especially important for major version updates!** - ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `home-assistant` ```console -helm install --name my-release k8s-at-home/home-assistant +helm install home-assistant k8s-at-home/home-assistant ``` +## Uninstalling the Chart + +To uninstall the `home-assistant` deployment + +```console +helm uninstall home-assistant +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install home-assistant \ + --set env.TZ="America/New York" \ + k8s-at-home/home-assistant +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install home-assistant k8s-at-home/home-assistant -f values.yaml +``` + +## Custom configuration + ### Z-Wave / Zigbee A Z-Wave and/or Zigbee controller device could be used with Home Assistant if passed through from the host to the pod. Skip this section if you are using zwave2mqtt and/or zigbee2mqtt or plan to. @@ -71,59 +114,119 @@ ingress: The value derived is the name of the kubernetes service object for home-assistant -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| git.deployKey | string | `""` | | +| git.deployKeyBase64 | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"homeassistant/home-assistant"` | | +| image.tag | string | `"2021.1.5"` | | +| influxdb.architecture | string | `"standalone"` | | +| influxdb.authEnabled | bool | `false` | | +| influxdb.database | string | `"home_assistant"` | | +| influxdb.enabled | bool | `false` | | +| influxdb.persistence.enabled | bool | `false` | | +| ingress.enabled | bool | `false` | | +| mariadb.architecture | string | `"standalone"` | | +| mariadb.auth.database | string | `"home-assistant"` | | +| mariadb.auth.password | string | `"home-assistant-pass"` | | +| mariadb.auth.rootPassword | string | `"home-assistantrootpass"` | | +| mariadb.auth.username | string | `"home-assistant"` | | +| mariadb.enabled | bool | `false` | | +| mariadb.primary.persistence.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| postgresql.enabled | bool | `false` | | +| postgresql.persistence.enabled | bool | `false` | | +| postgresql.postgresqlDatabase | string | `"home-assistant"` | | +| postgresql.postgresqlPassword | string | `"home-assistant-pass"` | | +| postgresql.postgresqlUsername | string | `"home-assistant"` | | +| prometheus.serviceMonitor.enabled | bool | `false` | | +| service.port.port | int | `8123` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/home-assistant/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +All notable changes to this project will be documented in this file. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install my-release \ - --set env.TZ="America/New_York" \ - k8s-at-home/home-assistant -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install my-release k8s-at-home/home-assistant --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -```yaml -image: - tag: ... -``` +## [5.0.0] ---- -**NOTE** +### Changed -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +- Migrated chart over to our common library, this version introduces breaking changes. Be sure to back up your config volume incase something goes wrong. +- Upgraded `home-assistant` container image to `2020.12.1` +- Upgraded `postgresql` subchart from version 10.1.3 to version 10.2.0. +- Upgraded `influxdb` subchart from version 1.1.2 to version 1.1.4. +- Upgraded `mariadb` subchart from version 9.1.2 to version 9.1.4 ---- +## [4.0.0] -## Upgrading an existing Release to a new major version +### Changed -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +- Bumped bitnami/mariadb to 9.1.2 in chart deps -### Upgrading from 4.x.x to 5.x.x +### Removed -As of 5.0.0 this chart was migrated to a centralized [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library, some values in `values.yaml` have changed. +- Appdaemon sidecar was removed and replaced by it's own chart at [charts/appdaemon](https://github.com/k8s-at-home/charts/tree/master/charts/appdaemon) +- Configurator sidecar was removed in favor of the `code-server` sidecar. One configure sidecar to rule them all! -Examples: +## [3.1.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +### Changed -Refer to the [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library for more configuration options. +- Fixed issue in default postgresql configuration. +- Bumped bitnami/postgresql to 10.1.1 in chart deps + +## [3.0.0] + +Any pre-existing StatefulSet will have to be removed before upgrading due to a name change in the chart. + +### Changed + +- The default `home-assistant` image has been updated to v0.118.3. +- The default `vscode` image has been updated to 3.7.2 +- :warning: Upgraded `influxdb` subchart from version 0.6.7 to version 1.0.0. +- :warning: Upgraded `postgresql` subchart from version 9.1.2 to version 10.1.0. + This is a major version update, [requiring changes](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#to-1000) in your `values.yaml` if you use it! +- :warning: Upgraded `mariadb` subchart from version 7.7.1 to version 9.0.1. + This is a major version update, [requiring changes](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#to-900) in your `values.yaml` if you use it! + +### Removed + +- Subchart support for `esphome` was removed as it is really a separate application and integration was only limited to sharing a secrets file. + +### Fixed + +- Fixed some formatting errors that were causing the pipeline to fail. + +## [2.7.0] + +This is the last version before starting this changelog. All sorts of cool stuff was changed, but only `git log` remembers what that was :slightly_frowning_face: + +[5.0.0]: https://github.com/k8s-at-home/charts/tree/home-assistant-5.0.0/charts/home-assistant + +[4.0.0]: https://github.com/k8s-at-home/charts/tree/home-assistant-4.0.0/charts/home-assistant + +[3.1.0]: https://github.com/k8s-at-home/charts/tree/home-assistant-3.1.0/charts/home-assistant + +[3.0.0]: https://github.com/k8s-at-home/charts/tree/home-assistant-3.0.0/charts/home-assistant + +[2.7.0]: https://github.com/k8s-at-home/charts/tree/home-assistant-2.7.0/charts/home-assistant + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/home-assistant/README.md.gotmpl b/charts/home-assistant/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/home-assistant/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/home-assistant/CHANGELOG.md b/charts/home-assistant/README_CHANGELOG.md.gotmpl similarity index 94% rename from charts/home-assistant/CHANGELOG.md rename to charts/home-assistant/README_CHANGELOG.md.gotmpl index e2c71c91..922b700a 100644 --- a/charts/home-assistant/CHANGELOG.md +++ b/charts/home-assistant/README_CHANGELOG.md.gotmpl @@ -1,4 +1,10 @@ -# Changelog +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -67,3 +73,4 @@ This is the last version before starting this changelog. All sorts of cool stuff [3.0.0]: https://github.com/k8s-at-home/charts/tree/home-assistant-3.0.0/charts/home-assistant [2.7.0]: https://github.com/k8s-at-home/charts/tree/home-assistant-2.7.0/charts/home-assistant +{{- end -}} diff --git a/charts/home-assistant/README_CONFIG.md.gotmpl b/charts/home-assistant/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..3cc844d8 --- /dev/null +++ b/charts/home-assistant/README_CONFIG.md.gotmpl @@ -0,0 +1,55 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +### Z-Wave / Zigbee + +A Z-Wave and/or Zigbee controller device could be used with Home Assistant if passed through from the host to the pod. Skip this section if you are using zwave2mqtt and/or zigbee2mqtt or plan to. + +First you will need to mount your Z-Wave and/or Zigbee device into the pod, you can do so by adding the following to your values: + +```yaml +additionalVolumeMounts: + - name: zwave-usb + mountPath: /path/to/device + +additionalVolumes: + - name: zwave-usb + hostPath: + path: /path/to/device +``` + +Second you will need to set a nodeAffinity rule, for example: + +```yaml +affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: app + operator: In + values: + - zwave-controller +``` + +... where a node with an attached zwave and/or zigbee controller USB device is labeled with `app: zwave-controller` + +### Websockets + +If an ingress controller is being used with home assistant, web sockets must be enabled using annotations to enable support of web sockets. + +Using NGINX as an example the following will need to be added to your values: + +```yaml +ingress: + enabled: true + annotations: + nginx.org/websocket-services: home-assistant +``` + +The value derived is the name of the kubernetes service object for home-assistant +{{- end -}} diff --git a/charts/homebridge/README.md b/charts/homebridge/README.md index bbe50f50..a5289aca 100644 --- a/charts/homebridge/README.md +++ b/charts/homebridge/README.md @@ -1,100 +1,75 @@ -# Homebridge +# homebridge -This is a helm chart for [Homebridge](https://homebridge.io) based on [Docker Homebridge](https://github.com/oznu/docker-homebridge). +![Version: 1.0.2](https://img.shields.io/badge/Version-1.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.1.0](https://img.shields.io/badge/AppVersion-3.1.0-informational?style=flat-square) -## TL;DR; +A lightweight NodeJS server that emulates the iOS HomeKit API -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/homebridge -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| bjw-s | bjw-s@users.noreply.github.com | | -```shell -helm install --name my-release k8s-at-home/homebridge -``` +## Source Code -## Uninstalling the Chart +* +* -To uninstall/delete the `my-release` deployment: +## Values -```shell -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| config.additionalPackages | list | `[]` | | +| config.enableUI | bool | `true` | | +| config.plugins | list | `[]` | | +| extraEnvs | list | `[]` | | +| fullnameOverride | string | `""` | | +| hostNetwork | bool | `false` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"oznu/homebridge"` | | +| image.tag | string | `"3.1.0"` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.enabled | bool | `true` | | +| persistence.size | string | `"1Gi"` | | +| persistence.skipuninstall | bool | `false` | | +| pgid | int | `1000` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| probes.liveness.enabled | bool | `true` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.initialDelaySeconds | int | `60` | | +| probes.liveness.timeoutSeconds | int | `10` | | +| probes.readiness.enabled | bool | `true` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.initialDelaySeconds | int | `60` | | +| probes.readiness.timeoutSeconds | int | `10` | | +| probes.startup.enabled | bool | `false` | | +| probes.startup.failureThreshold | int | `30` | | +| probes.startup.periodSeconds | int | `10` | | +| puid | int | `1000` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.homebridgePort | int | `51826` | | +| service.httpPort | int | `8080` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| strategyType | string | `"Recreate"` | | +| timezone | string | `"UTC"` | | +| tolerations | list | `[]` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Home Assistant chart and their default values. - -| Parameter | Description | Default | -| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| `image.repository` | Image repository | `oznu/homebridge` | -| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/oznu/homebridge/tags). | `3.1.0` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `image.pullSecrets` | Secrets to use when pulling the image | `[]` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `timezone` | Specify the container timezone | `UTC` | -| `puid` | process userID the instance should run as | `1000` | -| `pgid` | process groupID the instance should run as | `1000` | -| `config.enableUI` | Enable the Homebridge UI plugin | `true` | -| `config.plugins` | Additional Homebridge plugins to install at container startup | `[]` | -| `config.additionalPackages` | Additional Alpine packages to install at container statup | `[] ` | -| `probes.liveness.enabled` | Use the livenessProbe? | `true` | -| `probes.liveness.initialDelaySeconds` | Specify liveness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.liveness.failureThreshold` | Specify liveness `failureThreshold` parameter for the deployment | `5` | -| `probes.liveness.timeoutSeconds` | Specify liveness `timeoutSeconds` parameter for the deployment | `10` | -| `probes.readiness.enabled` | Use the readinessProbe? | `true` | -| `probes.readiness.initialDelaySeconds` | Specify readiness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.readiness.failureThreshold` | Specify readiness `failureThreshold` parameter for the deployment | `5` | -| `probes.readiness.timeoutSeconds` | Specify readiness `timeoutSeconds` parameter for the deployment | `10` | -| `probes.startup.enabled` | Use the startupProbe? (new in kubernetes 1.16) | `false` | -| `probes.startup.failureThreshold` | Specify startup `failureThreshold` parameter for the deployment | `5` | -| `probes.startup.periodSeconds` | Specify startup `periodSeconds` parameter for the deployment | `10` | -| `service.type` | Kubernetes service type for the homebridge GUI | `ClusterIP` | -| `service.httpPort` | Kubernetes port where the homebridge GUI is exposed | `8123` | -| `service.annotations` | Service annotations for the homebridge GUI | `{}` | -| `service.clusterIP` | Cluster IP for the homebridge GUI | `` | -| `service.externalIPs` | External IPs for the homebridge GUI | `[]` | -| `service.loadBalancerIP` | Loadbalancer IP for the homebridge GUI | `` | -| `service.loadBalancerSourceRanges` | Loadbalancer client IP restriction range for the homebridge GUI | `[]` | -| `service.externalTrafficPolicy` | Loadbalancer externalTrafficPolicy | `` | -| `hostNetwork` | Enable hostNetwork - needed for discovery to work | `false` | -| `service.nodePort` | nodePort to listen on for the homebridge GUI | `` | -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.path` | Ingress path | `/` | -| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `persistence.enabled` | Use persistent volume to store data | `true` | -| `persistence.size` | Size of persistent volume claim | `1Gi` | -| `persistence.existingClaim` | Use an existing PVC to persist data | `nil` | -| `persistence.storageClass` | Type of persistent volume claim | `-` | -| `persistence.accessMode` | Persistence access modes | `ReadWriteMany` | -| `persistence.skipuninstall` | Do not delete the pvc upon helm uninstall | `false` | -| `extraEnvs` | Extra ENV vars to pass to the homebridge container | `[]` | -| `resources` | CPU/Memory resource requests/limits or the homebridge GUI | `{}` | -| `nodeSelector` | Node labels for pod assignment or the homebridge GUI | `{}` | -| `tolerations` | Toleration labels for pod assignment or the homebridge GUI | `[]` | -| `affinity` | Affinity settings for pod assignment or the homebridge GUI | `{}` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```shell -helm install --name my-release \ - --set timezone="UTC" \ - k8s-at-home/homebridge -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```shell -helm install --name my-release -f values.yaml k8s-at-home/homebridge -``` - -Read through the [values.yaml](values.yaml) file. It has several commented out suggested values. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/homer/.helmignore b/charts/homer/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/homer/.helmignore +++ b/charts/homer/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/homer/README.md b/charts/homer/README.md index e951daf4..9ed2f3e6 100644 --- a/charts/homer/README.md +++ b/charts/homer/README.md @@ -1,61 +1,115 @@ # homer -This is a helm chart for [homer](https://github.com/bastienwirtz/homer). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 20.09.1](https://img.shields.io/badge/AppVersion-20.09.1-informational?style=flat-square) + +A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/homer +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install homer k8s-at-home/homer ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `homer` ```console -helm install --name my-release k8s-at-home/homer +helm install homer k8s-at-home/homer ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `homer` deployment ```console -helm delete my-release --purge +helm uninstall homer ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/homer/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install homer \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/homer ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install homer k8s-at-home/homer --values values.yaml +helm install homer k8s-at-home/homer -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"b4bz/homer"` | | +| image.tag | string | `"20.09.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/www/assets"` | | +| service.port.port | int | `8080` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/homer/README.md.gotmpl b/charts/homer/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/homer/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/homer/README_CHANGELOG.md.gotmpl b/charts/homer/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/homer/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/homer/README_CONFIG.md.gotmpl b/charts/homer/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/homer/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/hyperion-ng/.helmignore b/charts/hyperion-ng/.helmignore index ede8444e..4379e2b3 100644 --- a/charts/hyperion-ng/.helmignore +++ b/charts/hyperion-ng/.helmignore @@ -18,7 +18,9 @@ # Various IDEs .project .idea/ -.vscode/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/hyperion-ng/README.md b/charts/hyperion-ng/README.md index 4e7f996b..313cc1ed 100644 --- a/charts/hyperion-ng/README.md +++ b/charts/hyperion-ng/README.md @@ -1,67 +1,127 @@ -# Radarr +# hyperion-ng -This is a helm chart for [Hyperion.ng](https://github.com/hyperion-project/hyperion.ng). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 2.0.0-alpha9](https://img.shields.io/badge/AppVersion-2.0.0--alpha9-informational?style=flat-square) + +Hyperion is an opensource Bias or Ambient Lighting implementation **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/hyperion-ng +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install hyperion-ng k8s-at-home/hyperion-ng ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `hyperion-ng` ```console -helm install --name my-release k8s-at-home/hyperion-ng +helm install hyperion-ng k8s-at-home/hyperion-ng ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `hyperion-ng` deployment ```console -helm delete my-release --purge +helm uninstall hyperion-ng ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/hyperion-ng/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install hyperion-ng \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/hyperion-ng ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install hyperion-ng k8s-at-home/hyperion-ng --values values.yaml +helm install hyperion-ng k8s-at-home/hyperion-ng -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"sirfragalot/hyperion.ng"` | | +| image.tag | string | `"2.0.0-alpha.9-x86_64"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/root/.hyperion"` | | +| service.additionalPorts[0].name | string | `"jsonservice"` | | +| service.additionalPorts[0].port | int | `19444` | | +| service.additionalPorts[0].protocol | string | `"TCP"` | | +| service.additionalPorts[0].targetPort | int | `19444` | | +| service.additionalPorts[1].name | string | `"protobufservice"` | | +| service.additionalPorts[1].port | int | `19445` | | +| service.additionalPorts[1].protocol | string | `"TCP"` | | +| service.additionalPorts[1].targetPort | int | `19445` | | +| service.additionalPorts[2].name | string | `"boblightservice"` | | +| service.additionalPorts[2].port | int | `19333` | | +| service.additionalPorts[2].protocol | string | `"TCP"` | | +| service.additionalPorts[2].targetPort | int | `19333` | | +| service.port.port | int | `8090` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/hyperion-ng/README.md.gotmpl b/charts/hyperion-ng/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/hyperion-ng/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/hyperion-ng/README_CHANGELOG.md.gotmpl b/charts/hyperion-ng/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/hyperion-ng/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/hyperion-ng/README_CONFIG.md.gotmpl b/charts/hyperion-ng/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/hyperion-ng/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/icantbelieveitsnotvaletudo/README.md b/charts/icantbelieveitsnotvaletudo/README.md index 5c6671ea..416f7599 100644 --- a/charts/icantbelieveitsnotvaletudo/README.md +++ b/charts/icantbelieveitsnotvaletudo/README.md @@ -1,46 +1,62 @@ -# I can't belive it's not Valetudo +# icantbelieveitsnotvaletudo -Map generation companion service for [Valetudo](https://valetudo.cloud/) +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.0](https://img.shields.io/badge/AppVersion-0.3.0-informational?style=flat-square) -## TL;DR; +Create live map data from Valetudo powered robots -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/icantbelieveitsnotvaletudo -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| ishioni | helm@movishell.pl | | -```console -helm install --name my-release k8s-at-home/icantbelieveitsnotvaletudo -``` +## Source Code -## Uninstalling the Chart +* -To uninstall/delete the `my-release` deployment: +## Values -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| config.mapsettings.drawCharger | bool | `true` | | +| config.mapsettings.drawPath | bool | `true` | | +| config.mapsettings.drawRobot | bool | `true` | | +| config.mapsettings.scale | int | `4` | | +| config.mqtt.autoconfPrefix | string | `"homeassistant"` | | +| config.mqtt.broker_url | string | `"mqtt://user:pass@example.com:port"` | | +| config.mqtt.identifier | string | `"rockrobo"` | | +| config.mqtt.mapDataTopic | string | `"valetudo/rockrobo/map_data"` | | +| config.mqtt.minMillisecondsBetweenMapUpdates | int | `10000` | | +| config.mqtt.publishMapImage | bool | `true` | | +| config.mqtt.topicPrefix | string | `"valetudo"` | | +| config.webserver.enabled | bool | `false` | | +| config.webserver.port | int | `3000` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"pmaksymiuk/icantbelieveitsnotvaletudo"` | | +| image.tag | string | `nil` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths | list | `[]` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `80` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/icantbelieveitsnotvaletudo/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name my-release \ - --set config.mqtt.broker_url="mqtt://mymqttbroker" \ - k8s-at-home/icantbelieveitsnotvaletudo -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name my-release -f values.yaml k8s-at-home/icantbelieveitsnotvaletudo -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/intel-gpu-plugin/README.md b/charts/intel-gpu-plugin/README.md index 86f1ef89..ac38c191 100644 --- a/charts/intel-gpu-plugin/README.md +++ b/charts/intel-gpu-plugin/README.md @@ -1,73 +1,41 @@ -# intel-gpu-plugin helm chart +# intel-gpu-plugin -This is a helm chart that will deploy [intel-gpu-plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/master/cmd/gpu_plugin) as a DaemonSet. +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 0.18.1](https://img.shields.io/badge/AppVersion-0.18.1-informational?style=flat-square) -The GPU plugin facilitates offloading the processing of computation intensive workloads to GPU hardware. +The Intel GPU plugin facilitates offloading the processing of computation intensive workloads to GPU hardware -## TL;DR +**Homepage:** -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/intel-gpu-plugin -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `my-release`: +## Source Code -```shell -helm install my-release k8s-at-home/intel-gpu-plugin -``` +* -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"intel/intel-gpu-plugin"` | | +| image.tag | string | `"0.18.1"` | | +| imagePullSecrets | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | -```shell -helm delete my-release --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/intel-gpu-plugin/values.yaml) file. It has several commented out suggested values. - -| Parameter | Description | Default | -| ------------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `image.repository` | Image repository | `intel/intel-gpu-plugin` | -| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/intel/intel-gpu-plugin/tags). | `0.18.1` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```shell -helm install my-release \ - --set image.pullPolicy="Always" \ - k8s-at-home/intel-gpu-plugin -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```shell -helm install my-release -f values.yaml k8s-at-home/intel-gpu-plugin -``` - -### Node Feature Discovery - -If your cluster runs [Node Feature Discovery](https://github.com/k8s-at-home/charts/blob/master/charts/node-feature-discovery), you can deploy the device plugin only on nodes with Intel GPU by specifying the desired `nodeSelector` or `affinity` in your values. For example (make sure to update to your exact feature label): - -```yaml -affinity: - nodeAffinity: - requiredDuringSchedulingIgnoredDuringExecution: - nodeSelectorTerms: - - matchExpressions: - - key: feature.node.kubernetes.io/pci-0300_8086.present - operator: In - values: - - "true" -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/jackett/.helmignore b/charts/jackett/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/jackett/.helmignore +++ b/charts/jackett/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/jackett/README.md b/charts/jackett/README.md index 944bdc75..afb2142b 100644 --- a/charts/jackett/README.md +++ b/charts/jackett/README.md @@ -1,78 +1,117 @@ -# Jackett +# jackett -This is a helm chart for [Jackett](https://github.com/Jackett/Jackett). +![Version: 7.0.1](https://img.shields.io/badge/Version-7.0.1-informational?style=flat-square) ![AppVersion: v0.16.2106](https://img.shields.io/badge/AppVersion-v0.16.2106-informational?style=flat-square) + +API Support for your favorite torrent trackers **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/jackett +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install jackett k8s-at-home/jackett ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `jackett` ```console -helm install --name my-release k8s-at-home/jackett +helm install jackett k8s-at-home/jackett ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `jackett` deployment ```console -helm delete my-release --purge +helm uninstall jackett ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/jackett/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install jackett \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/jackett ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install jackett k8s-at-home/jackett --values values.yaml +helm install jackett k8s-at-home/jackett -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/jackett"` | | +| image.tag | string | `"version-v0.16.2106"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.torrentblackhole.emptyDir | bool | `false` | | +| persistence.torrentblackhole.enabled | bool | `false` | | +| persistence.torrentblackhole.mountPath | string | `"/downloads"` | | +| service.port.port | int | `9117` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 4.x.x to 5.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/jackett/README.md.gotmpl b/charts/jackett/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/jackett/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/jackett/README_CHANGELOG.md.gotmpl b/charts/jackett/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/jackett/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/jackett/README_CONFIG.md.gotmpl b/charts/jackett/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/jackett/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/jellyfin/.helmignore b/charts/jellyfin/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/jellyfin/.helmignore +++ b/charts/jellyfin/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/jellyfin/README.md b/charts/jellyfin/README.md index 62843aca..59f654d8 100644 --- a/charts/jellyfin/README.md +++ b/charts/jellyfin/README.md @@ -1,79 +1,116 @@ -# Jellyfin +# jellyfin -This is a helm chart for [Jellyfin](https://github.com/jellyfin/jellyfin). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: 10.6.4](https://img.shields.io/badge/AppVersion-10.6.4-informational?style=flat-square) + +Jellyfin is a Free Software Media System **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/jellyfin +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install jellyfin k8s-at-home/jellyfin ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `jellyfin` ```console -helm install --name my-release k8s-at-home/jellyfin +helm install jellyfin k8s-at-home/jellyfin ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `jellyfin` deployment ```console -helm delete my-release --purge +helm uninstall jellyfin ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/jellyfin/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install jellyfin \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/jellyfin ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install jellyfin k8s-at-home/jellyfin --values values.yaml +helm install jellyfin k8s-at-home/jellyfin -f values.yaml ``` -These values will be nested as it is a dependency, for example -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/jellyfin"` | | +| image.tag | string | `"version-10.6.4-1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `8096` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 2.x.x to 3.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/jellyfin/README.md.gotmpl b/charts/jellyfin/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/jellyfin/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/jellyfin/README_CHANGELOG.md.gotmpl b/charts/jellyfin/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/jellyfin/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/jellyfin/README_CONFIG.md.gotmpl b/charts/jellyfin/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/jellyfin/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/lazylibrarian/.helmignore b/charts/lazylibrarian/.helmignore index 0e8a0eb3..4379e2b3 100644 --- a/charts/lazylibrarian/.helmignore +++ b/charts/lazylibrarian/.helmignore @@ -14,10 +14,13 @@ *.swp *.bak *.tmp -*.orig *~ # Various IDEs .project .idea/ *.tmproj .vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/lazylibrarian/README.md b/charts/lazylibrarian/README.md index e043979a..d10724da 100644 --- a/charts/lazylibrarian/README.md +++ b/charts/lazylibrarian/README.md @@ -1,81 +1,117 @@ -# LazyLibrarian +# lazylibrarian -This is a helm chart for [LazyLibrarian](https://gitlab.com/LazyLibrarian/LazyLibrarian.git). +![Version: 4.0.1](https://img.shields.io/badge/Version-4.0.1-informational?style=flat-square) ![AppVersion: 1.7.2](https://img.shields.io/badge/AppVersion-1.7.2-informational?style=flat-square) + +A Helm chart for deploying LazyLibrarian **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + ## TL;DR -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/lazylibrarian +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install lazylibrarian k8s-at-home/lazylibrarian ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `lazylibrarian` ```console -helm install --name my-release k8s-at-home/lazylibrarian +helm install lazylibrarian k8s-at-home/lazylibrarian ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `lazylibrarian` deployment ```console -helm delete my-release --purge +helm uninstall lazylibrarian ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/lazylibrarian/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install lazylibrarian \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/lazylibrarian ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install lazylibrarian k8s-at-home/lazylibrarian --values values.yaml +helm install lazylibrarian k8s-at-home/lazylibrarian -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/lazylibrarian"` | | +| image.tag | string | `"version-047f91af"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `5299` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 2.x.x to 3.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `pguid` has been moved to `env` -* `pgid` has been moved to `env` -* All dockermods have been moved to `env` -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/lazylibrarian/README.md.gotmpl b/charts/lazylibrarian/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/lazylibrarian/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/lazylibrarian/README_CHANGELOG.md.gotmpl b/charts/lazylibrarian/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/lazylibrarian/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/lazylibrarian/README_CONFIG.md.gotmpl b/charts/lazylibrarian/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/lazylibrarian/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/librespeed/README.md b/charts/librespeed/README.md index d690307d..bda8b090 100644 --- a/charts/librespeed/README.md +++ b/charts/librespeed/README.md @@ -1,96 +1,58 @@ -# Librespeed +# librespeed -HTML5 based speedtest with password protected history +![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![AppVersion: 1.0.6-12](https://img.shields.io/badge/AppVersion-1.0.6--12-informational?style=flat-square) -**This chart is not maintained by the Librespeed project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new)** +Librespeed is a HTML5 webpage to test upload and download speeds -## TL;DR; +**Homepage:** -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/librespeed -``` +## Maintainers -## Introduction +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -This code is adopted from the [Linuxserver Librespeed docker image](https://hub.docker.com/r/linuxserver/librespeed) which runs the [Librespeed application](https://github.com/librespeed/speedtest) +## Source Code -## Installing the Chart +* +* +* -To install the chart with the release name `my-release`: +## Values -```shell -helm install --name my-release k8s-at-home/librespeed -``` -## Uninstalling the Chart +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| deploymentAnnotations | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"adolfintel/speedtest"` | | +| image.tag | string | `"latest"` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| livenessProbePath | string | `"/"` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.enabled | bool | `false` | | +| persistence.size | string | `"1Gi"` | | +| pgid | string | `"1000"` | | +| podAnnotations | object | `{}` | | +| puid | string | `"1000"` | | +| readinessProbePath | string | `"/"` | | +| resources | object | `{}` | | +| service.annotations | object | `{}` | | +| service.labels | object | `{}` | | +| service.loadBalancerIP | string | `nil` | | +| service.port | int | `80` | | +| service.type | string | `"ClusterIP"` | | +| strategyType | string | `"Recreate"` | | +| telemetry | bool | `false` | | +| timezone | string | `"UTC"` | | +| tolerations | list | `[]` | | -To uninstall/delete the `my-release` deployment: - -```shell -helm delete my-release --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Librespeed chart and their default values. - -| Parameter | Description | Default | -|:---------------------------------- |:----------------------------------------------------------------------- |:------------------------- | -| `image.repository` | Librespeed image | `linuxserver/librespeed` | -| `image.tag` | Librespeed image tag | `5.2-ls25` | -| `image.pullPolicy` | Librespeed image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `livenessProbePath` | Default livenessProbe path | `/` | -| `readinessProbePath` | Default readinessProbe path | `/` | -| `timezone` | Default timezone | `UTC` | -| `puid` | Default UID | `1000` | -| `pgid` | Default GID | `1000` | -| `telemetry` | Enable/Disable history | `false` | -| `title` | Title of your speedtest | `LibreSpeed` | -| `idObfuscation` | Test IDs are obfuscated, avoids exposing database internal sequential IDs| `false` | -| `redactIPAddresses` | IP addresses/hostnames are redacted from the collected telemetry | `false` | -| `email` | Email address for GDPR requests. Must be specified when telemetry=true | `fake@fake.com | -| `distance` | how the distance from the server is measured. Options `km`, `mi`, or `` | `km` | -| `service.type` | Kubernetes service type for the GUI | `ClusterIP` | -| `service.port` | Kubernetes port where the GUI is exposed | `1880` | -| `service.nodePort` | Kubernetes nodePort where the GUI is exposed | `` | -| `service.annotations` | Service annotations for the GUI | `{}` | -| `service.labels` | Custom labels | `{}` | -| `service.loadBalancerIP` | Loadbalance IP for the GUI | `{}` | -| `service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None | -| `service.externalTrafficPolicy` | Set the externalTrafficPolicy in the Service to either Cluster or Local | `Cluster` | -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.path` | Ingress path | `/` | -| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `persistence.enabled` | Use persistent volume to store data | `false` | -| `persistence.size` | Size of persistent volume claim | `5Gi` | -| `persistence.existingClaim` | Use an existing PVC to persist data | `nil` | -| `persistence.storageClass` | Type of persistent volume claim | `-` | -| `persistence.accessModes` | Persistence access modes | `ReadWriteOnce` | -| `persistence.subPath` | Mount a sub dir of the persistent volume | `nil` | -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Toleration labels for pod assignment | `[]` | -| `affinity` | Affinity settings for pod assignment | `{}` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | -| `deploymentAnnotations` | Key-value pairs to add as deployment annotations | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```shell -helm install --name my-release \ - --set config.timezone="America/New_York" \ - k8s-at-home/librespeed -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```shell -helm install --name my-release -f values.yaml k8s-at-home/librespeed -``` - -Read through the [values.yaml](values.yaml) file. It has several commented out suggested values. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/lidarr/.helmignore b/charts/lidarr/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/lidarr/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/lidarr/README.md b/charts/lidarr/README.md index 866b265f..a3899c88 100644 --- a/charts/lidarr/README.md +++ b/charts/lidarr/README.md @@ -1,78 +1,117 @@ -# Lidarr +# lidarr -This is a helm chart for [Lidarr](https://github.com/lidarr/Lidarr). +![Version: 7.0.1](https://img.shields.io/badge/Version-7.0.1-informational?style=flat-square) ![AppVersion: 0.8.0.1886](https://img.shields.io/badge/AppVersion-0.8.0.1886-informational?style=flat-square) + +Looks and smells like Sonarr but made for music **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/lidarr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install lidarr k8s-at-home/lidarr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `lidarr` ```console -helm install --name my-release k8s-at-home/lidarr +helm install lidarr k8s-at-home/lidarr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `lidarr` deployment ```console -helm delete my-release --purge +helm uninstall lidarr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/lidarr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install lidarr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/lidarr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install lidarr k8s-at-home/lidarr --values values.yaml +helm install lidarr k8s-at-home/lidarr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/lidarr"` | | +| image.tag | string | `"version-0.8.0.1886"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `8686` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 4.x.x to 5.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/lidarr/README.md.gotmpl b/charts/lidarr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/lidarr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/lidarr/README_CHANGELOG.md.gotmpl b/charts/lidarr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/lidarr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/lidarr/README_CONFIG.md.gotmpl b/charts/lidarr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/lidarr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/lychee/.helmignore b/charts/lychee/.helmignore index 0e8a0eb3..4379e2b3 100644 --- a/charts/lychee/.helmignore +++ b/charts/lychee/.helmignore @@ -14,10 +14,13 @@ *.swp *.bak *.tmp -*.orig *~ # Various IDEs .project .idea/ *.tmproj .vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/lychee/README.md b/charts/lychee/README.md index 151955d7..13efbe8d 100644 --- a/charts/lychee/README.md +++ b/charts/lychee/README.md @@ -1,67 +1,121 @@ -# Lychee +# lychee -This is a helm chart for [Lychee](https://github.com/LycheeOrg/Lychee). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 4.0.8](https://img.shields.io/badge/AppVersion-4.0.8-informational?style=flat-square) + +Lychee is a free photo-management tool, which runs on your server or web-space **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/lychee +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install lychee k8s-at-home/lychee ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `lychee` ```console -helm install --name my-release k8s-at-home/lychee +helm install lychee k8s-at-home/lychee ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `lychee` deployment ```console -helm delete my-release --purge +helm uninstall lychee ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/lychee/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install lychee \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/lychee ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install lychee k8s-at-home/lychee --values values.yaml +helm install lychee k8s-at-home/lychee -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"lycheeorg/lychee-laravel"` | | +| image.tag | string | `"v4.0.8"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/conf"` | | +| persistence.sym.emptyDir | bool | `false` | | +| persistence.sym.enabled | bool | `false` | | +| persistence.sym.mountPath | string | `"/sym"` | | +| persistence.uploads.emptyDir | bool | `false` | | +| persistence.uploads.enabled | bool | `false` | | +| persistence.uploads.mountPath | string | `"/uploads"` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/lychee/README.md.gotmpl b/charts/lychee/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/lychee/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/lychee/README_CHANGELOG.md.gotmpl b/charts/lychee/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/lychee/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/lychee/README_CONFIG.md.gotmpl b/charts/lychee/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/lychee/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/modem-stats/README.md b/charts/modem-stats/README.md index 13748011..de861e4d 100644 --- a/charts/modem-stats/README.md +++ b/charts/modem-stats/README.md @@ -1,69 +1,40 @@ -# cable modem (sb6183) signal and stats collection agent for influxdb +# modem-stats -![Screenshot](https://camo.githubusercontent.com/939e044c0491abf790d91bd1d7f909b187e4098c/68747470733a2f2f692e696d6775722e636f6d2f70705a6a6e6b502e706e67) +![Version: 3.0.0](https://img.shields.io/badge/Version-3.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) -This tool allows you to run periodic scanning of the sb6183 cable modem and save the results to Influxdb +periodic cable modem data collection and save the results to InfluxDB -## TL;DR; +**Homepage:** -```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/modem-stats -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `my-release`: +## Source Code -```console -$ helm install --name my-release k8s-at-home/modem-stats -``` -## Uninstalling the Chart +* +* -To uninstall/delete the `my-release` deployment: +## Values -```console -$ helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config.delay | int | `3600` | | +| config.influxdb.database | string | `"cable_modem_stats"` | | +| config.influxdb.host | string | `"influxdb-influxdb"` | | +| config.influxdb.port | int | `8086` | | +| config.influxdb.ssl | bool | `false` | | +| config.modem.url | string | `"http://192.168.100.1/RgConnect.asp"` | | +| debug | bool | `false` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"billimek/sb6183-for-influxdb"` | | +| image.tag | string | `"latest"` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The configuration is set as a block of text through a configmap and mouted as a file in /src/config.ini Any value in this text block should match the defined sb6183 configuration. There are several values here that will have to match our kubernetes configuration. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -| ------------------------------- | ------------------------------- | ---------------------------------------------------------- | -| `image.repository` | modem-stats image | `billimek/sb6183-for-influxdb` | -| `image.tag` | modem-stats image tag | `latest` | -| `image.pullPolicy` | modem-stats image pull policy | `IfNotPresent` | -| `debug` | Display debugging output | `false` | -| `config.delay` | how many seconds to wait between checks | `3600` | -| `config.influxdb.host` | InfluxDB hostname | `influxdb-influxdb` | -| `config.influxdb.port` | InfluxDB port | `8086` | -| `config.influxdb.database` | InfluxDB database | `sb6183` | -| `config.influxdb.username` | InfluxDB username | `` | -| `config.influxdb.password` | InfluxDB password | `` | -| `config.influxdb.ssl` | InfluxDB connection using SSL | `false` | -| `config.modem.url` | sb6183 stats URL page | `http://192.168.100.1/RgConnect.asp` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -$ helm install --name my-release \ - --set onfig.influxdb.host=some-influx-host \ - k8s-at-home/modem-stats -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -$ helm install --name my-release -f values.yaml k8s-at-home/modem-stats -``` - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/modem-stats/values.yaml) file. It has several commented out suggested values. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/monica/.helmignore b/charts/monica/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/monica/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/monica/README.md b/charts/monica/README.md index 6a8ed52d..a9a776d7 100644 --- a/charts/monica/README.md +++ b/charts/monica/README.md @@ -1,68 +1,123 @@ -# Monica +# monica -This is a helm chart for [Monica](https://github.com/monicahq/monica). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: v2.19.1](https://img.shields.io/badge/AppVersion-v2.19.1-informational?style=flat-square) + +A Personal Relationship Management tool to help you organize your social life **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -This chart supports many different environment variables. See the [Monica Documentation](https://raw.githubusercontent.com/monicahq/monica/master/.env.example) for more information. -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/monica +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | mariadb | 9.2.5 | +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install monica k8s-at-home/monica ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `monica` ```console -helm install --name my-release k8s-at-home/monica +helm install monica k8s-at-home/monica ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `monica` deployment ```console -helm delete my-release --purge +helm uninstall monica ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/monica/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install monica \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/monica ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install monica k8s-at-home/monica --values values.yaml +helm install monica k8s-at-home/monica -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"monica"` | | +| image.tag | string | `"2.19.1-apache"` | | +| ingress.enabled | bool | `false` | | +| mariadb.architecture | string | `"standalone"` | | +| mariadb.auth.database | string | `"monica"` | | +| mariadb.auth.password | string | `"monicapass"` | | +| mariadb.auth.rootPassword | string | `"monicarootpass"` | | +| mariadb.auth.username | string | `"monica"` | | +| mariadb.enabled | bool | `false` | | +| mariadb.primary.persistence.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/var/www/html/storage"` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/monica/README.md.gotmpl b/charts/monica/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/monica/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/monica/README_CHANGELOG.md.gotmpl b/charts/monica/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/monica/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/monica/README_CONFIG.md.gotmpl b/charts/monica/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/monica/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/mosquitto/README.md b/charts/mosquitto/README.md index d660ea32..2abac56e 100644 --- a/charts/mosquitto/README.md +++ b/charts/mosquitto/README.md @@ -1,46 +1,65 @@ -# Mosquitto: A small MQTT broker +# mosquitto -This is a helm chart for [mosquitto](https://mosquitto.org/) +![Version: 0.7.0](https://img.shields.io/badge/Version-0.7.0-informational?style=flat-square) ![AppVersion: 2.0.4](https://img.shields.io/badge/AppVersion-2.0.4-informational?style=flat-square) -## TL;DR; +Eclipse Mosquitto - An open source MQTT broker -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/mosquitto -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| ishioni | helm@movishell.pl | | -```console -helm install --name my-release k8s-at-home/mosquitto -``` +## Source Code -## Uninstalling the Chart +* -To uninstall/delete the `my-release` deployment: +## Values -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| extraVolumeMounts | list | `[]` | | +| extraVolumes | list | `[]` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"eclipse-mosquitto"` | | +| image.tag | string | `"{{ .Chart.AppVersion }}"` | | +| imagePullSecrets | list | `[]` | | +| monitoring.podMonitor.enabled | bool | `false` | | +| monitoring.sidecar.args[0] | string | `"--use-splitted-config"` | | +| monitoring.sidecar.enabled | bool | `false` | | +| monitoring.sidecar.envs[0].name | string | `"MQTT_CLIENT_ID"` | | +| monitoring.sidecar.envs[0].value | string | `"exporter"` | | +| monitoring.sidecar.envs[1].name | string | `"BROKER_HOST"` | | +| monitoring.sidecar.envs[1].valueFrom.fieldRef.fieldPath | string | `"status.podIP"` | | +| monitoring.sidecar.image.pullPolicy | string | `"IfNotPresent"` | | +| monitoring.sidecar.image.repository | string | `"nolte/mosquitto-exporter"` | | +| monitoring.sidecar.image.tag | string | `"v0.6.3"` | | +| monitoring.sidecar.port | int | `9234` | | +| monitoring.sidecar.resources.limits.cpu | string | `"300m"` | | +| monitoring.sidecar.resources.limits.memory | string | `"128Mi"` | | +| monitoring.sidecar.resources.requests.cpu | string | `"100m"` | | +| monitoring.sidecar.resources.requests.memory | string | `"64Mi"` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.annotations | object | `{}` | | +| persistence.enabled | bool | `false` | | +| persistence.size | string | `"5Gi"` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.annotations | object | `{}` | | +| service.port | int | `1883` | | +| service.type | string | `"ClusterIP"` | | +| service.websocketPort | int | `9001` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `nil` | | +| tolerations | list | `[]` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/mosquitto/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name my-release \ - --set persistence.enabled=true \ - k8s-at-home/mosquitto -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name my-release -f values.yaml k8s-at-home/mosquitto -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/navidrome/.helmignore b/charts/navidrome/.helmignore index ede8444e..4379e2b3 100644 --- a/charts/navidrome/.helmignore +++ b/charts/navidrome/.helmignore @@ -18,7 +18,9 @@ # Various IDEs .project .idea/ -.vscode/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/navidrome/README.md b/charts/navidrome/README.md index 216653a8..e8f8940b 100644 --- a/charts/navidrome/README.md +++ b/charts/navidrome/README.md @@ -1,67 +1,124 @@ -# Navidrome +# navidrome -This is a helm chart for [Navidrome](https://github.com/deluan/navidrome). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 0.39.0](https://img.shields.io/badge/AppVersion-0.39.0-informational?style=flat-square) + +Navidrome is an open source web-based music collection server and streamer **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/navidrome +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install navidrome k8s-at-home/navidrome ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `navidrome` ```console -helm install --name my-release k8s-at-home/navidrome +helm install navidrome k8s-at-home/navidrome ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `navidrome` deployment ```console -helm delete my-release --purge +helm uninstall navidrome ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/navidrome/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install navidrome \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/navidrome ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install navidrome k8s-at-home/navidrome --values values.yaml +helm install navidrome k8s-at-home/navidrome -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env.ND_ENABLETRANSCODINGCONFIG | string | `"true"` | | +| env.ND_LOGLEVEL | string | `"info"` | | +| env.ND_MUSICFOLDER | string | `"/music"` | | +| env.ND_SCANINTERVAL | string | `"15m"` | | +| env.ND_SESSIONTIMEOUT | string | `"24h"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"deluan/navidrome"` | | +| image.tag | string | `"0.39.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/data"` | | +| persistence.music.accessMode | string | `"ReadWriteOnce"` | | +| persistence.music.emptyDir | bool | `false` | | +| persistence.music.enabled | bool | `false` | | +| persistence.music.mountPath | string | `"/music"` | | +| service.port.port | int | `4533` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/navidrome/README.md.gotmpl b/charts/navidrome/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/navidrome/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/navidrome/README_CHANGELOG.md.gotmpl b/charts/navidrome/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/navidrome/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/navidrome/README_CONFIG.md.gotmpl b/charts/navidrome/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/navidrome/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/neolink/.helmignore b/charts/neolink/.helmignore index 0e8a0eb3..4379e2b3 100644 --- a/charts/neolink/.helmignore +++ b/charts/neolink/.helmignore @@ -14,10 +14,13 @@ *.swp *.bak *.tmp -*.orig *~ # Various IDEs .project .idea/ *.tmproj .vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/neolink/README.md b/charts/neolink/README.md index e46001f4..10be10a1 100644 --- a/charts/neolink/README.md +++ b/charts/neolink/README.md @@ -1,46 +1,112 @@ -# Neolink +# neolink -This is a helm chart for [Neolink](https://github.com/thirtythreeforty/neolink). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 0.3.0](https://img.shields.io/badge/AppVersion-0.3.0-informational?style=flat-square) -**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose).** +Neolink - RTSP bridge to Reolink IP cameras -## TL;DR; +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/neolink +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install neolink k8s-at-home/neolink ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `neolink` ```console -helm install my-release k8s-at-home/neolink +helm install neolink k8s-at-home/neolink ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `neolink` deployment ```console -helm delete my-release --purge +helm uninstall neolink ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -The chart's [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/neolink/values.yaml) file contains a set of suggested values for a minimal deployment. Further configuration options are found in the [common library](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml). -The configuration for the application itself is set as a configmap and mounted in the container as /etc/neolink.toml. Refer to the sample config [here.](https://github.com/thirtythreeforty/neolink/blob/master/sample_config.toml) +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console helm install neolink \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/neolink ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install neolink k8s-at-home/neolink --values values.yaml -``` \ No newline at end of file +helm install neolink k8s-at-home/neolink -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](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config | string | `"bind = \"0.0.0.0\"\n[[cameras]]\nname = \"driveway\"\nusername = \"admin\"\npassword = \"12345678\"\naddress = \"192.168.1.187:9000\"\n"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"thirtythreeforty/neolink"` | | +| image.tag | string | `"latest"` | | +| ingress.enabled | bool | `false` | | +| service.port.port | int | `8554` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/neolink/README.md.gotmpl b/charts/neolink/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/neolink/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/neolink/README_CHANGELOG.md.gotmpl b/charts/neolink/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/neolink/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/neolink/README_CONFIG.md.gotmpl b/charts/neolink/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/neolink/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/network-ups-tools/.helmignore b/charts/network-ups-tools/.helmignore index fcf9212f..4379e2b3 100644 --- a/charts/network-ups-tools/.helmignore +++ b/charts/network-ups-tools/.helmignore @@ -19,6 +19,8 @@ .project .idea/ *.tmproj -.vscode +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/network-ups-tools/README.md b/charts/network-ups-tools/README.md index ae3ed427..58b81ab3 100644 --- a/charts/network-ups-tools/README.md +++ b/charts/network-ups-tools/README.md @@ -1,67 +1,117 @@ # network-ups-tools -This is a helm chart for [network-ups-tools](https://github.com/networkupstools/nut). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v2.7.4-2061-g46c7da76](https://img.shields.io/badge/AppVersion-v2.7.4--2061--g46c7da76-informational?style=flat-square) + +Network UPS Tools is a collection of programs which provide a common interface for monitoring and administering UPS, PDU and SCD hardware. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/network-ups-tools +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install network-ups-tools k8s-at-home/network-ups-tools ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `network-ups-tools` ```console -helm install --name my-release k8s-at-home/network-ups-tools +helm install network-ups-tools k8s-at-home/network-ups-tools ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `network-ups-tools` deployment ```console -helm delete my-release --purge +helm uninstall network-ups-tools ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/network-ups-tools/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install network-ups-tools \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/network-ups-tools ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install network-ups-tools k8s-at-home/network-ups-tools --values values.yaml +helm install network-ups-tools k8s-at-home/network-ups-tools -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config.files."nut.conf" | string | `"MODE=netserver\n"` | | +| config.files."ups.conf" | string | `"[dummy]\n driver = dummy-ups\n port = dummy-ups.dev\n desc = \"dummy-ups in dummy mode\"\n"` | | +| config.files."upsd.conf" | string | `"LISTEN 0.0.0.0\n"` | | +| config.mode | string | `"values"` | | +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"k8sathome/network-ups-tools"` | | +| image.tag | string | `"v2.7.4-2061-g46c7da76"` | | +| ingress.enabled | bool | `false` | | +| service.port.name | string | `"server"` | | +| service.port.port | int | `3493` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/network-ups-tools/README.md.gotmpl b/charts/network-ups-tools/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/network-ups-tools/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/network-ups-tools/README_CHANGELOG.md.gotmpl b/charts/network-ups-tools/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/network-ups-tools/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/network-ups-tools/README_CONFIG.md.gotmpl b/charts/network-ups-tools/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/network-ups-tools/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/node-feature-discovery/README.md b/charts/node-feature-discovery/README.md index 9f3d9c54..a5b1212b 100644 --- a/charts/node-feature-discovery/README.md +++ b/charts/node-feature-discovery/README.md @@ -1,72 +1,63 @@ -# node-feature-discovery helm chart +# node-feature-discovery -This is a helm chart for [node-feature-discovery](https://github.com/kubernetes-sigs/node-feature-discovery) using the master/worker pattern. +![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![AppVersion: 0.7.0](https://img.shields.io/badge/AppVersion-0.7.0-informational?style=flat-square) -## TL;DR +Detect hardware features available on each node in a Kubernetes cluster, and advertises those features using node labels -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/node-feature-discovery -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -```shell -helm install my-release k8s-at-home/node-feature-discovery -``` +## Source Code -## Uninstalling the Chart +* +* -To uninstall/delete the `my-release` deployment: +## Values -```shell -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config | string | `"#sources:\n# cpu:\n# cpuid:\n## NOTE: whitelist has priority over blacklist\n# attributeBlacklist:\n# - \"BMI1\"\n# - \"BMI2\"\n# - \"CLMUL\"\n# - \"CMOV\"\n# - \"CX16\"\n# - \"ERMS\"\n# - \"F16C\"\n# - \"HTT\"\n# - \"LZCNT\"\n# - \"MMX\"\n# - \"MMXEXT\"\n# - \"NX\"\n# - \"POPCNT\"\n# - \"RDRAND\"\n# - \"RDSEED\"\n# - \"RDTSCP\"\n# - \"SGX\"\n# - \"SSE\"\n# - \"SSE2\"\n# - \"SSE3\"\n# - \"SSE4.1\"\n# - \"SSE4.2\"\n# - \"SSSE3\"\n# attributeWhitelist:\n# kernel:\n# kconfigFile: \"/path/to/kconfig\"\n# configOpts:\n# - \"NO_HZ\"\n# - \"X86\"\n# - \"DMI\"\n# pci:\n# deviceClassWhitelist:\n# - \"0200\"\n# - \"03\"\n# - \"12\"\n# deviceLabelFields:\n# - \"class\"\n# - \"vendor\"\n# - \"device\"\n# - \"subsystem_vendor\"\n# - \"subsystem_device\"\n# usb:\n# deviceClassWhitelist:\n# - \"0e\"\n# - \"ef\"\n# - \"fe\"\n# - \"ff\"\n# deviceLabelFields:\n# - \"class\"\n# - \"vendor\"\n# - \"device\"\n# custom:\n# - name: \"my.kernel.feature\"\n# matchOn:\n# - loadedKMod: [\"example_kmod1\", \"example_kmod2\"]\n# - name: \"my.pci.feature\"\n# matchOn:\n# - pciId:\n# class: [\"0200\"]\n# vendor: [\"15b3\"]\n# device: [\"1014\", \"1017\"]\n# - pciId :\n# vendor: [\"8086\"]\n# device: [\"1000\", \"1100\"]\n# - name: \"my.usb.feature\"\n# matchOn:\n# - usbId:\n# class: [\"ff\"]\n# vendor: [\"03e7\"]\n# device: [\"2485\"]\n# - usbId:\n# class: [\"fe\"]\n# vendor: [\"1a6e\"]\n# device: [\"089a\"]\n# - name: \"my.combined.feature\"\n# matchOn:\n# - pciId:\n# vendor: [\"15b3\"]\n# device: [\"1014\", \"1017\"]\n# loadedKMod : [\"vendor_kmod1\", \"vendor_kmod2\"]\n"` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"gcr.io/k8s-staging-nfd/node-feature-discovery"` | | +| image.tag | string | `"v0.7.0"` | | +| imagePullSecrets | list | `[]` | | +| master.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].preference.matchExpressions[0].key | string | `"node-role.kubernetes.io/master"` | | +| master.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].preference.matchExpressions[0].operator | string | `"In"` | | +| master.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].preference.matchExpressions[0].values[0] | string | `""` | | +| master.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].weight | int | `1` | | +| master.nodeSelector | object | `{}` | | +| master.replicaCount | int | `1` | | +| master.resources | object | `{}` | | +| master.securityContext | object | `{}` | | +| master.tolerations[0].effect | string | `"NoSchedule"` | | +| master.tolerations[0].key | string | `"node-role.kubernetes.io/master"` | | +| master.tolerations[0].operator | string | `"Equal"` | | +| master.tolerations[0].value | string | `""` | | +| nameOverride | string | `""` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| rbac.create | bool | `true` | | +| service.clusterIP | string | `""` | | +| service.externalIPs | list | `[]` | | +| service.externalTrafficPolicy | string | `nil` | | +| service.loadBalancerIP | string | `""` | | +| service.port | int | `8080` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| sources | list | `[]` | | +| worker.affinity | object | `{}` | | +| worker.nodeSelector | object | `{}` | | +| worker.resources | object | `{}` | | +| worker.securityContext | object | `{}` | | +| worker.tolerations | list | `[]` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/node-feature-discovery/values.yaml) file. It has several commented out suggested values. - -| Parameter | Description | Default | -| ------------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `image.repository` | Image repository | `quay.io/kubernetes_incubator/node-feature-discovery` | -| `image.tag` | Image tag. Possible values listed [here](https://github.com/kubernetes-sigs/node-feature-discovery/releases). | `v0.6.0` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `sources` | List of sources to consider when labeling - see [documentation](https://github.com/kubernetes-sigs/node-feature-discovery#feature-sources) for info | `[]` | -| `config` | node-feature-discovery configuration - see [nfd-worker.conf.example](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-worker.conf.example) for example | `{}` | -| `service.type` | Kubernetes service type for the GUI | `ClusterIP` | -| `service.port` | Kubernetes port where the GUI is exposed | `8080` | -| `service.annotations` | Service annotations for the GUI | `{}` | -| `service.labels` | Custom labels | `{}` | -| `service.loadBalancerIP` | Loadbalancer IP for the GUI | `{}` | -| `service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | `nil` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | -| `master.replicaCount` | Number of replicas to scale the master component to | `1` | -| `master.resources` | CPU/Memory resource requests/limits for master component | `{}` | -| `master.nodeSelector` | Node labels for master component pod assignment | `{}` | -| `master.tolerations` | Toleration labels for master component pod assignment | See [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/node-feature-discovery/values.yaml) | -| `master.affinity` | Affinity settings for master component pod assignment | See [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/node-feature-discovery/values.yaml) | -| `worker.resources` | CPU/Memory resource requests/limits for worker component | `{}` | -| `worker.nodeSelector` | Node labels for worker component pod assignment | `{}` | -| `worker.tolerations` | Toleration labels for worker component pod assignment | `[]` | -| `worker.affinity` | Affinity settings for worker component pod assignment | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install my-release \ - --set image.pullPolicy="Always" \ - k8s-at-home/node-feature-discovery -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install my-release -f values.yaml k8s-at-home/node-feature-discovery -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/node-red/.helmignore b/charts/node-red/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/node-red/.helmignore +++ b/charts/node-red/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/node-red/README.md b/charts/node-red/README.md index 13f0aefe..ed0aee27 100644 --- a/charts/node-red/README.md +++ b/charts/node-red/README.md @@ -1,79 +1,115 @@ -# Node-Red +# node-red -This is a helm chart for [Node-Red](https://nodered.org/). +![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![AppVersion: 1.2.5](https://img.shields.io/badge/AppVersion-1.2.5-informational?style=flat-square) + +Node-RED is low-code programming for event-driven applications **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/node-red +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install node-red k8s-at-home/node-red ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `node-red` ```console -helm install --name my-release k8s-at-home/node-red +helm install node-red k8s-at-home/node-red ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `node-red` deployment ```console -helm delete my-release --purge +helm uninstall node-red ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/node-red/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install node-red \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/node-red ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install node-red k8s-at-home/node-red --values values.yaml +helm install node-red k8s-at-home/node-red -f values.yaml ``` -These values will be nested as it is a dependency, for example -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"nodered/node-red"` | | +| image.tag | string | `"1.2.5"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/data"` | | +| service.port.port | int | `1880` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 3.x.x to 4.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/node-red/README.md.gotmpl b/charts/node-red/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/node-red/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/node-red/README_CHANGELOG.md.gotmpl b/charts/node-red/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/node-red/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/node-red/README_CONFIG.md.gotmpl b/charts/node-red/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/node-red/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/nzbget/.helmignore b/charts/nzbget/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/nzbget/.helmignore +++ b/charts/nzbget/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/nzbget/README.md b/charts/nzbget/README.md index 13ac6f58..0f4ca530 100644 --- a/charts/nzbget/README.md +++ b/charts/nzbget/README.md @@ -1,84 +1,122 @@ -# NZBGet +# nzbget -This is a helm chart for [NZBGet](https://nzbget.net/). +![Version: 8.0.1](https://img.shields.io/badge/Version-8.0.1-informational?style=flat-square) ![AppVersion: v21.0](https://img.shields.io/badge/AppVersion-v21.0-informational?style=flat-square) + +NZBGet is a Usenet downloader client **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/nzbget +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install nzbget k8s-at-home/nzbget ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `nzbget` ```console -helm install --name my-release k8s-at-home/nzbget +helm install nzbget k8s-at-home/nzbget ``` +## Uninstalling the Chart + +To uninstall the `nzbget` deployment + +```console +helm uninstall nzbget +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install nzbget \ + --set env.TZ="America/New York" \ + k8s-at-home/nzbget +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install nzbget k8s-at-home/nzbget -f values.yaml +``` + +## Custom configuration + The default login details (change ASAP) are: * login:nzbget * password:tegbzn6789 -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/nzbget"` | | +| image.tag | string | `"version-v21.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.downloads.emptyDir | bool | `false` | | +| persistence.downloads.enabled | bool | `false` | | +| persistence.downloads.mountPath | string | `"/downloads"` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `6789` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/nzbget/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install nzbget \ - --set env.TZ="America/New_York" \ - k8s-at-home/nzbget -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install radarr k8s-at-home/nzbget --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -These values will be nested as it is a dependency, for example -```yaml -image: - tag: ... -``` +### [1.0.0] ---- -**NOTE** +#### Added -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +- N/A ---- +#### Changed -## Upgrading an existing Release to a new major version +- N/A -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +#### Removed -### Upgrading from 5.x.x to 6.x.x +- N/A -Due to migrating to a centralized common library some values in `values.yaml` have changed. +[1.0.0]: #1.0.0 -Examples: +## Support -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community -Refer to the library values.yaml for more configuration options. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/nzbget/README.md.gotmpl b/charts/nzbget/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/nzbget/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/nzbget/README_CHANGELOG.md.gotmpl b/charts/nzbget/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/nzbget/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/nzbget/README_CONFIG.md.gotmpl b/charts/nzbget/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..106c2853 --- /dev/null +++ b/charts/nzbget/README_CONFIG.md.gotmpl @@ -0,0 +1,12 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +The default login details (change ASAP) are: + +* login:nzbget +* password:tegbzn6789 +{{- end -}} diff --git a/charts/nzbhydra2/.helmignore b/charts/nzbhydra2/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/nzbhydra2/.helmignore +++ b/charts/nzbhydra2/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/nzbhydra2/README.md b/charts/nzbhydra2/README.md index 951fc6e0..24a54255 100644 --- a/charts/nzbhydra2/README.md +++ b/charts/nzbhydra2/README.md @@ -1,78 +1,138 @@ -# Nzbhydra2 +# nzbhydra2 -This is a helm chart for [Nzbhydra2](https://github.com/theotherp/nzbhydra2). +![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![AppVersion: v3.8.1](https://img.shields.io/badge/AppVersion-v3.8.1-informational?style=flat-square) + +Usenet meta search **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/nzbhydra2 +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install nzbhydra2 k8s-at-home/nzbhydra2 ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `nzbhydra2` ```console -helm install --name my-release k8s-at-home/nzbhydra2 +helm install nzbhydra2 k8s-at-home/nzbhydra2 ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `nzbhydra2` deployment ```console -helm delete my-release --purge +helm uninstall nzbhydra2 ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/nzbhydra2/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install nzbhydra2 \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/nzbhydra2 ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install nzbhydra2 k8s-at-home/nzbhydra2 --values values.yaml +helm install nzbhydra2 k8s-at-home/nzbhydra2 -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/nzbhydra2"` | | +| image.tag | string | `"version-v3.8.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| probes.liveness.custom | bool | `true` | | +| probes.liveness.enabled | bool | `true` | | +| probes.liveness.spec.failureThreshold | int | `5` | | +| probes.liveness.spec.httpGet.path | string | `"/actuator/health/livenessState"` | | +| probes.liveness.spec.httpGet.port | string | `"http"` | | +| probes.liveness.spec.initialDelaySeconds | int | `30` | | +| probes.liveness.spec.periodSeconds | int | `10` | | +| probes.liveness.spec.timeoutSeconds | int | `10` | | +| probes.readiness.custom | bool | `true` | | +| probes.readiness.enabled | bool | `true` | | +| probes.readiness.spec.failureThreshold | int | `5` | | +| probes.readiness.spec.httpGet.path | string | `"/actuator/health/readinessState"` | | +| probes.readiness.spec.httpGet.port | string | `"http"` | | +| probes.readiness.spec.initialDelaySeconds | int | `30` | | +| probes.readiness.spec.periodSeconds | int | `10` | | +| probes.readiness.spec.timeoutSeconds | int | `10` | | +| probes.startup.custom | bool | `true` | | +| probes.startup.enabled | bool | `true` | | +| probes.startup.spec.failureThreshold | int | `5` | | +| probes.startup.spec.httpGet.path | string | `"/actuator/health/readinessState"` | | +| probes.startup.spec.httpGet.port | string | `"http"` | | +| probes.startup.spec.initialDelaySeconds | int | `30` | | +| probes.startup.spec.periodSeconds | int | `10` | | +| probes.startup.spec.timeoutSeconds | int | `10` | | +| service.port.port | int | `5076` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 3.x.x to 4.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/nzbhydra2/README.md.gotmpl b/charts/nzbhydra2/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/nzbhydra2/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/nzbhydra2/README_CHANGELOG.md.gotmpl b/charts/nzbhydra2/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/nzbhydra2/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/nzbhydra2/README_CONFIG.md.gotmpl b/charts/nzbhydra2/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/nzbhydra2/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/oauth2-proxy/README.md b/charts/oauth2-proxy/README.md index 1463a6c2..34aec658 100644 --- a/charts/oauth2-proxy/README.md +++ b/charts/oauth2-proxy/README.md @@ -1,176 +1,82 @@ # oauth2-proxy -[oauth2-proxy](https://github.com/pusher/oauth2_proxy) is a reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group. +![Version: 4.4.0](https://img.shields.io/badge/Version-4.4.0-informational?style=flat-square) ![AppVersion: 5.1.0](https://img.shields.io/badge/AppVersion-5.1.0-informational?style=flat-square) -## TL;DR; +A reverse proxy that provides authentication with Google, Github or other providers -```console -$ helm install stable/oauth2-proxy -``` +**Homepage:** -## Introduction +## Maintainers -This chart bootstraps an oauth2-proxy deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. +| Name | Email | Url | +| ---- | ------ | --- | +| carpenike | ryan@ryanholt.net | | -## Installing the Chart +## Source Code -To install the chart with the release name `my-release`: +* -```console -$ helm install stable/oauth2-proxy --name my-release -``` +## Requirements -The command deploys oauth2-proxy on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. +Kubernetes: `>=1.9.0-0` -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| authenticatedEmailsFile.enabled | bool | `false` | | +| authenticatedEmailsFile.restricted_access | string | `""` | | +| authenticatedEmailsFile.template | string | `""` | | +| config.clientID | string | `"XXXXXXX"` | | +| config.clientSecret | string | `"XXXXXXXX"` | | +| config.configFile | string | `"email_domains = [ \"*\" ]\nupstreams = [ \"file:///dev/null\" ]"` | | +| config.cookieSecret | string | `"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"` | | +| config.google | object | `{}` | | +| extraArgs | object | `{}` | | +| extraEnv | list | `[]` | | +| extraVolumeMounts | list | `[]` | | +| extraVolumes | list | `[]` | | +| htpasswdFile.enabled | bool | `false` | | +| htpasswdFile.entries | object | `{}` | | +| htpasswdFile.existingSecret | string | `""` | | +| httpScheme | string | `"http"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"quay.io/oauth2-proxy/oauth2-proxy"` | | +| image.tag | string | `"v6.1.1"` | | +| ingress.enabled | bool | `false` | | +| ingress.path | string | `"/"` | | +| initContainers | list | `[]` | | +| livenessProbe.enabled | bool | `true` | | +| livenessProbe.initialDelaySeconds | int | `0` | | +| livenessProbe.timeoutSeconds | int | `1` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podDisruptionBudget.enabled | bool | `true` | | +| podDisruptionBudget.minAvailable | int | `1` | | +| podLabels | object | `{}` | | +| podSecurityContext | object | `{}` | | +| priorityClassName | string | `""` | | +| proxyVarsAsSecrets | bool | `true` | | +| readinessProbe.enabled | bool | `true` | | +| readinessProbe.initialDelaySeconds | int | `0` | | +| readinessProbe.periodSeconds | int | `10` | | +| readinessProbe.successThreshold | int | `1` | | +| readinessProbe.timeoutSeconds | int | `1` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext.enabled | bool | `false` | | +| securityContext.runAsNonRoot | bool | `true` | | +| service.annotations | object | `{}` | | +| service.port | int | `80` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.enabled | bool | `true` | | +| serviceAccount.name | string | `nil` | | +| tolerations | list | `[]` | | +| topologySpreadConstraints.enabled | bool | `false` | | +| topologySpreadConstraints.maxSkew | int | `1` | | +| topologySpreadConstraints.topologyKey | string | `"topology.kubernetes.io/zone"` | | +| topologySpreadConstraints.whenUnsatisfiable | string | `"DoNotSchedule"` | | -```console -$ helm delete my-release -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Upgrading an existing Release to a new major version - -A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an -incompatible breaking change needing manual actions. - -### To 1.0.0 - -This version upgrade oauth2-proxy to v4.0.0. Please see the [changelog](https://github.com/pusher/oauth2_proxy/blob/v4.0.0/CHANGELOG.md#v400) in order to upgrade. - -### To 2.0.0 - -Version 2.0.0 of this chart introduces support for Kubernetes v1.16.x by way of addressing the deprecation of the Deployment object apiVersion `apps/v1beta2`. See [the v1.16 API deprecations page](https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/) for more information. - -Due to [this issue](https://github.com/helm/helm/issues/6583) there may be errors performing a `helm upgrade`of this chart from versions earlier than 2.0.0. - -### To 3.0.0 - -Version 3.0.0 introduces support for [EKS IAM roles for service accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) by adding a managed service account to the chart. This is a breaking change since the service account is enabled by default. To disable this behaviour set `serviceAccount.enabled` to `false` - -### To 4.0.0 - -This is a breaking change as the chart was moved to k8s-at-home. No other change on top of the 3.x.x branch. - -## Configuration - -The following table lists the configurable parameters of the oauth2-proxy chart and their default values. - -Parameter | Description | Default ---- | --- | --- -`affinity` | node/pod affinities | None -`authenticatedEmailsFile.enabled` | Enables authorize individual email addresses | `false` -`authenticatedEmailsFile.template` | Name of the configmap that is handled outside of that chart | `""` -`authenticatedEmailsFile.restricted_access` | [email addresses](https://github.com/pusher/oauth2_proxy#email-authentication) list config | `""` -`config.clientID` | oauth client ID | `""` -`config.clientSecret` | oauth client secret | `""` -`config.cookieSecret` | server specific cookie for the secret; create a new one with `openssl rand -base64 32 | head -c 32 | base64` | `""` -`config.existingSecret` | existing Kubernetes secret to use for OAuth2 credentials. See [secret template](https://github.com/helm/charts/blob/master/stable/oauth2-proxy/templates/secret.yaml) for the required values | `nil` -`config.configFile` | custom [oauth2_proxy.cfg](https://github.com/pusher/oauth2_proxy/blob/master/contrib/oauth2_proxy.cfg.example) contents for settings not overridable via environment nor command line | `""` -`config.existingConfig` | existing Kubernetes configmap to use for the configuration file. See [config template](https://github.com/helm/charts/blob/master/stable/oauth2-proxy/templates/configmap.yaml) for the required values | `nil` -`config.google.adminEmail` | user impersonated by the google service account | `""` -`config.google.serviceAccountJson` | google service account json contents | `""` -`config.google.existingConfig` | existing Kubernetes configmap to use for the service account file. See [google secret template](https://github.com/helm/charts/blob/master/stable/oauth2-proxy/templates/google-secret.yaml) for the required values | `nil` -`extraArgs` | key:value list of extra arguments to give the binary | `{}` -`extraEnv` | key:value list of extra environment variables to give the binary | `[]` -`extraVolumes` | list of extra volumes | `[]` -`extraVolumeMounts` | list of extra volumeMounts | `[]` -`htpasswdFile.enabled` | enable htpasswd-file option | `false` -`htpasswdFile.entries` | list of [SHA encrypted user:passwords](https://pusher.github.io/oauth2_proxy/configuration#command-line-options) | `{}` -`htpasswdFile.existingSecret` | existing Kubernetes secret to use for OAuth2 htpasswd file | `""` -`httpScheme` | `http` or `https`. `name` used for port on the deployment. `httpGet` port `name` and `scheme` used for `liveness`- and `readinessProbes`. `name` and `targetPort` used for the service. | `http` -`image.pullPolicy` | Image pull policy | `IfNotPresent` -`image.repository` | Image repository | `quay.io/pusher/oauth2_proxy` -`image.tag` | Image tag | `v5.1.0` -`imagePullSecrets` | Specify image pull secrets | `nil` (does not add image pull secrets to deployed pods) -`ingress.enabled` | Enable Ingress | `false` -`ingress.ingressClassName` | Set ingressClassName | `nil` -`ingress.path` | Ingress accepted path | `/` -`ingress.extraPaths` | Ingress extra paths to prepend to every host configuration. Useful when configuring [custom actions with AWS ALB Ingress Controller](https://kubernetes-sigs.github.io/aws-alb-ingress-controller/guide/ingress/annotation/#actions). | `[]` -`ingress.annotations` | Ingress annotations | `nil` -`ingress.hosts` | Ingress accepted hostnames | `nil` -`ingress.tls` | Ingress TLS configuration | `nil` -`initContainers` | pod init containers | `[]` -`livenessProbe.enabled` | enable Kubernetes livenessProbe. Disable to use oauth2-proxy with Istio mTLS. See [Istio FAQ](https://istio.io/help/faq/security/#k8s-health-checks) | `true` -`livenessProbe.initialDelaySeconds` | number of seconds | 0 -`livenessProbe.timeoutSeconds` | number of seconds | 1 -`nodeSelector` | node labels for pod assignment | `{}` -`podAnnotations` | annotations to add to each pod | `{}` -`podLabels` | additional labesl to add to each pod | `{}` -`podDisruptionBudget.enabled`| Enabled creation of PodDisruptionBudget (only if replicaCount > 1) | true -`podDisruptionBudget.minAvailable`| minAvailable parameter for PodDisruptionBudget | 1 -`podSecurityContext` | Kubernetes security context to apply to pod | `{}` -`priorityClassName` | priorityClassName | `nil` -`readinessProbe.enabled` | enable Kubernetes readinessProbe. Disable to use oauth2-proxy with Istio mTLS. See [Istio FAQ](https://istio.io/help/faq/security/#k8s-health-checks) | `true` -`readinessProbe.initialDelaySeconds` | number of seconds | 0 -`readinessProbe.timeoutSeconds` | number of seconds | 1 -`readinessProbe.periodSeconds` | number of seconds | 10 -`readinessProbe.successThreshold` | number of successes | 1 -`replicaCount` | desired number of pods | `1` -`resources` | pod resource requests & limits | `{}` -`service.port` | port for the service | `80` -`service.type` | type of service | `ClusterIP` -`service.clusterIP` | cluster ip address | `nil` -`service.loadBalancerIP` | ip of load balancer | `nil` -`service.loadBalancerSourceRanges` | allowed source ranges in load balancer | `nil` -`serviceAccount.enabled` | create a service account | `true` -`serviceAccount.name` | the service account name | `` -`serviceAccount.annotations` | (optional) annotations for the service account | `{}` -`tolerations` | list of node taints to tolerate | `[]` -`topologySpreadConstraints.enabled` | enable Kubernetes [topologySpreadConstraints](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/) | `false` -`topologySpreadConstraints.maxSkew` | the degree to which Pods may be unevenly distributed | `1` -`topologySpreadConstraints.topologyKey` | the key of node labels | `topology.kubernetes.io/zone` -`topologySpreadConstraints.whenUnsatisfiable` | how to deal with a Pod if it doesn't satisfy the spread constraint (`DoNotSchedule`, `ScheduleAnyway`) | `DoNotSchedule` -`securityContext.enabled` | enable Kubernetes security context on container | `false` -`securityContext.runAsNonRoot` | make sure that the container runs as a non-root user | `true` -`proxyVarsAsSecrets` | choose between environment values or secrets for setting up OAUTH2_PROXY variables. When set to false, remember to add the variables OAUTH2_PROXY_CLIENT_ID, OAUTH2_PROXY_CLIENT_SECRET, OAUTH2_PROXY_COOKIE_SECRET in extraEnv | `true` - - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -$ helm install stable/oauth2-proxy --name my-release \ - --set=image.tag=v0.0.2,resources.limits.cpu=200m -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -$ helm install stable/oauth2-proxy --name my-release -f values.yaml -``` - -> **Tip**: You can use the default [values.yaml](values.yaml) - -## SSL Configuration - -See: [SSL Configuration](https://pusher.github.io/oauth2_proxy/tls-configuration). -Use ```values.yaml``` like: - -```yaml -... -extraArgs: - tls-cert: /path/to/cert.pem - tls-key: /path/to/cert.key - -extraVolumes: - - name: ssl-cert - secret: - secretName: my-ssl-secret - -extraVolumeMounts: - - mountPath: /path/to/ - name: ssl-cert -... -``` - -With a secret called `my-ssl-secret`: - -```yaml -... -data: - cert.pem: AB..== - cert.key: CD..== -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/octoprint/.helmignore b/charts/octoprint/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/octoprint/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/octoprint/README.md b/charts/octoprint/README.md index 27085967..11c65655 100644 --- a/charts/octoprint/README.md +++ b/charts/octoprint/README.md @@ -1,63 +1,120 @@ -# Octoprint +# octoprint -This is a helm chart for [Octoprint](https://github.com/OctoPrint/OctoPrint). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 1.4.2](https://img.shields.io/badge/AppVersion-1.4.2-informational?style=flat-square) + +OctoPrint is the snappy web interface for your 3D printer **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/octoprint +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install octoprint k8s-at-home/octoprint ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `octoprint` ```console -helm install --name my-release k8s-at-home/octoprint +helm install octoprint k8s-at-home/octoprint ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `octoprint` deployment ```console -helm delete my-release --purge +helm uninstall octoprint ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/octoprint/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install octoprint \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/octoprint ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install octoprint k8s-at-home/octoprint --values values.yaml +helm install octoprint k8s-at-home/octoprint -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts[0].mountPath | string | `"/dev/ttyACM0"` | | +| additionalVolumeMounts[0].name | string | `"printer"` | | +| additionalVolumes[0].hostPath.path | string | `"/dev/ttyACM0"` | | +| additionalVolumes[0].name | string | `"printer"` | | +| env | string | `nil` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"octoprint/octoprint"` | | +| image.tag | string | `"1.4.2"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/octoprint"` | | +| securityContext.privileged | bool | `true` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/octoprint/README.md.gotmpl b/charts/octoprint/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/octoprint/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/octoprint/README_CHANGELOG.md.gotmpl b/charts/octoprint/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/octoprint/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/octoprint/README_CONFIG.md.gotmpl b/charts/octoprint/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/octoprint/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/omada-controller/.helmignore b/charts/omada-controller/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/omada-controller/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/omada-controller/README.md b/charts/omada-controller/README.md index c9e5e74c..33aaacac 100644 --- a/charts/omada-controller/README.md +++ b/charts/omada-controller/README.md @@ -1,68 +1,114 @@ # omada-controller -This is a helm chart for [omada-controller](https://github.com/mbentley/docker-omada-controller). +![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: 4.2.11](https://img.shields.io/badge/AppVersion-4.2.11-informational?style=flat-square) + +Omada enables the network administrators to monitor and manage all the Omada products in the network with a centralized management platform. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/omada-controller +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install omada-controller k8s-at-home/omada-controller ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `omada-controller` ```console -helm install --name my-release k8s-at-home/omada-controller +helm install omada-controller k8s-at-home/omada-controller ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `omada-controller` deployment ```console -helm delete my-release --purge +helm uninstall omada-controller ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/omada-controller/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install omada-controller \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/omada-controller ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install omada-controller k8s-at-home/omada-controller --values values.yaml +helm install omada-controller k8s-at-home/omada-controller -f values.yaml ``` -These values will be nested as it is a dependency, for example -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"mbentley/omada-controller"` | | +| image.tag | float | `4.2` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| service.port.port | int | `8043` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/omada-controller/README.md.gotmpl b/charts/omada-controller/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/omada-controller/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/omada-controller/README_CHANGELOG.md.gotmpl b/charts/omada-controller/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/omada-controller/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/omada-controller/README_CONFIG.md.gotmpl b/charts/omada-controller/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/omada-controller/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/ombi/.helmignore b/charts/ombi/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/ombi/.helmignore +++ b/charts/ombi/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/ombi/README.md b/charts/ombi/README.md index 340e463d..8bf539b7 100644 --- a/charts/ombi/README.md +++ b/charts/ombi/README.md @@ -1,78 +1,114 @@ -# Ombi +# ombi -This is a helm chart for [Ombi](https://github.com/tidusjar/Ombi). +![Version: 8.0.1](https://img.shields.io/badge/Version-8.0.1-informational?style=flat-square) ![AppVersion: 4.0.681](https://img.shields.io/badge/AppVersion-4.0.681-informational?style=flat-square) + +Want a Movie or TV Show on Plex or Emby? Use Ombi! **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/ombi +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install ombi k8s-at-home/ombi ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `ombi` ```console -helm install --name my-release k8s-at-home/ombi +helm install ombi k8s-at-home/ombi ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `ombi` deployment ```console -helm delete my-release --purge +helm uninstall ombi ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/ombi/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install ombi \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/ombi ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install ombi k8s-at-home/ombi --values values.yaml +helm install ombi k8s-at-home/ombi -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/ombi"` | | +| image.tag | string | `"version-v4.0.681"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `3579` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 4.x.x to 5.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/ombi/README.md.gotmpl b/charts/ombi/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/ombi/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/ombi/README_CHANGELOG.md.gotmpl b/charts/ombi/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/ombi/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/ombi/README_CONFIG.md.gotmpl b/charts/ombi/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/ombi/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/organizr/.helmignore b/charts/organizr/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/organizr/.helmignore +++ b/charts/organizr/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/organizr/README.md b/charts/organizr/README.md index 58b8d31d..6ea845c8 100644 --- a/charts/organizr/README.md +++ b/charts/organizr/README.md @@ -1,78 +1,114 @@ -# Organizr +# organizr -This is a helm chart for [Organizr](https://github.com/causefx/Organizr). +![Version: 4.0.1](https://img.shields.io/badge/Version-4.0.1-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) + +HTPC/Homelab Services Organizer **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/organizr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install organizr k8s-at-home/organizr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `organizr` ```console -helm install --name my-release k8s-at-home/organizr +helm install organizr k8s-at-home/organizr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `organizr` deployment ```console -helm delete my-release --purge +helm uninstall organizr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/organizr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install organizr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/organizr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install organizr k8s-at-home/organizr --values values.yaml +helm install organizr k8s-at-home/organizr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"Always"` | | +| image.repository | string | `"organizr/organizr"` | | +| image.tag | string | `"latest"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 1.x.x to 2.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/organizr/README.md.gotmpl b/charts/organizr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/organizr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/organizr/README_CHANGELOG.md.gotmpl b/charts/organizr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/organizr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/organizr/README_CONFIG.md.gotmpl b/charts/organizr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/organizr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/overseerr/.helmignore b/charts/overseerr/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/overseerr/.helmignore +++ b/charts/overseerr/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/overseerr/README.md b/charts/overseerr/README.md index b31a8ae8..3b99d4f4 100644 --- a/charts/overseerr/README.md +++ b/charts/overseerr/README.md @@ -1,67 +1,115 @@ -# Overseerr +# overseerr -This is a helm chart for [Overseerr](https://github.com/sct/overseerr). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 1.19.1](https://img.shields.io/badge/AppVersion-1.19.1-informational?style=flat-square) + +Overseerr is a free and open source software application for managing requests for your media library. It integrates with your existing services such as Sonarr, Radarr and Plex! **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/overseerr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install overseerr k8s-at-home/overseerr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `overseerr` ```console -helm install --name my-release k8s-at-home/overseerr +helm install overseerr k8s-at-home/overseerr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `overseerr` deployment ```console -helm delete my-release --purge +helm uninstall overseerr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/overseerr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install overseerr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/overseerr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install overseerr k8s-at-home/overseerr --values values.yaml +helm install overseerr k8s-at-home/overseerr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"sctx/overseerr"` | | +| image.tag | string | `"1.19.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/app/config"` | | +| service.port.port | int | `5055` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/overseerr/README.md.gotmpl b/charts/overseerr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/overseerr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/overseerr/README_CHANGELOG.md.gotmpl b/charts/overseerr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/overseerr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/overseerr/README_CONFIG.md.gotmpl b/charts/overseerr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/overseerr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/paperless/.helmignore b/charts/paperless/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/paperless/.helmignore +++ b/charts/paperless/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/paperless/README.md b/charts/paperless/README.md index 8c7b6646..5768ea89 100644 --- a/charts/paperless/README.md +++ b/charts/paperless/README.md @@ -1,57 +1,129 @@ -# Paperless +# paperless -This is a helm chart for [Paperless-ng](https://github.com/jonaswinkler/paperless-ng). The documentation can be found [here](https://paperless-ng.readthedocs.io/en/latest/). +![Version: 4.0.1](https://img.shields.io/badge/Version-4.0.1-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) -**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose).** +Paperless - Index and archive all of your scanned paper documents -## TL;DR; +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/paperless +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install paperless k8s-at-home/paperless ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `paperless` ```console -helm install --name my-release k8s-at-home/paperless +helm install paperless k8s-at-home/paperless ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `paperless` deployment ```console -helm delete my-release --purge +helm uninstall paperless ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -The chart's [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/paperless/values.yaml) file contains a set of suggested values for a minimal deployment. Further configuration options are found in the [common library](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml). All configuration for the Paperless application itself is through environment variables. Please refer to the links provided in chart's [values](https://github.com/k8s-at-home/charts/blob/master/charts/paperless/values.yaml) file. +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console helm install paperless \ - --set env.PAPERLESS_TIME_ZONE="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/paperless ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install paperless k8s-at-home/paperless --values values.yaml +helm install paperless k8s-at-home/paperless -f values.yaml ``` ---- -## Upgrading an existing Release to a new major version +## Custom configuration -A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +N/A -### Upgrading from 2.x.x to 3.x.x +## Values -Version 3.0.0 of this chart has been adapted for [Paperless-ng](https://github.com/jonaswinkler/paperless-ng) (currently a fork of the main project). The default `values.yaml` has been updated accordingly. Changes include: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -* A new set of [environment variables](https://github.com/jonaswinkler/paperless-ng/blob/master/paperless.conf.example) -* New mouthPath defaults for the consume and export volumes -* Seperate consumer pod no longer required. \ No newline at end of file +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalContainers[0].image | string | `"redis:6.0"` | | +| additionalContainers[0].imagePullPolicy | string | `"IfNotPresent"` | | +| additionalContainers[0].name | string | `"broker"` | | +| env.COMPOSE_PROJECT_NAME | string | `"paperless"` | | +| env.PAPERLESS_OCR_LANGUAGE | string | `"eng"` | | +| env.PAPERLESS_REDIS | string | `"redis://localhost:6379"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"jonaswinkler/paperless-ng"` | | +| image.tag | string | `"latest"` | | +| ingress.enabled | bool | `false` | | +| persistence.consume.emptyDir | bool | `false` | | +| persistence.consume.enabled | bool | `false` | | +| persistence.consume.mountPath | string | `"/usr/src/paperless/consume"` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/usr/src/paperless/data"` | | +| persistence.export.emptyDir | bool | `false` | | +| persistence.export.enabled | bool | `false` | | +| persistence.export.mountPath | string | `"/usr/src/paperless/export"` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/usr/src/paperless/media"` | | +| service.port.port | int | `8000` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/paperless/README.md.gotmpl b/charts/paperless/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/paperless/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/paperless/README_CHANGELOG.md.gotmpl b/charts/paperless/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/paperless/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/paperless/README_CONFIG.md.gotmpl b/charts/paperless/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/paperless/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/photoprism/.helmignore b/charts/photoprism/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/photoprism/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/photoprism/README.md b/charts/photoprism/README.md index 375b1133..0af8fbb3 100644 --- a/charts/photoprism/README.md +++ b/charts/photoprism/README.md @@ -1,69 +1,119 @@ -# Photoprism +# photoprism -This is a helm chart for [PhotoPrism](https://github.com/photoprism/photoprism). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 20201122](https://img.shields.io/badge/AppVersion-20201122-informational?style=flat-square) + +PhotoPrism® is a server-based application for browsing, organizing and sharing your personal photo collection **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -This chart requires heavy customization of the `env: {}` block within values.yaml to configure the service to operate properly. See the PhotoPrism [documentation](https://docs.photoprism.org/getting-started/config-options/) for available config options. +## Requirements -## TL;DR; +Kubernetes: `>=1.16.0-0` -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/photoprism +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install photoprism k8s-at-home/photoprism ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `photoprism` ```console -helm install --name my-release k8s-at-home/photoprism +helm install photoprism k8s-at-home/photoprism ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `photoprism` deployment ```console -helm delete my-release --purge +helm uninstall photoprism ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/photoprism/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install photoprism \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/photoprism ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install photoprism k8s-at-home/photoprism --values values.yaml +helm install photoprism k8s-at-home/photoprism -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env.PHOTOPRISM_ORIGINALS_PATH | string | `"/photoprism/originals"` | | +| env.PHOTOPRISM_STORAGE_PATH | string | `"/photoprism/storage"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"photoprism/photoprism"` | | +| image.tag | string | `"20201122"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/photoprism/storage"` | | +| persistence.originals.emptyDir | bool | `false` | | +| persistence.originals.enabled | bool | `false` | | +| persistence.originals.mountPath | string | `"/photoprism/originals"` | | +| service.port.port | int | `2342` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/photoprism/README.md.gotmpl b/charts/photoprism/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/photoprism/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/photoprism/README_CHANGELOG.md.gotmpl b/charts/photoprism/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/photoprism/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/photoprism/README_CONFIG.md.gotmpl b/charts/photoprism/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/photoprism/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/piaware/.helmignore b/charts/piaware/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/piaware/.helmignore +++ b/charts/piaware/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/piaware/README.md b/charts/piaware/README.md index cea805f9..4bfcdd0e 100644 --- a/charts/piaware/README.md +++ b/charts/piaware/README.md @@ -1,24 +1,68 @@ # piaware -This is a helm chart for [piaware](https://github.com/flightaware/piaware). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: v4.0](https://img.shields.io/badge/AppVersion-v4.0-informational?style=flat-square) + +Program for forwarding ADS-B data to FlightAware **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/piaware +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install piaware k8s-at-home/piaware ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `piaware` ```console -helm install --name my-release k8s-at-home/piaware +helm install piaware k8s-at-home/piaware ``` +## Uninstalling the Chart + +To uninstall the `piaware` deployment + +```console +helm uninstall piaware +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install piaware \ + --set env.TZ="America/New York" \ + k8s-at-home/piaware +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install piaware k8s-at-home/piaware -f values.yaml +``` + +## Custom configuration + **IMPORTANT NOTE:** a piaware device must be accessible on the node where this pod runs, in order for this chart to function properly. First, you will need to mount your piaware device into the pod, you can do so by adding the following to your values: @@ -50,59 +94,53 @@ affinity: ... where a node with an attached piaware USB device is labeled with `app: piaware` -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts[0].mountPath | string | `"/dev/bus/usb/001/004"` | | +| additionalVolumeMounts[0].name | string | `"usb"` | | +| additionalVolumes[0].hostPath.path | string | `"/dev/bus/usb/001/004"` | | +| additionalVolumes[0].name | string | `"usb"` | | +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"mikenye/piaware"` | | +| image.tag | string | `"v4.0"` | | +| ingress.enabled | bool | `false` | | +| securityContext.privileged | bool | `true` | | +| service.port.port | int | `8080` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/piaware/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install my-release \ - --set env.TZ="America/New_York" \ - k8s-at-home/piaware -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install my-release k8s-at-home/piaware --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -```yaml -image: - tag: ... -``` +### [1.0.0] ---- -**NOTE** +#### Added -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +- N/A ---- +#### Changed -## Upgrading an existing Release to a new major version +- N/A -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +#### Removed -### Upgrading from 2.x.x to 3.x.x +- N/A -As of 3.0.0 this chart was migrated to a centralized [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library, some values in `values.yaml` have changed. +[1.0.0]: #1.0.0 -Examples: +## Support -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community -Refer to the [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library for more configuration options. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/piaware/README.md.gotmpl b/charts/piaware/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/piaware/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/piaware/README_CHANGELOG.md.gotmpl b/charts/piaware/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/piaware/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/piaware/README_CONFIG.md.gotmpl b/charts/piaware/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..ad234eb1 --- /dev/null +++ b/charts/piaware/README_CONFIG.md.gotmpl @@ -0,0 +1,38 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +**IMPORTANT NOTE:** a piaware device must be accessible on the node where this pod runs, in order for this chart to function properly. + +First, you will need to mount your piaware device into the pod, you can do so by adding the following to your values: + +```yaml +additionalVolumeMounts: + - name: usb + mountPath: /path/to/device + +additionalVolumes: + - name: usb + hostPath: + path: /path/to/device +``` + +Second you will need to set a nodeAffinity rule, for example: + +```yaml +affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: app + operator: In + values: + - piaware +``` + +... where a node with an attached piaware USB device is labeled with `app: piaware` +{{- end -}} diff --git a/charts/plex-media-server/.helmignore b/charts/plex-media-server/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/plex-media-server/.helmignore +++ b/charts/plex-media-server/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/plex-media-server/README.md b/charts/plex-media-server/README.md index 7d1dbfbc..37908afa 100644 --- a/charts/plex-media-server/README.md +++ b/charts/plex-media-server/README.md @@ -1,7 +1,122 @@ # plex-media-server +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v1.21.3.4021-5a0a3e4b2](https://img.shields.io/badge/AppVersion-v1.21.3.4021--5a0a3e4b2-informational?style=flat-square) + +Plex Media Server + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install plex-media-server k8s-at-home/plex-media-server +``` + +## Installing the Chart + +To install the chart with the release name `plex-media-server` + +```console +helm install plex-media-server k8s-at-home/plex-media-server +``` + +## Uninstalling the Chart + +To uninstall the `plex-media-server` deployment + +```console +helm uninstall plex-media-server +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install plex-media-server \ + --set env.TZ="America/New York" \ + k8s-at-home/plex-media-server +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install plex-media-server k8s-at-home/plex-media-server -f values.yaml +``` + +## Custom configuration + **Do not use this chart, this is currently for testing bringing in the common library and using the k8s-at-home container image** Be sure to use the [plex](https://github.com/k8s-at-home/charts/tree/master/charts/plex) chart instead. -**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** \ No newline at end of file +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** + +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"ghcr.io/k8s-at-home/plex-media-server"` | | +| image.tag | string | `"v1.21.3.4021-5a0a3e4b2"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/config"` | | +| persistence.transcode.emptyDir | bool | `false` | | +| persistence.transcode.enabled | bool | `false` | | +| persistence.transcode.mountPath | string | `"/transcode"` | | +| service.port.port | int | `32400` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/plex-media-server/README.md.gotmpl b/charts/plex-media-server/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/plex-media-server/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/plex-media-server/README_CHANGELOG.md.gotmpl b/charts/plex-media-server/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/plex-media-server/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/plex-media-server/README_CONFIG.md.gotmpl b/charts/plex-media-server/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..ae7eb34c --- /dev/null +++ b/charts/plex-media-server/README_CONFIG.md.gotmpl @@ -0,0 +1,13 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +**Do not use this chart, this is currently for testing bringing in the common library and using the k8s-at-home container image** + +Be sure to use the [plex](https://github.com/k8s-at-home/charts/tree/master/charts/plex) chart instead. + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} diff --git a/charts/plex/README.md b/charts/plex/README.md index d086f384..b7073d98 100644 --- a/charts/plex/README.md +++ b/charts/plex/README.md @@ -1,48 +1,125 @@ -# Plex Media Server helm chart +# plex -This is an opinionated helm chart for Plex Media Center based on the [official container image](https://hub.docker.com/r/plexinc/pms-docker/). +![Version: 2.3.0](https://img.shields.io/badge/Version-2.3.0-informational?style=flat-square) ![AppVersion: 1.20.2.3402](https://img.shields.io/badge/AppVersion-1.20.2.3402-informational?style=flat-square) -This chart is 'forked' from the excellent [munnerz/kube-plex](https://github.com/munnerz/kube-plex) repo in order to allow for more timely updates and publishing to a helm registry. **NOTE:** This chart is not compatible as an upgrade from the `kube-plex` chart. +Plex Media Server -## TL;DR +**Homepage:** -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/plex -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `plex`: +## Source Code -```console -helm install plex k8s-at-home/plex -``` +* +* -## Uninstalling the Chart +## Values -To uninstall/delete the `plex` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| certificate.pkcsMangler.certificateSecret.crtName | string | `"tls.crt"` | | +| certificate.pkcsMangler.certificateSecret.keyName | string | `"tls.key"` | | +| certificate.pkcsMangler.certificateSecret.name | string | `""` | | +| certificate.pkcsMangler.certificateSecret.volume.mountPath | string | `"/etc/plex-certs"` | | +| certificate.pkcsMangler.certificateSecret.volume.name | string | `"plex-certs"` | | +| certificate.pkcsMangler.configmap.annotations | object | `{}` | | +| certificate.pkcsMangler.configmap.labels | object | `{}` | | +| certificate.pkcsMangler.configmap.name | string | `"42-pkcs-mangler"` | | +| certificate.pkcsMangler.enabled | bool | `false` | | +| certificate.pkcsMangler.image.repository | string | `"tlsprint/openssl"` | | +| certificate.pkcsMangler.image.tag | string | `"1.1.1f"` | | +| certificate.pkcsMangler.pfxInContainerPath | string | `"/config/plex.pfx"` | | +| certificate.pkcsMangler.pfxPassword.annotations | object | `{}` | | +| certificate.pkcsMangler.pfxPassword.labels | object | `{}` | | +| certificate.pkcsMangler.pfxPassword.passwordKey | string | `"pfx-password"` | | +| certificate.pkcsMangler.pfxPassword.secretName | string | `"plex-media-server-pfx-password"` | | +| certificate.pkcsMangler.pfxPassword.value | string | `"setpassword"` | | +| certificate.pkcsMangler.setPlexPreferences.customCertificateDomain | string | `""` | | +| certificate.pkcsMangler.setPlexPreferences.enabled | bool | `true` | | +| certificate.pkcsMangler.volume.defaultMode | int | `493` | | +| certificate.pkcsMangler.volume.mountPath | string | `"/etc/cont-init.d/42-pkcs-mangler"` | | +| certificate.pkcsMangler.volume.name | string | `"42-pkcs-mangler"` | | +| certificate.pkcsMangler.volume.subPath | string | `"42-pkcs-mangler"` | | +| claimToken | string | `""` | | +| deploymentAnnotations | object | `{}` | | +| fullnameOverride | string | `""` | | +| hostNetwork | bool | `false` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"plexinc/pms-docker"` | | +| image.tag | string | `"1.20.2.3402-0fec14d92"` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| logging.promtail.enabled | bool | `false` | | +| logging.promtail.image.pullPolicy | string | `"IfNotPresent"` | | +| logging.promtail.image.repository | string | `"grafana/promtail"` | | +| logging.promtail.image.tag | string | `"1.6.0"` | | +| logging.promtail.loki.url | string | `"http://loki.logs.svc.cluster.local:3100/loki/api/v1/push"` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.size | string | `"20Gi"` | | +| persistence.config.storageClass | string | `""` | | +| persistence.data.accessMode | string | `"ReadWriteOnce"` | | +| persistence.data.enabled | bool | `true` | | +| persistence.data.size | string | `"40Gi"` | | +| persistence.data.storageClass | string | `""` | | +| persistence.extraData | list | `[]` | | +| persistence.extraMounts | list | `[]` | | +| persistence.transcode.accessMode | string | `"ReadWriteOnce"` | | +| persistence.transcode.emptyDir.medium | string | `""` | | +| persistence.transcode.enabled | bool | `false` | | +| persistence.transcode.size | string | `"20Gi"` | | +| persistence.transcode.storageClass | string | `""` | | +| plexPreferences.configmap.annotations | object | `{}` | | +| plexPreferences.configmap.labels | object | `{}` | | +| plexPreferences.configmap.name | string | `"41-plex-preferences"` | | +| plexPreferences.enabled | bool | `false` | | +| plexPreferences.volume.defaultMode | int | `493` | | +| plexPreferences.volume.mountPath | string | `"/etc/cont-init.d/41-plex-preferences"` | | +| plexPreferences.volume.name | string | `"41-plex-preferences"` | | +| plexPreferences.volume.subPath | string | `"41-plex-preferences"` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| probes.liveness.enabled | bool | `true` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.httpGet.path | string | `"/identity"` | | +| probes.liveness.httpGet.port | int | `32400` | | +| probes.liveness.periodSeconds | int | `10` | | +| probes.readiness.enabled | bool | `true` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.httpGet.path | string | `"/identity"` | | +| probes.readiness.httpGet.port | int | `32400` | | +| probes.readiness.periodSeconds | int | `10` | | +| probes.startup.enabled | bool | `true` | | +| probes.startup.failureThreshold | int | `30` | | +| probes.startup.httpGet.path | string | `"/identity"` | | +| probes.startup.httpGet.port | int | `32400` | | +| probes.startup.initialDelaySeconds | int | `5` | | +| probes.startup.periodSeconds | int | `10` | | +| proxy.enabled | bool | `false` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| serviceTCP.annotations | object | `{}` | | +| serviceTCP.labels | object | `{}` | | +| serviceTCP.loadBalancerIP | string | `nil` | | +| serviceTCP.port | int | `32400` | | +| serviceTCP.type | string | `"ClusterIP"` | | +| serviceUDP.annotations | object | `{}` | | +| serviceUDP.labels | object | `{}` | | +| serviceUDP.loadBalancerIP | string | `nil` | | +| serviceUDP.type | string | `"ClusterIP"` | | +| strategyType | string | `"Recreate"` | | +| timezone | string | `"UTC"` | | +| tolerations | list | `[]` | | -```console -helm delete plex -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/plex/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install plex \ - --set timezone="America/New York" \ - k8s-at-home/plex -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install plex -f values.yaml k8s-at-home/plex -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/powerdns/README.md b/charts/powerdns/README.md new file mode 100644 index 00000000..325dcc9c --- /dev/null +++ b/charts/powerdns/README.md @@ -0,0 +1,84 @@ +# powerdns + +![Version: 3.0.3](https://img.shields.io/badge/Version-3.0.3-informational?style=flat-square) ![AppVersion: v4.3.1](https://img.shields.io/badge/AppVersion-v4.3.1-informational?style=flat-square) + +PowerDNS is a DNS server, written in C++ and licensed under the GPL. It runs on most Unix derivatives. PowerDNS features a large number of different backends ranging from simple BIND style zonefiles to relational databases and load balancing/failover algorithms. A DNS recursor is provided as a separate program. + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| carpenike | ryan@ryanholt.net | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | mariadb | 9.2.5 | +| https://charts.bitnami.com/bitnami | postgresql | 10.2.7 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"Always"` | | +| image.repository | string | `"naps/powerdns"` | | +| image.tag | string | `"4.3.1"` | | +| imagePullSecrets | list | `[]` | | +| mariadb.architecture | string | `"standalone"` | | +| mariadb.auth.database | string | `"pdns"` | | +| mariadb.auth.password | string | `"pdns-pass"` | | +| mariadb.auth.rootPassword | string | `"pdnsrootpass"` | | +| mariadb.auth.username | string | `"pdns"` | | +| mariadb.enabled | bool | `false` | | +| mariadb.primary.persistence.enabled | bool | `false` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podSecurityContext | object | `{}` | | +| postgresql.enabled | bool | `true` | | +| postgresql.persistence.enabled | bool | `false` | | +| postgresql.postgresqlDatabase | string | `"pdns"` | | +| postgresql.postgresqlPassword | string | `"pdnspass"` | | +| postgresql.postgresqlPostgresPassword | string | `"pdnsadminpass"` | | +| postgresql.postgresqlUsername | string | `"pdns"` | | +| powerdns.config | object | `{}` | | +| powerdns.dnssec | bool | `true` | | +| powerdns.domain | string | `"mydomain.local"` | | +| powerdns.mysql.database | string | `"pdns"` | | +| powerdns.mysql.password | string | `"pdnspass"` | | +| powerdns.mysql.username | string | `"pdns"` | | +| powerdns.postgres.database | string | `"pdns"` | | +| powerdns.postgres.password | string | `"pdnspass"` | | +| powerdns.postgres.username | string | `"pdns"` | | +| probes.liveness.enabled | bool | `true` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.initialDelaySeconds | int | `30` | | +| probes.liveness.timeoutSeconds | int | `10` | | +| probes.readiness.enabled | bool | `true` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.initialDelaySeconds | int | `30` | | +| probes.readiness.timeoutSeconds | int | `10` | | +| probes.startup.enabled | bool | `false` | | +| probes.startup.failureThreshold | int | `30` | | +| probes.startup.periodSeconds | int | `10` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.externalTrafficPolicy | string | `""` | | +| service.port | int | `53` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `nil` | | +| strategyType | string | `"Recreate"` | | +| tolerations | list | `[]` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/prometheus-nut-exporter/README.md b/charts/prometheus-nut-exporter/README.md index d45b3d1e..485f182b 100644 --- a/charts/prometheus-nut-exporter/README.md +++ b/charts/prometheus-nut-exporter/README.md @@ -1,50 +1,53 @@ -# Prometheus NUT Exporter +# prometheus-nut-exporter -This is a helm chart provides a service monitor to send NUT server metrics to a Prometheus instance. Based on [Prometheus NUT Exporter](https://github.com/HON95/prometheus-nut-exporter). +![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.1](https://img.shields.io/badge/AppVersion-1.0.1-informational?style=flat-square) -## TL;DR; +A Helm chart for Kubernetes -```console -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/prometheus-nut-exporter -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `prometheus-nut-exporter`: +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -```console -helm install --name prometheus-nut-exporter k8s-at-home/prometheus-nut-exporter -``` +## Source Code -## Uninstalling the Chart +* -To uninstall/delete the `prometheus-nut-exporter` deployment: +## Values -```console -helm delete prometheus-nut-exporter -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| env | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"hon95/prometheus-nut-exporter"` | | +| image.tag | string | `"1.0.1"` | | +| imagePullSecrets | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.initialDelaySeconds | int | `30` | | +| probes.liveness.timeoutSeconds | int | `10` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.initialDelaySeconds | int | `30` | | +| probes.readiness.timeoutSeconds | int | `10` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `9995` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| serviceMonitor.enabled | bool | `false` | | +| serviceMonitor.targets | list | `[]` | | +| tolerations | list | `[]` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/prometheus-nut-exporter/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name prometheus-nut-exporter \ - --set serviceMonitor.enabled=true \ - k8s-at-home/prometheus-nut-exporter -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name prometheus-nut-exporter -f values.yaml k8s-at-home/prometheus-nut-exporter -``` - -## Metrics - -You can find the exported metrics here: [metrics](https://github.com/HON95/prometheus-nut-exporter/blob/master/metrics.md). +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/protonmail-bridge/.helmignore b/charts/protonmail-bridge/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/protonmail-bridge/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/protonmail-bridge/README.md b/charts/protonmail-bridge/README.md index d5ecd86e..2f27b112 100644 --- a/charts/protonmail-bridge/README.md +++ b/charts/protonmail-bridge/README.md @@ -1,36 +1,70 @@ -# Protonmail-bridge +# protonmail-bridge -This is a helm chart for [Protonmail-bridge](https://github.com/shenxn/protonmail-bridge-docker). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 1.5.7-1](https://img.shields.io/badge/AppVersion-1.5.7--1-informational?style=flat-square) + +Container for protonmail bridge to work on the network. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/protonmail-bridge +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install protonmail-bridge k8s-at-home/protonmail-bridge ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `protonmail-bridge` ```console -helm install --name my-release k8s-at-home/protonmail-bridge +helm install protonmail-bridge k8s-at-home/protonmail-bridge ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `protonmail-bridge` deployment ```console -helm delete my-release --purge +helm uninstall protonmail-bridge ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install protonmail-bridge \ + --set env.TZ="America/New York" \ + k8s-at-home/protonmail-bridge +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install protonmail-bridge k8s-at-home/protonmail-bridge -f values.yaml +``` + +## Custom configuration + Once installed do the following to configure the application within the pod: + 1. Get the name of your deployed pod `kubectl get pods` 2. Run interactively on the pod (setup only) `kubectl exec --stdin --tty protonmail-bridge-deployment-6c79fd7f84-ftwcw -- /bin/bash` 3. Once logged in, execute the init command `bash /protonmail/entrypoint.sh init` @@ -39,50 +73,51 @@ Once installed do the following to configure the application within the pod: 6. Copy your SMTP server info (or IMAP, your choice) 7. Delete the active pod so a new one gets created (which will properly fire up with your persisted settings) -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/protonmail-bridge/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +## Values -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install protonmail-bridge \ - --set env.TZ="America/New_York" \ - k8s-at-home/protonmail-bridge -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install protonmail-bridge k8s-at-home/protonmail-bridge --values values.yaml -``` +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```yaml -image: - tag: ... -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"shenxn/protonmail-bridge"` | | +| image.tag | string | `"1.5.7-1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.enabled | bool | `true` | | +| persistence.config.mountPath | string | `"/root"` | | +| service.port.name | string | `"smtp-service"` | | +| service.port.port | int | `25` | | +| strategy.type | string | `"Recreate"` | | +## Changelog ---- -**NOTE** +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ---- +### [1.0.0] -## Upgrading an existing Release to a new major version +#### Added -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +- N/A -### Upgrading from 3.x.x to 4.x.x +#### Changed -Due to migrating to a centralized common library some values in `values.yaml` have changed. +- N/A -Examples: +#### Removed -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +- N/A -Refer to the library values.yaml for more configuration options. +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/protonmail-bridge/README.md.gotmpl b/charts/protonmail-bridge/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/protonmail-bridge/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/protonmail-bridge/README_CHANGELOG.md.gotmpl b/charts/protonmail-bridge/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/protonmail-bridge/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/protonmail-bridge/README_CONFIG.md.gotmpl b/charts/protonmail-bridge/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..a5906906 --- /dev/null +++ b/charts/protonmail-bridge/README_CONFIG.md.gotmpl @@ -0,0 +1,17 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +Once installed do the following to configure the application within the pod: + +1. Get the name of your deployed pod `kubectl get pods` +2. Run interactively on the pod (setup only) `kubectl exec --stdin --tty protonmail-bridge-deployment-6c79fd7f84-ftwcw -- /bin/bash` +3. Once logged in, execute the init command `bash /protonmail/entrypoint.sh init` +4. You should now see the CLI for protonmail-bridge, authenticate with login +5. (optional) If you use split address mode, change mode and info are good for printing the details. +6. Copy your SMTP server info (or IMAP, your choice) +7. Delete the active pod so a new one gets created (which will properly fire up with your persisted settings) +{{- end -}} diff --git a/charts/pyload/.helmignore b/charts/pyload/.helmignore index ede8444e..4379e2b3 100644 --- a/charts/pyload/.helmignore +++ b/charts/pyload/.helmignore @@ -18,7 +18,9 @@ # Various IDEs .project .idea/ -.vscode/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/pyload/README.md b/charts/pyload/README.md index cdfbe192..00d3df60 100644 --- a/charts/pyload/README.md +++ b/charts/pyload/README.md @@ -1,67 +1,114 @@ -# pyLoad +# pyload -This is a helm chart for [pyLoad](https://github.com/pyload/pyload). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 0.4.20](https://img.shields.io/badge/AppVersion-0.4.20-informational?style=flat-square) + +pyLoad is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/pyload +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install pyload k8s-at-home/pyload ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `pyload` ```console -helm install --name my-release k8s-at-home/pyload +helm install pyload k8s-at-home/pyload ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `pyload` deployment ```console -helm delete my-release --purge +helm uninstall pyload ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/pyload/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install pyload \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/pyload ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install pyload k8s-at-home/pyload --values values.yaml +helm install pyload k8s-at-home/pyload -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/pyload"` | | +| image.tag | string | `"version-5f5aaf56"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `8000` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/pyload/README.md.gotmpl b/charts/pyload/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/pyload/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/pyload/README_CHANGELOG.md.gotmpl b/charts/pyload/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/pyload/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/pyload/README_CONFIG.md.gotmpl b/charts/pyload/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/pyload/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/qbittorrent/.helmignore b/charts/qbittorrent/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/qbittorrent/.helmignore +++ b/charts/qbittorrent/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/qbittorrent/README.md b/charts/qbittorrent/README.md index 8a6c4460..23ea6116 100644 --- a/charts/qbittorrent/README.md +++ b/charts/qbittorrent/README.md @@ -1,82 +1,131 @@ -# qBittorrent +# qbittorrent -This is a helm chart for [qbittorrent](https://qbittorrent.org/). +![Version: 8.0.1](https://img.shields.io/badge/Version-8.0.1-informational?style=flat-square) ![AppVersion: 4.3.0](https://img.shields.io/badge/AppVersion-4.3.0-informational?style=flat-square) + +qBittorrent is a cross-platform free and open-source BitTorrent client **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/qbittorrent +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install qbittorrent k8s-at-home/qbittorrent ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `qbittorrent` ```console -helm install --name my-release k8s-at-home/qbittorrent +helm install qbittorrent k8s-at-home/qbittorrent ``` -The default login details (change ASAP) are: - -* login:admin -* password:adminadmin - ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `qbittorrent` deployment ```console -helm delete my-release --purge +helm uninstall qbittorrent ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/qbittorrent/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -helm install my-release \ - --set env.TZ="America/New_York" \ +helm install qbittorrent \ + --set env.TZ="America/New York" \ k8s-at-home/qbittorrent ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install my-release k8s-at-home/qbittorrent --values values.yaml +helm install qbittorrent k8s-at-home/qbittorrent -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts[0].mountPath | string | `"/config/custom-cont-init.d"` | | +| additionalVolumeMounts[0].name | string | `"qbittorrent-scripts"` | | +| additionalVolumes[0].emptyDir | object | `{}` | | +| additionalVolumes[0].name | string | `"qbittorrent-scripts"` | | +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/qbittorrent"` | | +| image.tag | string | `"version-4.3.0202010181232-7086-1c663adeeubuntu18.04.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.downloads.emptyDir | bool | `false` | | +| persistence.downloads.enabled | bool | `false` | | +| persistence.downloads.mountPath | string | `"/downloads"` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.additionalServices[0].enabled | bool | `true` | | +| service.additionalServices[0].nameSuffix | string | `"bittorrent"` | | +| service.additionalServices[0].port.name | string | `"bittorrent"` | | +| service.additionalServices[0].port.port | int | `6881` | | +| service.additionalServices[0].port.protocol | string | `"TCP"` | | +| service.additionalServices[0].port.targetPort | int | `6881` | | +| service.additionalServices[0].type | string | `"ClusterIP"` | | +| service.port.port | int | `8080` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 5.x.x to 6.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/qbittorrent/README.md.gotmpl b/charts/qbittorrent/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/qbittorrent/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/qbittorrent/README_CHANGELOG.md.gotmpl b/charts/qbittorrent/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/qbittorrent/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/qbittorrent/README_CONFIG.md.gotmpl b/charts/qbittorrent/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/qbittorrent/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/radarr/.helmignore b/charts/radarr/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/radarr/.helmignore +++ b/charts/radarr/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/radarr/README.md b/charts/radarr/README.md index c9841d10..c1989d9d 100644 --- a/charts/radarr/README.md +++ b/charts/radarr/README.md @@ -1,78 +1,117 @@ -# Radarr +# radarr -This is a helm chart for [Radarr](https://github.com/Radarr/Radarr). +![Version: 9.0.1](https://img.shields.io/badge/Version-9.0.1-informational?style=flat-square) ![AppVersion: 3.0.0.3989](https://img.shields.io/badge/AppVersion-3.0.0.3989-informational?style=flat-square) + +A fork of Sonarr to work with movies à la Couchpotato **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/radarr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install radarr k8s-at-home/radarr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `radarr` ```console -helm install --name my-release k8s-at-home/radarr +helm install radarr k8s-at-home/radarr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `radarr` deployment ```console -helm delete my-release --purge +helm uninstall radarr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/radarr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install radarr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/radarr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install radarr k8s-at-home/radarr --values values.yaml +helm install radarr k8s-at-home/radarr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/radarr"` | | +| image.tag | string | `"version-3.0.0.3989"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `7878` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 6.x.x to 7.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/radarr/README.md.gotmpl b/charts/radarr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/radarr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/radarr/README_CHANGELOG.md.gotmpl b/charts/radarr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/radarr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/radarr/README_CONFIG.md.gotmpl b/charts/radarr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/radarr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/readarr/.helmignore b/charts/readarr/.helmignore index bb3b20ac..4379e2b3 100644 --- a/charts/readarr/.helmignore +++ b/charts/readarr/.helmignore @@ -19,6 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS -.vscode/ +# helm-docs templates +*.gotmpl diff --git a/charts/readarr/README.md b/charts/readarr/README.md index 92baec90..8ab3b99e 100644 --- a/charts/readarr/README.md +++ b/charts/readarr/README.md @@ -1,55 +1,118 @@ -# Readarr +# readarr -This is a helm chart for [Readarr](https://github.com/Readarr/Readarr). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 0.1.0.351](https://img.shields.io/badge/AppVersion-0.1.0.351-informational?style=flat-square) -**Readarr is still in early development, and this chart will install a nightly build of Readarr. -[See the project readme for more information](https://github.com/Readarr/Readarr#readarr-is-in-early-stages-of-development-alphabeta-binary-builds-are-not-yet-available-use-of-any-test-builds-isnt-recommend-and-may-have-detrimental-effects-on-your-library). Take back-up's if you decide to use this on an existing library as the project is considered unstable** +A fork of Radarr to work with Books & AudioBooks **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/readarr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install readarr k8s-at-home/readarr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `readarr` ```console -helm install --name my-release k8s-at-home/readarr +helm install readarr k8s-at-home/readarr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `readarr` deployment ```console -helm delete my-release --purge +helm uninstall readarr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/readarr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install readarr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/readarr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install readarr k8s-at-home/readarr --values values.yaml +helm install readarr k8s-at-home/readarr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration + +**Readarr is still in early development, and this chart will install a nightly build of Readarr. +[See the project readme for more information](https://github.com/Readarr/Readarr#readarr-is-in-early-stages-of-development-alphabeta-binary-builds-are-not-yet-available-use-of-any-test-builds-isnt-recommend-and-may-have-detrimental-effects-on-your-library). Take back-up's if you decide to use this on an existing library as the project is considered unstable** + +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"hotio/readarr"` | | +| image.tag | string | `"nightly"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `8787` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/readarr/README.md.gotmpl b/charts/readarr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/readarr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/readarr/README_CHANGELOG.md.gotmpl b/charts/readarr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/readarr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/readarr/README_CONFIG.md.gotmpl b/charts/readarr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e3101b9d --- /dev/null +++ b/charts/readarr/README_CONFIG.md.gotmpl @@ -0,0 +1,11 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +**Readarr is still in early development, and this chart will install a nightly build of Readarr. +[See the project readme for more information](https://github.com/Readarr/Readarr#readarr-is-in-early-stages-of-development-alphabeta-binary-builds-are-not-yet-available-use-of-any-test-builds-isnt-recommend-and-may-have-detrimental-effects-on-your-library). Take back-up's if you decide to use this on an existing library as the project is considered unstable** + +{{- end -}} diff --git a/charts/recipes/.helmignore b/charts/recipes/.helmignore index 0e8a0eb3..4379e2b3 100644 --- a/charts/recipes/.helmignore +++ b/charts/recipes/.helmignore @@ -14,10 +14,13 @@ *.swp *.bak *.tmp -*.orig *~ # Various IDEs .project .idea/ *.tmproj .vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/recipes/README.md b/charts/recipes/README.md index c2cf8196..3c570c49 100644 --- a/charts/recipes/README.md +++ b/charts/recipes/README.md @@ -1,89 +1,142 @@ -# Recipes +# recipes -This is a helm chart for [Recipes](https://github.com/vabene1111/recipes). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: 0.13.0](https://img.shields.io/badge/AppVersion-0.13.0-informational?style=flat-square) + +Recipes is a Django application to manage, tag and search recipes using either built in models or external storage providers hosting PDF's, Images or other files. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/recipes +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install recipes k8s-at-home/recipes ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `recipes` ```console -helm install --name my-release k8s-at-home/recipes +helm install recipes k8s-at-home/recipes ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `recipes` deployment ```console -helm delete my-release --purge +helm uninstall recipes ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -The following table lists the configurable parameters of the recipes chart and their default values that have to be overriden. +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). -| Parameter | Description | Default | -| -------------------------------------| ------------------------------------------------------------------------------------------- | ------------------------------------------- | -| `env.DEBUG` | Only set this to true when testing/debugging | `0` | -| `env.ALLOWED_HOSTS` | Hosts the application can run under e.g. recipes.mydomain.com,cooking.mydomain.com,... | `*` | -| `env.SECRET_KEY` | Random secret key, use for example `openssl rand -base64 24` to generate one | `changeme` | -| `env.TIMEZONE` | Your default timezone | `America/New_York` | -| `env.DB_ENGINE` | Database connector | `django.db.backends.postgresql_psycopg2` | -| `env.POSTGRES_HOST` | External PostreSQL hostname | | -| `env.POSTGRES_PORT` | External PostreSQL port | | -| `env.POSTGRES_USER` | External PostreSQL user | | -| `env.POSTGRES_DB` | External PostreSQL database name | | -| `env.POSTGRES_PASSWORD` | External PostreSQL database password | | -| `env.GUNICORN_MEDIA` | Serve mediafiles directly using gunicorn. Basically everyone recommends not doing this. | `0` | -| `env.FRACTION_PREF_DEFAULT` | Enable/disable fraction support | `0` | -| `env.COMMENT_PREF_DEFAULT` | Enable/disable commenting system | `1` | -| `env.SHOPPING_MIN_AUTOSYNC_INTERVAL` | Amount of time after which the shopping list is refreshed when they are in viewing mode | `5` | +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. -You can add more environment variables, read through Recipes [.env.template](https://github.com/vabene1111/recipes/blob/master/.env.template) - -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/recipes/values.yaml) -file. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console helm install recipes \ - --set env.POSTGRES_HOST="postgresql.domain" \ + --set env.TZ="America/New York" \ k8s-at-home/recipes ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install recipes k8s-at-home/recipes --values values.yaml +helm install recipes k8s-at-home/recipes -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalContainers[0].image | string | `"nginx:1.19.6"` | | +| additionalContainers[0].name | string | `"nginx"` | | +| additionalContainers[0].ports[0].containerPort | int | `80` | | +| additionalContainers[0].ports[0].name | string | `"http"` | | +| additionalContainers[0].volumeMounts[0].mountPath | string | `"/etc/nginx/nginx.conf"` | | +| additionalContainers[0].volumeMounts[0].name | string | `"recipes-config"` | | +| additionalContainers[0].volumeMounts[0].readOnly | bool | `true` | | +| additionalContainers[0].volumeMounts[0].subPath | string | `"nginx-config"` | | +| additionalVolumes[0].configMap.name | string | `"recipes-config"` | | +| additionalVolumes[0].name | string | `"recipes-config"` | | +| env.ALLOWED_HOSTS | string | `"*"` | | +| env.COMMENT_PREF_DEFAULT | string | `"1"` | | +| env.DB_ENGINE | string | `"django.db.backends.sqlite3"` | | +| env.DEBUG | string | `"0"` | | +| env.FRACTION_PREF_DEFAULT | string | `"0"` | | +| env.GUNICORN_MEDIA | string | `"0"` | | +| env.POSTGRES_DB | string | `nil` | | +| env.POSTGRES_HOST | string | `nil` | | +| env.POSTGRES_PASSWORD | string | `nil` | | +| env.POSTGRES_PORT | string | `nil` | | +| env.POSTGRES_USER | string | `nil` | | +| env.SECRET_KEY | string | `"changeme"` | | +| env.SHOPPING_MIN_AUTOSYNC_INTERVAL | string | `"5"` | | +| env.TIMEZONE | string | `"America/New_York"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"vabene1111/recipes"` | | +| image.tag | string | `"0.13.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/opt/recipes/mediafiles"` | | +| persistence.static.emptyDir | bool | `false` | | +| persistence.static.enabled | bool | `false` | | +| persistence.static.mountPath | string | `"/opt/recipes/staticfiles"` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/recipes/README.md.gotmpl b/charts/recipes/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/recipes/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/recipes/README_CHANGELOG.md.gotmpl b/charts/recipes/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/recipes/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/recipes/README_CONFIG.md.gotmpl b/charts/recipes/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/recipes/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/resilio-sync/.helmignore b/charts/resilio-sync/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/resilio-sync/.helmignore +++ b/charts/resilio-sync/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/resilio-sync/README.md b/charts/resilio-sync/README.md index 6acc1df6..2f829c45 100644 --- a/charts/resilio-sync/README.md +++ b/charts/resilio-sync/README.md @@ -1,68 +1,138 @@ -# Resilio Sync +# resilio-sync -This is a helm chart for [resilio-sync](https://resilio-sync.org/). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 2.7.2](https://img.shields.io/badge/AppVersion-2.7.2-informational?style=flat-square) + +Resilio Sync is a fast, reliable, and simple file sync and share solution, powered by P2P technology **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/resilio-sync +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install resilio-sync k8s-at-home/resilio-sync ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `resilio-sync` ```console -helm install --name my-release k8s-at-home/resilio-sync +helm install resilio-sync k8s-at-home/resilio-sync ``` -The default login details (change ASAP) are: - ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `resilio-sync` deployment ```console -helm delete my-release --purge +helm uninstall resilio-sync ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/resilio-sync/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -helm install my-release \ - --set env.TZ="America/New_York" \ +helm install resilio-sync \ + --set env.TZ="America/New York" \ k8s-at-home/resilio-sync ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install my-release k8s-at-home/resilio-sync --values values.yaml +helm install resilio-sync k8s-at-home/resilio-sync -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"ghcr.io/linuxserver/resilio-sync"` | | +| image.tag | string | `"version-2.7.2.1375"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/config"` | | +| persistence.downloads.emptyDir | bool | `false` | | +| persistence.downloads.enabled | bool | `false` | | +| persistence.downloads.mountPath | string | `"/downloads"` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| persistence.sync.emptyDir | bool | `false` | | +| persistence.sync.enabled | bool | `false` | | +| persistence.sync.mountPath | string | `"/sync"` | | +| service.additionalServices[0].enabled | bool | `true` | | +| service.additionalServices[0].nameSuffix | string | `"bt"` | | +| service.additionalServices[0].port.name | string | `"bt"` | | +| service.additionalServices[0].port.port | int | `55555` | | +| service.additionalServices[0].port.protocol | string | `"TCP"` | | +| service.additionalServices[0].port.targetPort | int | `55555` | | +| service.additionalServices[0].type | string | `"ClusterIP"` | | +| service.additionalServices[1].enabled | bool | `true` | | +| service.additionalServices[1].nameSuffix | string | `"utp"` | | +| service.additionalServices[1].port.name | string | `"utp"` | | +| service.additionalServices[1].port.port | int | `55555` | | +| service.additionalServices[1].port.protocol | string | `"UDP"` | | +| service.additionalServices[1].port.targetPort | int | `55555` | | +| service.additionalServices[1].type | string | `"ClusterIP"` | | +| service.port.port | int | `8888` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/resilio-sync/README.md.gotmpl b/charts/resilio-sync/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/resilio-sync/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/resilio-sync/README_CHANGELOG.md.gotmpl b/charts/resilio-sync/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/resilio-sync/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/resilio-sync/README_CONFIG.md.gotmpl b/charts/resilio-sync/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/resilio-sync/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/rtorrent-flood/README.md b/charts/rtorrent-flood/README.md index 905d4ef5..0d4da2bb 100644 --- a/charts/rtorrent-flood/README.md +++ b/charts/rtorrent-flood/README.md @@ -1,27 +1,74 @@ -# rTorrent/flood BitTorrent client +# rtorrent-flood -## Setup +![Version: 5.0.0](https://img.shields.io/badge/Version-5.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) -NB: This chart will start 2 containers in a single pod, when both containers are started, you will be able to configure flood. +rtorrent and flood co-located in the same deployment -1. Install the chart `helm install rtorrent k8s-at-home/rtorrent-flood` +**Homepage:** -2. Port-forward to the container `kubectl port-forward $(kubectl get pods -A -o json | jq '.items[] | select(.metadata.labels."app.kubernetes.io/name"=="rtorrent-flood")' | jq .metadata.name -r) 3000:3000` +## Maintainers -3. To connect flood to rtorrent, provide the socket path : `/tmp/rtorrent.sock` +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -4. When connected with flood to rtorrent, go to the settings and change the download path to `/data` which is set by default by the chart +## Source Code -5. You should be able to start downloading torrents now :) +* +* +* +## Values -## Custom parameters +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| btService.annotations | object | `{}` | | +| btService.labels | object | `{}` | | +| btService.loadBalancerIP | string | `nil` | | +| btService.port | int | `49161` | | +| btService.type | string | `"NodePort"` | | +| flood.enabled | bool | `true` | | +| flood.image.pullPolicy | string | `"Always"` | | +| flood.image.repository | string | `"jfurrow/flood-ui"` | | +| flood.image.tag | string | `"latest"` | | +| flood.resources.limits.memory | string | `"250Mi"` | | +| flood.resources.requests.cpu | string | `"10m"` | | +| flood.resources.requests.memory | string | `"100Mi"` | | +| floodSecret | string | `"supersecret"` | | +| fullnameOverride | string | `""` | | +| gid | int | `1001` | | +| guiService.annotations | object | `{}` | | +| guiService.labels | object | `{}` | | +| guiService.loadBalancerIP | string | `nil` | | +| guiService.port | int | `3000` | | +| guiService.type | string | `"ClusterIP"` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.enabled | bool | `true` | | +| persistence.config.size | string | `"1Gi"` | | +| persistence.config.skipuninstall | bool | `false` | | +| persistence.data.accessMode | string | `"ReadWriteOnce"` | | +| persistence.data.enabled | bool | `true` | | +| persistence.data.size | string | `"10Gi"` | | +| persistence.data.skipuninstall | bool | `false` | | +| podAnnotations | object | `{}` | | +| rtorrent.enabled | bool | `true` | | +| rtorrent.image.pullPolicy | string | `"Always"` | | +| rtorrent.image.repository | string | `"billimek/rtorrent"` | | +| rtorrent.image.tag | string | `"latest"` | | +| rtorrent.resources.limits.memory | string | `"1Gi"` | | +| rtorrent.resources.requests.cpu | string | `"50m"` | | +| rtorrent.resources.requests.memory | string | `"50Mi"` | | +| strategyType | string | `"Recreate"` | | +| tolerations | list | `[]` | | +| uid | int | `1001` | | -Like any other chart, you can provide a file with your own values (check `./values.yaml` for reference) : - -`helm install rtorrent k8s-at-home/rtorrent-flood -f my-values.yaml` - - -## Pitfalls - -You may need to change the StorageClass depending on your kubernetes setup or the containers won't start, use a custom `values.yaml` file to do so. \ No newline at end of file +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/sabnzbd/.helmignore b/charts/sabnzbd/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/sabnzbd/.helmignore +++ b/charts/sabnzbd/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/sabnzbd/README.md b/charts/sabnzbd/README.md index 4d2aa983..fedcdd0f 100644 --- a/charts/sabnzbd/README.md +++ b/charts/sabnzbd/README.md @@ -1,24 +1,68 @@ -# Sabnzbd +# sabnzbd -This is a helm chart for [Sabnzbd](https://github.com/sabnzbd/sabnzbd). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: 3.1.0](https://img.shields.io/badge/AppVersion-3.1.0-informational?style=flat-square) + +Free and easy binary newsreader **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/sabnzbd +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install sabnzbd k8s-at-home/sabnzbd ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `sabnzbd` ```console -helm install --name my-release k8s-at-home/sabnzbd +helm install sabnzbd k8s-at-home/sabnzbd ``` +## Uninstalling the Chart + +To uninstall the `sabnzbd` deployment + +```console +helm uninstall sabnzbd +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install sabnzbd \ + --set env.TZ="America/New York" \ + k8s-at-home/sabnzbd +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install sabnzbd k8s-at-home/sabnzbd -f values.yaml +``` + +## Custom configuration + **IMPORTANT NOTE:** when installing this chart for the first time you will get the follow message in your browser when trying to access Sabnzbd: `Access denied - Hostname verification failed: sabnzbd.org/hostname-check` You can do one of two things to solve this issue: @@ -26,60 +70,56 @@ You can do one of two things to solve this issue: 1. Update the `sabnzbd.ini` config file to your `ingress` name and/or `loadBalancerIP` to the `host_whitelist` field and restart the pod, or 2. Forward the service to your local machine with `kubectl port-forward service/sabnzbd -n default 8080:8080` and update the `host_whitelist` in the Sabnzbd Settings UI -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/sabnzbd"` | | +| image.tag | string | `"version-3.1.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.downloads.emptyDir | bool | `false` | | +| persistence.downloads.enabled | bool | `false` | | +| persistence.downloads.mountPath | string | `"/downloads"` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `8080` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/sabnzbd/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install sabnzbd \ - --set env.TZ="America/New_York" \ - k8s-at-home/sabnzbd -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install sabnzbd k8s-at-home/sabnzbd --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -```yaml -image: - tag: ... -``` +### [1.0.0] ---- -**NOTE** +#### Added -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +- N/A ---- +#### Changed -## Upgrading an existing Release to a new major version +- N/A -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +#### Removed -### Upgrading from 2.x.x to 3.x.x +- N/A -Due to migrating to a centralized common library some values in `values.yaml` have changed. +[1.0.0]: #1.0.0 -Examples: +## Support -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community -Refer to the library values.yaml for more configuration options. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/sabnzbd/README.md.gotmpl b/charts/sabnzbd/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/sabnzbd/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/sabnzbd/README_CHANGELOG.md.gotmpl b/charts/sabnzbd/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/sabnzbd/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/sabnzbd/README_CONFIG.md.gotmpl b/charts/sabnzbd/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..40e857fc --- /dev/null +++ b/charts/sabnzbd/README_CONFIG.md.gotmpl @@ -0,0 +1,15 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +**IMPORTANT NOTE:** when installing this chart for the first time you will get the follow message in your browser when trying to access Sabnzbd: `Access denied - Hostname verification failed: sabnzbd.org/hostname-check` + +You can do one of two things to solve this issue: + +1. Update the `sabnzbd.ini` config file to your `ingress` name and/or `loadBalancerIP` to the `host_whitelist` field and restart the pod, or +2. Forward the service to your local machine with `kubectl port-forward service/sabnzbd -n default 8080:8080` and update the `host_whitelist` in the Sabnzbd Settings UI + +{{- end -}} diff --git a/charts/samba/.helmignore b/charts/samba/.helmignore index fcf9212f..4379e2b3 100644 --- a/charts/samba/.helmignore +++ b/charts/samba/.helmignore @@ -19,6 +19,8 @@ .project .idea/ *.tmproj -.vscode +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/samba/README.md b/charts/samba/README.md index dbb81bce..2104357e 100644 --- a/charts/samba/README.md +++ b/charts/samba/README.md @@ -1,67 +1,120 @@ # samba -This is a helm chart for a [samba](https://github.com/dperson/samba) server. +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) + +A simple in-cluster Samba server **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/samba +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install samba k8s-at-home/samba ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `samba` ```console -helm install --name my-release k8s-at-home/samba +helm install samba k8s-at-home/samba ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `samba` deployment ```console -helm delete my-release --purge +helm uninstall samba ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/samba/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install samba \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/samba ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install samba k8s-at-home/samba --values values.yaml +helm install samba k8s-at-home/samba -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts | list | `[]` | | +| additionalVolumes | list | `[]` | | +| env | object | `{}` | | +| image.pullPolicy | string | `"Always"` | | +| image.repository | string | `"dperson/samba"` | | +| image.tag | string | `"latest"` | | +| ingress.enabled | bool | `false` | | +| probes.liveness.enabled | bool | `false` | | +| probes.readiness.enabled | bool | `false` | | +| probes.startup.enabled | bool | `false` | | +| service.additionalPorts[0].name | string | `"netbios"` | | +| service.additionalPorts[0].port | int | `139` | | +| service.port.name | string | `"tcp"` | | +| service.port.port | int | `445` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/samba/README.md.gotmpl b/charts/samba/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/samba/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/samba/README_CHANGELOG.md.gotmpl b/charts/samba/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/samba/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/samba/README_CONFIG.md.gotmpl b/charts/samba/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/samba/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/searx/.helmignore b/charts/searx/.helmignore index ede8444e..4379e2b3 100644 --- a/charts/searx/.helmignore +++ b/charts/searx/.helmignore @@ -18,7 +18,9 @@ # Various IDEs .project .idea/ -.vscode/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/searx/README.md b/charts/searx/README.md index 10f6c58a..ce3beb1f 100644 --- a/charts/searx/README.md +++ b/charts/searx/README.md @@ -1,77 +1,164 @@ -# Searx +# searx -This is a helm chart for [Searx](https://github.com/searx/searx). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 0.18.0](https://img.shields.io/badge/AppVersion-0.18.0-informational?style=flat-square) + +Searx is a privacy-respecting, hackable metasearch engine **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/searx +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install searx k8s-at-home/searx ``` -## Configuration - -The following table lists the configurable parameters of the nextcloud chart and their default values that have to be overriden. - -| Parameter | Description | Default | -| --------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------- | -| `searx.baseUrl` | external url | `https://serax.DOMAIN` | -| `searx.mortyKey` | Morty reverse proxy unique key | `changeme` | - - ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `searx` ```console -helm install --name my-release k8s-at-home/searx +helm install searx k8s-at-home/searx ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `searx` deployment ```console -helm delete my-release --purge +helm uninstall searx ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/searx/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install searx \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/searx ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install searx k8s-at-home/searx --values values.yaml +helm install searx k8s-at-home/searx -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalContainers[0].image | string | `"caddy:2.2.0-alpine"` | | +| additionalContainers[0].name | string | `"caddy"` | | +| additionalContainers[0].ports[0].containerPort | int | `80` | | +| additionalContainers[0].ports[0].name | string | `"http"` | | +| additionalContainers[0].volumeMounts[0].mountPath | string | `"/etc/caddy/Caddyfile"` | | +| additionalContainers[0].volumeMounts[0].name | string | `"searx-config"` | | +| additionalContainers[0].volumeMounts[0].subPath | string | `"Caddyfile"` | | +| additionalContainers[0].volumeMounts[1].mountPath | string | `"/srv/searx-checker"` | | +| additionalContainers[0].volumeMounts[1].name | string | `"searx-checker"` | | +| additionalContainers[1].args[0] | string | `"-listen"` | | +| additionalContainers[1].args[1] | string | `"0.0.0.0:4040"` | | +| additionalContainers[1].args[2] | string | `"-api"` | | +| additionalContainers[1].args[3] | string | `"0.0.0.0:4041"` | | +| additionalContainers[1].args[4] | string | `"-target"` | | +| additionalContainers[1].args[5] | string | `"localhost:8080"` | | +| additionalContainers[1].image | string | `"dalf/filtron:latest"` | | +| additionalContainers[1].imagePullPolicy | string | `"Always"` | | +| additionalContainers[1].name | string | `"filtron"` | | +| additionalContainers[1].ports[0].containerPort | int | `4040` | | +| additionalContainers[1].ports[0].name | string | `"filtron"` | | +| additionalContainers[1].ports[1].containerPort | int | `4041` | | +| additionalContainers[1].ports[1].name | string | `"api"` | | +| additionalContainers[1].volumeMounts[0].mountPath | string | `"/etc/filtron/rules.json"` | | +| additionalContainers[1].volumeMounts[0].name | string | `"searx-config"` | | +| additionalContainers[1].volumeMounts[0].subPath | string | `"rules.json"` | | +| additionalContainers[2].args[0] | string | `"-listen"` | | +| additionalContainers[2].args[1] | string | `"localhost:3000"` | | +| additionalContainers[2].args[2] | string | `"-timeout"` | | +| additionalContainers[2].args[3] | string | `"6"` | | +| additionalContainers[2].args[4] | string | `"ipv6"` | | +| additionalContainers[2].envFrom[0].secretRef.name | string | `"searx-config"` | | +| additionalContainers[2].image | string | `"dalf/morty:latest"` | | +| additionalContainers[2].imagePullPolicy | string | `"Always"` | | +| additionalContainers[2].name | string | `"morty"` | | +| additionalContainers[2].ports[0].containerPort | int | `3000` | | +| additionalContainers[2].ports[0].name | string | `"morty"` | | +| additionalContainers[3].args[0] | string | `"-cron"` | | +| additionalContainers[3].args[1] | string | `"-o"` | | +| additionalContainers[3].args[2] | string | `"html/data/status.json"` | | +| additionalContainers[3].args[3] | string | `"http://localhost:8080"` | | +| additionalContainers[3].image | string | `"searx/searx-checker:latest"` | | +| additionalContainers[3].name | string | `"searx-checker"` | | +| additionalContainers[3].volumeMounts[0].mountPath | string | `"/usr/local/searx-checker/html/data"` | | +| additionalContainers[3].volumeMounts[0].name | string | `"searx-checker"` | | +| additionalVolumes[0].configMap.name | string | `"searx-config"` | | +| additionalVolumes[0].name | string | `"searx-config"` | | +| additionalVolumes[1].emptyDir | object | `{}` | | +| additionalVolumes[1].name | string | `"searx-checker"` | | +| envFrom[0].secretRef.name | string | `"searx-config"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"searx/searx"` | | +| image.tag | string | `"0.18.0"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| searx.baseUrl | string | `"https://searx.DOMAIN"` | | +| searx.mortyKey | string | `"changeme"` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/searx/README.md.gotmpl b/charts/searx/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/searx/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/searx/README_CHANGELOG.md.gotmpl b/charts/searx/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/searx/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/searx/README_CONFIG.md.gotmpl b/charts/searx/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/searx/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/ser2sock/README.md b/charts/ser2sock/README.md index 640daada..2ae5e407 100644 --- a/charts/ser2sock/README.md +++ b/charts/ser2sock/README.md @@ -1,86 +1,46 @@ -# ser2sock: Serial to Socket Redirector +# ser2sock -This is a helm chart for [ser2sock](https://github.com/nutechsoftware/ser2sock) +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) -## TL;DR; +Serial to Socket Redirector -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/ser2sock -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -```console -helm install --name my-release k8s-at-home/ser2sock -``` +## Source Code -**IMPORTANT NOTE:** the USB device must be accessible on the node where this pod runs, in order for this chart to function properly. +* +* -A way to achieve this can be with nodeAffinity rules, for example: +## Values -```yaml -affinity: - nodeAffinity: - requiredDuringSchedulingIgnoredDuringExecution: - nodeSelectorTerms: - - matchExpressions: - - key: usb - operator: In - values: - - alarmdecoder -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| baudRate | int | `115200` | | +| device | string | `"/dev/ttyUSB0"` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"tenstartups/ser2sock"` | | +| image.tag | string | `"latest"` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| pgid | string | `"1001"` | | +| podAnnotations | object | `{}` | | +| puid | string | `"1001"` | | +| resources | object | `{}` | | +| service.annotations | object | `{}` | | +| service.labels | object | `{}` | | +| service.loadBalancerIP | string | `nil` | | +| service.port | int | `10000` | | +| service.type | string | `"ClusterIP"` | | +| strategyType | string | `"Recreate"` | | +| tolerations | list | `[]` | | -... where a node with an attached Coral USB device is labeled with `usb: alarmdecoder` - -## Uninstalling the Chart - -To uninstall/delete the `my-release` deployment: - -```console -helm delete my-release --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -|----------------------------|-------------------------------------|---------------------------------------------------------| -| `image.repository` | Image repository | `tenstartups/ser2sock` | -| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/tenstartups/ser2sock/tags).| `latest`| -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `timezone` | Timezone the ser2sock instance should run as, e.g. 'America/New_York' | `` | -| `device` | USB Device to use | `/dev/ttyUSB0` | -| `puid` | UID to run as | `1001` | -| `pgid` | GID to run as | `1001` | -| `Service.type` | Kubernetes service type for the ser2sock GUI | `ClusterIP` | -| `Service.port` | Kubernetes port where the ser2sock GUI is exposed| `5000` | -| `Service.annotations` | Service annotations for the ser2sock GUI | `{}` | -| `Service.labels` | Custom labels | `{}` | -| `Service.loadBalancerIP` | Loadbalance IP for the ser2sock GUI | `{}` | -| `Service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Toleration labels for pod assignment | `[]` | -| `affinity` | Affinity settings for pod assignment | `{}` | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name my-release \ - k8s-at-home/ser2sock -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name my-release -f values.yaml k8s-at-home/ser2sock -``` - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/ser2sock/values.yaml) file. It has several commented out suggested values. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/smarter-device-manager/.helmignore b/charts/smarter-device-manager/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/smarter-device-manager/.helmignore +++ b/charts/smarter-device-manager/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/smarter-device-manager/README.md b/charts/smarter-device-manager/README.md index eba725bb..35a24f07 100644 --- a/charts/smarter-device-manager/README.md +++ b/charts/smarter-device-manager/README.md @@ -1,31 +1,70 @@ -# smarter device manager +# smarter-device-manager -This is a helm chart for [smarter-device-manager](https://gitlab.com/arm-research/smarter/smarter-device-manager/) -([see also](https://community.arm.com/developer/research/b/articles/posts/a-smarter-device-manager-for-kubernetes-on-the-edge)). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 1.1.2](https://img.shields.io/badge/AppVersion-1.1.2-informational?style=flat-square) -This tool discovers host hardware resources and manages their provisioning for the pods, decoupling host paths from them, and ensuring that pods don't compete for the same piece of hardware. - -Typical use cases are Zigbee/Zwave USB dongles for other charts available in this repository (Zigbee2MQTT, ZwaveJS2MQTT). +Manage hardware resource allocation without a need for privileged containers **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/smarter-device-manager +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install smarter-device-manager k8s-at-home/smarter-device-manager ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `smarter-device-manager` ```console -helm install --name my-release k8s-at-home/smarter-device-manager +helm install smarter-device-manager k8s-at-home/smarter-device-manager ``` -Please consider overriding the default configuration through `values.yaml` file. -For example: +## Uninstalling the Chart + +To uninstall the `smarter-device-manager` deployment + +```console +helm uninstall smarter-device-manager +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install smarter-device-manager \ + --set env.TZ="America/New York" \ + k8s-at-home/smarter-device-manager +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install smarter-device-manager k8s-at-home/smarter-device-manager -f values.yaml +``` + +## Custom configuration + +Please consider overriding the default configuration through `values.yaml` file. +For example: ```yaml config: - devicematch: ^snd$ @@ -37,7 +76,7 @@ config: - devicematch: ^ttyACM[0-9]*$ nummaxdevices: 1 ``` -The above configuration allows up to twenty pods to make use of `/dev/snd`, `/dev/rtc0` and each of `/dev/video[0-9]*` devices. +The above configuration allows up to twenty pods to make use of `/dev/snd`, `/dev/rtc0` and each of `/dev/video[0-9]*` devices. Only one pod at a time can use any of the discovered host `/dev/ttyACM[0-9]*` devices. This means that if a pod has reserved a dongle at `/dev/ttyACM0`, another pod requesting the same device will stay pending. Once the devices are discovered, they will be added as allocatable resources to the nodes: @@ -54,14 +93,8 @@ Capacity: smarter-devices/ttyUSB-Z-Stick-Gen5: 1 ``` -## Usage - -### Important limitation - Please note that only the root of the host `/dev` directory is considered for discovery. _Therefore, `by-id` paths will not work and some `udev` rules may be necessary._ -### Resource allocation - The hardware is requested by pods through `resources`, e.g.: ```yaml resources: @@ -73,39 +106,50 @@ The hardware is requested by pods through `resources`, e.g.: In this case host device `/dev/ttyUSB-Conbee-2` will be given at the same path, and the pod will only be created when this device is available. -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| devicePluginPath | string | `"/var/lib/kubelet/device-plugins"` | | +| dnsPolicy | string | `"ClusterFirstWithHostNet"` | | +| hostNetwork | bool | `true` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"registry.gitlab.com/arm-research/smarter/smarter-device-manager"` | | +| image.tag | string | `"v1.1.2"` | | +| priorityClassName | string | `"system-node-critical"` | | +| securityContext.allowPrivilegeEscalation | bool | `false` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/smarter-device-manager/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install my-release \ - --set image.pullPolicy="Always" \ - k8s-at-home/smarter-device-manager -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install my-release k8s-at-home/smarter-device-manager --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -```yaml -image: - tag: ... -``` +### [1.0.0] ---- +#### Added -## Upgrading an existing Release to a new major version +- N/A -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/smarter-device-manager/README.md.gotmpl b/charts/smarter-device-manager/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/smarter-device-manager/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/smarter-device-manager/README_CHANGELOG.md.gotmpl b/charts/smarter-device-manager/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/smarter-device-manager/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/smarter-device-manager/README_CONFIG.md.gotmpl b/charts/smarter-device-manager/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..362c67f1 --- /dev/null +++ b/charts/smarter-device-manager/README_CONFIG.md.gotmpl @@ -0,0 +1,50 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +Please consider overriding the default configuration through `values.yaml` file. +For example: +```yaml +config: + - devicematch: ^snd$ + nummaxdevices: 20 + - devicematch: ^rtc0$ + nummaxdevices: 20 + - devicematch: ^video[0-9]*$ + nummaxdevices: 20 + - devicematch: ^ttyACM[0-9]*$ + nummaxdevices: 1 +``` +The above configuration allows up to twenty pods to make use of `/dev/snd`, `/dev/rtc0` and each of `/dev/video[0-9]*` devices. +Only one pod at a time can use any of the discovered host `/dev/ttyACM[0-9]*` devices. This means that if a pod has reserved a dongle at `/dev/ttyACM0`, another pod requesting the same device will stay pending. + +Once the devices are discovered, they will be added as allocatable resources to the nodes: +``` + $ kubectl describe nodes +... +Capacity: + cpu: 4 + memory: 16104560Ki + pods: 110 + smarter-devices/gpiochip0: 0 + smarter-devices/i2c-0: 0 + smarter-devices/snd: 20 + smarter-devices/ttyUSB-Z-Stick-Gen5: 1 +``` + +Please note that only the root of the host `/dev` directory is considered for discovery. _Therefore, `by-id` paths will not work and some `udev` rules may be necessary._ + +The hardware is requested by pods through `resources`, e.g.: +```yaml + resources: + limits: + smarter-devices/ttyUSB-Conbee-2: 1 + requests: + smarter-devices/ttyUSB-Conbee-2: 1 +``` + +In this case host device `/dev/ttyUSB-Conbee-2` will be given at the same path, and the pod will only be created when this device is available. +{{- end -}} diff --git a/charts/sonarr/.helmignore b/charts/sonarr/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/sonarr/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/sonarr/README.md b/charts/sonarr/README.md index e09ce85d..1d9fe8f3 100644 --- a/charts/sonarr/README.md +++ b/charts/sonarr/README.md @@ -1,78 +1,117 @@ -# Sonarr +# sonarr -This is a helm chart for [Sonarr](https://github.com/Sonarr/Sonarr). +![Version: 9.0.2](https://img.shields.io/badge/Version-9.0.2-informational?style=flat-square) ![AppVersion: 3.0.4.993](https://img.shields.io/badge/AppVersion-3.0.4.993-informational?style=flat-square) + +Smart PVR for newsgroup and bittorrent users **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/sonarr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install sonarr k8s-at-home/sonarr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `sonarr` ```console -helm install --name my-release k8s-at-home/sonarr +helm install sonarr k8s-at-home/sonarr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `sonarr` deployment ```console -helm delete my-release --purge +helm uninstall sonarr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/sonarr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install sonarr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/sonarr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install sonarr k8s-at-home/sonarr --values values.yaml +helm install sonarr k8s-at-home/sonarr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/sonarr"` | | +| image.tag | string | `"version-3.0.4.993"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.media.emptyDir | bool | `false` | | +| persistence.media.enabled | bool | `false` | | +| persistence.media.mountPath | string | `"/media"` | | +| service.port.port | int | `8989` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 6.x.x to 7.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/sonarr/README.md.gotmpl b/charts/sonarr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/sonarr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/sonarr/README_CHANGELOG.md.gotmpl b/charts/sonarr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/sonarr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/sonarr/README_CONFIG.md.gotmpl b/charts/sonarr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/sonarr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/speedtest-prometheus/README.md b/charts/speedtest-prometheus/README.md index a674aad7..93c8517d 100644 --- a/charts/speedtest-prometheus/README.md +++ b/charts/speedtest-prometheus/README.md @@ -1,52 +1,45 @@ -# Prometheus Exporter using the Speedtest CLI +# speedtest-prometheus -![Screenshot](https://i.imgur.com/iIzWUre.png) +![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square) -This is a helm chart provising a prometheus exporter (with optional ServiceMontor) to conduct speedtests using the official speedtest CLI. Based on the [prometheus-speedtest-exporter](https://github.com/billimek/prometheus-speedtest-exporter) multi-arch container image. +Prometheus Exporter for the official Speedtest CLI -## TL;DR; +**Homepage:** -```console -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/speedtest-prometheus -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `speedtest-prometheus`: +## Source Code -```console -helm install --name speedtest-prometheus k8s-at-home/speedtest-prometheus -``` +* -## Uninstalling the Chart +## Values -To uninstall/delete the `speedtest-prometheus` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"billimek/prometheus-speedtest-exporter"` | | +| image.tag | string | `"1.1.0"` | | +| imagePullSecrets | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `9469` | | +| service.type | string | `"ClusterIP"` | | +| serviceMonitor.additionalLabels | object | `{}` | | +| serviceMonitor.enabled | bool | `false` | | +| serviceMonitor.interval | string | `"60m"` | | +| serviceMonitor.scrapeTimeout | string | `"90s"` | | +| tolerations | list | `[]` | | -```console -helm delete speedtest-prometheus -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/speedtest-prometheus/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name speedtest-prometheus \ - --set serviceMonitor.enabled=true \ - k8s-at-home/speedtest-prometheus -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name speedtest-prometheus -f values.yaml k8s-at-home/speedtest-prometheus -``` - -## Grafana Dashboard - -You can find an [example grafana dashboard](https://github.com/billimek/prometheus-speedtest-exporter/blob/master/speedtest-exporter.json) as shown in the screenshot above. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/speedtest/README.md b/charts/speedtest/README.md index 6cd22c40..f8e5db7b 100644 --- a/charts/speedtest/README.md +++ b/charts/speedtest/README.md @@ -1,72 +1,40 @@ -# Speedtest.net Collector For InfluxDB and Grafana +# speedtest -![Screenshot](https://camo.githubusercontent.com/c652a6685bcb5a8cec6a47c92e57d159b28e47e7/68747470733a2f2f7075752e73682f746d664f412f623535373665383864652e706e67) +![Version: 3.0.0](https://img.shields.io/badge/Version-3.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) -This tool is a wrapper for speedtest-cli which allows you to run periodic speedtets and save the results to Influxdb +periodic speedtest and save the results to InfluxDB -## TL;DR; +**Homepage:** -```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/speedtest -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `my-release`: +## Source Code -```console -$ helm install --name my-release k8s-at-home/speedtest -``` +* +* -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: - -```console -$ helm delete my-release --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The configuration is set as a block of text through a configmap and mounted as a file in /src/config.ini Any value in this text block should match the defined speedtest configuration. There are several values here that will have to match our kubernetes configuration. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -| ------------------------------- | ------------------------------- | ---------------------------------------------------------- | -| `image.repository` | speedtest image | `k8s-at-home/speedtestusage-for-influxdb` | -| `image.tag` | speedtest image tag | `latest` | -| `image.pullPolicy` | speedtest image pull policy | `IfNotPresent` | -| `debug` | Display debugging output | `false` | -| `config.delay` | how many seconds to wait between checks | `3600` | -| `config.influxdb.host` | InfluxDB hostname | `influxdb-influxdb` | -| `config.influxdb.port` | InfluxDB port | `8086` | -| `config.influxdb.database` | InfluxDB database | `speedtests` | -| `config.influxdb.username` | InfluxDB username | `` | -| `config.influxdb.password` | InfluxDB password | `` | -| `config.influxdb.ssl` | InfluxDB connection using SSL | `false` | -| `config.speedtest.server` | server to use for speedtest - leave blank to auto-pick | `` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | - - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -$ helm install --name my-release \ - --set config.influxdb.host=some-influx-host \ - k8s-at-home/speedtest -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -$ helm install --name my-release -f values.yaml k8s-at-home/speedtest -``` - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/speedtest/values.yaml) file. It has several commented out suggested values. +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config.delay | int | `3600` | | +| config.influxdb.database | string | `"speedtests"` | | +| config.influxdb.host | string | `"influxdb-influxdb"` | | +| config.influxdb.port | int | `8086` | | +| config.influxdb.ssl | bool | `false` | | +| config.speedtest.server | string | `nil` | | +| debug | bool | `false` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"atribe/speedtest-for-influxdb-and-grafana"` | | +| image.tag | string | `"latest"` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/statping/README.md b/charts/statping/README.md index bfeea11e..90052d84 100644 --- a/charts/statping/README.md +++ b/charts/statping/README.md @@ -1,36 +1,100 @@ -# statping | Status page for monitoring your websites and applications +# statping -## TL;DR -```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/statping -``` +![Version: 1.5.1](https://img.shields.io/badge/Version-1.5.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.90.65](https://img.shields.io/badge/AppVersion-v0.90.65-informational?style=flat-square) -## Installing the Chart -To install the chart with the release name `statping`: -```console -helm install statping k8s-at-home/statping -``` +Status page for monitoring your websites and applications -## Uninstalling the Chart -To uninstall the `statping` deployment: -```console -helm uninstall statping -``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +**Homepage:** -## Configuration -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/statping/values.yaml) -file. It has several commented out suggested values. +## Maintainers -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install statping \ - --set statping.env.TZ="America/New York" \ - k8s-at-home/statping -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install statping k8s-at-home/statping --values values.yaml -``` +| Name | Email | Url | +| ---- | ------ | --- | +| DirtyCajunRice | nick@cajun.pro | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | postgresql | 10.2.6 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts | list | `[]` | | +| additionalVolumes | list | `[]` | | +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `3` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| env | list | `[]` | | +| externalSecret.enabled | bool | `false` | | +| externalSecret.kubernetesExternalSecrets.data | list | `[]` | | +| externalSecret.kubernetesExternalSecrets.spec | object | `{}` | | +| externalSecret.type | string | `"kubernetes-external-secrets"` | | +| fullnameOverride | string | `""` | | +| global.postgresql.postgresqlDatabase | string | `"postgres"` | | +| global.postgresql.postgresqlUsername | string | `"postgres"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"statping/statping"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0] | string | `"/"` | | +| ingress.labels | object | `{}` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.enabled | bool | `true` | | +| persistence.size | string | `"1Gi"` | | +| persistence.skipuninstall | bool | `false` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| postgres.kubedb.enabled | bool | `false` | | +| postgres.kubedb.storage.accessModes[0] | string | `"ReadWriteOnce"` | | +| postgres.kubedb.storage.resources.requests.storage | string | `"1Gi"` | | +| postgres.kubedb.storageType | string | `"Durable"` | | +| postgres.kubedb.version | float | `11.1` | | +| postgres.posgresql.enabled | bool | `true` | | +| postgres.type | string | `"postgresql"` | | +| probes.liveness.failureThreshold | int | `5` | | +| probes.liveness.initialDelaySeconds | int | `60` | | +| probes.liveness.timeoutSeconds | int | `10` | | +| probes.readiness.failureThreshold | int | `5` | | +| probes.readiness.initialDelaySeconds | int | `60` | | +| probes.readiness.timeoutSeconds | int | `10` | | +| replication.enabled | bool | `false` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.additionalSpec | object | `{}` | | +| service.annotations | object | `{}` | | +| service.labels | object | `{}` | | +| service.port | int | `8080` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| statping.admin.email | string | `""` | | +| statping.admin.existingSecret.emailKey | string | `""` | | +| statping.admin.existingSecret.enabled | bool | `false` | | +| statping.admin.existingSecret.name | string | `""` | | +| statping.admin.existingSecret.passwordKey | string | `""` | | +| statping.admin.existingSecret.userKey | string | `""` | | +| statping.admin.password | string | `""` | | +| statping.admin.user | string | `""` | | +| statping.description | string | `""` | | +| statping.domain | string | `""` | | +| statping.name | string | `""` | | +| tolerations | list | `[]` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/tautulli/.helmignore b/charts/tautulli/.helmignore index 46fd8996..4379e2b3 100644 --- a/charts/tautulli/.helmignore +++ b/charts/tautulli/.helmignore @@ -19,5 +19,8 @@ .project .idea/ *.tmproj +.vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/tautulli/README.md b/charts/tautulli/README.md index d65424ff..98e45c74 100644 --- a/charts/tautulli/README.md +++ b/charts/tautulli/README.md @@ -1,78 +1,114 @@ -# Tautulli +# tautulli -This is a helm chart for [Tautulli](https://github.com/Tautulli/Tautulli). +![Version: 7.0.1](https://img.shields.io/badge/Version-7.0.1-informational?style=flat-square) ![AppVersion: v2.6.6](https://img.shields.io/badge/AppVersion-v2.6.6-informational?style=flat-square) + +A Python based monitoring and tracking tool for Plex Media Server **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/tautulli +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install tautulli k8s-at-home/tautulli ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `tautulli` ```console -helm install --name my-release k8s-at-home/tautulli +helm install tautulli k8s-at-home/tautulli ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `tautulli` deployment ```console -helm delete my-release --purge +helm uninstall tautulli ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/tautulli/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install tautulli \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/tautulli ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install tautulli k8s-at-home/tautulli --values values.yaml +helm install tautulli k8s-at-home/tautulli -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"tautulli/tautulli"` | | +| image.tag | string | `"v2.6.6"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `8181` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 4.x.x to 5.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/tautulli/README.md.gotmpl b/charts/tautulli/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/tautulli/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/tautulli/README_CHANGELOG.md.gotmpl b/charts/tautulli/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/tautulli/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/tautulli/README_CONFIG.md.gotmpl b/charts/tautulli/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/tautulli/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/teedy/.helmignore b/charts/teedy/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/teedy/.helmignore +++ b/charts/teedy/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/teedy/README.md b/charts/teedy/README.md index daaad9f4..9cbe1b48 100644 --- a/charts/teedy/README.md +++ b/charts/teedy/README.md @@ -1,68 +1,121 @@ # teedy -This is a helm chart for [teedy](https://github.com/sismics/docs). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v1.9](https://img.shields.io/badge/AppVersion-v1.9-informational?style=flat-square) + +Teedy is an open source, lightweight document management system for individuals and businesses. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/teedy +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | postgresql | 10.2.7 | +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install teedy k8s-at-home/teedy ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `teedy` ```console -helm install --name my-release k8s-at-home/teedy +helm install teedy k8s-at-home/teedy ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `teedy` deployment ```console -helm delete my-release --purge +helm uninstall teedy ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/teedy/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install teedy \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/teedy ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install teedy k8s-at-home/teedy --values values.yaml +helm install teedy k8s-at-home/teedy -f values.yaml ``` -These values will be nested as it is a dependency, for example -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"sismics/docs"` | | +| image.tag | string | `"v1.9"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/data"` | | +| postgresql.enabled | bool | `false` | | +| postgresql.persistence.enabled | bool | `false` | | +| postgresql.postgresqlDatabase | string | `"teedydb"` | | +| postgresql.postgresqlPassword | string | `"teedypassword"` | | +| postgresql.postgresqlUsername | string | `"teedyuser"` | | +| service.port.port | int | `8080` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/teedy/README.md.gotmpl b/charts/teedy/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/teedy/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/teedy/README_CHANGELOG.md.gotmpl b/charts/teedy/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/teedy/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/teedy/README_CONFIG.md.gotmpl b/charts/teedy/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/teedy/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/teslamate/README.md b/charts/teslamate/README.md index f5e7367c..28c94c5d 100644 --- a/charts/teslamate/README.md +++ b/charts/teslamate/README.md @@ -1,48 +1,77 @@ -# A self-hosted data logger for your Tesla 🚘 +# teslamate -This is an opinionated helm chart for [Teslamate](https://github.com/adriankumpf/teslamate) installed with a standalone postgresql database. +![Version: 3.5.1](https://img.shields.io/badge/Version-3.5.1-informational?style=flat-square) ![AppVersion: v1.20.0](https://img.shields.io/badge/AppVersion-v1.20.0-informational?style=flat-square) -The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64) +A self-hosted data logger for your Tesla 🚘 -## TL;DR; +**Homepage:** -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/teslamate -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `my-release`: +## Source Code -```console -helm install --name teslamate k8s-at-home/teslamate -``` +* -## Uninstalling the Chart +## Requirements -To uninstall/delete the `teslamate` deployment: +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | postgresql | 10.2.7 | -```console -helm delete teslamate --purge -``` +## Values -The command removes all the Kubernetes components associated with the chart and deletes the release. +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| checkOrigin | bool | `false` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"teslamate/teslamate"` | | +| image.tag | string | `"1.20.0"` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| locale | string | `"en"` | | +| mqtt.enabled | bool | `false` | | +| mqtt.host | string | `nil` | | +| mqtt.password | string | `nil` | | +| mqtt.tls | string | `nil` | | +| mqtt.tlsAcceptInvalid | string | `nil` | | +| mqtt.username | string | `nil` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| postgresql.enabled | bool | `true` | | +| postgresql.image.repository | string | `"postgres"` | | +| postgresql.image.tag | float | `12.1` | | +| postgresql.persistence.accessModes[0] | string | `"ReadWriteOnce"` | | +| postgresql.persistence.enabled | bool | `true` | | +| postgresql.persistence.mountPath | string | `"/data/"` | | +| postgresql.persistence.size | string | `"8Gi"` | | +| postgresql.persistence.storageClass | string | `nil` | | +| postgresql.postgresqlDataDir | string | `"/data/pgdata"` | | +| postgresql.postgresqlDatabase | string | `"teslamate"` | | +| postgresql.postgresqlPassword | string | `"teslamate"` | | +| postgresql.postgresqlUsername | string | `"teslamate"` | | +| probes.liveness.failureThreshold | int | `15` | | +| probes.liveness.periodSeconds | int | `10` | | +| probes.readiness.failureThreshold | int | `15` | | +| probes.readiness.periodSeconds | int | `10` | | +| probes.startup.failureThreshold | int | `30` | | +| probes.startup.initialDelaySeconds | int | `15` | | +| probes.startup.periodSeconds | int | `10` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| service.port | int | `4000` | | +| service.type | string | `"ClusterIP"` | | +| timeZone | string | `"UTC"` | | +| tolerations | list | `[]` | | +| virtualHost | string | `nil` | | -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/teslamate/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name teslamate \ - --set timeZone="America/New York" \ - k8s-at-home/teslamate -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name teslamate -f values.yaml stable/teslamate -``` +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/traccar/.helmignore b/charts/traccar/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/traccar/.helmignore +++ b/charts/traccar/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/traccar/README.md b/charts/traccar/README.md index 71e398e0..beef5d49 100644 --- a/charts/traccar/README.md +++ b/charts/traccar/README.md @@ -1,67 +1,124 @@ -# Traccar +# traccar -This is a helm chart for [Traccar](https://github.com/traccar/traccar). +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-informational?style=flat-square) ![AppVersion: v4.11](https://img.shields.io/badge/AppVersion-v4.11-informational?style=flat-square) + +Traccar is an open source GPS tracking system. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/traccar +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | mariadb | 9.2.5 | +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install traccar k8s-at-home/traccar ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `traccar` ```console -helm install --name my-release k8s-at-home/traccar +helm install traccar k8s-at-home/traccar ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `traccar` deployment ```console -helm delete my-release --purge +helm uninstall traccar ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/traccar/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install traccar \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/traccar ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install traccar k8s-at-home/traccar --values values.yaml +helm install traccar k8s-at-home/traccar -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env.CONFIG_USE_ENVIRONMENT_VARIABLES | bool | `true` | | +| env.LOGGER_CONSOLE | bool | `true` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"traccar/traccar"` | | +| image.tag | float | `4.11` | | +| ingress.enabled | bool | `false` | | +| mariadb.architecture | string | `"standalone"` | | +| mariadb.auth.database | string | `"traccar"` | | +| mariadb.auth.password | string | `"traccar"` | | +| mariadb.auth.username | string | `"traccar"` | | +| mariadb.enabled | bool | `false` | | +| mariadb.primary.persistence.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/opt/traccar/data"` | | +| probes.startup.enabled | bool | `true` | | +| service.port.port | int | `8082` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/traccar/README.md.gotmpl b/charts/traccar/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/traccar/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/traccar/README_CHANGELOG.md.gotmpl b/charts/traccar/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/traccar/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/traccar/README_CONFIG.md.gotmpl b/charts/traccar/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/traccar/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/traefik-forward-auth/README.md b/charts/traefik-forward-auth/README.md index f1770a11..d8dfe4f2 100644 --- a/charts/traefik-forward-auth/README.md +++ b/charts/traefik-forward-auth/README.md @@ -1,51 +1,21 @@ # traefik-forward-auth -![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![Version: 1.0.5](https://img.shields.io/badge/Version-1.0.5-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square) [![ArtifactHub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/traefik-forward-auth)](https://artifacthub.io/packages/helm/k8s-at-home/traefik-forward-auth) +![Version: 1.0.5](https://img.shields.io/badge/Version-1.0.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square) A minimal forward authentication service that provides OAuth/SSO login and authentication for the traefik reverse proxy/load balancer -The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64) +**Homepage:** -Chart that -* Adds docker image information leveraging the [official image](https://github.com/thomseddon/traefik-forward-auth) -* Deploys [traefik-forward-auth](https://github.com/thomseddon/traefik-forward-auth) +## Maintainers -## TL;DR -```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/traefik-forward-auth -``` +| Name | Email | Url | +| ---- | ------ | --- | +| DirtyCajunRice | nick@cajun.pro | | -## Installing the Chart -To install the chart with the release name `traefik-forward-auth`: -```console -helm install traefik-forward-auth k8s-at-home/traefik-forward-auth -``` +## Source Code -## Uninstalling the Chart -To uninstall the `traefik-forward-auth` deployment: -```console -helm uninstall traefik-forward-auth -``` -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/traefik-forward-auth/values.yaml) -file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install traefik-forward-auth \ - --set env.TZ="America/New York" \ - k8s-at-home/traefik-forward-auth -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. -For example, -```console -helm install traefik-forward-auth k8s-at-home/traefik-forward-auth --values values.yaml -``` +* +* ## Values @@ -123,4 +93,7 @@ helm install traefik-forward-auth k8s-at-home/traefik-forward-auth --values valu | serviceAccount.create | bool | `true` | | | serviceAccount.name | string | `""` | | | tolerations | list | `[]` | | -| urlPath | string | `""` | Callback URL Path (default: /_oauth) | \ No newline at end of file +| urlPath | string | `""` | Callback URL Path (default: /_oauth) | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/tvheadend/.helmignore b/charts/tvheadend/.helmignore index 0e8a0eb3..4379e2b3 100644 --- a/charts/tvheadend/.helmignore +++ b/charts/tvheadend/.helmignore @@ -14,10 +14,13 @@ *.swp *.bak *.tmp -*.orig *~ # Various IDEs .project .idea/ *.tmproj .vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/tvheadend/README.md b/charts/tvheadend/README.md index 87456319..d4990486 100644 --- a/charts/tvheadend/README.md +++ b/charts/tvheadend/README.md @@ -1,43 +1,118 @@ # tvheadend -This is a helm chart for [tvheadend](https://github.com/tvheadend/tvheadend). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) -**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose).** +TVheadend - a TV streaming server and digital video recorder -## TL;DR; +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/tvheadend +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install tvheadend k8s-at-home/tvheadend ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `tvheadend` ```console -helm install my-release k8s-at-home/tvheadend +helm install tvheadend k8s-at-home/tvheadend ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `tvheadend` deployment ```console -helm delete my-release --purge +helm uninstall tvheadend ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -The chart's [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/tvheadend/values.yaml) file contains a set of suggested values for a minimal deployment. Further configuration options are found in the [common library](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install tvheadend \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/tvheadend ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install tvheadend k8s-at-home/tvheadend --values values.yaml +helm install tvheadend k8s-at-home/tvheadend -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](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/tvheadend"` | | +| image.tag | string | `"latest"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/config"` | | +| persistence.recordings.emptyDir | bool | `false` | | +| persistence.recordings.enabled | bool | `false` | | +| persistence.recordings.mountPath | string | `"/recordings"` | | +| service.port.port | int | `9981` | | +| strategy.type | string | `"Recreate"` | | + +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/tvheadend/README.md.gotmpl b/charts/tvheadend/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/tvheadend/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/tvheadend/README_CHANGELOG.md.gotmpl b/charts/tvheadend/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/tvheadend/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/tvheadend/README_CONFIG.md.gotmpl b/charts/tvheadend/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/tvheadend/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/unifi-poller/.helmignore b/charts/unifi-poller/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/unifi-poller/.helmignore +++ b/charts/unifi-poller/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/unifi-poller/README.md b/charts/unifi-poller/README.md index 95a2aaae..4caebac9 100644 --- a/charts/unifi-poller/README.md +++ b/charts/unifi-poller/README.md @@ -1,78 +1,121 @@ # unifi-poller -This is a helm chart for [unifi-poller](https://github.com/unifi-poller/unifi-poller). +![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![AppVersion: 2.0.1](https://img.shields.io/badge/AppVersion-2.0.1-informational?style=flat-square) + +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](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/unifi-poller +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | influxdb | 1.1.9 | +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +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 `my-release`: +To install the chart with the release name `unifi-poller` ```console -helm install --name my-release k8s-at-home/unifi-poller +helm install unifi-poller k8s-at-home/unifi-poller ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `unifi-poller` deployment ```console -helm delete my-release --purge +helm uninstall unifi-poller ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/unifi-poller/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install unifi-poller \ - --set env.TZ="America/New_York" \ + --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. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install unifi-poller k8s-at-home/unifi-poller --values values.yaml +helm install unifi-poller k8s-at-home/unifi-poller -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"golift/unifi-poller"` | | +| image.tag | string | `"2.0.1"` | | +| influxdb.architecture | string | `"standalone"` | | +| influxdb.authEnabled | bool | `false` | | +| influxdb.database | string | `"unifi_poller"` | | +| influxdb.enabled | bool | `false` | | +| influxdb.persistence.enabled | bool | `false` | | +| ingress.enabled | bool | `false` | | +| prometheus.serviceMonitor.additionalLabels | object | `{}` | | +| prometheus.serviceMonitor.enabled | bool | `false` | | +| prometheus.serviceMonitor.interval | string | `"1m"` | | +| service.port.port | int | `9130` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 2.x.x to 3.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/unifi-poller/README.md.gotmpl b/charts/unifi-poller/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/unifi-poller/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/unifi-poller/README_CHANGELOG.md.gotmpl b/charts/unifi-poller/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/unifi-poller/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/unifi-poller/README_CONFIG.md.gotmpl b/charts/unifi-poller/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/unifi-poller/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/unifi/README.md b/charts/unifi/README.md index 50ff8561..dad6ae9e 100644 --- a/charts/unifi/README.md +++ b/charts/unifi/README.md @@ -1,225 +1,131 @@ -# Ubiquiti Network's Unifi Controller +# unifi -This is a helm chart for [Ubiquiti Network's][ubnt] [Unifi Controller][ubnt 2]. +![Version: 1.5.1](https://img.shields.io/badge/Version-1.5.1-informational?style=flat-square) ![AppVersion: 5.14.23](https://img.shields.io/badge/AppVersion-5.14.23-informational?style=flat-square) -## TL;DR; +Ubiquiti Network's Unifi Controller -```shell -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/unifi -``` +**Homepage:** -## Installing the Chart +## Maintainers -To install the chart with the release name `my-release`: +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | +| mcronce | mike@quadra-tec.net | | -```console -helm install --name my-release stable/unifi -``` +## Source Code -## Uninstalling the Chart +* -To uninstall/delete the `my-release` deployment: +## Values -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| GID | int | `999` | | +| UID | int | `999` | | +| affinity | object | `{}` | | +| captivePortalService.annotations | object | `{}` | | +| captivePortalService.enabled | bool | `false` | | +| captivePortalService.http | int | `8880` | | +| captivePortalService.https | int | `8843` | | +| captivePortalService.ingress.annotations | object | `{}` | | +| captivePortalService.ingress.enabled | bool | `false` | | +| captivePortalService.ingress.hosts[0] | string | `"chart-example.local"` | | +| captivePortalService.ingress.path | string | `"/"` | | +| captivePortalService.ingress.tls | list | `[]` | | +| captivePortalService.labels | object | `{}` | | +| captivePortalService.loadBalancerIP | string | `nil` | | +| captivePortalService.type | string | `"ClusterIP"` | | +| controllerService.annotations | object | `{}` | | +| controllerService.ingress.annotations | object | `{}` | | +| controllerService.ingress.enabled | bool | `false` | | +| controllerService.ingress.hosts[0] | string | `"chart-example.local"` | | +| controllerService.ingress.path | string | `"/"` | | +| controllerService.ingress.tls | list | `[]` | | +| controllerService.labels | object | `{}` | | +| controllerService.loadBalancerIP | string | `nil` | | +| controllerService.port | int | `8080` | | +| controllerService.type | string | `"NodePort"` | | +| customCert.certName | string | `"tls.crt"` | | +| customCert.enabled | bool | `false` | | +| customCert.isChain | bool | `false` | | +| customCert.keyName | string | `"tls.key"` | | +| deploymentAnnotations | object | `{}` | | +| discoveryService.annotations | object | `{}` | | +| discoveryService.labels | object | `{}` | | +| discoveryService.loadBalancerIP | string | `nil` | | +| discoveryService.port | int | `10001` | | +| discoveryService.type | string | `"NodePort"` | | +| extraConfigFiles | object | `{}` | | +| extraJvmOpts | list | `[]` | | +| extraVolumeMounts | list | `[]` | | +| extraVolumes | list | `[]` | | +| guiService.annotations | object | `{}` | | +| guiService.labels | object | `{}` | | +| guiService.loadBalancerIP | string | `nil` | | +| guiService.port | int | `8443` | | +| guiService.type | string | `"ClusterIP"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"jacobalberty/unifi"` | | +| image.tag | string | `"5.14.23"` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0] | string | `"chart-example.local"` | | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| jvmInitHeapSize | string | `nil` | | +| jvmMaxHeapSize | string | `"1024M"` | | +| livenessProbe.enabled | bool | `true` | | +| livenessProbe.failureThreshold | int | `3` | | +| livenessProbe.initialDelaySeconds | int | `30` | | +| livenessProbe.periodSeconds | int | `10` | | +| livenessProbe.successThreshold | int | `1` | | +| livenessProbe.timeoutSeconds | int | `1` | | +| logging.promtail.enabled | bool | `false` | | +| logging.promtail.image.pullPolicy | string | `"IfNotPresent"` | | +| logging.promtail.image.repository | string | `"grafana/promtail"` | | +| logging.promtail.image.tag | string | `"1.6.0"` | | +| logging.promtail.loki.url | string | `"http://loki.logs.svc.cluster.local:3100/loki/api/v1/push"` | | +| mongodb.databaseName | string | `"unifi"` | | +| mongodb.dbUri | string | `"mongodb://mongo/unifi"` | | +| mongodb.enabled | bool | `false` | | +| mongodb.statDbUri | string | `"mongodb://mongo/unifi_stat"` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.enabled | bool | `true` | | +| persistence.size | string | `"5Gi"` | | +| podAnnotations | object | `{}` | | +| readinessProbe.enabled | bool | `true` | | +| readinessProbe.failureThreshold | int | `3` | | +| readinessProbe.initialDelaySeconds | int | `15` | | +| readinessProbe.periodSeconds | int | `10` | | +| readinessProbe.successThreshold | int | `1` | | +| readinessProbe.timeoutSeconds | int | `1` | | +| resources | object | `{}` | | +| runAsRoot | bool | `false` | | +| speedtestService.annotations | object | `{}` | | +| speedtestService.labels | object | `{}` | | +| speedtestService.loadBalancerIP | string | `nil` | | +| speedtestService.port | int | `6789` | | +| speedtestService.type | string | `"ClusterIP"` | | +| strategyType | string | `"Recreate"` | | +| stunService.annotations | object | `{}` | | +| stunService.labels | object | `{}` | | +| stunService.loadBalancerIP | string | `nil` | | +| stunService.port | int | `3478` | | +| stunService.type | string | `"NodePort"` | | +| syslogService.annotations | object | `{}` | | +| syslogService.labels | object | `{}` | | +| syslogService.loadBalancerIP | string | `nil` | | +| syslogService.port | int | `5514` | | +| syslogService.type | string | `"NodePort"` | | +| timezone | string | `"UTC"` | | +| tolerations | list | `[]` | | +| unifiedService.annotations | object | `{}` | | +| unifiedService.enabled | bool | `false` | | +| unifiedService.labels | object | `{}` | | +| unifiedService.loadBalancerIP | string | `nil` | | +| unifiedService.type | string | `"ClusterIP"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the Unifi chart and their default values. - -| Parameter | Default | Description | -|-------------------------------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------| -| `image.repository` | `jacobalberty/unifi` | Image repository | -| `image.tag` | `5.14.23` | Image tag. Possible values listed [here][docker]. | -| `image.pullPolicy` | `IfNotPresent` | Image pull policy | -| `strategyType` | `Recreate` | Specifies the strategy used to replace old Pods by new ones | -| `guiService.type` | `ClusterIP` | Kubernetes service type for the Unifi GUI | -| `guiService.port` | `8443` | Kubernetes port where the Unifi GUI is exposed | -| `guiService.annotations` | `{}` | Service annotations for the Unifi GUI | -| `guiService.labels` | `{}` | Custom labels | -| `guiService.loadBalancerIP` | `{}` | Loadbalance IP for the Unifi GUI | -| `guiService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to load balancer (if supported) | -| `guiService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the Service to either Cluster or Local | -| `captivePortalService.enabled` | `false` | Install the captive portal service (needed if you want guest captive portal) | -| `captivePortalService.type` | `ClusterIP` | Kubernetes service type for the captive portal | -| `captivePortalService.http` | `8880` | Kubernetes port where the captive portal is exposed | -| `captivePortalService.https` | `8843` | Kubernetes port where the captive portal is exposed (with SSL) | -| `captivePortalService.annotations` | `{}` | Service annotations for the captive portal | -| `captivePortalService.labels` | `{}` | Custom labels | -| `captivePortalService.loadBalancerIP` | `{}` | Loadbalance IP for the Unifi GUI | -| `captivePortalService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to load balancer (if supported) | -| `captivePortalService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the Service to either Cluster or Local | -| `captivePortalService.ingress.enabled` | `false` | Enables Ingress (for the captive portal, the main ingress needs to be enabled for the controller to be accessible) | -| `captivePortalService.ingress.annotations` | `{}` | Ingress annotations for the captive portal | -| `captivePortalService.ingress.labels` | `{}` | Custom labels for the captive portal | -| `captivePortalService.ingress.path` | `/` | Ingress path for the captive portal | -| `captivePortalService.ingress.hosts` | `chart-example.local` | Ingress accepted hostnames for the captive portal | -| `captivePortalService.ingress.tls` | `[]` | Ingress TLS configuration for the captive portal | -| `controllerService.type` | `NodePort` | Kubernetes service type for the Unifi Controller communication | -| `controllerService.port` | `8080` | Kubernetes port where the Unifi Controller is exposed - this needs to be reachable by the unifi devices on the network | -| `controllerService.annotations` | `{}` | Service annotations for the Unifi Controller | -| `controllerService.labels` | `{}` | Custom labels | -| `controllerService.loadBalancerIP` | `{}` | Loadbalance IP for the Unifi Controller | -| `controllerService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to load balancer (if supported) | -| `controllerService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the Service to either Cluster or Local | -| `controllerService.ingress.enabled` | `false` | Enables Ingress for the controller | -| `controllerService.ingress.annotations` | `{}` | Ingress annotations for the controller | -| `controllerService.ingress.labels` | `{}` | Custom labels for the controller | -| `controllerService.ingress.path` | `/` | Ingress path for the controller | -| `controllerService.ingress.hosts` | `chart-example.local` | Ingress accepted hostnames for the controller | -| `controllerService.ingress.tls` | `[]` | Ingress TLS configuration for the controller | -| `stunService.type` | `NodePort` | Kubernetes service type for the Unifi STUN | -| `stunService.port` | `3478` | Kubernetes UDP port where the Unifi STUN is exposed | -| `stunService.annotations` | `{}` | Service annotations for the Unifi STUN | -| `stunService.labels` | `{}` | Custom labels | -| `stunService.loadBalancerIP` | `{}` | Loadbalance IP for the Unifi STUN | -| `stunService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to load balancer (if supported) | -| `stunService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the Service to either Cluster or Local | -| `discoveryService.type` | `NodePort` | Kubernetes service type for AP discovery | -| `discoveryService.port` | `10001` | Kubernetes UDP port for AP discovery | -| `discoveryService.annotations` | `{}` | Service annotations for AP discovery | -| `discoveryService.labels` | `{}` | Custom labels | -| `discoveryService.loadBalancerIP` | `{}` | Loadbalance IP for AP discovery | -| `discoveryService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to load balancer (if supported) | -| `discoveryService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the Service to either Cluster or Local | -| `syslogService.type` | `NodePort` | Kubernetes service type for remote syslog capture | -| `syslogService.port` | `5514` | Kubernetes UDP port for remote syslog capture | -| `syslogService.annotations` | `{}` | Service annotations for remote syslog capture | -| `syslogService.labels` | `{}` | Custom labels | -| `syslogService.loadBalancerIP` | `{}` | Loadbalancer IP for remote syslog capture | -| `syslogService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to load balancer (if supported) | -| `syslogService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the Service to either Cluster or Local | -| `speedtestService.type` | `ClusterIP` | Kubernetes service type for mobile speedtest | -| `speedtestService.port` | `6789` | Kubernetes UDP port for mobile speedtest | -| `speedtestService.annotations` | `{}` | Service annotations for mobile speedtest | -| `speedtestService.labels` | `{}` | Custom labels | -| `speedtestService.loadBalancerIP` | `{}` | Loadbalancer IP for mobile speedtest | -| `speedtestService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to load balancer (if supported) | -| `speedtestService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the Service to either Cluster or Local | -| `unifiedService.enabled` | `false` | Use a single service for GUI, controller, STUN, discovery, syslog and speedtest | -| `unifiedService.type` | `ClusterIP` | Kubernetes service type for the unified service | -| `unifiedService.annotations` | `{}` | Annotations for the unified service | -| `unifiedService.labels` | `{}` | Custom labels for the unified service | -| `unifiedService.loadBalancerIP` | None | Load balancer IP for the unified service | -| `unifiedService.loadBalancerSourceRanges` | None | List of IP CIDRs allowed access to the load balancer (if supported) | -| `unifiedService.externalTrafficPolicy` | `Cluster` | Set the externalTrafficPolicy in the service to either Cluster or Local | -| `ingress.enabled` | `false` | Enables Ingress | -| `ingress.annotations` | `{}` | Ingress annotations | -| `ingress.labels` | `{}` | Custom labels | -| `ingress.path` | `/` | Ingress path | -| `ingress.hosts` | `chart-example.local` | Ingress accepted hostnames | -| `ingress.tls` | `[]` | Ingress TLS configuration | -| `timezone` | `UTC` | Timezone the Unifi controller should run as, e.g. 'America/New York' | -| `runAsRoot` | `false` | Run the controller as UID0 (root user); if set to false, will give container SETFCAP instead | -| `UID` | `999` | Run the controller as user UID | -| `GID` | `999` | Run the controller as group GID | -| `customCert.enabled` | `false` | Define whether you are using s custom certificate | -| `customCert.isChain` | `false` | If you are using a Let's Encrypt certificate which already includes the full chain set this to `true` | -| `customCert.certName` | `tls.crt` | Name of the the certificate file in `/cert` | -| `customCert.keyName` | `tls.key` | Name of the the private key file in `/cert` | -| `customCert.certSecret` | `nil` | Name of the the k8s tls secret where the certificate and its key are stored. | -| `logging.promtail.enabled` | `false` | Enable a Promtail sidecar to collect controller logs | -| `logging.promtail.image.repository` | `grafana/promtail` | Promtail image repository | -| `logging.promtail.image.tag` | `1.6.0` | Promtail image tag | -| `logging.promtail.image.pullPolicy` | `IfNotPresent` | Promtail image pull policy | -| `logging.promtail.loki.url` | `http://loki.logs.svc.cluster.local:3100/loki/api/v1/push` | URL of the Loki push API | -| `mongodb.enabled` | `false` | Use external MongoDB for data storage | -| `mongodb.dbUri` | `mongodb://mongo/unifi` | external MongoDB URI | -| `mongodb.statDbUri` | `mongodb://mongo/unifi_stat` | external MongoDB statdb URI | -| `mongodb.databaseName` | `unifi` | external MongoDB database name | -| `persistence.enabled` | `true` | Use persistent volume to store data | -| `persistence.size` | `5Gi` | Size of persistent volume claim | -| `persistence.existingClaim` | `nil` | Use an existing PVC to persist data | -| `persistence.subPath` | `` | Store data in a subdirectory of PV instead of at the root directory | -| `persistence.storageClass` | `-` | Type of persistent volume claim | -| `extraVolumes` | `[]` | Additional volumes to be used by extraVolumeMounts | -| `extraVolumeMounts` | `[]` | Additional volume mounts to be mounted in unifi container | -| `persistence.accessModes` | `[]` | Persistence access modes | -| `extraConfigFiles` | `{}` | Dictionary containing files mounted to `/configmap` inside the pod (See [values.yaml](values.yaml) for examples) | -| `extraJvmOpts` | `[]` | List of additional JVM options, e.g. `["-Dlog4j.configurationFile=file:/configmap/log4j2.xml"]` | -| `jvmInitHeapSize` | `` | Java Virtual Machine (JVM) initial, and minimum, heap size. | -| `jvmMaxHeapSize` | `1024M` | Java Virtual Machine (JVM) maximum heap size. | -| `resources` | `{}` | CPU/Memory resource requests/limits | -| `livenessProbe.enabled` | `true` | Turn on and off liveness probe | -| `livenessProbe.initialDelaySeconds` | `30` | Delay before liveness probe is initiated | -| `livenessProbe.periodSeconds` | `15` | How often to perform the probe | -| `livenessProbe.timeoutSeconds` | `5` | When the probe times out | -| `livenessProbe.failureThreshold` | `3` | Minimum consecutive failures for the probe | -| `livenessProbe.successThreshold` | `1` | Minimum consecutive successes for the probe | -| `readinessProbe.enabled` | `true` | Turn on and off readiness probe | -| `readinessProbe.initialDelaySeconds` | `30` | Delay before readiness probe is initiated | -| `readinessProbe.periodSeconds` | `15` | How often to perform the probe | -| `readinessProbe.timeoutSeconds` | `5` | When the probe times out | -| `readinessProbe.failureThreshold` | `3` | Minimum consecutive failures for the probe | -| `readinessProbe.successThreshold` | `1` | Minimum consecutive successes for the probe | -| `nodeSelector` | `{}` | Node labels for pod assignment | -| `tolerations` | `[]` | Toleration labels for pod assignment | -| `affinity` | `{}` | Affinity settings for pod assignment | -| `podAnnotations` | `{}` | Key-value pairs to add as pod annotations | -| `deploymentAnnotations` | `{}` | Key-value pairs to add as deployment annotations | - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name my-release \ - --set timezone="America/New York" \ - stable/unifi -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name my-release -f values.yaml stable/unifi -``` - -Read through the [values.yaml](values.yaml) file. It has several commented out suggested values. - -## Regarding the services - -- `guiService`: Represents the main web UI and is what one would normally point - the ingress to. -- `captivePortalService`: This service is used to allow the captive portal webpage - to be accessible. It needs to be reachable by the clients connecting to your guest - network. -- `controllerService`: This is needed in order for the unifi devices to talk to - the controller and must be otherwise exposed to the network where the unifi - devices run. If you run this as a `NodePort` (the default setting), make sure - that there is an external load balancer that is directing traffic from port - 8080 to the `NodePort` for this service. -- `discoveryService`: This needs to be reachable by the unifi devices on the - network similar to the controller `Service` but only during the discovery - phase. This is a UDP service. -- `stunService`: Also used periodically by the unifi devices to communicate - with the controller using UDP. See [this article][ubnt 3] and [this other - article][ubnt 4] for more information. -- `syslogService`: Used to capture syslog from Unifi devices if the feature is - enabled in the site configuration. This needs to be reachable by Unifi devices - on port 5514/UDP. -- `speedtestService`: Used for mobile speedtest inside the UniFi Mobile app. - This needs to be reachable by clients connecting to port 6789/TCP. - -## Ingress and HTTPS - -Unifi does [not support HTTP][unifi] so if you wish to use the guiService, you -need to ensure that you use a backend transport of HTTPS. - -An example entry in `values.yaml` to achieve this is as follows: - -``` -ingress: - enabled: true - annotations: - nginx.ingress.kubernetes.io/backend-protocol: "HTTPS" -``` - -[docker]: https://hub.docker.com/r/jacobalberty/unifi/tags/ -[github]: https://github.com/jacobalberty/unifi-docker -[ubnt]: https://www.ubnt.com/ -[ubnt 2]: https://unifi-sdn.ubnt.com/ -[ubnt 3]: https://help.ubnt.com/hc/en-us/articles/204976094-UniFi-What-protocol-does-the-controller-use-to-communicate-with-the-UAP- -[ubnt 4]: https://help.ubnt.com/hc/en-us/articles/115015457668-UniFi-Troubleshooting-STUN-Communication-Errors -[unifi]: https://community.ui.com/questions/Controller-how-to-deactivate-http-to-https/c5e247d8-b5b9-4c84-a3bb-28a90fd65668 +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/unpackerr/.helmignore b/charts/unpackerr/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/unpackerr/.helmignore +++ b/charts/unpackerr/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/unpackerr/README.md b/charts/unpackerr/README.md index fc81e0bf..cf2a38c0 100644 --- a/charts/unpackerr/README.md +++ b/charts/unpackerr/README.md @@ -1,67 +1,118 @@ -# Unpackerr +# unpackerr -This is a helm chart for [Unpackerr](https://github.com/davidnewhall/unpackerr). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 0.7.2](https://img.shields.io/badge/AppVersion-0.7.2-informational?style=flat-square) + +This application runs as a daemon on your download host. It checks for completed downloads and extracts them so Radarr, Lidarr, Sonarr, and Readarr may import them. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/unpackerr +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install unpackerr k8s-at-home/unpackerr ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `unpackerr` ```console -helm install --name my-release k8s-at-home/unpackerr +helm install unpackerr k8s-at-home/unpackerr ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `unpackerr` deployment ```console -helm delete my-release --purge +helm uninstall unpackerr ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/unpackerr/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install unpackerr \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/unpackerr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install unpackerr k8s-at-home/unpackerr --values values.yaml +helm install unpackerr k8s-at-home/unpackerr -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"golift/unpackerr"` | | +| image.tag | string | `"0.7.2"` | | +| ingress.enabled | bool | `false` | | +| persistence.downloads.emptyDir | bool | `false` | | +| persistence.downloads.enabled | bool | `false` | | +| persistence.downloads.mountPath | string | `"/downloads"` | | +| probes.liveness.enabled | bool | `false` | | +| probes.readiness.enabled | bool | `false` | | +| probes.startup.enabled | bool | `false` | | +| service.enabled | bool | `false` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/unpackerr/README.md.gotmpl b/charts/unpackerr/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/unpackerr/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/unpackerr/README_CHANGELOG.md.gotmpl b/charts/unpackerr/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/unpackerr/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/unpackerr/README_CONFIG.md.gotmpl b/charts/unpackerr/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/unpackerr/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/uptimerobot-prometheus/README.md b/charts/uptimerobot-prometheus/README.md index 417c98fd..07119666 100644 --- a/charts/uptimerobot-prometheus/README.md +++ b/charts/uptimerobot-prometheus/README.md @@ -1,52 +1,46 @@ -# Prometheus Exporter using the Uptimerobot API +# uptimerobot-prometheus -![](https://raw.githubusercontent.com/lekpamartin/uptimerobot_exporter/master/dashboards/dashboard.PNG) +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square) -This is a helm chart providing a prometheus exporter to query the uptimerobot API. Based on the [uptimerobot_exporter](https://github.com/lekpamartin/uptimerobot_exporter) container image. +Prometheus Exporter for the official uptimerobot CLI -## TL;DR; +**Homepage:** -```console -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/uptimerobot-prometheus -``` +## Maintainers -## Installing the Chart +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -To install the chart with the release name `uptimerobot-prometheus`: +## Source Code -```console -helm install --name uptimerobot-prometheus k8s-at-home/uptimerobot-prometheus -``` +* +* -## Uninstalling the Chart +## Values -To uninstall/delete the `uptimerobot-prometheus` deployment: +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"billimek/prometheus-uptimerobot-exporter"` | | +| image.tag | string | `"0.0.1"` | | +| imagePullSecrets | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `9705` | | +| service.type | string | `"ClusterIP"` | | +| serviceMonitor.additionalLabels | object | `{}` | | +| serviceMonitor.enabled | bool | `false` | | +| serviceMonitor.interval | string | `"5m"` | | +| serviceMonitor.scrapeTimeout | string | `"90s"` | | +| tolerations | list | `[]` | | +| uptimerobotApiKey | string | `""` | | -```console -helm delete uptimerobot-prometheus -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/uptimerobot-prometheus/values.yaml) file. It has several commented out suggested values. - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -helm install --name uptimerobot-prometheus \ - --set serviceMonitor.enabled=true \ - k8s-at-home/uptimerobot-prometheus -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -helm install --name uptimerobot-prometheus -f values.yaml k8s-at-home/uptimerobot-prometheus -``` - -## Grafana Dashboard - -You can find an [example grafana dashboard](https://github.com/lekpamartin/uptimerobot_exporter/blob/master/dashboards/grafana.json) as shown in the screenshot above. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/uptimerobot/README.md b/charts/uptimerobot/README.md index 8ea04d2a..4b67de95 100644 --- a/charts/uptimerobot/README.md +++ b/charts/uptimerobot/README.md @@ -1,73 +1,39 @@ -# A tool to get statistics from Uptime Robot and log it into InfluxDB +# uptimerobot -![Screenshot](https://raw.githubusercontent.com/billimek/node-influx-uptimerobot/master/docs/dashboard.png) +![Version: 3.0.0](https://img.shields.io/badge/Version-3.0.0-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square) -This tool allows you to run periodic uptimerobot data usage checks and save the results to Influxdb +A tool to get statistics from Uptime Robot and log it into InfluxDB -## TL;DR; +**Homepage:** -```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/uptimerobot -``` +## Maintainers -## Introduction +| Name | Email | Url | +| ---- | ------ | --- | +| billimek | jeff@billimek.com | | -This code is adopted from [this original repo](https://github.com/trojanc/node-influx-uptimerobot) +## Source Code -## Installing the Chart +* +* -To install the chart with the release name `my-release`: +## Values -```console -$ helm install --name my-release k8s-at-home/uptimerobot -``` -## Uninstalling the Chart +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| config.influxdb.database | string | `"uptimerobot"` | | +| config.influxdb.host | string | `"influxdb-influxdb"` | | +| config.influxdb.port | int | `8086` | | +| config.influxdb.protocol | string | `"http"` | | +| config.uptimerobot.apikey | string | `"someapikey"` | | +| delay | int | `300` | | +| image.pullPolicy | string | `"Always"` | | +| image.repository | string | `"billimek/node-influx-uptimerobot"` | | +| image.tag | string | `"latest"` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | -To uninstall/delete the `my-release` deployment: - -```console -$ helm delete my-release --purge -``` - -The command removes all the Kubernetes components associated with the chart and deletes the release. - -## Configuration - -The configuration is set as a block of text through a configmap and mounted as a file in /src/config.ini Any value in this text block should match the defined uptimerobot configuration. There are several values here that will have to match our kubernetes configuration. - -## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -| ------------------------------- | ------------------------------- | ---------------------------------------------------------- | -| `image.repository` | uptimerobot image | `billimek/uptimerobotusage-for-influxdb` | -| `image.tag` | uptimerobot image tag | `latest` | -| `image.pullPolicy` | uptimerobot image pull policy | `IfNotPresent` | -| `delay` | number of seconds to wait between collections | `300` | -| `config.influxdb.host` | InfluxDB hostname | `influxdb-influxdb` | -| `config.influxdb.port` | InfluxDB port | `8086` | -| `config.influxdb.database` | InfluxDB database | `uptimerobot` | -| `config.influxdb.protocol` | InfluxDB protocol | `http` | -| `config.influxdb.username` | InfluxDB username | `` | -| `config.influxdb.password` | InfluxDB password | `` | -| `config.uptimerobot.apikey` | uptimerobot API key (REQUIRED) | `someapikey` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | - - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - -```console -$ helm install --name my-release \ - --set config.uptimerobot.apikey=thisismyapikey \ - k8s-at-home/uptimerobot -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - -```console -$ helm install --name my-release -f values.yaml k8s-at-home/uptimerobot -``` - -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/uptimerobot/values.yaml) file. It has several commented out suggested values. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/xbackbone/.helmignore b/charts/xbackbone/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/xbackbone/.helmignore +++ b/charts/xbackbone/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/xbackbone/README.md b/charts/xbackbone/README.md index 073644c2..c003ba7f 100644 --- a/charts/xbackbone/README.md +++ b/charts/xbackbone/README.md @@ -1,67 +1,115 @@ -# XBackBone +# xbackbone -This is a helm chart for [XBackBone](https://github.com/SergiX44/XBackBone). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 3.3.3](https://img.shields.io/badge/AppVersion-3.3.3-informational?style=flat-square) + +XBackBone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/xbackbone +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install xbackbone k8s-at-home/xbackbone ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `xbackbone` ```console -helm install --name my-release k8s-at-home/xbackbone +helm install xbackbone k8s-at-home/xbackbone ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `xbackbone` deployment ```console -helm delete my-release --purge +helm uninstall xbackbone ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/xbackbone/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install xbackbone \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/xbackbone ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install xbackbone k8s-at-home/xbackbone --values values.yaml +helm install xbackbone k8s-at-home/xbackbone -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"pe46dro/xbackbone-docker"` | | +| image.tag | string | `"3.3.3"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/app/config"` | | +| service.port.port | int | `80` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/xbackbone/README.md.gotmpl b/charts/xbackbone/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/xbackbone/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/xbackbone/README_CHANGELOG.md.gotmpl b/charts/xbackbone/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/xbackbone/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/xbackbone/README_CONFIG.md.gotmpl b/charts/xbackbone/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/xbackbone/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/xteve/.helmignore b/charts/xteve/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/xteve/.helmignore +++ b/charts/xteve/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/xteve/README.md b/charts/xteve/README.md index b62eb02e..550f2159 100644 --- a/charts/xteve/README.md +++ b/charts/xteve/README.md @@ -1,78 +1,114 @@ # xteve -This is a helm chart for [xTeVe](https://github.com/xteve-project/xTeVe). +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: 2.1.2.0120](https://img.shields.io/badge/AppVersion-2.1.2.0120-informational?style=flat-square) + +M3U Proxy for Plex DVR and Emby Live TV. **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/xteve +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install xteve k8s-at-home/xteve ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `xteve` ```console -helm install --name my-release k8s-at-home/xteve +helm install xteve k8s-at-home/xteve ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `xteve` deployment ```console -helm delete my-release --purge +helm uninstall xteve ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/xteve/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install xteve \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/xteve ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install xteve k8s-at-home/xteve --values values.yaml +helm install xteve k8s-at-home/xteve -f values.yaml ``` -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"k8sathome/xteve"` | | +| image.tag | string | `"v2.1.2.0120"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| service.port.port | int | `34400` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## Changelog -### Upgrading from 2.x.x to 3.x.x +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Due to migrating to a centralized common library some values in `values.yaml` have changed. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -Examples: +### [1.0.0] -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +#### Added -Refer to the library values.yaml for more configuration options. +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/xteve/README.md.gotmpl b/charts/xteve/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/xteve/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/xteve/README_CHANGELOG.md.gotmpl b/charts/xteve/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/xteve/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/xteve/README_CONFIG.md.gotmpl b/charts/xteve/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/xteve/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/zigbee2mqtt/.helmignore b/charts/zigbee2mqtt/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/zigbee2mqtt/.helmignore +++ b/charts/zigbee2mqtt/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/zigbee2mqtt/README.md b/charts/zigbee2mqtt/README.md index 676e6df2..09c5973d 100644 --- a/charts/zigbee2mqtt/README.md +++ b/charts/zigbee2mqtt/README.md @@ -1,24 +1,68 @@ # zigbee2mqtt -This is a helm chart for [zigbee2mqtt](https://www.zigbee2mqtt.io). +![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![AppVersion: 1.17.1](https://img.shields.io/badge/AppVersion-1.17.1-informational?style=flat-square) + +Bridges events and allows you to control your Zigbee devices via MQTT **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/zigbee2mqtt +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install zigbee2mqtt k8s-at-home/zigbee2mqtt ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `zigbee2mqtt` ```console -helm install --name my-release k8s-at-home/zigbee2mqtt +helm install zigbee2mqtt k8s-at-home/zigbee2mqtt ``` +## Uninstalling the Chart + +To uninstall the `zigbee2mqtt` deployment + +```console +helm uninstall zigbee2mqtt +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install zigbee2mqtt \ + --set env.TZ="America/New York" \ + k8s-at-home/zigbee2mqtt +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install zigbee2mqtt k8s-at-home/zigbee2mqtt -f values.yaml +``` + +## Custom configuration + **IMPORTANT NOTE:** a zigbee controller device must be accessible on the node where this pod runs, in order for this chart to function properly. First, you will need to mount your zigbee device into the pod, you can do so by adding the following to your values: @@ -50,74 +94,67 @@ affinity: ... where a node with an attached zigbee controller USB device is labeled with `app: zigbee-controller` -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts | list | `[]` | | +| additionalVolumes | list | `[]` | | +| config.advanced.homeassistant_discovery_topic | string | `"homeassistant"` | | +| config.advanced.homeassistant_status_topic | string | `"homeassistant/status"` | | +| config.advanced.last_seen | string | `"ISO_8601"` | | +| config.advanced.log_level | string | `"info"` | | +| config.advanced.log_output[0] | string | `"console"` | | +| config.advanced.network_key | string | `"GENERATE"` | | +| config.experimental.new_api | bool | `true` | | +| config.frontend.port | int | `8080` | | +| config.homeassistant | bool | `false` | | +| config.mqtt.base_topic | string | `"zigbee2mqtt"` | | +| config.mqtt.include_device_information | bool | `true` | | +| config.mqtt.server | string | `"mqtt://localhost"` | | +| config.permit_join | bool | `true` | | +| config.serial | string | `nil` | | +| env.ZIGBEE2MQTT_DATA | string | `"/data"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"koenkk/zigbee2mqtt"` | | +| image.tag | string | `"1.17.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.data.emptyDir | bool | `false` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/data"` | | +| service.port.port | int | `8080` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/zigbee2mqtt/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install my-release \ - --set env.TZ="America/New_York" \ - k8s-at-home/zigbee2mqtt -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install my-release k8s-at-home/zigbee2mqtt --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -```yaml -image: - tag: ... -``` +### [1.0.0] ---- -**NOTE** +#### Added -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +- N/A ---- +#### Changed -## Upgrading an existing Release to a new major version +- N/A -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +#### Removed -### Upgrading from 2.x.x to 3.x.x +- N/A -**Note:** _It may be wise to back up your existing data incase something unexpected happens_ +[1.0.0]: #1.0.0 -As of 3.0.0 this chart was migrated to a centralized [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library, some values in `values.yaml` have changed. +## Support -Examples: +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. - -Refer to the [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library for more configuration options. - -### Upgrading from 1.x.x to 2.x.x - -Zigbee2MQTT has gained a native full-feature WebUI. Because of this, Zigbee2MQTTAssistant was dropped from the chart - -You should delete the assistant config from your values.yaml. If you wish to use the new UI, make sure you have -``` -frontend: - port: 8080 -experimental: - new_api: true -``` -in the config section, and enable the ingress in values.yaml. Because of the way this chart works, you'll need to add this section to your configuration.yaml in zigbee2mqtt manually if you want to upgrade in-place +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/zigbee2mqtt/README.md.gotmpl b/charts/zigbee2mqtt/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/zigbee2mqtt/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/zigbee2mqtt/README_CHANGELOG.md.gotmpl b/charts/zigbee2mqtt/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/zigbee2mqtt/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/zigbee2mqtt/README_CONFIG.md.gotmpl b/charts/zigbee2mqtt/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..8e01b320 --- /dev/null +++ b/charts/zigbee2mqtt/README_CONFIG.md.gotmpl @@ -0,0 +1,38 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +**IMPORTANT NOTE:** a zigbee controller device must be accessible on the node where this pod runs, in order for this chart to function properly. + +First, you will need to mount your zigbee device into the pod, you can do so by adding the following to your values: + +```yaml +additionalVolumeMounts: + - name: usb + mountPath: /path/to/device + +additionalVolumes: + - name: usb + hostPath: + path: /path/to/device +``` + +Second you will need to set a nodeAffinity rule, for example: + +```yaml +affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: app + operator: In + values: + - zigbee-controller +``` + +... where a node with an attached zigbee controller USB device is labeled with `app: zigbee-controller` +{{- end -}} diff --git a/charts/zwave2mqtt/.helmignore b/charts/zwave2mqtt/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/zwave2mqtt/.helmignore +++ b/charts/zwave2mqtt/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/zwave2mqtt/README.md b/charts/zwave2mqtt/README.md index 469eedd9..1be1d238 100644 --- a/charts/zwave2mqtt/README.md +++ b/charts/zwave2mqtt/README.md @@ -1,24 +1,68 @@ # zwave2mqtt -This is a helm chart for [zwave2mqtt](https://zwave2mqtt.org/). +![Version: 7.0.1](https://img.shields.io/badge/Version-7.0.1-informational?style=flat-square) ![AppVersion: 4.0.6](https://img.shields.io/badge/AppVersion-4.0.6-informational?style=flat-square) + +Fully configurable Zwave to MQTT gateway and Control Panel using NodeJS and Vue **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/zwave2mqtt +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install zwave2mqtt k8s-at-home/zwave2mqtt ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `zwave2mqtt` ```console -helm install --name my-release k8s-at-home/zwave2mqtt +helm install zwave2mqtt k8s-at-home/zwave2mqtt ``` +## Uninstalling the Chart + +To uninstall the `zwave2mqtt` deployment + +```console +helm uninstall zwave2mqtt +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install zwave2mqtt \ + --set env.TZ="America/New York" \ + k8s-at-home/zwave2mqtt +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install zwave2mqtt k8s-at-home/zwave2mqtt -f values.yaml +``` + +## Custom configuration + **IMPORTANT NOTE:** a zwave controller device must be accessible on the node where this pod runs, in order for this chart to function properly. First, you will need to mount your zwave device into the pod, you can do so by adding the following to your values: @@ -50,59 +94,56 @@ affinity: ... where a node with an attached zwave controller USB device is labeled with `app: zwave-controller` -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts | list | `[]` | | +| additionalVolumes | list | `[]` | | +| env.OZW_AUTO_UPDATE_CONFIG | bool | `true` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"robertslando/zwave2mqtt"` | | +| image.tag | string | `"4.0.6"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/usr/src/app/store"` | | +| probes.liveness.enabled | bool | `true` | | +| probes.readiness.enabled | bool | `true` | | +| probes.startup.enabled | bool | `false` | | +| service.port.port | int | `8091` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/zwave2mqtt/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install my-release \ - --set env.TZ="America/New_York" \ - k8s-at-home/zwave2mqtt -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install my-release k8s-at-home/zwave2mqtt --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -```yaml -image: - tag: ... -``` +### [1.0.0] ---- -**NOTE** +#### Added -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +- N/A ---- +#### Changed -## Upgrading an existing Release to a new major version +- N/A -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +#### Removed -### Upgrading from 4.x.x to 5.x.x +- N/A -As of 5.0.0 this chart was migrated to a centralized [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library, some values in `values.yaml` have changed. +[1.0.0]: #1.0.0 -Examples: +## Support -* `service.port` has been moved to `service.port.port`. -* `persistence.type` has been moved to `controllerType`. +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community -Refer to the [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library for more configuration options. +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/zwave2mqtt/README.md.gotmpl b/charts/zwave2mqtt/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/zwave2mqtt/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/zwave2mqtt/README_CHANGELOG.md.gotmpl b/charts/zwave2mqtt/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/zwave2mqtt/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/zwave2mqtt/README_CONFIG.md.gotmpl b/charts/zwave2mqtt/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..3b1ec799 --- /dev/null +++ b/charts/zwave2mqtt/README_CONFIG.md.gotmpl @@ -0,0 +1,38 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +**IMPORTANT NOTE:** a zwave controller device must be accessible on the node where this pod runs, in order for this chart to function properly. + +First, you will need to mount your zwave device into the pod, you can do so by adding the following to your values: + +```yaml +additionalVolumeMounts: + - name: usb + mountPath: /path/to/device + +additionalVolumes: + - name: usb + hostPath: + path: /path/to/device +``` + +Second you will need to set a nodeAffinity rule, for example: + +```yaml +affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: app + operator: In + values: + - zwave-controller +``` + +... where a node with an attached zwave controller USB device is labeled with `app: zwave-controller` +{{- end -}} diff --git a/charts/zwavejs2mqtt/.helmignore b/charts/zwavejs2mqtt/.helmignore index e559de0a..4379e2b3 100644 --- a/charts/zwavejs2mqtt/.helmignore +++ b/charts/zwavejs2mqtt/.helmignore @@ -22,3 +22,5 @@ .vscode/ # OWNERS file for Kubernetes OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/zwavejs2mqtt/README.md b/charts/zwavejs2mqtt/README.md index 16b9e2e3..2ab8b8a5 100644 --- a/charts/zwavejs2mqtt/README.md +++ b/charts/zwavejs2mqtt/README.md @@ -1,24 +1,68 @@ # zwavejs2mqtt -This is a helm chart for [zwavejs2mqtt](https://github.com/zwave-js/zwavejs2mqtt). +![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: 1.1.1](https://img.shields.io/badge/AppVersion-1.1.1-informational?style=flat-square) + +Fully configurable Zwave to MQTT Gateway and Control Panel **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/zwavejs2mqtt +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install zwavejs2mqtt k8s-at-home/zwavejs2mqtt ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `zwavejs2mqtt` ```console -helm install --name my-release k8s-at-home/zwavejs2mqtt +helm install zwavejs2mqtt k8s-at-home/zwavejs2mqtt ``` +## Uninstalling the Chart + +To uninstall the `zwavejs2mqtt` deployment + +```console +helm uninstall zwavejs2mqtt +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install zwavejs2mqtt \ + --set env.TZ="America/New York" \ + k8s-at-home/zwavejs2mqtt +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install zwavejs2mqtt k8s-at-home/zwavejs2mqtt -f values.yaml +``` + +## Custom configuration + **IMPORTANT NOTE:** a zwave controller device must be accessible on the node where this pod runs, in order for this chart to function properly. First, you will need to mount your zwave device into the pod, you can do so by adding the following to your values: @@ -50,48 +94,56 @@ affinity: ... where a node with an attached zwave controller USB device is labeled with `app: zwave-controller` -## Uninstalling the Chart +## Values -To uninstall/delete the `my-release` deployment: +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -```console -helm delete my-release --purge -``` +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| additionalVolumeMounts | list | `[]` | | +| additionalVolumes | list | `[]` | | +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"zwavejs/zwavejs2mqtt"` | | +| image.tag | string | `"1.1.1"` | | +| ingress.enabled | bool | `false` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/usr/src/app/store"` | | +| probes.liveness.enabled | bool | `true` | | +| probes.readiness.enabled | bool | `true` | | +| probes.startup.enabled | bool | `false` | | +| service.port.port | int | `8091` | | +| strategy.type | string | `"Recreate"` | | -The command removes all the Kubernetes components associated with the chart and deletes the release. +## Changelog -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/zwavejs2mqtt/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, -```console -helm install my-release \ - --set env.TZ="America/New_York" \ - k8s-at-home/zwavejs2mqtt -``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, -```console -helm install my-release k8s-at-home/zwavejs2mqtt --values values.yaml -``` +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -```yaml -image: - tag: ... -``` +### [1.0.0] ---- -**NOTE** +#### Added -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +- N/A ---- +#### Changed -## Upgrading an existing Release to a new major version +- N/A -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/charts/zwavejs2mqtt/README.md.gotmpl b/charts/zwavejs2mqtt/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/charts/zwavejs2mqtt/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/zwavejs2mqtt/README_CHANGELOG.md.gotmpl b/charts/zwavejs2mqtt/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/zwavejs2mqtt/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/zwavejs2mqtt/README_CONFIG.md.gotmpl b/charts/zwavejs2mqtt/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..3b1ec799 --- /dev/null +++ b/charts/zwavejs2mqtt/README_CONFIG.md.gotmpl @@ -0,0 +1,38 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +**IMPORTANT NOTE:** a zwave controller device must be accessible on the node where this pod runs, in order for this chart to function properly. + +First, you will need to mount your zwave device into the pod, you can do so by adding the following to your values: + +```yaml +additionalVolumeMounts: + - name: usb + mountPath: /path/to/device + +additionalVolumes: + - name: usb + hostPath: + path: /path/to/device +``` + +Second you will need to set a nodeAffinity rule, for example: + +```yaml +affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: app + operator: In + values: + - zwave-controller +``` + +... where a node with an attached zwave controller USB device is labeled with `app: zwave-controller` +{{- end -}} diff --git a/hack/gen-helm-docs.sh b/hack/gen-helm-docs.sh new file mode 100755 index 00000000..a6df2706 --- /dev/null +++ b/hack/gen-helm-docs.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash +set -eu + +# +# Generate helm-docs for Helm charts using the common library +# + +# Absolute path of repository +repository=$(git rev-parse --show-toplevel) + +# Templates to copy into each chart directory +readme_template="${repository}/hack/templates/README.md.gotmpl" +readme_config_template="${repository}/hack/templates/README_CONFIG.md.gotmpl" +readme_changelog_template="${repository}/hack/templates/README_CHANGELOG.md.gotmpl" + +# Gather all charts using the common library, excluding common-test +charts=$(find "${repository}" -name "Chart.yaml" -exec grep --exclude="*common-test*" -l "\- name\: common" {} \;) + +for chart in ${charts}; do + chart_directory="$(dirname "${chart}")" + # Copy README template into each Chart directory, overwrite if exists + cp "${readme_template}" "${chart_directory}" + # Copy CUSTOM_CONFIG template to each Chart directory, do not overwrite if exists + cp -n "${readme_config_template}" "${chart_directory}" || true + # Copy CHANGELOG template to each Chart directory, do not overwrite if exists + cp -n "${readme_changelog_template}" "${chart_directory}" || true +done + +# Run helm-docs for charts using the common library and the common library itself +helm-docs \ + --ignore-file="${repository}/.helmdocsignore" \ + --template-files="$(basename "${readme_template}")" \ + --template-files="$(basename "${readme_config_template}")" \ + --template-files="$(basename "${readme_changelog_template}")" \ + --chart-search-root="${repository}" diff --git a/hack/gen-helmdocsignore.sh b/hack/gen-helmdocsignore.sh new file mode 100755 index 00000000..c0eb4bb0 --- /dev/null +++ b/hack/gen-helmdocsignore.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env bash +set -eu + +# +# Generate .helmdocsignore for excluding non-common based helm charts +# + +# shellcheck disable=SC2155 +export REPO_ROOT=$(git rev-parse --show-toplevel) + +grep -L -r "\- name\: common" ./charts/**/Chart.yaml \ + | sed 's|\.\/\(.*\)/Chart.yaml|\1|' \ + | grep -v "common" \ + > .helmdocsignore + +echo "charts/common-test" >> .helmdocsignore diff --git a/hack/gen-helmignore.sh b/hack/gen-helmignore.sh new file mode 100755 index 00000000..7132c830 --- /dev/null +++ b/hack/gen-helmignore.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash +set -eu + +# +# Generate common charts .helmignore files +# + +# Absolute path of repository +repository=$(git rev-parse --show-toplevel) + +# Templates to copy into each chart directory +helmignore="${repository}/hack/templates/.helmignore" + +# Gather all charts using the common library, excluding common-test +charts=$(find "${repository}" -name "Chart.yaml" -exec grep -l "\- name\: common" {} \;) + +for chart in ${charts}; do + chart_directory="$(dirname "${chart}")" + # Copy .helmignore into each Chart directory, overwrite if exists + cp "${helmignore}" "${chart_directory}" +done diff --git a/hack/templates/.helmignore b/hack/templates/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/hack/templates/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/hack/templates/README.md.gotmpl b/hack/templates/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/hack/templates/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/hack/templates/README_CHANGELOG.md.gotmpl b/hack/templates/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/hack/templates/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/hack/templates/README_CONFIG.md.gotmpl b/hack/templates/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/hack/templates/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/templates/chart/.helmignore b/templates/chart/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/templates/chart/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/templates/chart/README.md b/templates/chart/README.md index 6689e368..a65a35b4 100644 --- a/templates/chart/README.md +++ b/templates/chart/README.md @@ -1,68 +1,112 @@ # ${CHARTNAME} -This is a helm chart for [${CHARTNAME}](https://${CHARTNAME}.org/). +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +${CHARTNAME} helm package **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** -## TL;DR; +## Requirements -```shell -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/${CHARTNAME} +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://k8s-at-home.com/charts/ | common | 3.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `${CHARTNAME}` ```console -helm install --name my-release k8s-at-home/${CHARTNAME} +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `${CHARTNAME}` deployment ```console -helm delete my-release --purge +helm uninstall ${CHARTNAME} ``` -The command removes all the Kubernetes components associated with the chart and deletes the release. +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Configuration -Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/${CHARTNAME}/values.yaml) -file. It has several commented out suggested values. -Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + ```console helm install ${CHARTNAME} \ - --set env.TZ="America/New_York" \ + --set env.TZ="America/New York" \ k8s-at-home/${CHARTNAME} ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the -chart. For example, + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + ```console -helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} --values values.yaml +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} -f values.yaml ``` -These values will be nested as it is a dependency, for example -```yaml -image: - tag: ... -``` +## Custom configuration ---- -**NOTE** +N/A -If you get -```console -Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` -``` -it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +## Values ---- +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) -## Upgrading an existing Release to a new major version +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` | | +| image.tag | string | `"1.0.0"` | | +| ingress.enabled | bool | `false` | | +| service.port.port | int | `1880` | | +| strategy.type | string | `"Recreate"` | | -A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) \ No newline at end of file diff --git a/templates/chart/README.md.gotmpl b/templates/chart/README.md.gotmpl new file mode 100644 index 00000000..d9926fa1 --- /dev/null +++ b/templates/chart/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Wiki](https://github.com/k8s-at-home/charts/wiki). +- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/charts/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/templates/chart/README_CHANGELOG.md.gotmpl b/templates/chart/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/templates/chart/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +### [1.0.0] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/templates/chart/README_CONFIG.md.gotmpl b/templates/chart/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/templates/chart/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}}