From e94b5a16793ea581f27756b67301a1c0fe72fdef Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Mon, 18 Oct 2021 09:37:53 +0200 Subject: [PATCH] [teamspeak] Add new chart. (#1235) * Add TeamSpeak chart. --- charts/incubator/teamspeak/Chart.yaml | 19 +++ charts/incubator/teamspeak/README.md | 122 +++++++++++++++ charts/incubator/teamspeak/README.md.gotmpl | 146 ++++++++++++++++++ .../teamspeak/README_CHANGELOG.md.gotmpl | 27 ++++ .../teamspeak/README_CONFIG.md.gotmpl | 9 ++ charts/incubator/teamspeak/ci/ct-values.yaml | 2 + .../incubator/teamspeak/templates/NOTES.txt | 1 + .../incubator/teamspeak/templates/common.yaml | 1 + charts/incubator/teamspeak/values.yaml | 70 +++++++++ 9 files changed, 397 insertions(+) create mode 100644 charts/incubator/teamspeak/Chart.yaml create mode 100644 charts/incubator/teamspeak/README.md create mode 100644 charts/incubator/teamspeak/README.md.gotmpl create mode 100644 charts/incubator/teamspeak/README_CHANGELOG.md.gotmpl create mode 100644 charts/incubator/teamspeak/README_CONFIG.md.gotmpl create mode 100644 charts/incubator/teamspeak/ci/ct-values.yaml create mode 100644 charts/incubator/teamspeak/templates/NOTES.txt create mode 100644 charts/incubator/teamspeak/templates/common.yaml create mode 100644 charts/incubator/teamspeak/values.yaml diff --git a/charts/incubator/teamspeak/Chart.yaml b/charts/incubator/teamspeak/Chart.yaml new file mode 100644 index 00000000..bf84bfd4 --- /dev/null +++ b/charts/incubator/teamspeak/Chart.yaml @@ -0,0 +1,19 @@ +apiVersion: v2 +appVersion: 3.13.6 +description: TeamSpeak Server +name: teamspeak +version: 0.1.0 +kubeVersion: ">=1.16.0-0" +keywords: +- teamspeak +home: https://github.com/k8s-at-home/charts/tree/master/charts/incubator/teamspeak +icon: https://teamspeak.com/user/themes/teamspeak/images/logo_inverse.svg +sources: +- https://hub.docker.com/_/teamspeak +maintainers: +- name: reitermarkus + email: me@reitermark.us +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.0.1 diff --git a/charts/incubator/teamspeak/README.md b/charts/incubator/teamspeak/README.md new file mode 100644 index 00000000..11475314 --- /dev/null +++ b/charts/incubator/teamspeak/README.md @@ -0,0 +1,122 @@ +# teamspeak + +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![AppVersion: 3.13.6](https://img.shields.io/badge/AppVersion-3.13.6-informational?style=flat-square) + +TeamSpeak 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 + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install teamspeak k8s-at-home/teamspeak +``` + +## Installing the Chart + +To install the chart with the release name `teamspeak` + +```console +helm install teamspeak k8s-at-home/teamspeak +``` + +## Uninstalling the Chart + +To uninstall the `teamspeak` deployment + +```console +helm uninstall teamspeak +``` + +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 teamspeak \ + --set env.TZ="America/New York" \ + k8s-at-home/teamspeak +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install teamspeak k8s-at-home/teamspeak -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 | +|-----|------|---------|-------------| +| env | string | `nil` | environment variables. See more environment variables in the [teamspeak image documentation](https://hub.docker.com/_/teamspeak). | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"teamspeak"` | image repository | +| image.tag | string | `"3.13.6"` | image tag | +| nodeSelector | object | `{"kubernetes.io/arch":"amd64"}` | The TeamSpeak server binary is only available for x86_64. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| probes.liveness.custom | bool | `true` | | +| probes.liveness.spec.tcpSocket.port | int | `10011` | | +| probes.readiness.custom | bool | `true` | | +| probes.readiness.spec.tcpSocket.port | int | `10011` | | +| probes.startup.custom | bool | `true` | | +| probes.startup.spec.tcpSocket.port | int | `10011` | | +| 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 + +- 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) diff --git a/charts/incubator/teamspeak/README.md.gotmpl b/charts/incubator/teamspeak/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/incubator/teamspeak/README.md.gotmpl @@ -0,0 +1,146 @@ +{{- 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](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 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/library-charts/tree/main/charts/stable/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/incubator/teamspeak/README_CHANGELOG.md.gotmpl b/charts/incubator/teamspeak/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..06ad5fb3 --- /dev/null +++ b/charts/incubator/teamspeak/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/incubator/teamspeak/README_CONFIG.md.gotmpl b/charts/incubator/teamspeak/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/incubator/teamspeak/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/incubator/teamspeak/ci/ct-values.yaml b/charts/incubator/teamspeak/ci/ct-values.yaml new file mode 100644 index 00000000..ab697df5 --- /dev/null +++ b/charts/incubator/teamspeak/ci/ct-values.yaml @@ -0,0 +1,2 @@ +env: + TS3SERVER_LICENSE: accept diff --git a/charts/incubator/teamspeak/templates/NOTES.txt b/charts/incubator/teamspeak/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/incubator/teamspeak/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/incubator/teamspeak/templates/common.yaml b/charts/incubator/teamspeak/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/incubator/teamspeak/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/incubator/teamspeak/values.yaml b/charts/incubator/teamspeak/values.yaml new file mode 100644 index 00000000..8cb77fd9 --- /dev/null +++ b/charts/incubator/teamspeak/values.yaml @@ -0,0 +1,70 @@ +# +# 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: teamspeak + # -- image tag + tag: 3.13.6 + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [teamspeak image documentation](https://hub.docker.com/_/teamspeak). +# @default -- See below +env: + # TS3SERVER_LICENSE: accept + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + enabled: false + primary: false + voice: + enabled: true + primary: true + port: 9987 + protocol: UDP + tcp: + enabled: true + ports: + serverquery: + enabled: true + port: 10011 + filetransfer: + enabled: true + port: 30033 + +probes: + readiness: + custom: true + spec: + tcpSocket: + port: 10011 + liveness: + custom: true + spec: + tcpSocket: + port: 10011 + startup: + custom: true + spec: + tcpSocket: + port: 10011 + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: + data: + enabled: false + mountPath: /var/ts3server + +# -- The TeamSpeak server binary is only available for x86_64. +nodeSelector: + kubernetes.io/arch: amd64