-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provider PowerDNS implementation (#390)
* Provider powerdns implementation * Fix formatting * Add documentation and example for PowerDNS provider
- Loading branch information
Showing
11 changed files
with
397 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # PowerDNS Provider | ||
|
|
||
| This DNS provider allows you to create and manage DNS entries with [PowerDNS](https://www.powerdns.com/). | ||
|
|
||
| ## Required permissions | ||
|
|
||
| There are no special permissions for the `apiToken`. | ||
|
|
||
| ## Credentials | ||
|
|
||
| You need to have an `apiToken` and the url of your PowerDNS `server` in place. | ||
|
|
||
| Create a `Secret` resource. All credentials need to be base64 encoded. | ||
|
|
||
| ```yaml | ||
| apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| name: powerdns-credentials | ||
| namespace: default | ||
| type: Opaque | ||
| data: | ||
| # replace '...' with values encoded as base64 | ||
| apiToken: ... # your PowerDNS token | ||
| server: ... # your PowerDNS server url | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| name: powerdns-credentials | ||
| namespace: default | ||
| type: Opaque | ||
| data: | ||
| # replace '...' with values encoded as base64 | ||
| apiToken: ... # your PowerDNS token | ||
| server: ... # your PowerDNS server url |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| apiVersion: dns.gardener.cloud/v1alpha1 | ||
| kind: DNSProvider | ||
| metadata: | ||
| name: powerdns | ||
| namespace: default | ||
| spec: | ||
| type: powerdns | ||
| secretRef: | ||
| name: powerdns-credentials | ||
| domains: | ||
| include: | ||
| - my.own.domain.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| // SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package controller | ||
|
|
||
| import ( | ||
| "github.com/gardener/external-dns-management/pkg/controller/provider/powerdns" | ||
| "github.com/gardener/external-dns-management/pkg/dns/provider" | ||
| ) | ||
|
|
||
| func init() { | ||
| provider.DNSController("", powerdns.Factory). | ||
| FinalizerDomain("dns.gardener.cloud"). | ||
| MustRegister(provider.CONTROLLER_GROUP_DNS_CONTROLLERS) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| // SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and Gardener contributors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package powerdns | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/gardener/controller-manager-library/pkg/logger" | ||
| "github.com/joeig/go-powerdns/v3" | ||
|
|
||
| "github.com/gardener/external-dns-management/pkg/dns" | ||
| "github.com/gardener/external-dns-management/pkg/dns/provider" | ||
| ) | ||
|
|
||
| type RecordSet struct { | ||
| Name string | ||
| RecordType powerdns.RRType | ||
| TTL uint32 | ||
| Content []string | ||
| } | ||
|
|
||
| type Execution struct { | ||
| logger.LogContext | ||
| handler *Handler | ||
| zone provider.DNSHostedZone | ||
| } | ||
|
|
||
| func NewExecution(logger logger.LogContext, h *Handler, zone provider.DNSHostedZone) *Execution { | ||
| return &Execution{LogContext: logger, handler: h, zone: zone} | ||
| } | ||
|
|
||
| func (exec *Execution) buildRecordSet(req *provider.ChangeRequest) (*RecordSet, error) { | ||
| var dnsset *dns.DNSSet | ||
|
|
||
| switch req.Action { | ||
| case provider.R_CREATE, provider.R_UPDATE: | ||
| dnsset = req.Addition | ||
| case provider.R_DELETE: | ||
| dnsset = req.Deletion | ||
| } | ||
|
|
||
| name, rset := dns.MapToProvider(req.Type, dnsset, exec.zone.Domain()) | ||
|
|
||
| if name.SetIdentifier != "" || dnsset.RoutingPolicy != nil { | ||
| return nil, fmt.Errorf("routing policies not supported for " + TYPE_CODE) | ||
| } | ||
|
|
||
| if name.DNSName == "" || len(rset.Records) == 0 { | ||
| return nil, nil | ||
| } | ||
|
|
||
| exec.Infof("Desired %s: %s record set %s[%s] with TTL %d: %s", req.Action, rset.Type, name.DNSName, exec.zone.Id(), rset.TTL, rset.RecordString()) | ||
|
|
||
| recordSet := RecordSet{ | ||
| Name: name.DNSName, | ||
| RecordType: powerdns.RRType(rset.Type), | ||
| } | ||
|
|
||
| switch req.Action { | ||
| case provider.R_CREATE, provider.R_UPDATE: | ||
| var content []string | ||
| for _, record := range rset.Records { | ||
| content = append(content, record.Value) | ||
| } | ||
|
|
||
| recordSet.Content = content | ||
| recordSet.TTL = uint32(rset.TTL) | ||
| } | ||
|
|
||
| return &recordSet, nil | ||
| } | ||
|
|
||
| func (exec *Execution) apply(action string, rset *RecordSet, metrics provider.Metrics) error { | ||
| var err error | ||
| switch action { | ||
| case provider.R_CREATE, provider.R_UPDATE: | ||
| err = exec.update(rset, metrics) | ||
| case provider.R_DELETE: | ||
| err = exec.delete(rset, metrics) | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| func (exec *Execution) update(rset *RecordSet, metrics provider.Metrics) error { | ||
| exec.handler.config.RateLimiter.Accept() | ||
| zoneID := exec.zone.Id().ID | ||
| err := exec.handler.powerdns.Records.Change(exec.handler.ctx, zoneID, rset.Name, rset.RecordType, rset.TTL, rset.Content) | ||
| metrics.AddZoneRequests(zoneID, provider.M_UPDATERECORDS, 1) | ||
| return err | ||
| } | ||
|
|
||
| func (exec *Execution) delete(rset *RecordSet, metrics provider.Metrics) error { | ||
| exec.handler.config.RateLimiter.Accept() | ||
| zoneID := exec.zone.Id().ID | ||
| err := exec.handler.powerdns.Records.Delete(exec.handler.ctx, zoneID, rset.Name, rset.RecordType) | ||
| metrics.AddZoneRequests(zoneID, provider.M_DELETERECORDS, 1) | ||
| return err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| // SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package powerdns | ||
|
|
||
| import ( | ||
| "github.com/gardener/external-dns-management/pkg/controller/provider/compound" | ||
| "github.com/gardener/external-dns-management/pkg/dns/provider" | ||
| ) | ||
|
|
||
| const TYPE_CODE = "powerdns" | ||
|
|
||
| var rateLimiterDefaults = provider.RateLimiterOptions{ | ||
| Enabled: true, | ||
| QPS: 50, | ||
| Burst: 10, | ||
| } | ||
|
|
||
| var Factory = provider.NewDNSHandlerFactory(TYPE_CODE, NewHandler). | ||
| SetGenericFactoryOptionDefaults(provider.GenericFactoryOptionDefaults.SetRateLimiterOptions(rateLimiterDefaults)) | ||
|
|
||
| func init() { | ||
| compound.MustRegister(Factory) | ||
| } |
Oops, something went wrong.