mirror of
https://github.com/kubernetes-sigs/external-dns.git
synced 2026-01-22 03:11:06 +01:00
5a55b09f48
* feat(annotations): add custom annotation prefix support for split horizon DNS Add --annotation-prefix flag to allow customizing the annotation prefix used by external-dns. This enables split horizon DNS scenarios where multiple instances process different sets of annotations from the same Kubernetes resources. Changes: - Add AnnotationPrefix field to Config with validation - Convert annotation constants to variables that can be reconfigured - Add SetAnnotationPrefix() function to rebuild annotation keys - Integrate annotation prefix setting in controller startup - Update Helm chart with annotationPrefix value - Add comprehensive split horizon DNS documentation - Update FAQ with annotation prefix examples This maintains full backward compatibility - the default prefix remains "external-dns.alpha.kubernetes.io/". Co-Authored-By: Claude <noreply@anthropic.com> * docs(advanced): fix markdown formatting in split-horizon guide Add blank lines before code blocks to improve markdown rendering and comply with markdownlint rules. Co-Authored-By: Claude <noreply@anthropic.com> * docs(advanced): fix markdown formatting in split-horizon guide Co-Authored-By: Claude <noreply@anthropic.com> * docs(charts): regenerate Helm chart documentation Co-Authored-By: Claude <noreply@anthropic.com> * test: add AnnotationPrefix field to test configs Add missing AnnotationPrefix field to minimalConfig and overriddenConfig test configurations to match the new default value set in NewConfig(). Co-Authored-By: Claude <noreply@anthropic.com> * test(charts): update error pattern in json-schema test Update expected error message pattern to match current Helm validation output format. Co-Authored-By: Claude <noreply@anthropic.com> * refactor(annotations): remove init() for explicit initialization - Remove init() function from annotations package - Add explicit SetAnnotationPrefix() call in controller/execute.go - Remove annotation key aliases from source/source.go - Replace all alias usages with annotations.* references (348 changes in 28 files) - Add TestMain to existing test files (service_test.go, cloudflare_test.go) This change makes annotation initialization explicit and predictable, avoiding hidden global state initialization at import time. Co-Authored-By: Claude <noreply@anthropic.com> * docs: update changelog and mkdocs to include annotationPrefix and split horizon DNS Signed-off-by: Aleksei Sviridkin <f@lex.la> * docs(split-horizon): fix linting Signed-off-by: Aleksei Sviridkin <f@lex.la> * refactor(annotations): replace hardcoded annotation prefix with constant Replace all hardcoded "external-dns.alpha.kubernetes.io/" strings with annotations.DefaultAnnotationPrefix constant to establish a single source of truth. Changes: - Add DefaultAnnotationPrefix constant in source/annotations/annotations.go - Replace hardcoded string in controller/execute.go with constant reference - Replace hardcoded strings in pkg/apis/externaldns/types.go (2 occurrences) - Add helm unit tests for annotationPrefix value This eliminates string duplication and makes future changes easier. Co-Authored-By: Claude <noreply@anthropic.com> --------- Signed-off-by: Aleksei Sviridkin <f@lex.la> Co-authored-by: Claude <noreply@anthropic.com>
102 lines
4.0 KiB
Go
102 lines
4.0 KiB
Go
/*
|
|
Copyright 2025 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 annotations
|
|
|
|
import (
|
|
"math"
|
|
)
|
|
|
|
const (
|
|
// DefaultAnnotationPrefix is the default annotation prefix used by external-dns
|
|
DefaultAnnotationPrefix = "external-dns.alpha.kubernetes.io/"
|
|
|
|
ttlMinimum = 1
|
|
ttlMaximum = math.MaxInt32
|
|
)
|
|
|
|
var (
|
|
// AnnotationKeyPrefix is set on all annotations consumed by external-dns (outside of user templates)
|
|
// to provide easy filtering. Can be customized via SetAnnotationPrefix.
|
|
AnnotationKeyPrefix = DefaultAnnotationPrefix
|
|
|
|
// CloudflareProxiedKey The annotation used for determining if traffic will go through Cloudflare
|
|
CloudflareProxiedKey string
|
|
CloudflareCustomHostnameKey string
|
|
CloudflareRegionKey string
|
|
CloudflareRecordCommentKey string
|
|
CloudflareTagsKey string
|
|
|
|
AWSPrefix string
|
|
CoreDNSPrefix string
|
|
SCWPrefix string
|
|
WebhookPrefix string
|
|
CloudflarePrefix string
|
|
|
|
TtlKey string
|
|
SetIdentifierKey string
|
|
AliasKey string
|
|
TargetKey string
|
|
// ControllerKey The annotation used for figuring out which controller is responsible
|
|
ControllerKey string
|
|
// HostnameKey The annotation used for defining the desired hostname
|
|
HostnameKey string
|
|
// AccessKey The annotation used for specifying whether the public or private interface address is used
|
|
AccessKey string
|
|
// EndpointsTypeKey The annotation used for specifying the type of endpoints to use for headless services
|
|
EndpointsTypeKey string
|
|
// Ingress the annotation used to determine if the gateway is implemented by an Ingress object
|
|
Ingress string
|
|
// IngressHostnameSourceKey The annotation used to determine the source of hostnames for ingresses. This is an optional field - all
|
|
// available hostname sources are used if not specified.
|
|
IngressHostnameSourceKey string
|
|
// ControllerValue The value of the controller annotation so that we feel responsible
|
|
ControllerValue = "dns-controller"
|
|
// InternalHostnameKey The annotation used for defining the desired hostname
|
|
InternalHostnameKey string
|
|
)
|
|
|
|
// SetAnnotationPrefix sets a custom annotation prefix and rebuilds all annotation keys.
|
|
// This must be called before any sources are initialized.
|
|
// The prefix must end with '/'.
|
|
func SetAnnotationPrefix(prefix string) {
|
|
AnnotationKeyPrefix = prefix
|
|
|
|
// Cloudflare annotations
|
|
CloudflareProxiedKey = AnnotationKeyPrefix + "cloudflare-proxied"
|
|
CloudflareCustomHostnameKey = AnnotationKeyPrefix + "cloudflare-custom-hostname"
|
|
CloudflareRegionKey = AnnotationKeyPrefix + "cloudflare-region-key"
|
|
CloudflareRecordCommentKey = AnnotationKeyPrefix + "cloudflare-record-comment"
|
|
CloudflareTagsKey = AnnotationKeyPrefix + "cloudflare-tags"
|
|
|
|
// Provider prefixes
|
|
AWSPrefix = AnnotationKeyPrefix + "aws-"
|
|
CoreDNSPrefix = AnnotationKeyPrefix + "coredns-"
|
|
SCWPrefix = AnnotationKeyPrefix + "scw-"
|
|
WebhookPrefix = AnnotationKeyPrefix + "webhook-"
|
|
CloudflarePrefix = AnnotationKeyPrefix + "cloudflare-"
|
|
|
|
// Core annotations
|
|
TtlKey = AnnotationKeyPrefix + "ttl"
|
|
SetIdentifierKey = AnnotationKeyPrefix + "set-identifier"
|
|
AliasKey = AnnotationKeyPrefix + "alias"
|
|
TargetKey = AnnotationKeyPrefix + "target"
|
|
ControllerKey = AnnotationKeyPrefix + "controller"
|
|
HostnameKey = AnnotationKeyPrefix + "hostname"
|
|
AccessKey = AnnotationKeyPrefix + "access"
|
|
EndpointsTypeKey = AnnotationKeyPrefix + "endpoints-type"
|
|
Ingress = AnnotationKeyPrefix + "ingress"
|
|
IngressHostnameSourceKey = AnnotationKeyPrefix + "ingress-hostname-source"
|
|
InternalHostnameKey = AnnotationKeyPrefix + "internal-hostname"
|
|
}
|