diff --git a/.helmdocsignore b/.helmdocsignore index fd7adb42..d3c824c1 100644 --- a/.helmdocsignore +++ b/.helmdocsignore @@ -1,29 +1,8 @@ -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/CONTRIBUTING.md b/CONTRIBUTING.md index 0215305a..0fc65b2d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,6 @@ Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to This repo supports the [pre-commit](https://pre-commit.com) framework. By installing the framework (see [docs](https://pre-commit.com/#install)) it is possible to perform the chart linting step before committing your code. This can help prevent linter issues in the pipeline. Note that this requires having Docker running on your development environment. -## Wiki +## Documentation -See the [wiki](https://github.com/k8s-at-home/charts/wiki) for more information. +See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) for more information. diff --git a/charts/adguard-home/Chart.yaml b/charts/adguard-home/Chart.yaml index 65534b1e..2e288b51 100644 --- a/charts/adguard-home/Chart.yaml +++ b/charts/adguard-home/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: v0.102.0 description: DNS proxy as ad-blocker for local network name: adguard-home -version: 2.2.0 +version: 2.2.1 keywords: - adguard-home - adguard diff --git a/charts/adguard-home/README.md b/charts/adguard-home/README.md index d3c9dc80..4189d793 100644 --- a/charts/adguard-home/README.md +++ b/charts/adguard-home/README.md @@ -1,64 +1,265 @@ -# 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 + +**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)** + +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| ## TL;DR -```shell +```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/adguard-home +helm repo update +helm install adguard-home k8s-at-home/adguard-home ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `adguard-home` ```console -helm install --name adguard-home k8s-at-home/adguard-home +helm install adguard-home k8s-at-home/adguard-home ``` ## Uninstalling the Chart -To uninstall/delete the `adguard-home` deployment: +To uninstall the `adguard-home` deployment ```console -helm delete adguard-home --purge +helm uninstall adguard-home ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/adguard-home/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name adguard-home \ - --set timeZone="America/New York" \ +helm install adguard-home \ + --set env.TZ="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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name adguard-home -f values.yaml k8s-at-home/adguard-home +helm install adguard-home k8s-at-home/adguard-home -f values.yaml ``` -#### Helm force upgrade +## Custom configuration -```sh -helm upgrade --force -``` +N/A -#### Delete the existing `adguard-home` services prior to upgrading +## Values -```sh -kubectl delete svc/adguard-home -``` +**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/) -#### Remove the existing adguard-home chart first +| 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 | `{}` | | -This is the 'easiest' approach, but will incur downtime which can be problematic if you rely on adguard-home for DNS +## 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). + +### [2.2.0] + +#### Added + +- N/A + +#### Changed + +- Use helm-docs + +#### Removed + +- N/A + +[2.2.0]: #2.2.0 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/adguard-home/README.md.gotmpl b/charts/adguard-home/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/adguard-home/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/adguard-home/README_CHANGELOG.md.gotmpl b/charts/adguard-home/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..8943f4e8 --- /dev/null +++ b/charts/adguard-home/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). + +### [2.2.1] + +#### Added + +- N/A + +#### Changed + +- Use helm-docs + +#### Removed + +- N/A + +[2.2.1]: #2.2.1 +{{- end -}} diff --git a/charts/adguard-home/README_CONFIG.md.gotmpl b/charts/adguard-home/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/adguard-home/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/airsonic/README.md b/charts/airsonic/README.md index 70b5659e..9bdddc41 100644 --- a/charts/airsonic/README.md +++ b/charts/airsonic/README.md @@ -125,8 +125,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community diff --git a/charts/airsonic/README.md.gotmpl b/charts/airsonic/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/airsonic/README.md.gotmpl +++ b/charts/airsonic/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/alertmanager-bot/README.md b/charts/alertmanager-bot/README.md index b66c819f..4125eb32 100644 --- a/charts/alertmanager-bot/README.md +++ b/charts/alertmanager-bot/README.md @@ -111,9 +111,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/alertmanager-bot/README.md.gotmpl b/charts/alertmanager-bot/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/alertmanager-bot/README.md.gotmpl +++ b/charts/alertmanager-bot/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/appdaemon/README.md b/charts/appdaemon/README.md index 2d35ab8c..bcefde79 100644 --- a/charts/appdaemon/README.md +++ b/charts/appdaemon/README.md @@ -109,9 +109,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/appdaemon/README.md.gotmpl b/charts/appdaemon/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/appdaemon/README.md.gotmpl +++ b/charts/appdaemon/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/bazarr/README.md b/charts/bazarr/README.md index 5bd73f80..de1bcf4a 100644 --- a/charts/bazarr/README.md +++ b/charts/bazarr/README.md @@ -113,9 +113,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/bazarr/README.md.gotmpl b/charts/bazarr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/bazarr/README.md.gotmpl +++ b/charts/bazarr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/bitwardenrs/Chart.yaml b/charts/bitwardenrs/Chart.yaml index ff5c82d1..6a65bf4a 100644 --- a/charts/bitwardenrs/Chart.yaml +++ b/charts/bitwardenrs/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: bitwardenrs description: Unofficial Bitwarden compatible server written in Rust type: application -version: 2.0.0 +version: 2.0.1 appVersion: 1.18.0 keywords: - bitwarden diff --git a/charts/bitwardenrs/README.md b/charts/bitwardenrs/README.md index 350ad331..b986aeb2 100644 --- a/charts/bitwardenrs/README.md +++ b/charts/bitwardenrs/README.md @@ -1,58 +1,185 @@ -# 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 + +**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)** + +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| ## TL;DR ```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/bitwardenrs +helm repo update +helm install bitwardenrs k8s-at-home/bitwardenrs ``` ## Installing the Chart -To install the chart with the release name `bitwarden`: +To install the chart with the release name `bitwardenrs` ```console -helm install bitwarden k8s-at-home/bitwardenrs +helm install bitwardenrs k8s-at-home/bitwardenrs ``` ## Uninstalling the Chart -To uninstall/delete the `bitwarden` deployment: +To uninstall the `bitwardenrs` deployment ```console -helm uninstall bitwarden +helm uninstall bitwardenrs ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/bitwardenrs/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install bitwarden \ - --set timeZone="America/New York" \ +helm install bitwardenrs \ + --set env.TZ="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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install bitwarden k8s-at-home/bitwardenrs --values values.yaml +helm install bitwardenrs k8s-at-home/bitwardenrs -f values.yaml ``` -## Upgrading an existing Release to a new major version +## Custom configuration -A major chart version change (like 1.1.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. +N/A -### Upgrading from 1.x.x to 2.x.x +## Values -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. +**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 | +|-----|------|---------|-------------| +| 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 | `[]` | | + +## 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). + +### [2.0.0] + +#### Added + +- 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. + +#### Changed + +- Use helm-docs + +#### Removed + +- N/A + +[2.0.0]: #2.0.0 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/bitwardenrs/README.md.gotmpl b/charts/bitwardenrs/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/bitwardenrs/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/bitwardenrs/README_CHANGELOG.md.gotmpl b/charts/bitwardenrs/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..cf13b948 --- /dev/null +++ b/charts/bitwardenrs/README_CHANGELOG.md.gotmpl @@ -0,0 +1,29 @@ +{{- 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). + +### [2.0.1] + +#### Added + +- 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. + +#### Changed + +- Use helm-docs + +#### Removed + +- N/A + +[2.0.1]: #2.0.1 +{{- end -}} diff --git a/charts/bitwardenrs/README_CONFIG.md.gotmpl b/charts/bitwardenrs/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/bitwardenrs/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/blocky/Chart.yaml b/charts/blocky/Chart.yaml index b5a32773..34df47fd 100644 --- a/charts/blocky/Chart.yaml +++ b/charts/blocky/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: v0.12 description: DNS proxy as ad-blocker for local network name: blocky -version: 5.0.0 +version: 5.0.1 keywords: - blocky - adblock diff --git a/charts/blocky/README.md b/charts/blocky/README.md index fb4ba177..53945e76 100644 --- a/charts/blocky/README.md +++ b/charts/blocky/README.md @@ -1,79 +1,149 @@ -# 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 + +**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)** + +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| ## TL;DR -```shell +```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/blocky +helm repo update +helm install blocky k8s-at-home/blocky ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `blocky` ```console -helm install --name blocky k8s-at-home/blocky +helm install blocky k8s-at-home/blocky ``` ## Uninstalling the Chart -To uninstall/delete the `blocky` deployment: +To uninstall the `blocky` deployment ```console -helm delete blocky --purge +helm uninstall blocky ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/blocky/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name blocky \ - --set timeZone="America/New York" \ +helm install blocky \ + --set env.TZ="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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name blocky -f values.yaml k8s-at-home/blocky +helm install blocky k8s-at-home/blocky -f values.yaml ``` ---- +## Custom configuration -## Upgrading an existing Release to a new major version +N/A -A major chart version change (like 2.2.2 -> 3.0.0) indicates that there is an -incompatible breaking change needing manual actions. +## Values -### Upgrading from 2.x.x to 3.x.x +**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/) -Due to the renaming of the service port, an upgrade-in-place will not work. The following are possible approaches to solve this: +| 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 | `[]` | | -#### Helm force upgrade +## Changelog -```sh -helm upgrade --force -``` +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). -#### Delete the existing `blocky` service prior to upgrading +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). -```sh -kubectl delete svc/blocky -``` +### [5.0.0] -#### Remove the existing blocky chart first +#### Added -This is the 'easiest' approach, but will incur downtime which can be problematic if you rely on blocky for DNS +- N/A -### Upgrading from 4.x.x to 5.x.x +#### Changed -Configuration inside `config` is no longer a yaml object, it is now a multiline string +- configuration inside `config` is no longer a yaml object, it is now a multiline string +- moved to helm-docs + +#### Removed + +- N/A + +[5.0.0]: #5.0.0 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/blocky/README.md.gotmpl b/charts/blocky/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/blocky/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/blocky/README_CHANGELOG.md.gotmpl b/charts/blocky/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..c4499c0e --- /dev/null +++ b/charts/blocky/README_CHANGELOG.md.gotmpl @@ -0,0 +1,28 @@ +{{- 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). + +### [5.0.1] + +#### Added + +- N/A + +#### Changed + +- configuration inside `config` is no longer a yaml object, it is now a multiline string +- moved to helm-docs + +#### Removed + +- N/A + +[5.0.1]: #5.0.1 +{{- end -}} diff --git a/charts/blocky/README_CONFIG.md.gotmpl b/charts/blocky/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/blocky/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/booksonic-air/README.md b/charts/booksonic-air/README.md index 1ae894ca..c57739e9 100644 --- a/charts/booksonic-air/README.md +++ b/charts/booksonic-air/README.md @@ -121,9 +121,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/booksonic-air/README.md.gotmpl b/charts/booksonic-air/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/booksonic-air/README.md.gotmpl +++ b/charts/booksonic-air/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/calibre-web/README.md b/charts/calibre-web/README.md index 97336769..023e57ec 100644 --- a/charts/calibre-web/README.md +++ b/charts/calibre-web/README.md @@ -112,9 +112,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/calibre-web/README.md.gotmpl b/charts/calibre-web/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/calibre-web/README.md.gotmpl +++ b/charts/calibre-web/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/comcast/Chart.yaml b/charts/comcast/Chart.yaml index ade88f27..2a12e05e 100644 --- a/charts/comcast/Chart.yaml +++ b/charts/comcast/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: comcast -version: 3.0.0 +version: 3.0.1 appVersion: 1.0.0 description: periodic comcast data usage checks and save the results to InfluxDB keywords: diff --git a/charts/comcast/README.md b/charts/comcast/README.md index fd282d55..a20373dd 100644 --- a/charts/comcast/README.md +++ b/charts/comcast/README.md @@ -1,79 +1,71 @@ -# 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; +**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)** + +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR ```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/comcast +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install comcast k8s-at-home/comcast ``` -## Introduction - -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) - ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `comcast` ```console -$ helm install --name my-release k8s-at-home/comcast +helm install comcast k8s-at-home/comcast ``` + ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `comcast` deployment ```console -$ helm delete my-release --purge +helm uninstall comcast ``` -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 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. +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). -## 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, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name my-release \ - --set config.comcast.username=tonystark,config.comcast.password=mypassword \ +helm install comcast \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name my-release -f values.yaml k8s-at-home/comcast +helm install comcast k8s-at-home/comcast -f values.yaml ``` -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. +## Custom configuration -## InfluxDB metrics +### InfluxDB metrics ``` 'measurement': 'comcast_data_usage', 'fields': { @@ -82,3 +74,57 @@ Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master 'unit' } ``` + +## 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.comcast.password | string | `"somepassword"` | Comcast website login password | +| config.comcast.username | string | `"someuser"` | Comcast website login username | +| config.delay | int | `3600` | how many seconds to wait between checks | +| config.influxdb.database | string | `"comcast"` | InfluxDB database | +| config.influxdb.host | string | `"influxdb-influxdb"` | InfluxDB hostname | +| config.influxdb.port | int | `8086` | InfluxDB port | +| config.influxdb.ssl | bool | `false` | InfluxDB connection using SSL | +| debug | bool | `false` | Display debugging output | +| image.pullPolicy | string | `"IfNotPresent"` | Comcast image pull policy | +| image.repository | string | `"billimek/comcastusage-for-influxdb"` | Comcast image | +| image.tag | string | `"latest"` | Comcast image tag | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | Key-value pairs to add as pod annotations | +| replicaCount | int | `1` | | +| resources | object | `{}` | | + +## 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). + +### [3.0.0] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[3.0.0]: #3.0.0 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/comcast/README.md.gotmpl b/charts/comcast/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/comcast/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/comcast/README_CHANGELOG.md.gotmpl b/charts/comcast/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..fd469ccd --- /dev/null +++ b/charts/comcast/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). + +### [3.0.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[3.0.1]: #3.0.1 +{{- end -}} diff --git a/charts/comcast/README_CONFIG.md.gotmpl b/charts/comcast/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..9d105f3a --- /dev/null +++ b/charts/comcast/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" . }} + +### InfluxDB metrics +``` +'measurement': 'comcast_data_usage', +'fields': { + 'used', + 'total', + 'unit' +} +``` +{{- end -}} diff --git a/charts/comcast/values.yaml b/charts/comcast/values.yaml index 75e92248..6427d0fc 100644 --- a/charts/comcast/values.yaml +++ b/charts/comcast/values.yaml @@ -3,8 +3,11 @@ # Declare variables to be passed into your templates. replicaCount: 1 image: + # -- Comcast image repository: billimek/comcastusage-for-influxdb + # -- Comcast image tag tag: latest + # -- Comcast image pull policy pullPolicy: IfNotPresent resources: {} # We usually recommend not to specify default resources and to leave this as a conscious @@ -18,21 +21,28 @@ resources: {} # cpu: 100m # memory: 128Mi nodeSelector: {} +# -- Display debugging output debug: false config: - # how many seconds to wait between checks + # -- how many seconds to wait between checks delay: 3600 influxdb: - # host/port/database are mandatory - change as needed + # -- InfluxDB hostname host: influxdb-influxdb + # -- InfluxDB port port: 8086 + # -- InfluxDB database database: comcast # username: # password: + + # -- InfluxDB connection using SSL ssl: false comcast: - # username/password are mandatory and must be populated + # -- Comcast website login username username: someuser + # -- Comcast website login password password: somepassword +# -- Key-value pairs to add as pod annotations podAnnotations: {} diff --git a/charts/common-test/Chart.yaml b/charts/common-test/Chart.yaml index 9950d0c6..2b142104 100644 --- a/charts/common-test/Chart.yaml +++ b/charts/common-test/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: common-test description: Helper chart to test different use cases of the common library -version: 1.0.4 +version: 1.0.5 kubeVersion: ">=1.16.0-0" keywords: - k8s-at-home diff --git a/charts/common-test/README.md b/charts/common-test/README.md index be1f0726..bd0c056e 100644 --- a/charts/common-test/README.md +++ b/charts/common-test/README.md @@ -1,27 +1,74 @@ # common-test -![Version: 1.0.4](https://img.shields.io/badge/Version-1.0.4-informational?style=flat-square) +![Version: 1.0.5](https://img.shields.io/badge/Version-1.0.5-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 | | +**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 | |------------|------|---------| | file://../common | common | n/a | +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install common-test k8s-at-home/common-test +``` + +## Installing the Chart + +To install the chart with the release name `common-test` + +```console +helm install common-test k8s-at-home/common-test +``` + +## Uninstalling the Chart + +To uninstall the `common-test` deployment + +```console +helm uninstall common-test +``` + +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-test \ + --set env.TZ="America/New York" \ + k8s-at-home/common-test +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install common-test k8s-at-home/common-test -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 | |-----|------|---------|-------------| | image.pullPolicy | string | `"IfNotPresent"` | | @@ -30,5 +77,34 @@ Kubernetes: `>=1.16.0-0` | ingress.enabled | bool | `true` | | | service.port.port | int | `8080` | | +## 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.5] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[1.0.5]: #1.0.5 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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) +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-test/README.md.gotmpl b/charts/common-test/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/common-test/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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-test/README_CHANGELOG.md.gotmpl b/charts/common-test/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..2738dc96 --- /dev/null +++ b/charts/common-test/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.5] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[1.0.5]: #1.0.5 +{{- end -}} diff --git a/charts/common-test/README_CONFIG.md.gotmpl b/charts/common-test/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/common-test/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/common/README.md b/charts/common/README.md index ee63869a..a4b760f4 100644 --- a/charts/common/README.md +++ b/charts/common/README.md @@ -424,9 +424,9 @@ This is the last version before starting this changelog. All sorts of cool stuff ## 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/). +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/common/README.md.gotmpl b/charts/common/README.md.gotmpl index 47563133..1454546b 100644 --- a/charts/common/README.md.gotmpl +++ b/charts/common/README.md.gotmpl @@ -104,9 +104,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/). +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/ddclient/README.md b/charts/ddclient/README.md index be834033..ba331d4b 100644 --- a/charts/ddclient/README.md +++ b/charts/ddclient/README.md @@ -112,9 +112,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/ddclient/README.md.gotmpl b/charts/ddclient/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/ddclient/README.md.gotmpl +++ b/charts/ddclient/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/deconz/Chart.yaml b/charts/deconz/Chart.yaml index 615e306a..54da8719 100644 --- a/charts/deconz/Chart.yaml +++ b/charts/deconz/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: deconz description: A Helm chart for deploying deCONZ -version: 2.0.1 +version: 2.0.2 appVersion: 2.05.80 keywords: - deconz diff --git a/charts/deconz/README.md b/charts/deconz/README.md index d621067a..3b232008 100644 --- a/charts/deconz/README.md +++ b/charts/deconz/README.md @@ -1,102 +1,166 @@ -# 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) + +A Helm chart for deploying deCONZ + +**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)** + +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| ## TL;DR -```shell +```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/deconz +helm repo update +helm install deconz k8s-at-home/deconz ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `deconz` -```shell -helm install my-release k8s-at-home/deconz +```console +helm install deconz k8s-at-home/deconz ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `deconz` deployment -```shell -helm delete my-release --purge +```console +helm uninstall deconz ``` -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 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. +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 | -| ------------------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| `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, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install my-release \ - --set timezone="Europe/Amsterdam" \ +helm install deconz \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install my-release -f values.yaml k8s-at-home/deconz +helm install deconz k8s-at-home/deconz -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 | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | Enables Pod auto-scaling | +| autoscaling.maxReplicas | int | `1` | Maximum number of replicas to auto-scale to | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas to auto-scale to | +| extraVolumes | list | `[]` | Optionally add additional Volumes Volumes will be mounted to the folder specified under mountPath If no mountPath is set it will be mounted to /mnt/ | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy | +| image.repository | string | `"marthoc/deconz"` | Image repository | +| image.tag | string | `"amd64-2.05.80"` | Image tag. Possible values listed [here](https://hub.docker.com/r/marthoc/deconz/tags/). | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | Ingress annotations | +| ingress.enabled | bool | `false` | Enables Ingress | +| ingress.hosts | list | `[{"host":"deconz.local"}]` | Ingress accepted hostnames | +| ingress.labels | object | `{}` | | +| ingress.path | string | `"/"` | Ingress path | +| ingress.tls | list | `[]` | Ingress TLS configuration | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| persistence.accessMode | string | `"ReadWriteOnce"` | Use an existing PVC to persist data existingClaim: deconz-data -- Persistence access mode | +| persistence.annotations | object | `{}` | Key-value pairs to add as persistent volume claim annotations | +| persistence.enabled | bool | `false` | Use persistent volume to store configuration data | +| persistence.size | string | `"1Gi"` | Size of persistent volume claim | +| podAnnotations | object | `{}` | Key-value pairs to add as pod annotations | +| podSecurityContext | object | `{}` | | +| probes.liveness.enabled | bool | `true` | Enables liveness probe for the Pod | +| probes.liveness.failureThreshold | int | `5` | Specify liveness `failureThreshold` parameter for the Pod | +| probes.liveness.initialDelaySeconds | int | `30` | Specify liveness `initialDelaySeconds` parameter for the Pod | +| probes.liveness.timeoutSeconds | int | `10` | Specify liveness `timeoutSeconds` parameter for the Pod | +| probes.readiness.enabled | bool | `true` | Enables readiness probe for the Pod | +| probes.readiness.failureThreshold | int | `5` | Specify readiness `failureThreshold` parameter for the Pod | +| probes.readiness.initialDelaySeconds | int | `30` | Specify readiness `initialDelaySeconds` parameter for the Pod | +| probes.startup.enabled | bool | `false` | Enables startup probe for the Pod | +| probes.startup.failureThreshold | int | `30` | Specify startup `failureThreshold` parameter for the Pod | +| probes.startup.periodSeconds | int | `10` | Specify startup `periodSeconds` parameter for the Pod | +| replicaCount | int | `1` | Number of replicas to scale to | +| resources | object | `{}` | CPU/Memory resource requests/limits | +| securityContext.privileged | bool | `true` | | +| service.annotations | object | `{}` | Service annotations for the GUI | +| service.clusterIP | string | `""` | | +| service.externalIPs | list | `[]` | | +| service.externalTrafficPolicy | string | `"Local"` | Set the externalTrafficPolicy in the Service to either Cluster or Local | +| service.httpPort | int | `80` | Kubernetes port where the GUI is exposed | +| service.labels | object | `{}` | Custom labels | +| service.loadBalancerIP | string | `""` | Loadbalancer IP for the GUI | +| service.loadBalancerSourceRanges | string | `nil` | List of IP CIDRs allowed access to load balancer (if supported) | +| service.type | string | `"ClusterIP"` | Kubernetes service type for the GUI | +| service.vncPort | int | `5900` | Kubernetes port where the VNC server is exposed | +| service.websocketPort | int | `443` | Kubernetes port where the websocket is exposed | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. @default: a name is generated using the fullname template | +| strategyType | string | `"Recreate"` | Specifies the strategy used to replace old Pods by new ones | +| timezone | string | `"UTC"` | Timezone the instance should run as, e.g. 'America/New_York' | +| tolerations | list | `[]` | Toleration labels for pod assignment | +| vnc.enabled | bool | `true` | Enabled the built-in VNC server to access the application | +| vnc.existingSecret | string | `""` | Existing Kubernetes secret containing the VNC password | +| vnc.password | string | `"changeme"` | VNC server password | +| zigbeeDevice.enabled | bool | `false` | Enables passing through a Zigbee device | +| zigbeeDevice.hostPath | string | `"/dev/ttyUSB1"` | HostPath of the Zigbee device that should be passed through | + +## 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/deconz/README.md.gotmpl b/charts/deconz/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/deconz/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/deconz/README_CHANGELOG.md.gotmpl b/charts/deconz/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..3e6a8a04 --- /dev/null +++ b/charts/deconz/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). + +### [2.0.2] + +#### Added + +- N/A + +#### Changed + +- move to helm-docs + +#### Removed + +- N/A + +[2.0.2]: #2.0.2 +{{- end -}} diff --git a/charts/deconz/README_CONFIG.md.gotmpl b/charts/deconz/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/deconz/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/values.yaml b/charts/deconz/values.yaml index 3a050b5f..274c5d2a 100644 --- a/charts/deconz/values.yaml +++ b/charts/deconz/values.yaml @@ -2,51 +2,62 @@ # This is a YAML-formatted file. # Declare variables to be passed into your templates. +# -- Number of replicas to scale to replicaCount: 1 autoscaling: + # -- Enables Pod auto-scaling enabled: false + # -- Minimum number of replicas to auto-scale to minReplicas: 1 + # -- Maximum number of replicas to auto-scale to maxReplicas: 1 image: + # -- Image repository repository: marthoc/deconz + # -- Image pull policy pullPolicy: IfNotPresent - # Overrides the image tag whose default is the chart appVersion. + # -- Image tag. Possible values listed [here](https://hub.docker.com/r/marthoc/deconz/tags/). tag: "amd64-2.05.80" imagePullSecrets: [] -# upgrade strategy type (e.g. Recreate or RollingUpdate) +# -- Specifies the strategy used to replace old Pods by new ones strategyType: Recreate nameOverride: "" fullnameOverride: "" +# -- Timezone the instance should run as, e.g. 'America/New_York' timezone: "UTC" # Specify the Zigbee device that should be passed through to the deCONZ container zigbeeDevice: + # -- Enables passing through a Zigbee device enabled: false + # -- HostPath of the Zigbee device that should be passed through hostPath: /dev/ttyUSB1 vnc: + # -- Enabled the built-in VNC server to access the application enabled: true - ## deCONZ VNC password + # -- VNC server password password: changeme - ## Specify VNC password using existing secret containing a key named 'vnc-password' + # -- Existing Kubernetes secret containing the VNC password existingSecret: "" serviceAccount: - # Specifies whether a service account should be created + # -- Specifies whether a service account should be created create: true - # Annotations to add to the service account + # -- Annotations to add to the service account annotations: {} - # The name of the service account to use. - # If not set and create is true, a name is generated using the fullname template + # -- The name of the service account to use. + # @default: a name is generated using the fullname template name: "" +# -- Key-value pairs to add as pod annotations podAnnotations: {} podSecurityContext: {} @@ -62,7 +73,9 @@ securityContext: # runAsUser: 1000 persistence: + # -- Use persistent volume to store configuration data enabled: false + # -- Key-value pairs to add as persistent volume claim annotations annotations: {} ## deconz data Persistent Volume Storage Class ## If defined, storageClassName: @@ -71,18 +84,20 @@ persistence: ## set, choosing the default provisioner. (gp2 on AWS, standard on ## GKE, AWS & OpenStack) ## + # -- Type of persistent volume claim # storageClass: "-" - ## If you want to reuse an existing claim, you can pass the name of the PVC using - ## the existingClaim variable - ## + # -- Use an existing PVC to persist data # existingClaim: deconz-data + + # -- Persistence access mode accessMode: ReadWriteOnce + # -- Size of persistent volume claim size: 1Gi - ## When mounting the data volume you may specify a subPath + # -- Mount a sub dir of the persistent volume # subPath: /configs/deconz -# Any extra volumes to define for the pod +# -- Optionally add additional Volumes # Volumes will be mounted to the folder specified under mountPath # If no mountPath is set it will be mounted to /mnt/ extraVolumes: [] @@ -93,38 +108,55 @@ extraVolumes: [] # mountPath: "/mnt/test" service: + # -- Kubernetes service type for the GUI type: ClusterIP clusterIP: "" + # -- Kubernetes port where the GUI is exposed httpPort: 80 + # -- Kubernetes port where the websocket is exposed websocketPort: 443 + # -- Kubernetes port where the VNC server is exposed vncPort: 5900 + # -- Service annotations for the GUI + annotations: {} + # -- Custom labels + labels: {} ## Specify the nodePort value for the LoadBalancer and NodePort service types. ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport # nodePort: - ## List of IP addresses at which the hass-configurator service is available + # -- List of IP addresses at which the hass-configurator service is available ## Ref: https://kubernetes.io/docs/user-guide/services/#external-ips externalIPs: [] - ## Use loadBalancerIP to request a specific static IP, otherwise leave blank + # -- Loadbalancer IP for the GUI loadBalancerIP: "" - # loadBalancerSourceRanges: [] - ## Set the externalTrafficPolicy in the Service to either Cluster or Local + # -- List of IP CIDRs allowed access to load balancer (if supported) + loadBalancerSourceRanges: + # -- Set the externalTrafficPolicy in the Service to either Cluster or Local externalTrafficPolicy: Local ingress: + # -- Enables Ingress enabled: false + # -- Ingress annotations annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" + # -- Custom labels + labels: {} + # -- Ingress path path: / + # -- Ingress accepted hostnames hosts: - host: deconz.local + # -- Ingress TLS configuration tls: [] # - secretName: deconz-tls # hosts: # - deconz.local +# -- CPU/Memory resource requests/limits resources: {} # We usually recommend not to specify default resources and to leave this as a conscious # choice for the user. This also increases chances charts run on environments with little @@ -139,22 +171,35 @@ resources: {} probes: liveness: + # -- Enables liveness probe for the Pod enabled: true + # -- Specify liveness `initialDelaySeconds` parameter for the Pod initialDelaySeconds: 30 + # -- Specify liveness `failureThreshold` parameter for the Pod failureThreshold: 5 + # -- Specify liveness `timeoutSeconds` parameter for the Pod timeoutSeconds: 10 readiness: + # -- Enables readiness probe for the Pod enabled: true + # -- Specify readiness `initialDelaySeconds` parameter for the Pod initialDelaySeconds: 30 + # -- Specify readiness `failureThreshold` parameter for the Pod failureThreshold: 5 - timeoutSeconds: 10 + # -- Specify readiness `timeoutSeconds` parameter for the Pod startup: + # -- Enables startup probe for the Pod enabled: false + # -- Specify startup `failureThreshold` parameter for the Pod failureThreshold: 30 + # -- Specify startup `periodSeconds` parameter for the Pod periodSeconds: 10 +# -- Node labels for pod assignment nodeSelector: {} +# -- Toleration labels for pod assignment tolerations: [] +# -- Affinity settings for pod assignment affinity: {} diff --git a/charts/deluge/README.md b/charts/deluge/README.md index c272d7d0..1582e06e 100644 --- a/charts/deluge/README.md +++ b/charts/deluge/README.md @@ -116,9 +116,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/deluge/README.md.gotmpl b/charts/deluge/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/deluge/README.md.gotmpl +++ b/charts/deluge/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/digitalocean-dyndns/Chart.yaml b/charts/digitalocean-dyndns/Chart.yaml index f31b57b9..e3499d72 100644 --- a/charts/digitalocean-dyndns/Chart.yaml +++ b/charts/digitalocean-dyndns/Chart.yaml @@ -1,8 +1,8 @@ apiVersion: v2 -appVersion: 1.0 +appVersion: "1.0" description: Dynamic DNS using DigitalOcean's DNS Services name: digitalocean-dyndns -version: 2.0.1 +version: 2.0.2 keywords: - digitalocean - dynamicdns diff --git a/charts/digitalocean-dyndns/README.md b/charts/digitalocean-dyndns/README.md index 79d2618a..4f1715aa 100644 --- a/charts/digitalocean-dyndns/README.md +++ b/charts/digitalocean-dyndns/README.md @@ -1,62 +1,119 @@ -# 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 + +**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)** + +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR ```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/digitalocean-dyndns +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install digitalocean-dyndns k8s-at-home/digitalocean-dyndns ``` -## Introduction - -This code is adopted from [this original repo](https://github.com/tunix/digitalocean-dyndns) - ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `digitalocean-dyndns` ```console -$ helm install --name my-release k8s-at-home/digitalocean-dyndns +helm install digitalocean-dyndns k8s-at-home/digitalocean-dyndns ``` + ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `digitalocean-dyndns` deployment ```console -$ helm delete my-release --purge +helm uninstall digitalocean-dyndns ``` -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 tables lists the configurable parameters of the Sentry chart and their default values. +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 | -| ------------------------------- | ------------------------------- | ---------------------------------------------------------- | -| `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, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name my-release \ - --set config.digitalocean.token=thisismyapikey \ +helm install digitalocean-dyndns \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name my-release -f values.yaml k8s-at-home/digitalocean-dyndns +helm install digitalocean-dyndns k8s-at-home/digitalocean-dyndns -f values.yaml ``` -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. +## 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 | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| digitialocean.domain | string | `"somedomain"` | The domain your subdomain is registered at. (i.e. foo.com for home.foo.com) | +| digitialocean.name | string | `"@"` | Subdomain to use. (name in A record) (i.e. home for home.foo.com or @ for no subdomain) | +| digitialocean.sleep_interval | int | `300` | Polling time in seconds | +| digitialocean.token | string | `"sometoken"` | The token you generate in DigitalOcean's API settings. | +| image.pullPolicy | string | `"Always"` | digitalocean-dyndns image pull policy | +| image.repository | string | `"tunix/digitalocean-dyndns"` | digitalocean-dyndns image | +| image.tag | string | `"latest"` | | +| nodeSelector | object | `{}` | | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | | +| tolerations | 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](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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/digitalocean-dyndns/README.md.gotmpl b/charts/digitalocean-dyndns/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/digitalocean-dyndns/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/digitalocean-dyndns/README_CHANGELOG.md.gotmpl b/charts/digitalocean-dyndns/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..8c39c6b7 --- /dev/null +++ b/charts/digitalocean-dyndns/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). + +### [2.0.2] + +#### Added + +- N/A + +#### Changed + +- Use helm-docs + +#### Removed + +- N/A + +[2.0.2]: #2.0.2 +{{- end -}} diff --git a/charts/digitalocean-dyndns/README_CONFIG.md.gotmpl b/charts/digitalocean-dyndns/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/digitalocean-dyndns/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/digitalocean-dyndns/values.yaml b/charts/digitalocean-dyndns/values.yaml index 7b593685..7219320b 100644 --- a/charts/digitalocean-dyndns/values.yaml +++ b/charts/digitalocean-dyndns/values.yaml @@ -2,17 +2,25 @@ # This is a YAML-formatted file. # Declare variables to be passed into your templates. +# -- Number of replicas replicaCount: 1 image: + # -- digitalocean-dyndns image repository: tunix/digitalocean-dyndns + # - digitalocean-dyndns image tag tag: latest + # -- digitalocean-dyndns image pull policy pullPolicy: Always digitialocean: - token: sometoken # REQUIRED: The token you generate in DigitalOcean's API settings. - domain: somedomain # REQUIRED: The domain your subdomain is registered at. (i.e. foo.com for home.foo.com) - name: "@" # REQUIRED: Subdomain to use. (name in A record) (i.e. home for home.foo.com or @ for no subdomain) + # -- The token you generate in DigitalOcean's API settings. + token: sometoken + # -- The domain your subdomain is registered at. (i.e. foo.com for home.foo.com) + domain: somedomain + # -- Subdomain to use. (name in A record) (i.e. home for home.foo.com or @ for no subdomain) + name: "@" + # -- Polling time in seconds sleep_interval: 300 # Polling time in seconds resources: {} diff --git a/charts/dizquetv/README.md b/charts/dizquetv/README.md index 5090da86..2595e972 100644 --- a/charts/dizquetv/README.md +++ b/charts/dizquetv/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/dizquetv/README.md.gotmpl b/charts/dizquetv/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/dizquetv/README.md.gotmpl +++ b/charts/dizquetv/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/dsmr-reader/README.md b/charts/dsmr-reader/README.md index dacf9c9c..3767ef8c 100644 --- a/charts/dsmr-reader/README.md +++ b/charts/dsmr-reader/README.md @@ -118,9 +118,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/dsmr-reader/README.md.gotmpl b/charts/dsmr-reader/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/dsmr-reader/README.md.gotmpl +++ b/charts/dsmr-reader/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/duplicati/Chart.yaml b/charts/duplicati/Chart.yaml index 38727f4d..dd062126 100644 --- a/charts/duplicati/Chart.yaml +++ b/charts/duplicati/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: v2.0.5.1 description: Store securely encrypted backups on cloud storage services! name: duplicati -version: 2.1.0 +version: 2.1.1 keywords: - duplicati home: https://github.com/k8s-at-home/charts/tree/master/charts/duplicati diff --git a/charts/duplicati/README.md b/charts/duplicati/README.md index f5b409db..b44003e8 100644 --- a/charts/duplicati/README.md +++ b/charts/duplicati/README.md @@ -1,104 +1,70 @@ -# 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.1.1](https://img.shields.io/badge/Version-2.1.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 +**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)** + +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install duplicati k8s-at-home/duplicati ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `duplicati` ```console -helm install my-release k8s-at-home/duplicati +helm install duplicati k8s-at-home/duplicati ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `duplicati` deployment ```console -helm delete my-release +helm uninstall duplicati ``` -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 tables lists the configurable parameters of the Sentry chart and their default values. +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 | -|----------------------------|-------------------------------------|---------------------------------------------------------| -| `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, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install my-release \ - --set timezone="America/New York" \ +helm install duplicati \ + --set env.TZ="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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install my-release -f values.yaml k8s-at-home/duplicati +helm install duplicati k8s-at-home/duplicati -f values.yaml ``` +## Custom configuration + --- **NOTE** @@ -106,4 +72,87 @@ If you get `Error: rendered manifests contain a resource that already exists. Un --- -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. +## 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 | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| cliArgs | string | `""` | Optionally specify any CLI variables you want to launch the app with | +| deploymentAnnotations | object | `{}` | Key-value pairs to add as deployment annotations | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy | +| image.repository | string | `"linuxserver/duplicati"` | Image repository | +| image.tag | string | `"v2.0.5.1-2.0.5.1_beta_2020-01-18-ls72"` | Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/duplicati/tags/). | +| ingress.annotations | object | `{}` | Ingress annotations | +| ingress.enabled | bool | `false` | Enables Ingress | +| ingress.hosts | list | `["chart-example.local"]` | Ingress accepted hostnames | +| ingress.labels | object | `{}` | Custom labels | +| ingress.path | string | `"/"` | Ingress path | +| ingress.tls | list | `[]` | Ingress TLS configuration | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| persistence.backups.accessMode | string | `"ReadWriteOnce"` | Use an existing PVC to persist data existingClaim: your-claim -- Persistence access mode | +| persistence.backups.enabled | bool | `true` | Use persistent volume to store backups data | +| persistence.backups.size | string | `"1Gi"` | Size of persistent volume claim | +| persistence.backups.skipuninstall | bool | `false` | Do not delete the pvc upon helm uninstall | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | Use an existing PVC to persist data existingClaim: your-claim -- Persistence access mode | +| persistence.config.enabled | bool | `true` | Use persistent volume to store configuration data | +| persistence.config.size | string | `"1Gi"` | Size of persistent volume claim | +| persistence.config.skipuninstall | bool | `false` | Do not delete the pvc upon helm uninstall | +| persistence.extraExistingClaimMounts | list | `[]` | Optionally add multiple existing claims | +| persistence.source.accessMode | string | `"ReadWriteOnce"` | Use an existing PVC to persist data existingClaim: your-claim -- Persistence access mode | +| persistence.source.enabled | bool | `true` | Use persistent volume to store source data | +| persistence.source.size | string | `"1Gi"` | Size of persistent volume claim | +| persistence.source.skipuninstall | bool | `false` | Do not delete the pvc upon helm uninstall | +| pgid | int | `1001` | Process groupID the duplicati instance should run as | +| podAnnotations | object | `{}` | Key-value pairs to add as pod annotations | +| probes.liveness.failureThreshold | int | `5` | Specify liveness `failureThreshold` parameter for the deployment | +| probes.liveness.initialDelaySeconds | int | `60` | Specify liveness `initialDelaySeconds` parameter for the deployment | +| probes.liveness.timeoutSeconds | int | `10` | Specify liveness `timeoutSeconds` parameter for the deployment | +| probes.readiness.failureThreshold | int | `5` | Specify readiness `failureThreshold` parameter for the deployment | +| probes.readiness.initialDelaySeconds | int | `60` | Specify readiness `initialDelaySeconds` parameter for the deployment | +| probes.readiness.timeoutSeconds | int | `10` | Specify readiness `timeoutSeconds` parameter for the deployment | +| puid | int | `1001` | Process userID the duplicati instance should run as | +| resources | object | `{}` | CPU/Memory resource requests/limits | +| service.annotations | object | `{}` | Service annotations for the duplicati GUI | +| service.labels | object | `{}` | Custom labels | +| service.loadBalancerIP | string | `nil` | Loadbalance IP for the duplicati GUI | +| service.port | int | `8200` | Kubernetes port where the duplicati GUI is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type for the duplicati GUI | +| strategyType | string | `"Recreate"` | Specifies the strategy used to replace old Pods by new ones | +| timezone | string | `"UTC"` | Timezone the duplicati instance should run as, e.g. 'America/New_York' | +| tolerations | list | `[]` | Toleration labels for pod assignment | + +## 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). + +### [2.1.1] + +#### Added + +- N/A + +#### Changed + +- Use helm-docs + +#### Removed + +- N/A + +[2.1.1]: #2.1.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/duplicati/README.md.gotmpl b/charts/duplicati/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/duplicati/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/duplicati/README_CHANGELOG.md.gotmpl b/charts/duplicati/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..681bab6d --- /dev/null +++ b/charts/duplicati/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). + +### [2.1.1] + +#### Added + +- N/A + +#### Changed + +- Use helm-docs + +#### Removed + +- N/A + +[2.1.1]: #2.1.1 +{{- end -}} diff --git a/charts/duplicati/README_CONFIG.md.gotmpl b/charts/duplicati/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..30b66367 --- /dev/null +++ b/charts/duplicati/README_CONFIG.md.gotmpl @@ -0,0 +1,14 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +--- +**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`. + +--- +{{- end -}} diff --git a/charts/duplicati/values.yaml b/charts/duplicati/values.yaml index 43814828..0c7d63d0 100644 --- a/charts/duplicati/values.yaml +++ b/charts/duplicati/values.yaml @@ -3,62 +3,80 @@ # Declare variables to be passed into your templates. image: + # -- Image repository repository: linuxserver/duplicati + # -- Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/duplicati/tags/). tag: v2.0.5.1-2.0.5.1_beta_2020-01-18-ls72 + # -- Image pull policy pullPolicy: IfNotPresent -# upgrade strategy type (e.g. Recreate or RollingUpdate) +# -- Specifies the strategy used to replace old Pods by new ones strategyType: Recreate # Probes configuration probes: liveness: + # -- Specify liveness `initialDelaySeconds` parameter for the deployment initialDelaySeconds: 60 + # -- Specify liveness `failureThreshold` parameter for the deployment failureThreshold: 5 + # -- Specify liveness `timeoutSeconds` parameter for the deployment timeoutSeconds: 10 readiness: + # -- Specify readiness `initialDelaySeconds` parameter for the deployment initialDelaySeconds: 60 + # -- Specify readiness `failureThreshold` parameter for the deployment failureThreshold: 5 + # -- Specify readiness `timeoutSeconds` parameter for the deployment timeoutSeconds: 10 nameOverride: "" fullnameOverride: "" +# -- Timezone the duplicati instance should run as, e.g. 'America/New_York' timezone: UTC +# -- Process userID the duplicati instance should run as puid: 1001 +# -- Process groupID the duplicati instance should run as pgid: 1001 +# -- Optionally specify any CLI variables you want to launch the app with cliArgs: "" service: + # -- Kubernetes service type for the duplicati GUI type: ClusterIP + # -- Kubernetes port where the duplicati GUI is exposed port: 8200 ## Specify the nodePort value for the LoadBalancer and NodePort service types. ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport ## # nodePort: - ## Provide any additional annotations which may be required. This can be used to - ## set the LoadBalancer service type to internal only. - ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer - ## + + # -- Service annotations for the duplicati GUI annotations: {} + # -- Custom labels labels: {} - ## Use loadBalancerIP to request a specific static IP, - ## otherwise leave blank - ## + # -- Loadbalance IP for the duplicati GUI loadBalancerIP: + # -- List of IP CIDRs allowed access to load balancer (if supported) # loadBalancerSourceRanges: [] + ## Set the externalTrafficPolicy in the Service to either Cluster or Local # externalTrafficPolicy: Cluster ingress: + # -- Enables Ingress enabled: false + # -- Ingress annotations annotations: {} - # kubernetes.io/ingress.class: nginx - # kubernetes.io/tls-acme: "true" + # -- Custom labels labels: {} + # -- Ingress path path: / + # -- Ingress accepted hostnames hosts: - chart-example.local + # -- Ingress TLS configuration tls: [] # - secretName: chart-example-tls # hosts: @@ -66,59 +84,51 @@ ingress: persistence: config: + # -- Use persistent volume to store configuration data enabled: true - ## duplicati configuration data Persistent Volume Storage Class - ## If defined, storageClassName: - ## If set to "-", storageClassName: "", which disables dynamic provisioning - ## If undefined (the default) or set to null, no storageClassName spec is - ## set, choosing the default provisioner. (gp2 on AWS, standard on - ## GKE, AWS & OpenStack) - ## + # -- Type of persistent volume claim # storageClass: "-" - ## - ## If you want to reuse an existing claim, you can pass the name of the PVC using - ## the existingClaim variable + + # -- Use an existing PVC to persist data # existingClaim: your-claim + + # -- Persistence access mode accessMode: ReadWriteOnce + # -- Size of persistent volume claim size: 1Gi - ## Do not delete the pvc upon helm uninstall + # -- Do not delete the pvc upon helm uninstall skipuninstall: false source: + # -- Use persistent volume to store source data enabled: true - ## duplicati source data Persistent Volume Storage Class - ## If defined, storageClassName: - ## If set to "-", storageClassName: "", which disables dynamic provisioning - ## If undefined (the default) or set to null, no storageClassName spec is - ## set, choosing the default provisioner. (gp2 on AWS, standard on - ## GKE, AWS & OpenStack) - ## + # -- Type of persistent volume claim # storageClass: "-" - ## - ## If you want to reuse an existing claim, you can pass the name of the PVC using - ## the existingClaim variable + + # -- Use an existing PVC to persist data # existingClaim: your-claim + + # -- Persistence access mode accessMode: ReadWriteOnce + # -- Size of persistent volume claim size: 1Gi - ## Do not delete the pvc upon helm uninstall + # -- Do not delete the pvc upon helm uninstall skipuninstall: false backups: + # -- Use persistent volume to store backups data enabled: true - ## duplicati backups data Persistent Volume Storage Class - ## If defined, storageClassName: - ## If set to "-", storageClassName: "", which disables dynamic provisioning - ## If undefined (the default) or set to null, no storageClassName spec is - ## set, choosing the default provisioner. (gp2 on AWS, standard on - ## GKE, AWS & OpenStack) - ## + # -- Type of persistent volume claim # storageClass: "-" - ## - ## If you want to reuse an existing claim, you can pass the name of the PVC using - ## the existingClaim variable + + # -- Use an existing PVC to persist data # existingClaim: your-claim + + # -- Persistence access mode accessMode: ReadWriteOnce + # -- Size of persistent volume claim size: 1Gi - ## Do not delete the pvc upon helm uninstall + # -- Do not delete the pvc upon helm uninstall skipuninstall: false + # -- Optionally add multiple existing claims extraExistingClaimMounts: [] # - name: external-mount # mountPath: /srv/external-mount @@ -127,6 +137,7 @@ persistence: # existingClaim: # readOnly: true +# -- CPU/Memory resource requests/limits resources: {} # We usually recommend not to specify default resources and to leave this as a conscious # choice for the user. This also increases chances charts run on environments with little @@ -139,12 +150,17 @@ resources: {} # cpu: 100m # memory: 128Mi +# -- Node labels for pod assignment nodeSelector: {} +# -- Toleration labels for pod assignment tolerations: [] +# -- Affinity settings for pod assignment affinity: {} +# -- Key-value pairs to add as pod annotations podAnnotations: {} +# -- Key-value pairs to add as deployment annotations deploymentAnnotations: {} diff --git a/charts/esphome/README.md b/charts/esphome/README.md index 7aff2078..1994a967 100644 --- a/charts/esphome/README.md +++ b/charts/esphome/README.md @@ -109,9 +109,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/esphome/README.md.gotmpl b/charts/esphome/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/esphome/README.md.gotmpl +++ b/charts/esphome/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/flaresolverr/README.md b/charts/flaresolverr/README.md index 7c10cf2c..df4aa6f5 100644 --- a/charts/flaresolverr/README.md +++ b/charts/flaresolverr/README.md @@ -108,9 +108,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/flaresolverr/README.md.gotmpl b/charts/flaresolverr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/flaresolverr/README.md.gotmpl +++ b/charts/flaresolverr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/flood/README.md b/charts/flood/README.md index 49392a19..70bd28ba 100644 --- a/charts/flood/README.md +++ b/charts/flood/README.md @@ -111,9 +111,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/flood/README.md.gotmpl b/charts/flood/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/flood/README.md.gotmpl +++ b/charts/flood/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/freshrss/README.md b/charts/freshrss/README.md index 261341b3..c981a7ed 100644 --- a/charts/freshrss/README.md +++ b/charts/freshrss/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/freshrss/README.md.gotmpl b/charts/freshrss/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/freshrss/README.md.gotmpl +++ b/charts/freshrss/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/gaps/README.md b/charts/gaps/README.md index bde9fb58..c09a4b82 100644 --- a/charts/gaps/README.md +++ b/charts/gaps/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/gaps/README.md.gotmpl b/charts/gaps/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/gaps/README.md.gotmpl +++ b/charts/gaps/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/gonic/README.md b/charts/gonic/README.md index 2874dd5e..7ef37bf9 100644 --- a/charts/gonic/README.md +++ b/charts/gonic/README.md @@ -117,9 +117,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/gonic/README.md.gotmpl b/charts/gonic/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/gonic/README.md.gotmpl +++ b/charts/gonic/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/grocy/README.md b/charts/grocy/README.md index a9362c5c..239429cc 100644 --- a/charts/grocy/README.md +++ b/charts/grocy/README.md @@ -109,9 +109,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/grocy/README.md.gotmpl b/charts/grocy/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/grocy/README.md.gotmpl +++ b/charts/grocy/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/heimdall/README.md b/charts/heimdall/README.md index 4b1c7208..350fe8f1 100644 --- a/charts/heimdall/README.md +++ b/charts/heimdall/README.md @@ -111,9 +111,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/heimdall/README.md.gotmpl b/charts/heimdall/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/heimdall/README.md.gotmpl +++ b/charts/heimdall/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/home-assistant/README.md b/charts/home-assistant/README.md index d457d126..d6ba8716 100644 --- a/charts/home-assistant/README.md +++ b/charts/home-assistant/README.md @@ -229,9 +229,9 @@ This is the last version before starting this changelog. All sorts of cool stuff ## 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/home-assistant/README.md.gotmpl b/charts/home-assistant/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/home-assistant/README.md.gotmpl +++ b/charts/home-assistant/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/homer/README.md b/charts/homer/README.md index e0a63c43..af4892cd 100644 --- a/charts/homer/README.md +++ b/charts/homer/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/homer/README.md.gotmpl b/charts/homer/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/homer/README.md.gotmpl +++ b/charts/homer/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/hyperion-ng/README.md b/charts/hyperion-ng/README.md index 14d077ff..0ed1c600 100644 --- a/charts/hyperion-ng/README.md +++ b/charts/hyperion-ng/README.md @@ -123,9 +123,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/hyperion-ng/README.md.gotmpl b/charts/hyperion-ng/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/hyperion-ng/README.md.gotmpl +++ b/charts/hyperion-ng/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/icantbelieveitsnotvaletudo/Chart.yaml b/charts/icantbelieveitsnotvaletudo/Chart.yaml index 47eb5072..1f0be48f 100644 --- a/charts/icantbelieveitsnotvaletudo/Chart.yaml +++ b/charts/icantbelieveitsnotvaletudo/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 2021.2.0 description: Create live map data from Valetudo powered robots name: icantbelieveitsnotvaletudo -version: 2.1.0 +version: 2.1.1 kubeVersion: ">=1.16.0-0" keywords: - icantbelieveitsnotvaletudo diff --git a/charts/icantbelieveitsnotvaletudo/README.md b/charts/icantbelieveitsnotvaletudo/README.md index be73a16c..6ef20982 100644 --- a/charts/icantbelieveitsnotvaletudo/README.md +++ b/charts/icantbelieveitsnotvaletudo/README.md @@ -1,6 +1,6 @@ # icantbelieveitsnotvaletudo -![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![AppVersion: 2021.2.0](https://img.shields.io/badge/AppVersion-2021.2.0-informational?style=flat-square) +![Version: 2.1.1](https://img.shields.io/badge/Version-2.1.1-informational?style=flat-square) ![AppVersion: 2021.2.0](https://img.shields.io/badge/AppVersion-2021.2.0-informational?style=flat-square) Create live map data from Valetudo powered robots @@ -19,7 +19,7 @@ Kubernetes: `>=1.16.0-0` | Repository | Name | Version | |------------|------|---------| -| https://k8s-at-home.com/charts/ | common | 3.0.1 | +| https://k8s-at-home.com/charts/ | common | 3.1.0 | ## TL;DR @@ -102,7 +102,7 @@ All notable changes to this application Helm chart will be documented in this fi 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). -### [2.0.0] +### [2.0.1] #### Added @@ -126,9 +126,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/icantbelieveitsnotvaletudo/README.md.gotmpl b/charts/icantbelieveitsnotvaletudo/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/icantbelieveitsnotvaletudo/README.md.gotmpl +++ b/charts/icantbelieveitsnotvaletudo/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/icantbelieveitsnotvaletudo/README_CHANGELOG.md.gotmpl b/charts/icantbelieveitsnotvaletudo/README_CHANGELOG.md.gotmpl index 4e88d4e1..1447f30b 100644 --- a/charts/icantbelieveitsnotvaletudo/README_CHANGELOG.md.gotmpl +++ b/charts/icantbelieveitsnotvaletudo/README_CHANGELOG.md.gotmpl @@ -9,7 +9,7 @@ All notable changes to this application Helm chart will be documented in this fi 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). -### [2.0.0] +### [2.0.1] #### Added diff --git a/charts/intel-gpu-plugin/Chart.yaml b/charts/intel-gpu-plugin/Chart.yaml index 7c3a799b..07de02e2 100644 --- a/charts/intel-gpu-plugin/Chart.yaml +++ b/charts/intel-gpu-plugin/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: intel-gpu-plugin -version: 1.0.0 +version: 1.0.1 appVersion: 0.18.1 description: The Intel GPU plugin facilitates offloading the processing of computation intensive workloads to GPU hardware keywords: diff --git a/charts/intel-gpu-plugin/README.md b/charts/intel-gpu-plugin/README.md index 86f1ef89..073ce86a 100644 --- a/charts/intel-gpu-plugin/README.md +++ b/charts/intel-gpu-plugin/README.md @@ -1,61 +1,69 @@ -# 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.1](https://img.shields.io/badge/Version-1.0.1-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 + +**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)** + +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| ## TL;DR -```shell +```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/intel-gpu-plugin +helm repo update +helm install intel-gpu-plugin k8s-at-home/intel-gpu-plugin ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `intel-gpu-plugin` -```shell -helm install my-release k8s-at-home/intel-gpu-plugin +```console +helm install intel-gpu-plugin k8s-at-home/intel-gpu-plugin ``` ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `intel-gpu-plugin` deployment -```shell -helm delete my-release --purge +```console +helm uninstall intel-gpu-plugin ``` -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 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. +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 | -| ------------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `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`. -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" \ +```console +helm install intel-gpu-plugin \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. -```shell -helm install my-release -f values.yaml k8s-at-home/intel-gpu-plugin +```console +helm install intel-gpu-plugin k8s-at-home/intel-gpu-plugin -f values.yaml ``` +## Custom configuration + ### 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): @@ -71,3 +79,59 @@ affinity: values: - "true" ``` + +## 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 | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy | +| image.repository | string | `"intel/intel-gpu-plugin"` | Image repository | +| image.tag | string | `"0.18.1"` | Image tag. Possible values listed [here](https://hub.docker.com/r/intel/intel-gpu-plugin/tags) | +| imagePullSecrets | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | Key-value pairs to add as pod annotations | +| podSecurityContext | object | `{}` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| strategyType | string | `"Recreate"` | Specifies the strategy used to replace old Pods by new ones | +| tolerations | 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](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). + +### [0.18.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[0.18.1]: #0.18.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/intel-gpu-plugin/README.md.gotmpl b/charts/intel-gpu-plugin/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/intel-gpu-plugin/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/intel-gpu-plugin/README_CHANGELOG.md.gotmpl b/charts/intel-gpu-plugin/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..1b467617 --- /dev/null +++ b/charts/intel-gpu-plugin/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). + +### [0.18.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[0.18.1]: #0.18.1 +{{- end -}} diff --git a/charts/intel-gpu-plugin/README_CONFIG.md.gotmpl b/charts/intel-gpu-plugin/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..bb6785df --- /dev/null +++ b/charts/intel-gpu-plugin/README_CONFIG.md.gotmpl @@ -0,0 +1,24 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +### 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" +``` + +{{- end -}} diff --git a/charts/intel-gpu-plugin/values.yaml b/charts/intel-gpu-plugin/values.yaml index b0a27245..35104dfb 100644 --- a/charts/intel-gpu-plugin/values.yaml +++ b/charts/intel-gpu-plugin/values.yaml @@ -1,10 +1,16 @@ # Default values for intel-gpu-plugin. image: + # -- Image repository repository: intel/intel-gpu-plugin + # -- Image pull policy pullPolicy: IfNotPresent + # -- Image tag. Possible values listed [here](https://hub.docker.com/r/intel/intel-gpu-plugin/tags) tag: 0.18.1 +# -- Specifies the strategy used to replace old Pods by new ones +strategyType: Recreate + imagePullSecrets: [] nameOverride: "" fullnameOverride: "" @@ -18,6 +24,7 @@ serviceAccount: # If not set and create is true, a name is generated using the fullname template name: "" +# -- Key-value pairs to add as pod annotations podAnnotations: {} podSecurityContext: {} diff --git a/charts/jackett/README.md b/charts/jackett/README.md index 8cc50c53..c77e6d58 100644 --- a/charts/jackett/README.md +++ b/charts/jackett/README.md @@ -113,9 +113,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/jackett/README.md.gotmpl b/charts/jackett/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/jackett/README.md.gotmpl +++ b/charts/jackett/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/jellyfin/README.md b/charts/jellyfin/README.md index 106b283f..5eddeea7 100644 --- a/charts/jellyfin/README.md +++ b/charts/jellyfin/README.md @@ -112,9 +112,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/jellyfin/README.md.gotmpl b/charts/jellyfin/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/jellyfin/README.md.gotmpl +++ b/charts/jellyfin/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/lazylibrarian/README.md b/charts/lazylibrarian/README.md index fcbee9e3..8a97b240 100644 --- a/charts/lazylibrarian/README.md +++ b/charts/lazylibrarian/README.md @@ -113,9 +113,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/lazylibrarian/README.md.gotmpl b/charts/lazylibrarian/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/lazylibrarian/README.md.gotmpl +++ b/charts/lazylibrarian/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/lidarr/README.md b/charts/lidarr/README.md index 36785e8e..a89d2fc0 100644 --- a/charts/lidarr/README.md +++ b/charts/lidarr/README.md @@ -113,9 +113,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/lidarr/README.md.gotmpl b/charts/lidarr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/lidarr/README.md.gotmpl +++ b/charts/lidarr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/lychee/README.md b/charts/lychee/README.md index 6a6e9bac..95a79791 100644 --- a/charts/lychee/README.md +++ b/charts/lychee/README.md @@ -117,9 +117,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/lychee/README.md.gotmpl b/charts/lychee/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/lychee/README.md.gotmpl +++ b/charts/lychee/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/modem-stats/Chart.yaml b/charts/modem-stats/Chart.yaml index d5d8621c..452459b0 100644 --- a/charts/modem-stats/Chart.yaml +++ b/charts/modem-stats/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: modem-stats -version: 3.0.0 +version: 3.0.1 appVersion: 1.0.0 description: periodic cable modem data collection and save the results to InfluxDB keywords: diff --git a/charts/modem-stats/README.md b/charts/modem-stats/README.md index 13748011..a57a5269 100644 --- a/charts/modem-stats/README.md +++ b/charts/modem-stats/README.md @@ -1,69 +1,123 @@ -# cable modem (sb6183) signal and stats collection agent for influxdb +# modem-stats -![Screenshot](https://camo.githubusercontent.com/939e044c0491abf790d91bd1d7f909b187e4098c/68747470733a2f2f692e696d6775722e636f6d2f70705a6a6e6b502e706e67) +![Version: 3.0.1](https://img.shields.io/badge/Version-3.0.1-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; +**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)** + +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR ```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/modem-stats +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install modem-stats k8s-at-home/modem-stats ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `modem-stats` ```console -$ helm install --name my-release k8s-at-home/modem-stats +helm install modem-stats k8s-at-home/modem-stats ``` + ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall the `modem-stats` deployment ```console -$ helm delete my-release --purge +helm uninstall modem-stats ``` -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 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. +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). -## 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, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -$ helm install --name my-release \ - --set onfig.influxdb.host=some-influx-host \ +helm install modem-stats \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -$ helm install --name my-release -f values.yaml k8s-at-home/modem-stats +helm install modem-stats k8s-at-home/modem-stats -f values.yaml ``` -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. +## Custom configuration + +![Screenshot](https://camo.githubusercontent.com/939e044c0491abf790d91bd1d7f909b187e4098c/68747470733a2f2f692e696d6775722e636f6d2f70705a6a6e6b502e706e67) + +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. + +## 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.delay | int | `3600` | how many seconds to wait between checks | +| config.influxdb.database | string | `"cable_modem_stats"` | InfluxDB database | +| config.influxdb.host | string | `"influxdb-influxdb"` | InfluxDB hostname | +| config.influxdb.port | int | `8086` | InfluxDB port | +| config.influxdb.ssl | bool | `false` | InfluxDB connection using SSL | +| config.modem.url | string | `"http://192.168.100.1/RgConnect.asp"` | sb6183 stats URL page | +| debug | bool | `false` | Display debugging output | +| image.pullPolicy | string | `"IfNotPresent"` | modem-stats image pull policy | +| image.repository | string | `"billimek/sb6183-for-influxdb"` | modem-stats image | +| image.tag | string | `"latest"` | modem-stats image tag | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | Key-value pairs to add as pod annotations | +| replicaCount | int | `1` | | +| resources | object | `{}` | | + +## 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). + +### [3.0.1] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[3.0.1]: #3.0.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/modem-stats/README.md.gotmpl b/charts/modem-stats/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/modem-stats/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/modem-stats/README_CHANGELOG.md.gotmpl b/charts/modem-stats/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..43c00852 --- /dev/null +++ b/charts/modem-stats/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). + +### [3.0.1] + +#### Added + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[3.0.1]: #3.0.1 +{{- end -}} diff --git a/charts/modem-stats/README_CONFIG.md.gotmpl b/charts/modem-stats/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..72e05afe --- /dev/null +++ b/charts/modem-stats/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" . }} + +![Screenshot](https://camo.githubusercontent.com/939e044c0491abf790d91bd1d7f909b187e4098c/68747470733a2f2f692e696d6775722e636f6d2f70705a6a6e6b502e706e67) + +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. + +{{- end -}} diff --git a/charts/modem-stats/values.yaml b/charts/modem-stats/values.yaml index 22a89aa2..4512a5c8 100644 --- a/charts/modem-stats/values.yaml +++ b/charts/modem-stats/values.yaml @@ -3,8 +3,11 @@ # Declare variables to be passed into your templates. replicaCount: 1 image: + # -- modem-stats image repository: billimek/sb6183-for-influxdb + # -- modem-stats image tag tag: latest + # -- modem-stats image pull policy pullPolicy: IfNotPresent resources: {} # We usually recommend not to specify default resources and to leave this as a conscious @@ -18,19 +21,28 @@ resources: {} # cpu: 100m # memory: 128Mi nodeSelector: {} +# -- Display debugging output debug: false config: - # how many seconds to wait between checks + # -- how many seconds to wait between checks delay: 3600 influxdb: - # host/port/database are mandatory - change as needed + # -- InfluxDB hostname host: influxdb-influxdb + # -- InfluxDB port port: 8086 + # -- InfluxDB database database: cable_modem_stats + # -- InfluxDB username # username: + # -- InfluxDB password # password: + + # -- InfluxDB connection using SSL ssl: false modem: + # -- sb6183 stats URL page url: http://192.168.100.1/RgConnect.asp +# -- Key-value pairs to add as pod annotations podAnnotations: {} diff --git a/charts/monica/README.md b/charts/monica/README.md index 8cb95ca7..e551ad09 100644 --- a/charts/monica/README.md +++ b/charts/monica/README.md @@ -119,9 +119,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/monica/README.md.gotmpl b/charts/monica/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/monica/README.md.gotmpl +++ b/charts/monica/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/mosquitto/Chart.yaml b/charts/mosquitto/Chart.yaml index b7951cc6..46cc70f6 100644 --- a/charts/mosquitto/Chart.yaml +++ b/charts/mosquitto/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 2.0.7 description: Eclipse Mosquitto - An open source MQTT broker name: mosquitto -version: 1.1.0 +version: 1.1.1 kubeVersion: ">=1.16.0-0" keywords: - mosquitto diff --git a/charts/mosquitto/README.md b/charts/mosquitto/README.md index 0b512e5b..14241f7a 100644 --- a/charts/mosquitto/README.md +++ b/charts/mosquitto/README.md @@ -1,6 +1,6 @@ # mosquitto -![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.0.7](https://img.shields.io/badge/AppVersion-2.0.7-informational?style=flat-square) +![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-informational?style=flat-square) ![AppVersion: 2.0.7](https://img.shields.io/badge/AppVersion-2.0.7-informational?style=flat-square) Eclipse Mosquitto - An open source MQTT broker @@ -18,7 +18,7 @@ Kubernetes: `>=1.16.0-0` | Repository | Name | Version | |------------|------|---------| -| https://k8s-at-home.com/charts/ | common | 3.0.1 | +| https://k8s-at-home.com/charts/ | common | 3.1.0 | ## TL;DR @@ -80,8 +80,8 @@ N/A | image.tag | string | `"2.0.7"` | | | persistence.data.accessMode | string | `"ReadWriteOnce"` | | | persistence.data.emptyDir | bool | `false` | | -| persistence.data.enabled | bool | `true` | | -| persistence.data.mountPath | string | `"/data"` | | +| persistence.data.enabled | bool | `false` | | +| persistence.data.mountPath | string | `"/mosquitto/data"` | | | persistence.data.size | string | `"100Mi"` | | | service.annotations | object | `{}` | | | service.port.name | string | `"mqtt"` | | @@ -95,27 +95,27 @@ All notable changes to this application Helm chart will be documented in this fi 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] +### [1.1.1] #### Added -- Initial release +- N/A #### Changed -- N/A +- Migrated the chart to the [k8s-at-home common library chart](https://github.com/k8s-at-home/charts/tree/master/charts/common). #### Removed - N/A -[1.0.0]: #1.0.0 +[1.1.1]: #1.1.1 ## 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/mosquitto/README.md.gotmpl b/charts/mosquitto/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/mosquitto/README.md.gotmpl +++ b/charts/mosquitto/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/mosquitto/README_CHANGELOG.md.gotmpl b/charts/mosquitto/README_CHANGELOG.md.gotmpl index e2d26b43..5939aba3 100644 --- a/charts/mosquitto/README_CHANGELOG.md.gotmpl +++ b/charts/mosquitto/README_CHANGELOG.md.gotmpl @@ -9,7 +9,7 @@ All notable changes to this application Helm chart will be documented in this fi 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] +### [1.1.1] #### Added @@ -23,5 +23,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - N/A -[1.0.0]: #1.0.0 +[1.1.1]: #1.1.1 {{- end -}} diff --git a/charts/mylar/README.md b/charts/mylar/README.md index ae8fe2f3..ca99e9ad 100644 --- a/charts/mylar/README.md +++ b/charts/mylar/README.md @@ -117,8 +117,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community diff --git a/charts/mylar/README.md.gotmpl b/charts/mylar/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/mylar/README.md.gotmpl +++ b/charts/mylar/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/navidrome/README.md b/charts/navidrome/README.md index aca07003..4e2c0f0b 100644 --- a/charts/navidrome/README.md +++ b/charts/navidrome/README.md @@ -120,9 +120,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/navidrome/README.md.gotmpl b/charts/navidrome/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/navidrome/README.md.gotmpl +++ b/charts/navidrome/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/neolink/README.md b/charts/neolink/README.md index 446d2374..af4919ae 100644 --- a/charts/neolink/README.md +++ b/charts/neolink/README.md @@ -107,9 +107,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/neolink/README.md.gotmpl b/charts/neolink/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/neolink/README.md.gotmpl +++ b/charts/neolink/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/network-ups-tools/README.md b/charts/network-ups-tools/README.md index e5ef11d1..0c7dcb81 100644 --- a/charts/network-ups-tools/README.md +++ b/charts/network-ups-tools/README.md @@ -112,9 +112,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/network-ups-tools/README.md.gotmpl b/charts/network-ups-tools/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/network-ups-tools/README.md.gotmpl +++ b/charts/network-ups-tools/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/node-red/README.md b/charts/node-red/README.md index c9582e4c..597a388f 100644 --- a/charts/node-red/README.md +++ b/charts/node-red/README.md @@ -111,9 +111,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/node-red/README.md.gotmpl b/charts/node-red/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/node-red/README.md.gotmpl +++ b/charts/node-red/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/nzbget/README.md b/charts/nzbget/README.md index da554ab0..8603b5d3 100644 --- a/charts/nzbget/README.md +++ b/charts/nzbget/README.md @@ -118,9 +118,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/nzbget/README.md.gotmpl b/charts/nzbget/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/nzbget/README.md.gotmpl +++ b/charts/nzbget/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/nzbhydra2/README.md b/charts/nzbhydra2/README.md index a3338bf3..2d26e33f 100644 --- a/charts/nzbhydra2/README.md +++ b/charts/nzbhydra2/README.md @@ -134,9 +134,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/nzbhydra2/README.md.gotmpl b/charts/nzbhydra2/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/nzbhydra2/README.md.gotmpl +++ b/charts/nzbhydra2/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/octoprint/README.md b/charts/octoprint/README.md index 9340d8fb..046e2ca7 100644 --- a/charts/octoprint/README.md +++ b/charts/octoprint/README.md @@ -116,9 +116,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/octoprint/README.md.gotmpl b/charts/octoprint/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/octoprint/README.md.gotmpl +++ b/charts/octoprint/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/omada-controller/README.md b/charts/omada-controller/README.md index 9e5cf909..d87a4d71 100644 --- a/charts/omada-controller/README.md +++ b/charts/omada-controller/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/omada-controller/README.md.gotmpl b/charts/omada-controller/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/omada-controller/README.md.gotmpl +++ b/charts/omada-controller/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/ombi/README.md b/charts/ombi/README.md index 86b7b295..3d18af1c 100644 --- a/charts/ombi/README.md +++ b/charts/ombi/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/ombi/README.md.gotmpl b/charts/ombi/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/ombi/README.md.gotmpl +++ b/charts/ombi/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/organizr/README.md b/charts/organizr/README.md index 5c3b9320..669a75a2 100644 --- a/charts/organizr/README.md +++ b/charts/organizr/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/organizr/README.md.gotmpl b/charts/organizr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/organizr/README.md.gotmpl +++ b/charts/organizr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/overseerr/README.md b/charts/overseerr/README.md index 613356a2..d808c3b4 100644 --- a/charts/overseerr/README.md +++ b/charts/overseerr/README.md @@ -111,9 +111,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/overseerr/README.md.gotmpl b/charts/overseerr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/overseerr/README.md.gotmpl +++ b/charts/overseerr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/paperless/README.md b/charts/paperless/README.md index 35e5bd46..0a8a67ce 100644 --- a/charts/paperless/README.md +++ b/charts/paperless/README.md @@ -124,9 +124,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/paperless/README.md.gotmpl b/charts/paperless/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/paperless/README.md.gotmpl +++ b/charts/paperless/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/photoprism/README.md b/charts/photoprism/README.md index b8614880..d9d6ce5b 100644 --- a/charts/photoprism/README.md +++ b/charts/photoprism/README.md @@ -115,9 +115,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/photoprism/README.md.gotmpl b/charts/photoprism/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/photoprism/README.md.gotmpl +++ b/charts/photoprism/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/piaware/README.md b/charts/piaware/README.md index d8b03c1f..f92e0fe8 100644 --- a/charts/piaware/README.md +++ b/charts/piaware/README.md @@ -141,9 +141,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/piaware/README.md.gotmpl b/charts/piaware/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/piaware/README.md.gotmpl +++ b/charts/piaware/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/plex-media-server/README.md b/charts/plex-media-server/README.md index 287bfe0b..2c8795c6 100644 --- a/charts/plex-media-server/README.md +++ b/charts/plex-media-server/README.md @@ -118,9 +118,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/plex-media-server/README.md.gotmpl b/charts/plex-media-server/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/plex-media-server/README.md.gotmpl +++ b/charts/plex-media-server/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/plex/Chart.yaml b/charts/plex/Chart.yaml index 6479dab8..aa507e9d 100644 --- a/charts/plex/Chart.yaml +++ b/charts/plex/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 1.20.2.3402 description: Plex Media Server name: plex -version: 2.3.1 +version: 2.3.2 keywords: - plex home: https://plex.tv/ diff --git a/charts/plex/README.md b/charts/plex/README.md index d086f384..e954119f 100644 --- a/charts/plex/README.md +++ b/charts/plex/README.md @@ -1,19 +1,34 @@ -# 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.2](https://img.shields.io/badge/Version-2.3.2-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 + +**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)** + +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| ## TL;DR -```shell +```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/plex +helm repo update +helm install plex k8s-at-home/plex ``` ## Installing the Chart -To install the chart with the release name `plex`: +To install the chart with the release name `plex` ```console helm install plex k8s-at-home/plex @@ -21,28 +36,171 @@ helm install plex k8s-at-home/plex ## Uninstalling the Chart -To uninstall/delete the `plex` deployment: +To uninstall the `plex` deployment ```console -helm delete plex +helm uninstall plex ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/plex/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console helm install plex \ - --set timezone="America/New York" \ + --set env.TZ="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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install plex -f values.yaml k8s-at-home/plex +helm install plex k8s-at-home/plex -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 | +|-----|------|---------|-------------| +| 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 | `[]` | | + +## 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). + +### [2.3.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[2.3.1]: #2.3.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/README.md.gotmpl b/charts/plex/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/plex/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/README_CHANGELOG.md.gotmpl b/charts/plex/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..fed7f2b8 --- /dev/null +++ b/charts/plex/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). + +### [2.3.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[2.3.1]: #2.3.1 +{{- end -}} diff --git a/charts/plex/README_CONFIG.md.gotmpl b/charts/plex/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/plex/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/powerdns/Chart.yaml b/charts/powerdns/Chart.yaml index 1d7f167a..87b5f2df 100755 --- a/charts/powerdns/Chart.yaml +++ b/charts/powerdns/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: v4.3.1 description: 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. name: powerdns -version: 3.1.0 +version: 3.1.1 home: https://www.powerdns.com/ sources: - http://www.github.com/PowerDNS/ diff --git a/charts/powerdns/README.md b/charts/powerdns/README.md new file mode 100644 index 00000000..6bcb118a --- /dev/null +++ b/charts/powerdns/README.md @@ -0,0 +1,160 @@ +# powerdns + +![Version: 3.1.1](https://img.shields.io/badge/Version-3.1.1-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. + +**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)** + +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | mariadb | 9.3.4 | +| https://charts.bitnami.com/bitnami | postgresql | 10.3.7 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install powerdns k8s-at-home/powerdns +``` + +## Installing the Chart + +To install the chart with the release name `powerdns` + +```console +helm install powerdns k8s-at-home/powerdns +``` + +## Uninstalling the Chart + +To uninstall the `powerdns` deployment + +```console +helm uninstall powerdns +``` + +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 powerdns \ + --set env.TZ="America/New York" \ + k8s-at-home/powerdns +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install powerdns k8s-at-home/powerdns -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 | +|-----|------|---------|-------------| +| 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 | `[]` | | + +## 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 + +- use helm-docs + +#### Removed + +- N/A + +[3.1.1]: #3.1.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/powerdns/README.md.gotmpl b/charts/powerdns/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/powerdns/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/powerdns/README_CHANGELOG.md.gotmpl b/charts/powerdns/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..520cb480 --- /dev/null +++ b/charts/powerdns/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 + +- use helm-docs + +#### Removed + +- N/A + +[3.1.1]: #3.1.1 +{{- end -}} diff --git a/charts/powerdns/README_CONFIG.md.gotmpl b/charts/powerdns/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/powerdns/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/prometheus-nut-exporter/Chart.yaml b/charts/prometheus-nut-exporter/Chart.yaml index 36bdfc0d..a393e485 100644 --- a/charts/prometheus-nut-exporter/Chart.yaml +++ b/charts/prometheus-nut-exporter/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: prometheus-nut-exporter description: A Helm chart for Kubernetes type: application -version: 1.0.1 +version: 1.0.2 appVersion: 1.0.1 keywords: - nut diff --git a/charts/prometheus-nut-exporter/README.md b/charts/prometheus-nut-exporter/README.md index d45b3d1e..b70a4084 100644 --- a/charts/prometheus-nut-exporter/README.md +++ b/charts/prometheus-nut-exporter/README.md @@ -1,50 +1,136 @@ -# 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.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: 1.0.1](https://img.shields.io/badge/AppVersion-1.0.1-informational?style=flat-square) -## TL;DR; +A Helm chart for Kubernetes + +**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)** + +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR ```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/prometheus-nut-exporter +helm repo update +helm install prometheus-nut-exporter k8s-at-home/prometheus-nut-exporter ``` ## Installing the Chart -To install the chart with the release name `prometheus-nut-exporter`: +To install the chart with the release name `prometheus-nut-exporter` ```console -helm install --name prometheus-nut-exporter k8s-at-home/prometheus-nut-exporter +helm install prometheus-nut-exporter k8s-at-home/prometheus-nut-exporter ``` ## Uninstalling the Chart -To uninstall/delete the `prometheus-nut-exporter` deployment: +To uninstall the `prometheus-nut-exporter` deployment ```console -helm delete prometheus-nut-exporter +helm uninstall prometheus-nut-exporter ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/prometheus-nut-exporter/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name prometheus-nut-exporter \ - --set serviceMonitor.enabled=true \ +helm install prometheus-nut-exporter \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name prometheus-nut-exporter -f values.yaml k8s-at-home/prometheus-nut-exporter +helm install prometheus-nut-exporter k8s-at-home/prometheus-nut-exporter -f values.yaml ``` -## Metrics +## Custom configuration + +### Metrics You can find the exported metrics here: [metrics](https://github.com/HON95/prometheus-nut-exporter/blob/master/metrics.md). + +## 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 | +|-----|------|---------|-------------| +| 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 | `[]` | | + +## 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.2] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[1.0.2]: #1.0.2 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/prometheus-nut-exporter/README.md.gotmpl b/charts/prometheus-nut-exporter/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/prometheus-nut-exporter/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/prometheus-nut-exporter/README_CHANGELOG.md.gotmpl b/charts/prometheus-nut-exporter/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..0ba75caa --- /dev/null +++ b/charts/prometheus-nut-exporter/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.2] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[1.0.2]: #1.0.2 +{{- end -}} diff --git a/charts/prometheus-nut-exporter/README_CONFIG.md.gotmpl b/charts/prometheus-nut-exporter/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..18f7c8cd --- /dev/null +++ b/charts/prometheus-nut-exporter/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" . }} + +### Metrics + +You can find the exported metrics here: [metrics](https://github.com/HON95/prometheus-nut-exporter/blob/master/metrics.md). +{{- end -}} diff --git a/charts/protonmail-bridge/README.md b/charts/protonmail-bridge/README.md index d6059469..02b14e5d 100644 --- a/charts/protonmail-bridge/README.md +++ b/charts/protonmail-bridge/README.md @@ -119,9 +119,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/protonmail-bridge/README.md.gotmpl b/charts/protonmail-bridge/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/protonmail-bridge/README.md.gotmpl +++ b/charts/protonmail-bridge/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/pyload/README.md b/charts/pyload/README.md index 2fb425d5..996c26ef 100644 --- a/charts/pyload/README.md +++ b/charts/pyload/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/pyload/README.md.gotmpl b/charts/pyload/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/pyload/README.md.gotmpl +++ b/charts/pyload/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/qbittorrent/README.md b/charts/qbittorrent/README.md index 0ba1d328..feb30ae2 100644 --- a/charts/qbittorrent/README.md +++ b/charts/qbittorrent/README.md @@ -126,9 +126,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/qbittorrent/README.md.gotmpl b/charts/qbittorrent/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/qbittorrent/README.md.gotmpl +++ b/charts/qbittorrent/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/radarr/README.md b/charts/radarr/README.md index 5ce58adc..e72401f8 100644 --- a/charts/radarr/README.md +++ b/charts/radarr/README.md @@ -113,9 +113,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/radarr/README.md.gotmpl b/charts/radarr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/radarr/README.md.gotmpl +++ b/charts/radarr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/readarr/README.md b/charts/readarr/README.md index e524f358..fc287257 100644 --- a/charts/readarr/README.md +++ b/charts/readarr/README.md @@ -114,9 +114,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/readarr/README.md.gotmpl b/charts/readarr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/readarr/README.md.gotmpl +++ b/charts/readarr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/recipes/README.md b/charts/recipes/README.md index 63fc2194..6c95f874 100644 --- a/charts/recipes/README.md +++ b/charts/recipes/README.md @@ -138,9 +138,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/recipes/README.md.gotmpl b/charts/recipes/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/recipes/README.md.gotmpl +++ b/charts/recipes/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/resilio-sync/README.md b/charts/resilio-sync/README.md index acfa4f12..4a1febc6 100644 --- a/charts/resilio-sync/README.md +++ b/charts/resilio-sync/README.md @@ -133,9 +133,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/resilio-sync/README.md.gotmpl b/charts/resilio-sync/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/resilio-sync/README.md.gotmpl +++ b/charts/resilio-sync/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/rtorrent-flood/Chart.yaml b/charts/rtorrent-flood/Chart.yaml index 7b22911c..7c3e699b 100644 --- a/charts/rtorrent-flood/Chart.yaml +++ b/charts/rtorrent-flood/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 1.0.0 description: rtorrent and flood co-located in the same deployment name: rtorrent-flood -version: 5.0.0 +version: 5.0.1 keywords: - rtorrent - flood diff --git a/charts/rtorrent-flood/README.md b/charts/rtorrent-flood/README.md index f4d044a7..ef8b30a5 100644 --- a/charts/rtorrent-flood/README.md +++ b/charts/rtorrent-flood/README.md @@ -1,6 +1,72 @@ -# rTorrent/flood BitTorrent client +# rtorrent-flood -## Setup +![Version: 5.0.1](https://img.shields.io/badge/Version-5.0.1-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +rtorrent and flood co-located in the same deployment + +**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)** + +## Source Code + +* +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install rtorrent-flood k8s-at-home/rtorrent-flood +``` + +## Installing the Chart + +To install the chart with the release name `rtorrent-flood` + +```console +helm install rtorrent-flood k8s-at-home/rtorrent-flood +``` + +## Uninstalling the Chart + +To uninstall the `rtorrent-flood` deployment + +```console +helm uninstall rtorrent-flood +``` + +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 rtorrent-flood \ + --set env.TZ="America/New York" \ + k8s-at-home/rtorrent-flood +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install rtorrent-flood k8s-at-home/rtorrent-flood -f values.yaml +``` + +## Custom configuration + +### Setup NB: This chart will start 2 containers in a single pod, when both containers are started, you will be able to configure flood. @@ -14,14 +80,92 @@ NB: This chart will start 2 containers in a single pod, when both containers are 5. You should be able to start downloading torrents now :) - -## Custom parameters - -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 +### 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. + +## 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 | +|-----|------|---------|-------------| +| 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` | | + +## 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). + +### [5.0.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[5.0.1]: #5.0.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/rtorrent-flood/README.md.gotmpl b/charts/rtorrent-flood/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/rtorrent-flood/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/rtorrent-flood/README_CHANGELOG.md.gotmpl b/charts/rtorrent-flood/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..9265b9d3 --- /dev/null +++ b/charts/rtorrent-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). + +### [5.0.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[5.0.1]: #5.0.1 +{{- end -}} diff --git a/charts/rtorrent-flood/README_CONFIG.md.gotmpl b/charts/rtorrent-flood/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..f871bd86 --- /dev/null +++ b/charts/rtorrent-flood/README_CONFIG.md.gotmpl @@ -0,0 +1,26 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +### Setup + +NB: This chart will start 2 containers in a single pod, when both containers are started, you will be able to configure flood. + +1. Install the chart `helm install rtorrent k8s-at-home/rtorrent-flood` + +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` + +3. To connect flood to rtorrent, provide the socket path : `/tmp/rtorrent.sock` + +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 + +5. You should be able to start downloading torrents now :) + +### 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. + +{{- end -}} diff --git a/charts/sabnzbd/README.md b/charts/sabnzbd/README.md index 460082a4..e8c6c355 100644 --- a/charts/sabnzbd/README.md +++ b/charts/sabnzbd/README.md @@ -121,9 +121,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/sabnzbd/README.md.gotmpl b/charts/sabnzbd/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/sabnzbd/README.md.gotmpl +++ b/charts/sabnzbd/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/samba/README.md b/charts/samba/README.md index 4c19919f..c324c2bf 100644 --- a/charts/samba/README.md +++ b/charts/samba/README.md @@ -115,9 +115,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/samba/README.md.gotmpl b/charts/samba/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/samba/README.md.gotmpl +++ b/charts/samba/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/searx/README.md b/charts/searx/README.md index f3381b49..4f750463 100644 --- a/charts/searx/README.md +++ b/charts/searx/README.md @@ -162,9 +162,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/searx/README.md.gotmpl b/charts/searx/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/searx/README.md.gotmpl +++ b/charts/searx/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/smarter-device-manager/README.md b/charts/smarter-device-manager/README.md index cb4cd8e5..8ad18813 100644 --- a/charts/smarter-device-manager/README.md +++ b/charts/smarter-device-manager/README.md @@ -151,9 +151,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/smarter-device-manager/README.md.gotmpl b/charts/smarter-device-manager/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/smarter-device-manager/README.md.gotmpl +++ b/charts/smarter-device-manager/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/sonarr/README.md b/charts/sonarr/README.md index 84a4947a..25fad2eb 100644 --- a/charts/sonarr/README.md +++ b/charts/sonarr/README.md @@ -113,9 +113,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/sonarr/README.md.gotmpl b/charts/sonarr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/sonarr/README.md.gotmpl +++ b/charts/sonarr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/speedtest-prometheus/Chart.yaml b/charts/speedtest-prometheus/Chart.yaml index 4a749ea6..494c7bde 100644 --- a/charts/speedtest-prometheus/Chart.yaml +++ b/charts/speedtest-prometheus/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: speedtest-prometheus description: Prometheus Exporter for the official Speedtest CLI type: application -version: 2.1.0 +version: 2.1.1 appVersion: 1.1.0 keywords: - speedtest diff --git a/charts/speedtest-prometheus/README.md b/charts/speedtest-prometheus/README.md index a674aad7..43db5b40 100644 --- a/charts/speedtest-prometheus/README.md +++ b/charts/speedtest-prometheus/README.md @@ -1,52 +1,128 @@ -# Prometheus Exporter using the Speedtest CLI +# speedtest-prometheus -![Screenshot](https://i.imgur.com/iIzWUre.png) +![Version: 2.1.1](https://img.shields.io/badge/Version-2.1.1-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; +**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)** + +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR ```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/speedtest-prometheus +helm repo update +helm install speedtest-prometheus k8s-at-home/speedtest-prometheus ``` ## Installing the Chart -To install the chart with the release name `speedtest-prometheus`: +To install the chart with the release name `speedtest-prometheus` ```console -helm install --name speedtest-prometheus k8s-at-home/speedtest-prometheus +helm install speedtest-prometheus k8s-at-home/speedtest-prometheus ``` ## Uninstalling the Chart -To uninstall/delete the `speedtest-prometheus` deployment: +To uninstall the `speedtest-prometheus` deployment ```console -helm delete speedtest-prometheus +helm uninstall speedtest-prometheus ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/speedtest-prometheus/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name speedtest-prometheus \ - --set serviceMonitor.enabled=true \ +helm install speedtest-prometheus \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name speedtest-prometheus -f values.yaml k8s-at-home/speedtest-prometheus +helm install speedtest-prometheus k8s-at-home/speedtest-prometheus -f values.yaml ``` -## Grafana Dashboard +## Custom configuration + +### 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. + +## 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 | +|-----|------|---------|-------------| +| 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 | `[]` | | + +## 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). + +### [2.1.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[2.1.1]: #2.1.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/speedtest-prometheus/README.md.gotmpl b/charts/speedtest-prometheus/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/speedtest-prometheus/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/speedtest-prometheus/README_CHANGELOG.md.gotmpl b/charts/speedtest-prometheus/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..f66db3d4 --- /dev/null +++ b/charts/speedtest-prometheus/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). + +### [2.1.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[2.1.1]: #2.1.1 +{{- end -}} diff --git a/charts/speedtest-prometheus/README_CONFIG.md.gotmpl b/charts/speedtest-prometheus/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..8d0bc652 --- /dev/null +++ b/charts/speedtest-prometheus/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" . }} + +### 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. + +{{- end -}} diff --git a/charts/statping/README.md b/charts/statping/README.md index e5efb31a..14f90c61 100644 --- a/charts/statping/README.md +++ b/charts/statping/README.md @@ -129,9 +129,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/statping/README.md.gotmpl b/charts/statping/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/statping/README.md.gotmpl +++ b/charts/statping/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/tautulli/README.md b/charts/tautulli/README.md index b14003fa..0d13e9f9 100644 --- a/charts/tautulli/README.md +++ b/charts/tautulli/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/tautulli/README.md.gotmpl b/charts/tautulli/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/tautulli/README.md.gotmpl +++ b/charts/tautulli/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/teedy/README.md b/charts/teedy/README.md index 2650cad5..1feb8017 100644 --- a/charts/teedy/README.md +++ b/charts/teedy/README.md @@ -117,9 +117,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/teedy/README.md.gotmpl b/charts/teedy/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/teedy/README.md.gotmpl +++ b/charts/teedy/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/teslamate/Chart.yaml b/charts/teslamate/Chart.yaml index bccd53c3..ed872eb3 100644 --- a/charts/teslamate/Chart.yaml +++ b/charts/teslamate/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: v1.20.0 description: A self-hosted data logger for your Tesla 🚘 name: teslamate -version: 3.6.0 +version: 3.6.1 keywords: - teslamate - tesla diff --git a/charts/teslamate/README.md b/charts/teslamate/README.md index f5e7367c..aa1a3a87 100644 --- a/charts/teslamate/README.md +++ b/charts/teslamate/README.md @@ -1,48 +1,153 @@ -# 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.6.1](https://img.shields.io/badge/Version-3.6.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; +**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/teslamate +## Source Code + +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | postgresql | 10.3.7 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install teslamate k8s-at-home/teslamate ``` ## Installing the Chart -To install the chart with the release name `my-release`: +To install the chart with the release name `teslamate` ```console -helm install --name teslamate k8s-at-home/teslamate +helm install teslamate k8s-at-home/teslamate ``` ## Uninstalling the Chart -To uninstall/delete the `teslamate` deployment: +To uninstall the `teslamate` deployment ```console -helm delete teslamate --purge +helm uninstall teslamate ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/teslamate/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name teslamate \ - --set timeZone="America/New York" \ +helm install teslamate \ + --set env.TZ="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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name teslamate -f values.yaml stable/teslamate +helm install teslamate k8s-at-home/teslamate -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 | +|-----|------|---------|-------------| +| 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` | | + +## 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). + +### [3.6.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[3.6.1]: #3.6.1 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/teslamate/README.md.gotmpl b/charts/teslamate/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/teslamate/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/teslamate/README_CHANGELOG.md.gotmpl b/charts/teslamate/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..25636210 --- /dev/null +++ b/charts/teslamate/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). + +### [3.6.1] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[3.6.1]: #3.6.1 +{{- end -}} diff --git a/charts/teslamate/README_CONFIG.md.gotmpl b/charts/teslamate/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/teslamate/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/traccar/README.md b/charts/traccar/README.md index 7d704358..eb3a42b2 100644 --- a/charts/traccar/README.md +++ b/charts/traccar/README.md @@ -120,9 +120,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/traccar/README.md.gotmpl b/charts/traccar/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/traccar/README.md.gotmpl +++ b/charts/traccar/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/traefik-forward-auth/Chart.yaml b/charts/traefik-forward-auth/Chart.yaml index 80e8a0c4..c2904353 100644 --- a/charts/traefik-forward-auth/Chart.yaml +++ b/charts/traefik-forward-auth/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: traefik-forward-auth description: A minimal forward authentication service that provides OAuth/SSO login and authentication for the traefik reverse proxy/load balancer type: application -version: 1.0.5 +version: 1.0.6 appVersion: 2.2.0 keywords: - traefik diff --git a/charts/traefik-forward-auth/README.md b/charts/traefik-forward-auth/README.md index 27c67e16..ec533e2a 100644 --- a/charts/traefik-forward-auth/README.md +++ b/charts/traefik-forward-auth/README.md @@ -1,40 +1,56 @@ # 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.6](https://img.shields.io/badge/Version-1.0.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.1](https://img.shields.io/badge/AppVersion-2.2.1-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) +**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)** -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) +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| ## TL;DR + ```console -$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ -$ helm install k8s-at-home/traefik-forward-auth +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install traefik-forward-auth k8s-at-home/traefik-forward-auth ``` ## Installing the Chart -To install the chart with the release name `traefik-forward-auth`: + +To install the chart with the release name `traefik-forward-auth` + ```console helm install traefik-forward-auth k8s-at-home/traefik-forward-auth ``` ## Uninstalling the Chart -To uninstall the `traefik-forward-auth` deployment: + +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. + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** 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. +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 traefik-forward-auth \ --set env.TZ="America/New York" \ @@ -42,13 +58,19 @@ helm install 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 +helm install traefik-forward-auth k8s-at-home/traefik-forward-auth -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 | |-----|------|---------|-------------| | affinity | object | `{}` | | @@ -124,3 +146,35 @@ helm install traefik-forward-auth k8s-at-home/traefik-forward-auth --values valu | serviceAccount.name | string | `""` | | | tolerations | list | `[]` | | | urlPath | string | `""` | Callback URL Path (default: /_oauth) | + +## 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.6] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[1.0.6]: #1.0.6 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/traefik-forward-auth/README.md.gotmpl b/charts/traefik-forward-auth/README.md.gotmpl index d51bacfc..8b868671 100644 --- a/charts/traefik-forward-auth/README.md.gotmpl +++ b/charts/traefik-forward-auth/README.md.gotmpl @@ -1,26 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + {{ template "chart.header" . }} -{{ template "chart.typeBadge" . }}{{ template "chart.versionBadge" . }}{{ template "chart.appVersionBadge" . }}{{ template "badge.artifactHub" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} {{ template "chart.description" . }} -{{ template "description.multiarch" . }} +{{ template "custom.notes" . }} -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) +{{ template "chart.sourcesSection" . }} -{{ template "install.tldr" . }} +{{ template "custom.requirements" . }} -{{ template "install" . }} +{{ template "custom.dependencies" . }} -{{ template "uninstall" . }} +{{ template "custom.install.tldr" . }} -{{ template "configuration.header" . }} +{{ template "custom.install" . }} -{{ template "configuration.readValues" . }} +{{ template "custom.uninstall" . }} -{{ template "configuration.example.set" .}} +{{ template "custom.configuration.header" . }} -{{ template "configuration.example.file" . }} +{{ template "custom.configuration.readValues" . }} -{{ template "chart.valuesSection" . }} +{{ 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/traefik-forward-auth/README_CHANGELOG.md.gotmpl b/charts/traefik-forward-auth/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..9fb01650 --- /dev/null +++ b/charts/traefik-forward-auth/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.6] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[1.0.6]: #1.0.6 +{{- end -}} diff --git a/charts/traefik-forward-auth/README_CONFIG.md.gotmpl b/charts/traefik-forward-auth/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/traefik-forward-auth/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/transmission/README.md b/charts/transmission/README.md index 1975eff9..c82ed664 100644 --- a/charts/transmission/README.md +++ b/charts/transmission/README.md @@ -202,9 +202,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/transmission/README.md.gotmpl b/charts/transmission/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/transmission/README.md.gotmpl +++ b/charts/transmission/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/tt-rss/README.md b/charts/tt-rss/README.md index 40b3a96d..940ecb15 100644 --- a/charts/tt-rss/README.md +++ b/charts/tt-rss/README.md @@ -121,9 +121,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/tt-rss/README.md.gotmpl b/charts/tt-rss/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/tt-rss/README.md.gotmpl +++ b/charts/tt-rss/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/tvheadend/README.md b/charts/tvheadend/README.md index 067b824b..e3b26b2b 100644 --- a/charts/tvheadend/README.md +++ b/charts/tvheadend/README.md @@ -113,9 +113,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/tvheadend/README.md.gotmpl b/charts/tvheadend/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/tvheadend/README.md.gotmpl +++ b/charts/tvheadend/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/unifi-poller/README.md b/charts/unifi-poller/README.md index 5ae1a345..a5196edb 100644 --- a/charts/unifi-poller/README.md +++ b/charts/unifi-poller/README.md @@ -117,9 +117,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/unifi-poller/README.md.gotmpl b/charts/unifi-poller/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/unifi-poller/README.md.gotmpl +++ b/charts/unifi-poller/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/unpackerr/README.md b/charts/unpackerr/README.md index ac64a73a..e9ed2778 100644 --- a/charts/unpackerr/README.md +++ b/charts/unpackerr/README.md @@ -114,9 +114,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/unpackerr/README.md.gotmpl b/charts/unpackerr/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/unpackerr/README.md.gotmpl +++ b/charts/unpackerr/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/uptimerobot-prometheus/Chart.yaml b/charts/uptimerobot-prometheus/Chart.yaml index 0c8a311e..5530f8e5 100644 --- a/charts/uptimerobot-prometheus/Chart.yaml +++ b/charts/uptimerobot-prometheus/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: uptimerobot-prometheus description: Prometheus Exporter for the official uptimerobot CLI type: application -version: 2.0.1 +version: 2.0.2 appVersion: 0.0.1 keywords: - uptimerobot diff --git a/charts/uptimerobot-prometheus/README.md b/charts/uptimerobot-prometheus/README.md index 417c98fd..438ba1d8 100644 --- a/charts/uptimerobot-prometheus/README.md +++ b/charts/uptimerobot-prometheus/README.md @@ -1,52 +1,129 @@ -# Prometheus Exporter using the Uptimerobot API +# uptimerobot-prometheus -![](https://raw.githubusercontent.com/lekpamartin/uptimerobot_exporter/master/dashboards/dashboard.PNG) +![Version: 2.0.2](https://img.shields.io/badge/Version-2.0.2-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; +**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)** + +## Source Code + +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| + +## TL;DR ```console helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm install k8s-at-home/uptimerobot-prometheus +helm repo update +helm install uptimerobot-prometheus k8s-at-home/uptimerobot-prometheus ``` ## Installing the Chart -To install the chart with the release name `uptimerobot-prometheus`: +To install the chart with the release name `uptimerobot-prometheus` ```console -helm install --name uptimerobot-prometheus k8s-at-home/uptimerobot-prometheus +helm install uptimerobot-prometheus k8s-at-home/uptimerobot-prometheus ``` ## Uninstalling the Chart -To uninstall/delete the `uptimerobot-prometheus` deployment: +To uninstall the `uptimerobot-prometheus` deployment ```console -helm delete uptimerobot-prometheus +helm uninstall uptimerobot-prometheus ``` -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](https://github.com/k8s-at-home/charts/blob/master/charts/uptimerobot-prometheus/values.yaml) file. It has several commented out suggested values. +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`. For example, +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install --name uptimerobot-prometheus \ - --set serviceMonitor.enabled=true \ +helm install uptimerobot-prometheus \ + --set env.TZ="America/New York" \ 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, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. ```console -helm install --name uptimerobot-prometheus -f values.yaml k8s-at-home/uptimerobot-prometheus +helm install uptimerobot-prometheus k8s-at-home/uptimerobot-prometheus -f values.yaml ``` -## Grafana Dashboard +## Custom configuration + +### 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. + +## 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 | +|-----|------|---------|-------------| +| 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 | `""` | | + +## 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). + +### [2.0.2] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[2.0.2]: #2.0.2 + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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/uptimerobot-prometheus/README.md.gotmpl b/charts/uptimerobot-prometheus/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/uptimerobot-prometheus/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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 [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/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 "chart.sourcesSection" . }} + +{{ 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/uptimerobot-prometheus/README_CHANGELOG.md.gotmpl b/charts/uptimerobot-prometheus/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..24b4fb14 --- /dev/null +++ b/charts/uptimerobot-prometheus/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). + +### [2.0.2] + +#### Added + +- N/A + +#### Changed + +- use helm-docs + +#### Removed + +- N/A + +[2.0.2]: #2.0.2 +{{- end -}} diff --git a/charts/uptimerobot-prometheus/README_CONFIG.md.gotmpl b/charts/uptimerobot-prometheus/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..400d973f --- /dev/null +++ b/charts/uptimerobot-prometheus/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" . }} + +### 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. +{{- end -}} diff --git a/charts/wallabag/README.md b/charts/wallabag/README.md index 0177d690..ddfccfd9 100644 --- a/charts/wallabag/README.md +++ b/charts/wallabag/README.md @@ -115,8 +115,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community diff --git a/charts/wallabag/README.md.gotmpl b/charts/wallabag/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/wallabag/README.md.gotmpl +++ b/charts/wallabag/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/xbackbone/README.md b/charts/xbackbone/README.md index 298dbf61..4e657217 100644 --- a/charts/xbackbone/README.md +++ b/charts/xbackbone/README.md @@ -111,9 +111,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/xbackbone/README.md.gotmpl b/charts/xbackbone/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/xbackbone/README.md.gotmpl +++ b/charts/xbackbone/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/xteve/README.md b/charts/xteve/README.md index a234cab3..d8c6a0b4 100644 --- a/charts/xteve/README.md +++ b/charts/xteve/README.md @@ -110,9 +110,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/xteve/README.md.gotmpl b/charts/xteve/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/xteve/README.md.gotmpl +++ b/charts/xteve/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/youtubedl-material/README.md b/charts/youtubedl-material/README.md index 18952eac..ace9c7ab 100644 --- a/charts/youtubedl-material/README.md +++ b/charts/youtubedl-material/README.md @@ -123,8 +123,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community diff --git a/charts/youtubedl-material/README.md.gotmpl b/charts/youtubedl-material/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/youtubedl-material/README.md.gotmpl +++ b/charts/youtubedl-material/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/zigbee2mqtt/README.md b/charts/zigbee2mqtt/README.md index 335a3e1c..3f878995 100644 --- a/charts/zigbee2mqtt/README.md +++ b/charts/zigbee2mqtt/README.md @@ -155,9 +155,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/zigbee2mqtt/README.md.gotmpl b/charts/zigbee2mqtt/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/zigbee2mqtt/README.md.gotmpl +++ b/charts/zigbee2mqtt/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/zwave2mqtt/README.md b/charts/zwave2mqtt/README.md index ee94c970..4a33445e 100644 --- a/charts/zwave2mqtt/README.md +++ b/charts/zwave2mqtt/README.md @@ -144,9 +144,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/zwave2mqtt/README.md.gotmpl b/charts/zwave2mqtt/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/zwave2mqtt/README.md.gotmpl +++ b/charts/zwave2mqtt/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/charts/zwavejs2mqtt/README.md b/charts/zwavejs2mqtt/README.md index 70a85a91..9fc11faf 100644 --- a/charts/zwavejs2mqtt/README.md +++ b/charts/zwavejs2mqtt/README.md @@ -145,9 +145,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/charts/zwavejs2mqtt/README.md.gotmpl b/charts/zwavejs2mqtt/README.md.gotmpl index 387904a6..8b868671 100644 --- a/charts/zwavejs2mqtt/README.md.gotmpl +++ b/charts/zwavejs2mqtt/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/hack/templates/README.md.gotmpl b/hack/templates/README.md.gotmpl index 387904a6..8b868671 100644 --- a/hack/templates/README.md.gotmpl +++ b/hack/templates/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}} diff --git a/templates/chart/README.md b/templates/chart/README.md index 1e6a47d5..84488e96 100644 --- a/templates/chart/README.md +++ b/templates/chart/README.md @@ -108,9 +108,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- diff --git a/templates/chart/README.md.gotmpl b/templates/chart/README.md.gotmpl index 387904a6..8b868671 100644 --- a/templates/chart/README.md.gotmpl +++ b/templates/chart/README.md.gotmpl @@ -100,9 +100,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - {{- 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) +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- end -}}