diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f2779a0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,22 @@ +# Changelog + +## [0.0.1](https://github.com/CrystalNET-org/helm-powerdns/releases/tag/0.0.1) - 2024-02-05 + +### ❤️ Thanks to all contributors! ❤️ + +@psych0d0g, @Lukas Wingerberg, @Psych0D0g + +### Misc + +- Update harbor.crystalnet.org/dockerhub-proxy/woodpeckerci/plugin-git Docker tag to v2.5.0 [[#9](https://github.com/CrystalNET-org/helm-powerdns/pull/9)] +- Update harbor.crystalnet.org/dockerhub-proxy/renovate/renovate Docker tag to v37.173.0 [[#8](https://github.com/CrystalNET-org/helm-powerdns/pull/8)] +- Update harbor.crystalnet.org/dockerhub-proxy/alpine/helm Docker tag to v3.14.0 [[#7](https://github.com/CrystalNET-org/helm-powerdns/pull/7)] +- Update harbor.crystalnet.org/dockerhub-proxy/renovate/renovate Docker tag to v37.140.10 [[#6](https://github.com/CrystalNET-org/helm-powerdns/pull/6)] +- Update .gitattributes ([9953366](https://github.com/CrystalNET-org/helm-powerdns/commit/9953366aecdd26d736691582f641805dd09a2542)) +- Update .gitattributes ([ca161b4](https://github.com/CrystalNET-org/helm-powerdns/commit/ca161b41b6526ef02d90defbecdb5e976800b48f)) +- Create .gitattributes ([f80ba79](https://github.com/CrystalNET-org/helm-powerdns/commit/f80ba795a589412374984fbb08637d8c7b136345)) +- Update _helpers.tpl ([d3a2584](https://github.com/CrystalNET-org/helm-powerdns/commit/d3a2584e5924c6bd3047e676a8a65462a32e5ae1)) +- Update harbor.crystalnet.org/dockerhub-proxy/renovate/renovate Docker tag to v37.122.0 [[#5](https://github.com/CrystalNET-org/helm-powerdns/pull/5)] +- Update harbor.crystalnet.org/dockerhub-proxy/renovate/renovate Docker tag to v37.119.0 [[#4](https://github.com/CrystalNET-org/helm-powerdns/pull/4)] +- Update harbor.crystalnet.org/dockerhub-proxy/renovate/renovate Docker tag to v37.117.1 [[#1](https://github.com/CrystalNET-org/helm-powerdns/pull/1)] +- first commit ([5d28608](https://github.com/CrystalNET-org/helm-powerdns/commit/5d28608d075987dbe27193c7891516fb4bc03def)) diff --git a/README.md b/README.md new file mode 100644 index 0000000..7aaa967 --- /dev/null +++ b/README.md @@ -0,0 +1,195 @@ + + + + +

+ + Logo + +

+ +

Powerdns - A Helm chart to deploy PowerDNS to Kubernetes

+ +
+
+ + [ + ![License](https://img.shields.io/github/license/CrystalNET-org/helm-powerdns?logo=git&logoColor=white&logoWidth=20) + ](LICENSE) +
+ ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) + ![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) + ![AppVersion: 4.7.3-3](https://img.shields.io/badge/AppVersion-4.7.3--3-informational?style=flat-square) + [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/CrystalNET)](https://artifacthub.io/packages/helm/crystalnet/powerdns) + +
+ +--- + +## [Powerdns](https://www.powerdns.com/) + +> _Disclaimer: This application has been developed by the [Powerdns](https://www.powerdns.com/) community._ + +[> More about Powerdns](https://www.powerdns.com/) + +--- + +## TL;DR + +Direct install via oci://: +```shell +helm install my-release oci://harbor.crystalnet.org/charts/powerdns +``` + +install using chartMuseum: +```shell +helm repo add crystalnet https://charts.crystalnet.org +helm install my-release crystalnet/powerdns +``` + +## Introduction + +This chart bootstraps a Powerdns deployment on a [Kubernetes](kubernetes.io) cluster using the [Helm](helm.sh) package manager. + +## Prerequisites + +- Helm 3+ +- loadbalancer support for DNS to work (a manually setup nginx udp-* and tcp-services configuration also works) + +## Installing the Chart + +To install the chart with the release name `my-release`: + +Direct install via oci://: +```shell +helm install my-release oci://harbor.crystalnet.org/charts/powerdns +``` + +install using chartMuseum: +```shell +helm repo add crystalnet https://charts.crystalnet.org +helm install my-release crystalnet/powerdns +``` + +These commands deploy powerdns on the Kubernetes cluster in the default configuration. +The Parameters section lists the parameters that can be configured during installation. + +> **Tip:** List all releases using `helm list` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```shell +helm delete my-release +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Parameters + +### Global parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Common parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Powerdns parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `image.pullPolicy` | | `"IfNotPresent"` | +| `image.repository` | | `"psitrax/powerdns"` | +| `image.tag` | | `"v4.4.1"` | + +### Security parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Deployment/Statefulset parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `affinity` | | `{}` | +| `nodeSelector` | | `{}` | +| `replicaCount` | | `1` | +| `resources` | | `{}` | +| `tolerations` | | `[]` | + +### Network parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `ingress.annotations` | | `{}` | +| `ingress.enabled` | | `true` | +| `ingress.hosts[0]` | | `"chart-example.local"` | +| `ingress.path` | | `"/"` | +| `ingress.tls` | | `[]` | +| `service.type` | | `"ClusterIP"` | + +### Persistence parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Database parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `mariadb.db.name` | | `"powerdns"` | +| `mariadb.db.password` | | `"powerdns"` | +| `mariadb.db.user` | | `"powerdns"` | +| `mariadb.master.persistence.accessModes[0]` | | `"ReadWriteOnce"` | +| `mariadb.master.persistence.enabled` | | `true` | +| `mariadb.master.persistence.size` | | `"8Gi"` | +| `mariadb.metrics.enabled` | | `true` | +| `mariadb.serviceDiscovery` | | `"dns"` | +| `mariadb.slave.persistence.accessModes[0]` | | `"ReadWriteOnce"` | +| `mariadb.slave.persistence.enabled` | | `true` | +| `mariadb.slave.persistence.size` | | `"8Gi"` | + +### redis parameters + +| Key | Description | Default | +|-----|-------------|---------| +### Other parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `pdns.api.enabled` | | `"yes"` | +| `pdns.api.key` | | `"PowerDNSAPI"` | +| `pdns.dnsupdate.enabled` | | `"no"` | +| `pdns.webserver.allowFrom` | | `"0.0.0.0/0"` | + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```shell +helm install my-release --set fullnameOverride=my-powerdns oci://harbor.crystalnet.org/charts/powerdns +``` + +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, + +```shell +helm install my-release -f values.yaml oci://harbor.crystalnet.org/charts/powerdns +``` + +> **Tip:** You can use the default values.yaml + +## License + +Licensed under the GNU General Public License v3.0 (the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + +``` +TBD +``` + +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific +language governing permissions and limitations under the License. + diff --git a/chart/Chart.yaml b/chart/Chart.yaml index cb3d317..a46d21d 100644 --- a/chart/Chart.yaml +++ b/chart/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: powerdns description: A Helm chart to deploy PowerDNS to Kubernetes type: application -version: 0.2.5 +version: 0.0.1 # renovate: datasource=github-releases depName=CrystalNET-org/powerdns extractVersion=^v(?.*)$ appVersion: 4.7.3-3 home: https://www.powerdns.com/ diff --git a/chart/README.md b/chart/README.md index 08f5cce..7aaa967 100644 --- a/chart/README.md +++ b/chart/README.md @@ -1,96 +1,195 @@ -# Helm Chart for PowerDNS -* Installs a PowerDNS authoritative nameserver inside a Kubernetes cluster -## TL;DR; + -```console -$ git clone https://github.com/cdwv/powerdns-helm -$ cd powerdns-helm -$ helm install . +

+ + Logo + +

+ +

Powerdns - A Helm chart to deploy PowerDNS to Kubernetes

+ +
+
+ + [ + ![License](https://img.shields.io/github/license/CrystalNET-org/helm-powerdns?logo=git&logoColor=white&logoWidth=20) + ](LICENSE) +
+ ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) + ![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) + ![AppVersion: 4.7.3-3](https://img.shields.io/badge/AppVersion-4.7.3--3-informational?style=flat-square) + [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/CrystalNET)](https://artifacthub.io/packages/helm/crystalnet/powerdns) + +
+ +--- + +## [Powerdns](https://www.powerdns.com/) + +> _Disclaimer: This application has been developed by the [Powerdns](https://www.powerdns.com/) community._ + +[> More about Powerdns](https://www.powerdns.com/) + +--- + +## TL;DR + +Direct install via oci://: +```shell +helm install my-release oci://harbor.crystalnet.org/charts/powerdns +``` + +install using chartMuseum: +```shell +helm repo add crystalnet https://charts.crystalnet.org +helm install my-release crystalnet/powerdns ``` -> Note: This will leave you with a PowerDNS server deployed to your k8s cluster. You will also need to configure some means of accesibility from the outside world for the DNS server to be accesible. You can do it e.g. by modifying your nginx-ingress-controller. +## Introduction + +This chart bootstraps a Powerdns deployment on a [Kubernetes](kubernetes.io) cluster using the [Helm](helm.sh) package manager. + +## Prerequisites + +- Helm 3+ +- loadbalancer support for DNS to work (a manually setup nginx udp-* and tcp-services configuration also works) ## Installing the Chart To install the chart with the release name `my-release`: -```console -$ helm install --name my-release . +Direct install via oci://: +```shell +helm install my-release oci://harbor.crystalnet.org/charts/powerdns ``` +install using chartMuseum: +```shell +helm repo add crystalnet https://charts.crystalnet.org +helm install my-release crystalnet/powerdns +``` + +These commands deploy powerdns on the Kubernetes cluster in the default configuration. +The Parameters section lists the parameters that can be configured during installation. + +> **Tip:** List all releases using `helm list` + ## Uninstalling the Chart -To uninstall/delete the my-release deployment: +To uninstall/delete the `my-release` deployment: -```console -$ helm delete my-release +```shell +helm delete my-release ``` The command removes all the Kubernetes components associated with the chart and deletes the release. +## Parameters + +### Global parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Common parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Powerdns parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `image.pullPolicy` | | `"IfNotPresent"` | +| `image.repository` | | `"psitrax/powerdns"` | +| `image.tag` | | `"v4.4.1"` | + +### Security parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Deployment/Statefulset parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `affinity` | | `{}` | +| `nodeSelector` | | `{}` | +| `replicaCount` | | `1` | +| `resources` | | `{}` | +| `tolerations` | | `[]` | + +### Network parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `ingress.annotations` | | `{}` | +| `ingress.enabled` | | `true` | +| `ingress.hosts[0]` | | `"chart-example.local"` | +| `ingress.path` | | `"/"` | +| `ingress.tls` | | `[]` | +| `service.type` | | `"ClusterIP"` | + +### Persistence parameters + +| Key | Description | Default | +|-----|-------------|---------| + +### Database parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `mariadb.db.name` | | `"powerdns"` | +| `mariadb.db.password` | | `"powerdns"` | +| `mariadb.db.user` | | `"powerdns"` | +| `mariadb.master.persistence.accessModes[0]` | | `"ReadWriteOnce"` | +| `mariadb.master.persistence.enabled` | | `true` | +| `mariadb.master.persistence.size` | | `"8Gi"` | +| `mariadb.metrics.enabled` | | `true` | +| `mariadb.serviceDiscovery` | | `"dns"` | +| `mariadb.slave.persistence.accessModes[0]` | | `"ReadWriteOnce"` | +| `mariadb.slave.persistence.enabled` | | `true` | +| `mariadb.slave.persistence.size` | | `"8Gi"` | + +### redis parameters + +| Key | Description | Default | +|-----|-------------|---------| +### Other parameters + +| Key | Description | Default | +|-----|-------------|---------| +| `pdns.api.enabled` | | `"yes"` | +| `pdns.api.key` | | `"PowerDNSAPI"` | +| `pdns.dnsupdate.enabled` | | `"no"` | +| `pdns.webserver.allowFrom` | | `"0.0.0.0/0"` | + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```shell +helm install my-release --set fullnameOverride=my-powerdns oci://harbor.crystalnet.org/charts/powerdns +``` + +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, + +```shell +helm install my-release -f values.yaml oci://harbor.crystalnet.org/charts/powerdns +``` + +> **Tip:** You can use the default values.yaml + +## License + +Licensed under the GNU General Public License v3.0 (the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + +``` +TBD +``` + +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific +language governing permissions and limitations under the License. -## Configuration - -### PowerDNS - -| Parameter | Description | Default | -|----------------------------|-------------------------------------|---------------------------------------------------------| -| `pdns.api.enabled` | Should the PowerDNS API be enabled | `yes` -| `pdns.api.key` | PowerDNS API key | `PowerDNSAPI` -| `pdns.webserver.allowFrom` | PowerDNS webserver allowed IP whitelist | `0.0.0.0/0` -| `pdns.dnsupdate.enabled` | Should DNS UPDATE support be enabled | `no` | -| `replicaCount` | Number of pdns nodes | `1` | -| `image.repository` | Image repository | `psitrax/powerdns` | -| `image.tag` | Image tag. | `4.1.2`| -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `service.type` | Kubernetes service type | `ClusterIP` | -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.path` | Custom path | `/` -| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `resources` | CPU/Memory resource limits/requests | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Toleration labels for pod assignment | `[]` | -| `affinity` | Affinity settings for pod assignment | `{}` | -| `mariadb.enabled` | Deploy MariaDB container(s) | `true` | -| `mariadb.mariadbRootPassword` | MariaDB admin password | `nil` | -| `mariadb.mariadbDatabase` | Database name to create | `powerdns` | -| `mariadb.mariadbUser` | Database user to create | `powerdns` | -| `mariadb.mariadbPassword` | Password for the database | `powerdns` | -| `mariadb.persistence.enabled` | Enable persistence using PVC | `false` | -| `mariadb.persistence.existingClaim` | Enable persistence using an existing PVC | `nil` | -| `mariadb.persistence.storageClass` | PVC Storage Class | `nil` (uses alpha storage class annotation) | -| `mariadb.persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` | -| `mariadb.persistence.size` | PVC Storage Request | `2Gi` | -| `mariadb.serviceDiscovery` | Discovery of mariadb service. One of: dns, env | `dns` | - - -# Modifications to nginx-ingress - -General steps are outlined below. You can consult the files in the nginx-ingress folder for more information. - -1. Patch the nginx-ingress deployment to add UDP services (--udp-services-configmap=nginx-ingress/udp-ports) -2. Add udp-ports configmap to nginx-ingress namespace -2. Add a UDP loadbalancer service - -# TODO - -* [ ] - Make sure all kubernetes/charts [technical requirements](https://github.com/kubernetes/charts/blob/master/CONTRIBUTING.md#technical-requirements) are met -* [ ] - Make sure all kubernetes/charts [documentation requirements](https://github.com/kubernetes/charts/blob/master/CONTRIBUTING.md#documentation-requirements) are met -* [ ] - Add more pdns configuration options -* [ ] - Support secrets - -License -======================================================================= - -Creative Commons License
powerdns-helm by CodeWave is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License. - -Maintainers -=========== - -[](http://codewave.eu) - -Project is currently maintained, in our spare time, by [codewave.eu](http://codewave.eu) and a growing number of Contributors!