diff --git a/charts/antennas/.helmignore b/charts/antennas/.helmignore new file mode 100644 index 0000000..4379e2b --- /dev/null +++ b/charts/antennas/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/antennas/Chart.yaml b/charts/antennas/Chart.yaml new file mode 100644 index 0000000..2b4769d --- /dev/null +++ b/charts/antennas/Chart.yaml @@ -0,0 +1,21 @@ +apiVersion: v2 +appVersion: "4.1.0" +description: Antennas +name: antennas +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: + - tvheadend + - antennas + - iptv +home: https://github.com/nikdoof/helm-charts/tree/master/charts/antennas/ +sources: + - https://github.com/jfarseneau/antennas + - https://hub.docker.com/r/thejf/antennas +maintainers: + - name: nikdoof + email: andy@tensixtyone.com +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 4.2.0 diff --git a/charts/antennas/README.md b/charts/antennas/README.md new file mode 100644 index 0000000..90baabd --- /dev/null +++ b/charts/antennas/README.md @@ -0,0 +1,120 @@ +# antennas + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 4.1.0](https://img.shields.io/badge/AppVersion-4.1.0-informational?style=flat-square) + +Antennas + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/nikdoof/helm-charts/issues/new/choose)** + +## Source Code + +* +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.2.0 | + +## TL;DR + +```console +helm repo add nikdoof-helm-charts https://nikdoof.github.io/helm-charts/ +helm repo update +helm install antennas nikdoof-helm-charts/antennas +``` + +## Installing the Chart + +To install the chart with the release name `antennas` + +```console +helm install antennas nikdoof-helm-charts/antennas +``` + +## Uninstalling the Chart + +To uninstall the `antennas` deployment + +```console +helm uninstall antennas +``` + +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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install antennas \ + --set antennas.tvheadend_url="http://tvheadend:9981"\ + nikdoof-helm-charts/antennas +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install antennas nikdoof-helm-charts/antennas -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/library-charts/tree/main/charts/stable/common) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| antennas | object | See below | Antennas configuration options. See more environment variables in the [antennas documentation](https://github.com/jfarseneau/antennas). | +| antennas.antennas_url | string | `nil` | Externally accessible URL for this antennas instance, defaults to the main service http port. | +| antennas.stream_url | string | `nil` | Optional stream URL, used for situations where the internal and external URL for TVHeadend is different. | +| antennas.tuner_count | int | `4` | Number of tuners to present to Plex | +| antennas.tvheadend_url | string | `nil` | URL of the TVHeadend instance. | +| dnsPolicy | string | `nil` | When hostNetwork is true set dnsPolicy to ClusterFirstWithHostNet | +| env | object | See below | environment variables. See more environment variables in the [antennas documentation](https://github.com/jfarseneau/antennas). | +| hostNetwork | bool | `false` | Enable Antennas to be discoverable via SSDP | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"thejf/antennas"` | image repository | +| image.tag | string | `"4.1.0"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| service | object | See values.yaml | Configures service settings for the chart. | + +## 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/library-charts/tree/main/charts/stable/common#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 + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 + +## Support + +- Open an [issue](https://github.com/nikdoof/helm-charts/issues/new/choose) + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/antennas/README.md.gotmpl b/charts/antennas/README.md.gotmpl new file mode 100644 index 0000000..399b08a --- /dev/null +++ b/charts/antennas/README.md.gotmpl @@ -0,0 +1,143 @@ +{{- define "custom.repository.organization" -}} +nikdoof-helm-charts +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/nikdoof/helm-charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://nikdoof.github.io/helm-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/nikdoof/helm-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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/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 antennas.tvheadend_url="http://tvheadend:9981"\ + {{ 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/library-charts/tree/main/charts/stable/common) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- Open an [issue](https://github.com/nikdoof/helm-charts/issues/new/choose) +{{- 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/antennas/README_CHANGELOG.md.gotmpl b/charts/antennas/README_CHANGELOG.md.gotmpl new file mode 100644 index 0000000..06ad5fb --- /dev/null +++ b/charts/antennas/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/library-charts/tree/main/charts/stable/common#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 + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 +{{- end -}} diff --git a/charts/antennas/README_CONFIG.md.gotmpl b/charts/antennas/README_CONFIG.md.gotmpl new file mode 100644 index 0000000..e93d80b --- /dev/null +++ b/charts/antennas/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/antennas/ci/test-values.yaml b/charts/antennas/ci/test-values.yaml new file mode 100644 index 0000000..059b36b --- /dev/null +++ b/charts/antennas/ci/test-values.yaml @@ -0,0 +1,3 @@ +--- +antennas: + tvheadend_url: http://tvheadend:9981 diff --git a/charts/antennas/templates/NOTES.txt b/charts/antennas/templates/NOTES.txt new file mode 100644 index 0000000..90f7b65 --- /dev/null +++ b/charts/antennas/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/antennas/templates/common.yaml b/charts/antennas/templates/common.yaml new file mode 100644 index 0000000..7c3c340 --- /dev/null +++ b/charts/antennas/templates/common.yaml @@ -0,0 +1,18 @@ + +{{/* Make sure all variables are set properly */}} +{{- include "common.values.setup" . }} + +{{/* Append the hardcoded settings */}} +{{- define "antennas.harcodedValues" -}} + {{/* Append the configMap volume to the volumes */}} + persistence: + antennas-config: + enabled: true + type: "configMap" + name: "{{ include "common.names.fullname" . }}-config" + mountPath: "/antennas/config/config.yml" + subPath: "config.yml" +{{- end -}} +{{- $_ := mergeOverwrite .Values (include "antennas.harcodedValues" . | fromYaml) -}} + +{{ include "common.all" . }} diff --git a/charts/antennas/templates/configmap.yaml b/charts/antennas/templates/configmap.yaml new file mode 100644 index 0000000..487dddd --- /dev/null +++ b/charts/antennas/templates/configmap.yaml @@ -0,0 +1,21 @@ +{{- $values := .Values.service -}} +{{- $serviceName := include "common.names.fullname" . -}} +{{- if and (hasKey $values "nameOverride") $values.nameOverride -}} + {{- $serviceName = printf "%v-%v" $serviceName $values.nameOverride -}} +{{ end -}} +{{- $defaultAntennasURL := printf "http://%v:%v" $serviceName .Values.service.main.ports.http.port -}} +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "common.names.fullname" . }}-config + labels: + {{- include "common.labels" . | nindent 4 }} +data: + config.yml: |- + tvheadend_url: {{ required "A TVHeadend URL is required!" .Values.antennas.tvheadend_url }} + antennas_url: {{ .Values.antennas.antennas_url | default $defaultAntennasURL }} + tuner_count: {{ .Values.antennas.tuner_count }} + {{ if .Values.antennas.stream_url }} + stream_url: {{ .Values.antennas.stream_url }} + {{ end }} diff --git a/charts/antennas/values.yaml b/charts/antennas/values.yaml new file mode 100644 index 0000000..04dc49a --- /dev/null +++ b/charts/antennas/values.yaml @@ -0,0 +1,50 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# + +image: + # -- image repository + repository: thejf/antennas + # -- image tag + tag: 4.1.0 + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [antennas documentation](https://github.com/jfarseneau/antennas). +# @default -- See below +env: {} + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 5004 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false + +# -- Enable Antennas to be discoverable via SSDP +hostNetwork: false + +# -- When hostNetwork is true set dnsPolicy to ClusterFirstWithHostNet +dnsPolicy: # ClusterFirstWithHostNet + +# -- Antennas configuration options. See more environment variables in the [antennas documentation](https://github.com/jfarseneau/antennas). +# @default -- See below +antennas: + # -- URL of the TVHeadend instance. + tvheadend_url: + # -- Optional stream URL, used for situations where the internal and external URL for TVHeadend is different. + stream_url: + # -- Number of tuners to present to Plex + tuner_count: 4 + # -- Externally accessible URL for this antennas instance, defaults to the main service http port. + antennas_url: