mirror of
https://github.com/kubernetes-sigs/external-dns.git
synced 2025-12-02 10:21:00 +01:00
* 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>
104 lines
3.2 KiB
Go
104 lines
3.2 KiB
Go
/*
|
|
Copyright 2021 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 source
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
corev1 "k8s.io/api/core/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
kubefake "k8s.io/client-go/kubernetes/fake"
|
|
"sigs.k8s.io/external-dns/endpoint"
|
|
"sigs.k8s.io/external-dns/source/annotations"
|
|
v1 "sigs.k8s.io/gateway-api/apis/v1"
|
|
"sigs.k8s.io/gateway-api/apis/v1alpha2"
|
|
v1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"
|
|
gatewayfake "sigs.k8s.io/gateway-api/pkg/client/clientset/versioned/fake"
|
|
)
|
|
|
|
func TestGatewayTCPRouteSourceEndpoints(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
gwClient := gatewayfake.NewSimpleClientset()
|
|
kubeClient := kubefake.NewSimpleClientset()
|
|
clients := new(MockClientGenerator)
|
|
clients.On("GatewayClient").Return(gwClient, nil)
|
|
clients.On("KubeClient").Return(kubeClient, nil)
|
|
|
|
ctx := context.Background()
|
|
ns := &corev1.Namespace{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: "default",
|
|
},
|
|
}
|
|
_, err := kubeClient.CoreV1().Namespaces().Create(ctx, ns, metav1.CreateOptions{})
|
|
require.NoError(t, err, "failed to create Namespace")
|
|
|
|
ips := []string{"10.64.0.1", "10.64.0.2"}
|
|
gw := &v1beta1.Gateway{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: "internal",
|
|
Namespace: "default",
|
|
},
|
|
Spec: v1.GatewaySpec{
|
|
Listeners: []v1.Listener{{
|
|
Protocol: v1.TCPProtocolType,
|
|
}},
|
|
},
|
|
Status: gatewayStatus(ips...),
|
|
}
|
|
_, err = gwClient.GatewayV1beta1().Gateways(gw.Namespace).Create(ctx, gw, metav1.CreateOptions{})
|
|
require.NoError(t, err, "failed to create Gateway")
|
|
|
|
rt := &v1alpha2.TCPRoute{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: "api",
|
|
Namespace: "default",
|
|
Annotations: map[string]string{
|
|
annotations.HostnameKey: "api-annotation.foobar.internal",
|
|
},
|
|
},
|
|
Spec: v1alpha2.TCPRouteSpec{
|
|
CommonRouteSpec: v1.CommonRouteSpec{
|
|
ParentRefs: []v1.ParentReference{
|
|
gwParentRef("default", "internal"),
|
|
},
|
|
},
|
|
},
|
|
Status: v1alpha2.TCPRouteStatus{
|
|
RouteStatus: gwRouteStatus(gwParentRef("default", "internal")),
|
|
},
|
|
}
|
|
_, err = gwClient.GatewayV1alpha2().TCPRoutes(rt.Namespace).Create(ctx, rt, metav1.CreateOptions{})
|
|
require.NoError(t, err, "failed to create TCPRoute")
|
|
|
|
src, err := NewGatewayTCPRouteSource(clients, &Config{
|
|
FQDNTemplate: "{{.Name}}-template.foobar.internal",
|
|
CombineFQDNAndAnnotation: true,
|
|
})
|
|
require.NoError(t, err, "failed to create Gateway TCPRoute Source")
|
|
|
|
endpoints, err := src.Endpoints(ctx)
|
|
require.NoError(t, err, "failed to get Endpoints")
|
|
validateEndpoints(t, endpoints, []*endpoint.Endpoint{
|
|
newTestEndpoint("api-annotation.foobar.internal", "A", ips...),
|
|
newTestEndpoint("api-template.foobar.internal", "A", ips...),
|
|
})
|
|
}
|