Treat any annotations with the recognised prefix, but that are not ot…

…herwise recognised, as provider properties.
kubernetes-sigs · Nov 26, 2024 · c2041db · c2041db
1 parent 8d8be2a
commit c2041db
Show file tree

Hide file tree

Showing 15 changed files with 140 additions and 169 deletions.
diff --git a/docs/annotations/annotations.md b/docs/annotations/annotations.md
@@ -99,7 +99,13 @@ It must be between 1 and 2,147,483,647 seconds.
 
 ## Provider-specific annotations
 
-Some providers define their own annotations. Cloud-specific annotations have keys prefixed as follows:
+Provider-specific annotations are prefixed by `external-dns.alpha.kubernetes.io/`
+and the provider's name, for example `external-dns.alpha.kubernetes.io/aws-`.
+
+Individual provider implementations should be examined to identify the additional
+configuration offered via supported annotations.
+
+Currently, supported Cloud-specific annotations include the following prefixes:
 
 | Cloud      | Annotation prefix                              |
 |------------|------------------------------------------------|

diff --git a/docs/contributing/crd-source/dnsendpoint-aws-example.yaml b/docs/contributing/crd-source/dnsendpoint-aws-example.yaml
@@ -6,11 +6,11 @@ spec:
   endpoints:
   - dnsName: subdomain.foo.bar.com
     providerSpecific:
-      - name: "aws/failover"
+      - name: "aws-failover"
         value: "PRIMARY"
-      - name: "aws/health-check-id"
+      - name: "aws-health-check-id"
         value: "asdf1234-as12-as12-as12-asdf12345678" 
-      - name: "aws/evaluate-target-health"
+      - name: "aws-evaluate-target-health"
         value: "true"
     recordType: CNAME
     setIdentifier: some-unique-id

diff --git a/docs/contributing/crd-source/dnsendpoint-example.yaml b/docs/contributing/crd-source/dnsendpoint-example.yaml
@@ -11,5 +11,5 @@ spec:
     - 192.168.99.216
     # Provider specific configurations are set like an annotation would on other sources
     providerSpecific:
-      - name: external-dns.alpha.kubernetes.io/cloudflare-proxied
+      - name: cloudflare-proxied
         value: "true"
diff --git a/provider/aws/aws.go b/provider/aws/aws.go
@@ -48,19 +48,19 @@ const (
 	route53PageSize int32 = 300
 	// providerSpecificAlias specifies whether a CNAME endpoint maps to an AWS ALIAS record.
 	providerSpecificAlias            = "alias"
-	providerSpecificTargetHostedZone = "aws/target-hosted-zone"
+	providerSpecificTargetHostedZone = "aws-target-hosted-zone"
 	// providerSpecificEvaluateTargetHealth specifies whether an AWS ALIAS record
 	// has the EvaluateTargetHealth field set to true. Present iff the endpoint
 	// has a `providerSpecificAlias` value of `true`.
-	providerSpecificEvaluateTargetHealth       = "aws/evaluate-target-health"
-	providerSpecificWeight                     = "aws/weight"
-	providerSpecificRegion                     = "aws/region"
-	providerSpecificFailover                   = "aws/failover"
-	providerSpecificGeolocationContinentCode   = "aws/geolocation-continent-code"
-	providerSpecificGeolocationCountryCode     = "aws/geolocation-country-code"
-	providerSpecificGeolocationSubdivisionCode = "aws/geolocation-subdivision-code"
-	providerSpecificMultiValueAnswer           = "aws/multi-value-answer"
-	providerSpecificHealthCheckID              = "aws/health-check-id"
+	providerSpecificEvaluateTargetHealth       = "aws-evaluate-target-health"
+	providerSpecificWeight                     = "aws-weight"
+	providerSpecificRegion                     = "aws-region"
+	providerSpecificFailover                   = "aws-failover"
+	providerSpecificGeolocationContinentCode   = "aws-geolocation-continent-code"
+	providerSpecificGeolocationCountryCode     = "aws-geolocation-country-code"
+	providerSpecificGeolocationSubdivisionCode = "aws-geolocation-subdivision-code"
+	providerSpecificMultiValueAnswer           = "aws-multi-value-answer"
+	providerSpecificHealthCheckID              = "aws-health-check-id"
 	sameZoneAlias                              = "same-zone"
 )
 

diff --git a/provider/cloudflare/cloudflare.go b/provider/cloudflare/cloudflare.go
@@ -31,7 +31,6 @@ import (
 	"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 (
@@ -43,6 +42,9 @@ const (
 	cloudFlareUpdate = "UPDATE"
 	// defaultCloudFlareRecordTTL 1 = automatic
 	defaultCloudFlareRecordTTL = 1
+
+	// providerSpecificProxied specifies whether traffic will go through Cloudflare
+	providerSpecificProxied = "cloudflare-proxied"
 )
 
 // We have to use pointers to bools now, as the upstream cloudflare-go library requires them
@@ -422,7 +424,7 @@ func (p *CloudFlareProvider) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]
 		if proxied {
 			e.RecordTTL = 0
 		}
-		e.SetProviderSpecificProperty(source.CloudflareProxiedKey, strconv.FormatBool(proxied))
+		e.SetProviderSpecificProperty(providerSpecificProxied, strconv.FormatBool(proxied))
 
 		adjustedEndpoints = append(adjustedEndpoints, e)
 	}
@@ -519,10 +521,10 @@ func shouldBeProxied(endpoint *endpoint.Endpoint, proxiedByDefault bool) bool {
 	proxied := proxiedByDefault
 
 	for _, v := range endpoint.ProviderSpecific {
-		if v.Name == source.CloudflareProxiedKey {
+		if v.Name == providerSpecificProxied {
 			b, err := strconv.ParseBool(v.Value)
 			if err != nil {
-				log.Errorf("Failed to parse annotation [%s]: %v", source.CloudflareProxiedKey, err)
+				log.Errorf("Failed parsing value of %s: %v", providerSpecificProxied, err)
 			} else {
 				proxied = b
 			}
@@ -567,7 +569,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(providerSpecificProxied, strconv.FormatBool(*records[0].Proxied)),
 		)
 	}
 

diff --git a/provider/cloudflare/cloudflare_test.go b/provider/cloudflare/cloudflare_test.go
@@ -479,7 +479,7 @@ func TestCloudflareProxiedOverrideTrue(t *testing.T) {
 			Targets:    endpoint.Targets{"127.0.0.1"},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				endpoint.ProviderSpecificProperty{
-					Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+					Name:  providerSpecificProxied,
 					Value: "true",
 				},
 			},
@@ -511,7 +511,7 @@ func TestCloudflareProxiedOverrideFalse(t *testing.T) {
 			Targets:    endpoint.Targets{"127.0.0.1"},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				endpoint.ProviderSpecificProperty{
-					Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+					Name:  providerSpecificProxied,
 					Value: "false",
 				},
 			},
@@ -543,7 +543,7 @@ func TestCloudflareProxiedOverrideIllegal(t *testing.T) {
 			Targets:    endpoint.Targets{"127.0.0.1"},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				endpoint.ProviderSpecificProperty{
-					Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+					Name:  providerSpecificProxied,
 					Value: "asfasdfa",
 				},
 			},
@@ -594,7 +594,7 @@ func TestCloudflareSetProxied(t *testing.T) {
 				Targets:    endpoint.Targets{"127.0.0.1"},
 				ProviderSpecific: endpoint.ProviderSpecific{
 					endpoint.ProviderSpecificProperty{
-						Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+						Name:  providerSpecificProxied,
 						Value: "true",
 					},
 				},
@@ -932,7 +932,7 @@ func TestCloudflareGroupByNameAndType(t *testing.T) {
 					Labels:     endpoint.Labels{},
 					ProviderSpecific: endpoint.ProviderSpecific{
 						{
-							Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+							Name:  providerSpecificProxied,
 							Value: "false",
 						},
 					},
@@ -966,7 +966,7 @@ func TestCloudflareGroupByNameAndType(t *testing.T) {
 					Labels:     endpoint.Labels{},
 					ProviderSpecific: endpoint.ProviderSpecific{
 						{
-							Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+							Name:  providerSpecificProxied,
 							Value: "false",
 						},
 					},
@@ -1014,7 +1014,7 @@ func TestCloudflareGroupByNameAndType(t *testing.T) {
 					Labels:     endpoint.Labels{},
 					ProviderSpecific: endpoint.ProviderSpecific{
 						{
-							Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+							Name:  providerSpecificProxied,
 							Value: "false",
 						},
 					},
@@ -1027,7 +1027,7 @@ func TestCloudflareGroupByNameAndType(t *testing.T) {
 					Labels:     endpoint.Labels{},
 					ProviderSpecific: endpoint.ProviderSpecific{
 						{
-							Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+							Name:  providerSpecificProxied,
 							Value: "false",
 						},
 					},
@@ -1068,7 +1068,7 @@ func TestCloudflareGroupByNameAndType(t *testing.T) {
 					Labels:     endpoint.Labels{},
 					ProviderSpecific: endpoint.ProviderSpecific{
 						{
-							Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+							Name:  providerSpecificProxied,
 							Value: "false",
 						},
 					},
@@ -1081,7 +1081,7 @@ func TestCloudflareGroupByNameAndType(t *testing.T) {
 					Labels:     endpoint.Labels{},
 					ProviderSpecific: endpoint.ProviderSpecific{
 						{
-							Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+							Name:  providerSpecificProxied,
 							Value: "false",
 						},
 					},
@@ -1122,7 +1122,7 @@ func TestCloudflareGroupByNameAndType(t *testing.T) {
 					Labels:     endpoint.Labels{},
 					ProviderSpecific: endpoint.ProviderSpecific{
 						{
-							Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+							Name:  providerSpecificProxied,
 							Value: "false",
 						},
 					},
@@ -1261,7 +1261,7 @@ func TestCloudflareComplexUpdate(t *testing.T) {
 			Labels:     endpoint.Labels{},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				{
-					Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+					Name:  providerSpecificProxied,
 					Value: "true",
 				},
 			},
@@ -1356,7 +1356,7 @@ func TestCustomTTLWithEnabledProxyNotChanged(t *testing.T) {
 			Labels:     endpoint.Labels{},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				{
-					Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+					Name:  providerSpecificProxied,
 					Value: "true",
 				},
 			},

diff --git a/provider/ibmcloud/ibmcloud.go b/provider/ibmcloud/ibmcloud.go
@@ -965,7 +965,7 @@ func shouldBeProxied(endpoint *endpoint.Endpoint, proxiedByDefault bool) bool {
 		if v.Name == proxyFilter {
 			b, err := strconv.ParseBool(v.Value)
 			if err != nil {
-				log.Errorf("Failed to parse annotation [%s]: %v", proxyFilter, err)
+				log.Errorf("Failed parsing value of %s: %v", proxyFilter, err)
 			} else {
 				proxied = b
 			}

diff --git a/provider/ibmcloud/ibmcloud_test.go b/provider/ibmcloud/ibmcloud_test.go
@@ -161,7 +161,7 @@ func newTestIBMCloudProvider(private bool) *IBMCloudProvider {
 			Targets: endpoint.Targets{"4.3.2.1"},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				{
-					Name:  "ibmcloud-vpc",
+					Name:  vpcFilter,
 					Value: "crn:v1:staging:public:is:us-south:a/0821fa9f9ebcc7b7c9a0d6e9bf9442a4::vpc:be33cdad-9a03-4bfa-82ca-eadb9f1de688",
 				},
 			},
@@ -223,7 +223,7 @@ func TestPublic_ApplyChanges(t *testing.T) {
 				Targets:    endpoint.NewTargets("4.3.2.1"),
 				ProviderSpecific: endpoint.ProviderSpecific{
 					{
-						Name:  "ibmcloud-proxied",
+						Name:  proxyFilter,
 						Value: "false",
 					},
 				},
@@ -237,7 +237,7 @@ func TestPublic_ApplyChanges(t *testing.T) {
 				Targets:    endpoint.NewTargets("1.2.3.4"),
 				ProviderSpecific: endpoint.ProviderSpecific{
 					{
-						Name:  "ibmcloud-proxied",
+						Name:  proxyFilter,
 						Value: "false",
 					},
 				},
@@ -251,7 +251,7 @@ func TestPublic_ApplyChanges(t *testing.T) {
 				Targets:    endpoint.NewTargets("1.2.3.4", "5.6.7.8"),
 				ProviderSpecific: endpoint.ProviderSpecific{
 					{
-						Name:  "ibmcloud-proxied",
+						Name:  proxyFilter,
 						Value: "true",
 					},
 				},
@@ -284,7 +284,7 @@ func TestPrivate_ApplyChanges(t *testing.T) {
 			Targets:    endpoint.NewTargets("4.3.2.1"),
 			ProviderSpecific: endpoint.ProviderSpecific{
 				{
-					Name:  "ibmcloud-vpc",
+					Name:  vpcFilter,
 					Value: "crn:v1:staging:public:is:us-south:a/0821fa9f9ebcc7b7c9a0d6e9bf9442a4::vpc:be33cdad-9a03-4bfa-82ca-eadb9f1de688",
 				},
 			},
@@ -352,7 +352,7 @@ func TestAdjustEndpoints(t *testing.T) {
 			Labels:     endpoint.Labels{},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				{
-					Name:  "ibmcloud-proxied",
+					Name: proxyFilter,
 					Value: "1",
 				},
 			},
@@ -364,7 +364,7 @@ func TestAdjustEndpoints(t *testing.T) {
 
 	assert.Equal(t, endpoint.TTL(0), ep[0].RecordTTL)
 	assert.Equal(t, "test.example.com", ep[0].DNSName)
-	proxied, _ := ep[0].GetProviderSpecificProperty("ibmcloud-proxied")
+	proxied, _ := ep[0].GetProviderSpecificProperty(proxyFilter)
 	assert.Equal(t, "true", proxied)
 }
 

diff --git a/provider/scaleway/scaleway.go b/provider/scaleway/scaleway.go
@@ -36,7 +36,7 @@ import (
 const (
 	scalewyRecordTTL        uint32 = 300
 	scalewayDefaultPriority uint32 = 0
-	scalewayPriorityKey     string = "scw/priority"
+	scalewayPriorityKey     string = "scw-priority"
 )
 
 // ScalewayProvider implements the DNS provider for Scaleway DNS

diff --git a/source/ambassador_host_test.go b/source/ambassador_host_test.go
@@ -247,7 +247,7 @@ func TestAmbassadorHostSource(t *testing.T) {
 					Name: "basic-host",
 					Annotations: map[string]string{
 						ambHostAnnotation:    hostAnnotation,
-						CloudflareProxiedKey: "true",
+						"external-dns.alpha.kubernetes.io/cloudflare-proxied": "true",
 					},
 				},
 				Spec: &ambassador.HostSpec{
@@ -272,7 +272,7 @@ func TestAmbassadorHostSource(t *testing.T) {
 					RecordType: endpoint.RecordTypeA,
 					Targets:    endpoint.Targets{"1.1.1.1"},
 					ProviderSpecific: endpoint.ProviderSpecific{{
-						Name:  "external-dns.alpha.kubernetes.io/cloudflare-proxied",
+						Name:  "cloudflare-proxied",
 						Value: "true",
 					}},
 				},

diff --git a/source/gateway.go b/source/gateway.go
@@ -46,7 +46,7 @@ const (
 	gatewayGroup = "gateway.networking.k8s.io"
 	gatewayKind  = "Gateway"
 	// gatewayAPIDualstackAnnotationKey is the annotation used for determining if a Gateway Route is dualstack
-	gatewayAPIDualstackAnnotationKey = "external-dns.alpha.kubernetes.io/dualstack"
+	gatewayAPIDualstackAnnotationKey = annotationKeyPrefix + "dualstack"
 	// gatewayAPIDualstackAnnotationValue is the value of the Gateway Route dualstack annotation that indicates it is dualstack
 	gatewayAPIDualstackAnnotationValue = "true"
 )

diff --git a/source/gloo_proxy_test.go b/source/gloo_proxy_test.go
@@ -508,7 +508,7 @@ func TestGlooSource(t *testing.T) {
 			Labels:        endpoint.Labels{},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				endpoint.ProviderSpecificProperty{
-					Name:  "aws/geolocation-country-code",
+					Name:  "aws-geolocation-country-code",
 					Value: "LU",
 				},
 			},
@@ -530,7 +530,7 @@ func TestGlooSource(t *testing.T) {
 			Labels:        endpoint.Labels{},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				endpoint.ProviderSpecificProperty{
-					Name:  "aws/geolocation-country-code",
+					Name:  "aws-geolocation-country-code",
 					Value: "JP",
 				},
 			},
@@ -560,7 +560,7 @@ func TestGlooSource(t *testing.T) {
 			Labels:        endpoint.Labels{},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				endpoint.ProviderSpecificProperty{
-					Name:  "aws/geolocation-country-code",
+					Name:  "aws-geolocation-country-code",
 					Value: "ES",
 				},
 			},
@@ -581,7 +581,7 @@ func TestGlooSource(t *testing.T) {
 			Labels:        endpoint.Labels{},
 			ProviderSpecific: endpoint.ProviderSpecific{
 				endpoint.ProviderSpecificProperty{
-					Name:  "aws/geolocation-country-code",
+					Name:  "aws-geolocation-country-code",
 					Value: "IT",
 				},
 			},

diff --git a/source/istio_gateway.go b/source/istio_gateway.go
@@ -40,7 +40,7 @@ import (
 
 // IstioGatewayIngressSource is the annotation used to determine if the gateway is implemented by an Ingress object
 // instead of a standard LoadBalancer service type
-const IstioGatewayIngressSource = "external-dns.alpha.kubernetes.io/ingress"
+const IstioGatewayIngressSource = annotationKeyPrefix + "ingress"
 
 // gatewaySource is an implementation of Source for Istio Gateway objects.
 // The gateway implementation uses the spec.servers.hosts values for the hostnames.