feat: provider generic annotations

Fixes #4467

Signed-off-by: Jan Jansen <[email protected]>

Author: farodin91

internal/testutils/mock_source.go

@@ -20,6 +20,8 @@ import (
 	"context"
 	"time"
 
+	"sigs.k8s.io/external-dns/pkg/apis"
+
 	"github.com/stretchr/testify/mock"
 
 	"sigs.k8s.io/external-dns/endpoint"
@@ -58,3 +60,10 @@ func (m *MockSource) AddEventHandler(ctx context.Context, handler func()) {
 		}
 	}()
 }
+
+func (b *MockSource) SetProviderSpecificConfig(_ apis.ProviderSpecificConfig) {
+}
+
+func (b *MockSource) GetProviderSpecificAnnotations(_ map[string]string) (endpoint.ProviderSpecific, string) {
+	return nil, ""
+}

main.go

@@ -431,6 +431,12 @@ func main() {
 		os.Exit(0)
 	}
 
+	ps, err := p.GetProviderSpecific(ctx)
+	if err != nil {
+		log.Fatal(err)
+	}
+	endpointsSource.SetProviderSpecificConfig(ps)
+
 	var r registry.Registry
 	switch cfg.Registry {
 	case "dynamodb":

pkg/apis/types.go

@@ -0,0 +1,22 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+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.
+*/
+
+package apis
+
+type ProviderSpecificConfig struct {
+	Translation       map[string]string `json:"translation"`
+	PrefixTranslation map[string]string `json:"prefixTranslation"`
+}

provider/aws/aws.go

@@ -24,6 +24,8 @@ import (
 	"strings"
 	"time"
 
+	"sigs.k8s.io/external-dns/pkg/apis"
+
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/request"
 	"github.com/aws/aws-sdk-go/service/route53"
@@ -293,6 +295,14 @@ func NewAWSProvider(awsConfig AWSConfig, client Route53API) (*AWSProvider, error
 	return provider, nil
 }
 
+func (p *AWSProvider) GetProviderSpecific(_ context.Context) (apis.ProviderSpecificConfig, error) {
+	return apis.ProviderSpecificConfig{
+		PrefixTranslation: map[string]string{
+			"external-dns.alpha.kubernetes.io/aws-": "aws/",
+		},
+	}, nil
+}
+
 // Zones returns the list of hosted zones.
 func (p *AWSProvider) Zones(ctx context.Context) (map[string]*route53.HostedZone, error) {
 	if p.zonesCache.zones != nil && time.Since(p.zonesCache.age) < p.zonesCache.duration {

provider/cloudflare/cloudflare.go

@@ -24,13 +24,14 @@ import (
 	"strconv"
 	"strings"
 
+	"sigs.k8s.io/external-dns/pkg/apis"
+
 	cloudflare "github.com/cloudflare/cloudflare-go"
 	log "github.com/sirupsen/logrus"
 
 	"sigs.k8s.io/external-dns/endpoint"
 	"sigs.k8s.io/external-dns/plan"
 	"sigs.k8s.io/external-dns/provider"
-	"sigs.k8s.io/external-dns/source"
 )
 
 const (
@@ -42,6 +43,8 @@ const (
 	cloudFlareUpdate = "UPDATE"
 	// defaultCloudFlareRecordTTL 1 = automatic
 	defaultCloudFlareRecordTTL = 1
+	// The annotation used for determining if traffic will go through Cloudflare
+	CloudflareProxiedKey = "external-dns.alpha.kubernetes.io/cloudflare-proxied"
 )
 
 // We have to use pointers to bools now, as the upstream cloudflare-go library requires them
@@ -162,7 +165,7 @@ func getCreateDNSRecordParam(cfc cloudFlareChange) cloudflare.CreateDNSRecordPar
 }
 
 // NewCloudFlareProvider initializes a new CloudFlare DNS based Provider.
-func NewCloudFlareProvider(domainFilter endpoint.DomainFilter, zoneIDFilter provider.ZoneIDFilter, proxiedByDefault bool, dryRun bool, dnsRecordsPerPage int) (*CloudFlareProvider, error) {
+func NewCloudFlareProvider(domainFilter endpoint.DomainFilter, zoneIDFilter provider.ZoneIDFilter, proxiedByDefault bool, dryRun bool, dnsRecordsPerPage int) (provider.Provider, error) {
 	// initialize via chosen auth method and returns new API object
 	var (
 		config *cloudflare.API
@@ -196,6 +199,14 @@ func NewCloudFlareProvider(domainFilter endpoint.DomainFilter, zoneIDFilter prov
 	return provider, nil
 }
 
+func (p *CloudFlareProvider) GetProviderSpecific(_ context.Context) (apis.ProviderSpecificConfig, error) {
+	return apis.ProviderSpecificConfig{
+		Translation: map[string]string{
+			CloudflareProxiedKey: CloudflareProxiedKey,
+		},
+	}, nil
+}
+
 // Zones returns the list of hosted zones.
 func (p *CloudFlareProvider) Zones(ctx context.Context) ([]cloudflare.Zone, error) {
 	result := []cloudflare.Zone{}
@@ -398,7 +409,7 @@ func (p *CloudFlareProvider) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]
 		if proxied {
 			e.RecordTTL = 0
 		}
-		e.SetProviderSpecificProperty(source.CloudflareProxiedKey, strconv.FormatBool(proxied))
+		e.SetProviderSpecificProperty(CloudflareProxiedKey, strconv.FormatBool(proxied))
 
 		adjustedEndpoints = append(adjustedEndpoints, e)
 	}
@@ -487,10 +498,10 @@ func shouldBeProxied(endpoint *endpoint.Endpoint, proxiedByDefault bool) bool {
 	proxied := proxiedByDefault
 
 	for _, v := range endpoint.ProviderSpecific {
-		if v.Name == source.CloudflareProxiedKey {
+		if v.Name == CloudflareProxiedKey {
 			b, err := strconv.ParseBool(v.Value)
 			if err != nil {
-				log.Errorf("Failed to parse annotation [%s]: %v", source.CloudflareProxiedKey, err)
+				log.Errorf("Failed to parse annotation [%s]: %v", CloudflareProxiedKey, err)
 			} else {
 				proxied = b
 			}
@@ -535,7 +546,7 @@ func groupByNameAndType(records []cloudflare.DNSRecord) []*endpoint.Endpoint {
 				records[0].Type,
 				endpoint.TTL(records[0].TTL),
 				targets...).
-				WithProviderSpecific(source.CloudflareProxiedKey, strconv.FormatBool(*records[0].Proxied)),
+				WithProviderSpecific(CloudflareProxiedKey, strconv.FormatBool(*records[0].Proxied)),
 		)
 	}
 

provider/dyn/soap/services.go

@@ -242,7 +242,7 @@ func TestGoogleZonesVisibilityFilterPrivatePeering(t *testing.T) {
 
 	zones, err := provider.Zones(context.Background())
 	require.NoError(t, err)
-	
+
 	validateZones(t, zones, map[string]*dns.ManagedZone{
 		"svc-local": {Name: "svc-local", DnsName: "svc.local.", Id: 1005, Visibility: "private"},
 	})
@@ -694,7 +694,6 @@ func newGoogleProviderZoneOverlap(t *testing.T, domainFilter endpoint.DomainFilt
 		Visibility: "private",
 	})
 
-
 	createZone(t, provider, &dns.ManagedZone{
 		Name:       "svc-local",
 		DnsName:    "svc.local.",
@@ -703,13 +702,13 @@ func newGoogleProviderZoneOverlap(t *testing.T, domainFilter endpoint.DomainFilt
 	})
 
 	createZone(t, provider, &dns.ManagedZone{
-		Name:       "svc-local-peer",
-		DnsName:    "svc.local.",
-		Id:         10006,
-		Visibility: "private",
+		Name:          "svc-local-peer",
+		DnsName:       "svc.local.",
+		Id:            10006,
+		Visibility:    "private",
 		PeeringConfig: &dns.ManagedZonePeeringConfig{TargetNetwork: nil},
 	})
-	
+
 	provider.dryRun = dryRun
 
 	return provider

provider/google/google_test.go

@@ -24,6 +24,8 @@ import (
 	"strconv"
 	"strings"
 
+	"sigs.k8s.io/external-dns/pkg/apis"
+
 	"github.com/IBM-Cloud/ibm-cloud-cli-sdk/bluemix/crn"
 	"github.com/IBM/go-sdk-core/v5/core"
 	"github.com/IBM/networking-go-sdk/dnsrecordsv1"
@@ -301,7 +303,7 @@ func (c *ibmcloudConfig) Validate(authenticator core.Authenticator, domainFilter
 // NewIBMCloudProvider creates a new IBMCloud provider.
 //
 // Returns the provider or an error if a provider could not be created.
-func NewIBMCloudProvider(configFile string, domainFilter endpoint.DomainFilter, zoneIDFilter provider.ZoneIDFilter, source source.Source, proxiedByDefault bool, dryRun bool) (*IBMCloudProvider, error) {
+func NewIBMCloudProvider(configFile string, domainFilter endpoint.DomainFilter, zoneIDFilter provider.ZoneIDFilter, source source.Source, proxiedByDefault bool, dryRun bool) (provider.Provider, error) {
 	cfg, err := getConfig(configFile)
 	if err != nil {
 		return nil, err
@@ -335,6 +337,14 @@ func NewIBMCloudProvider(configFile string, domainFilter endpoint.DomainFilter,
 	return provider, nil
 }
 
+func (p *IBMCloudProvider) GetProviderSpecific(_ context.Context) (apis.ProviderSpecificConfig, error) {
+	return apis.ProviderSpecificConfig{
+		PrefixTranslation: map[string]string{
+			"external-dns.alpha.kubernetes.io/ibmcloud-": "ibmcloud/",
+		},
+	}, nil
+}
+
 // Records gets the current records.
 //
 // Returns the current records or an error if the operation failed.

provider/ibmcloud/ibmcloud.go

@@ -17,10 +17,11 @@ limitations under the License.
 package oci
 
 import (
-	"github.com/oracle/oci-go-sdk/v65/dns"
-	"github.com/stretchr/testify/assert"
 	"testing"
 	"time"
+
+	"github.com/oracle/oci-go-sdk/v65/dns"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestZoneCache(t *testing.T) {

provider/oci/cache_test.go

@@ -22,6 +22,8 @@ import (
 	"net"
 	"strings"
 
+	"sigs.k8s.io/external-dns/pkg/apis"
+
 	"sigs.k8s.io/external-dns/endpoint"
 	"sigs.k8s.io/external-dns/plan"
 )
@@ -49,6 +51,7 @@ type Provider interface {
 	// Endpoints. It is permitted to modify the supplied endpoints.
 	AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)
 	GetDomainFilter() endpoint.DomainFilter
+	GetProviderSpecific(ctx context.Context) (apis.ProviderSpecificConfig, error)
 }
 
 type BaseProvider struct{}
@@ -61,6 +64,10 @@ func (b BaseProvider) GetDomainFilter() endpoint.DomainFilter {
 	return endpoint.DomainFilter{}
 }
 
+func (b BaseProvider) GetProviderSpecific(_ context.Context) (apis.ProviderSpecificConfig, error) {
+	return apis.ProviderSpecificConfig{}, nil
+}
+
 type contextKey struct {
 	name string
 }

provider/provider.go

@@ -23,6 +23,8 @@ import (
 	"strconv"
 	"strings"
 
+	"sigs.k8s.io/external-dns/pkg/apis"
+
 	domain "github.com/scaleway/scaleway-sdk-go/api/domain/v2beta1"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 	log "github.com/sirupsen/logrus"
@@ -104,6 +106,14 @@ func NewScalewayProvider(ctx context.Context, domainFilter endpoint.DomainFilter
 	}, nil
 }
 
+func (p *ScalewayProvider) GetProviderSpecific(_ context.Context) (apis.ProviderSpecificConfig, error) {
+	return apis.ProviderSpecificConfig{
+		PrefixTranslation: map[string]string{
+			"external-dns.alpha.kubernetes.io/scw-": "scw/",
+		},
+	}, nil
+}
+
 // AdjustEndpoints is used to normalize the endoints
 func (p *ScalewayProvider) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error) {
 	eps := make([]*endpoint.Endpoint, len(endpoints))

provider/scaleway/scaleway.go

@@ -74,6 +74,24 @@ func (p *WebhookServer) RecordsHandler(w http.ResponseWriter, req *http.Request)
 		w.WriteHeader(http.StatusBadRequest)
 	}
 }
+func (p *WebhookServer) ProvideSpecificHandler(w http.ResponseWriter, req *http.Request) {
+	if req.Method != http.MethodGet {
+		log.Errorf("Unsupported method %s", req.Method)
+		w.WriteHeader(http.StatusBadRequest)
+	}
+
+	records, err := p.Provider.GetProviderSpecific(context.Background())
+	if err != nil {
+		log.Errorf("Failed to get Provide-Specific: %v", err)
+		w.WriteHeader(http.StatusInternalServerError)
+		return
+	}
+	w.Header().Set(ContentTypeHeader, MediaTypeFormatAndVersion)
+	w.WriteHeader(http.StatusOK)
+	if err := json.NewEncoder(w).Encode(records); err != nil {
+		log.Errorf("Failed to encode records: %v", err)
+	}
+}
 
 func (p *WebhookServer) AdjustEndpointsHandler(w http.ResponseWriter, req *http.Request) {
 	if req.Method != http.MethodPost {
@@ -114,6 +132,7 @@ func (p *WebhookServer) NegotiateHandler(w http.ResponseWriter, req *http.Reques
 // - /records (GET): returns the current records
 // - /records (POST): applies the changes
 // - /adjustendpoints (POST): executes the AdjustEndpoints method
+// - /provider-specific (GET): init provider specific stuff
 func StartHTTPApi(provider provider.Provider, startedChan chan struct{}, readTimeout, writeTimeout time.Duration, providerPort string) {
 	p := WebhookServer{
 		Provider: provider,
@@ -123,6 +142,7 @@ func StartHTTPApi(provider provider.Provider, startedChan chan struct{}, readTim
 	m.HandleFunc("/", p.NegotiateHandler)
 	m.HandleFunc("/records", p.RecordsHandler)
 	m.HandleFunc("/adjustendpoints", p.AdjustEndpointsHandler)
+	m.HandleFunc("/provider-specific", p.ProvideSpecificHandler)
 
 	s := &http.Server{
 		Addr:         providerPort,

provider/webhook/api/httpapi.go

@@ -27,6 +27,8 @@ import (
 	"testing"
 	"time"
 
+	"sigs.k8s.io/external-dns/pkg/apis"
+
 	"github.com/stretchr/testify/require"
 	"sigs.k8s.io/external-dns/endpoint"
 	"sigs.k8s.io/external-dns/plan"
@@ -39,6 +41,11 @@ type FakeWebhookProvider struct {
 	domainFilter endpoint.DomainFilter
 }
 
+func (p FakeWebhookProvider) GetProviderSpecific(ctx context.Context) (apis.ProviderSpecificConfig, error) {
+	//TODO implement me
+	panic("implement me")
+}
+
 func (p FakeWebhookProvider) Records(ctx context.Context) ([]*endpoint.Endpoint, error) {
 	if p.err != nil {
 		return nil, p.err