From 8b6f48109960e98973d85e39ef21ea8a61ab21dc Mon Sep 17 00:00:00 2001 From: Lukas Wingerberg Date: Tue, 18 Jan 2022 13:47:12 +0100 Subject: [PATCH] [powerdns-admin] initial release of powerdns-admin frontend (#1373) * initial release of powerdns-admin frontend --- charts/stable/powerdns-admin/.helmignore | 26 +++ charts/stable/powerdns-admin/Chart.yaml | 25 +++ charts/stable/powerdns-admin/README.md | 120 ++++++++++++ charts/stable/powerdns-admin/README.md.gotmpl | 176 ++++++++++++++++++ .../powerdns-admin/README_CONFIG.md.gotmpl | 9 + .../stable/powerdns-admin/templates/NOTES.txt | 1 + .../powerdns-admin/templates/common.yaml | 1 + charts/stable/powerdns-admin/values.yaml | 52 ++++++ 8 files changed, 410 insertions(+) create mode 100644 charts/stable/powerdns-admin/.helmignore create mode 100644 charts/stable/powerdns-admin/Chart.yaml create mode 100644 charts/stable/powerdns-admin/README.md create mode 100644 charts/stable/powerdns-admin/README.md.gotmpl create mode 100644 charts/stable/powerdns-admin/README_CONFIG.md.gotmpl create mode 100644 charts/stable/powerdns-admin/templates/NOTES.txt create mode 100644 charts/stable/powerdns-admin/templates/common.yaml create mode 100644 charts/stable/powerdns-admin/values.yaml diff --git a/charts/stable/powerdns-admin/.helmignore b/charts/stable/powerdns-admin/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/powerdns-admin/.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/stable/powerdns-admin/Chart.yaml b/charts/stable/powerdns-admin/Chart.yaml new file mode 100644 index 00000000..ca337499 --- /dev/null +++ b/charts/stable/powerdns-admin/Chart.yaml @@ -0,0 +1,25 @@ +apiVersion: v2 +appVersion: v0.2.4 +description: A PowerDNS web interface with advanced features +name: powerdns-admin +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- powerdns +- pdns +- powerdns-admin +- admin +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/powerdns-admin +sources: +- https://github.com/PowerDNS-Admin/PowerDNS-Admin +maintainers: +- name: psych0d0g + email: psych0d0g@users.noreply.github.com +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.3.0 +annotations: + artifacthub.io/changes: | + - kind: added + description: Initial chart version diff --git a/charts/stable/powerdns-admin/README.md b/charts/stable/powerdns-admin/README.md new file mode 100644 index 00000000..6253f905 --- /dev/null +++ b/charts/stable/powerdns-admin/README.md @@ -0,0 +1,120 @@ +# powerdns-admin + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: v0.2.4](https://img.shields.io/badge/AppVersion-v0.2.4-informational?style=flat-square) + +A PowerDNS web interface with advanced features + +**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.3.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install powerdns-admin k8s-at-home/powerdns-admin +``` + +## Installing the Chart + +To install the chart with the release name `powerdns-admin` + +```console +helm install powerdns-admin k8s-at-home/powerdns-admin +``` + +## Uninstalling the Chart + +To uninstall the `powerdns-admin` deployment + +```console +helm uninstall powerdns-admin +``` + +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 powerdns-admin \ + --set env.TZ="America/New York" \ + k8s-at-home/powerdns-admin +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install powerdns-admin k8s-at-home/powerdns-admin -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 | object | See below (only deviations from the default settings are specified) | environment variables. See [undocumented configs](https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/configs/docker_config.py) and [application docs](# https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/configs/development.py) for more details. | +| env.GUNICORN_LOGLEVEL | string | `"DEBUG"` | Gunicorn loglevel to use | +| env.GUNICORN_TIMEOUT | int | `60` | Timeout for Gunicorn workers | +| env.GUNICORN_WORKERS | int | `2` | How many Gunicorn workers to spawn | +| env.SECRET_KEY | string | `"changeme"` | Unique app Key | +| env.SQLALCHEMY_DATABASE_URI | string | `"mysql://db_user:db_pass@db_host/powerdns_admin"` | Database connection string - if not set uses internal sqlite db | +| env.TZ | string | `"UTC"` | Application Timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"ngoduykhanh/powerdns-admin"` | image repository | +| image.tag | string | `"v0.2.4"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. this persists the internal sqlite DB if no other database is enabled | +| service | object | See values.yaml | Configures service settings for the chart. | + +## Changelog + +### Version 1.0.0 + +#### Added + +* Initial chart version + +#### Changed + +N/A + +#### Fixed + +N/A + +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/powerdns-admin?modal=changelog) + +## 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 v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1) diff --git a/charts/stable/powerdns-admin/README.md.gotmpl b/charts/stable/powerdns-admin/README.md.gotmpl new file mode 100644 index 00000000..94f7808a --- /dev/null +++ b/charts/stable/powerdns-admin/README.md.gotmpl @@ -0,0 +1,176 @@ +{{- 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 -}} + +{{- define "custom.changelog" -}} +{{ $changeTypes := list "added" "changed" "fixed" }} +## Changelog + +### Version {{ template "chart.version" . }} + +{{ range $changeType := $changeTypes }} + {{- with (index $.Annotations "artifacthub.io/changes") }} + {{- print "#### " ($changeType | title) | nindent 0 }} + {{- print "" | nindent 0 }} + {{- $changesFound := false }} + {{- range (print "changes:\n" . | fromYaml).changes }} + {{- if eq .kind $changeType }} + {{- print "* " .description | nindent 0 }} + {{- $changesFound = true }} + {{- end }} + {{- end }} + {{- if not $changesFound }} + {{- print "N/A" | nindent 0 }} + {{- end }} + {{- print "" | nindent 0 }} + {{- end }} +{{- end }} + +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/{{- template "chart.name" . }}?modal=changelog) + +{{- 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/stable/powerdns-admin/README_CONFIG.md.gotmpl b/charts/stable/powerdns-admin/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/powerdns-admin/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/stable/powerdns-admin/templates/NOTES.txt b/charts/stable/powerdns-admin/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/powerdns-admin/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/powerdns-admin/templates/common.yaml b/charts/stable/powerdns-admin/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/powerdns-admin/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/powerdns-admin/values.yaml b/charts/stable/powerdns-admin/values.yaml new file mode 100644 index 00000000..8da75221 --- /dev/null +++ b/charts/stable/powerdns-admin/values.yaml @@ -0,0 +1,52 @@ +# 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: ngoduykhanh/powerdns-admin + # -- image tag + tag: v0.2.4 + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See [undocumented configs](https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/configs/docker_config.py) +# and [application docs](# https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/configs/development.py) for more details. +# @default -- See below (only deviations from the default settings are specified) +env: + # Application Configuration + # -- Application Timezone + TZ: UTC + # -- Unique app Key + SECRET_KEY: changeme + # -- Database connection string - if not set uses internal sqlite db + # SQLALCHEMY_DATABASE_URI: mysql://db_user:db_pass@db_host/powerdns_admin + # -- Timeout for Gunicorn workers + GUNICORN_TIMEOUT: 60 + # -- How many Gunicorn workers to spawn + GUNICORN_WORKERS: 2 + # -- Gunicorn loglevel to use + GUNICORN_LOGLEVEL: DEBUG + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 80 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false + +# -- Configure persistence settings for the chart under this key. +# this persists the internal sqlite DB if no other database is enabled +# @default -- See values.yaml +persistence: + data: + enabled: false