feat(source): optional exclusion of unschedulable nodes #5045
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -7,8 +7,9 @@ The node source adds an `A` record per each node `externalIP` (if not found, any | |
| It also adds an `AAAA` record per each node IPv6 `internalIP`. Refer to the [IPv6 Behavior](#ipv6-behavior) section for more details. | ||
| The TTL of the records can be set with the `external-dns.alpha.kubernetes.io/ttl` node annotation. | ||
|
|
||
| Nodes marked as **Unschedulable** as per [core/v1/NodeSpec](https://pkg.go.dev/k8s.io/[email protected]/core/v1#NodeSpec) are excluded by default. | ||
| As such, no DNS records are created for Unhealthy, NotReady or SchedulingDisabled (cordon) nodes (and existing ones are removed). | ||
| In case you want to override the default, for example if you manage per-host DNS records via ExternalDNS, you can specify `--no-exclude-unschedulable` to always expose nodes no matter their status. | ||
|
|
||
| ## IPv6 Behavior | ||
|
|
||
|
|
||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -83,6 +83,7 @@ func testNodeSourceNewNodeSource(t *testing.T) { | |
| ti.fqdnTemplate, | ||
| labels.Everything(), | ||
| true, | ||
| true, | ||
| ) | ||
|
|
||
| if ti.expectError { | ||
|
|
@@ -99,18 +100,21 @@ func testNodeSourceEndpoints(t *testing.T) { | |
| t.Parallel() | ||
|
|
||
| for _, tc := range []struct { | ||
| title string | ||
| annotationFilter string | ||
| labelSelector string | ||
| fqdnTemplate string | ||
| nodeName string | ||
| nodeAddresses []v1.NodeAddress | ||
| labels map[string]string | ||
| annotations map[string]string | ||
| excludeUnschedulable bool // default to false | ||
| exposeInternalIPv6 bool // default to true for this version. Change later when the next minor version is released. | ||
| unschedulable bool // default to false | ||
| expected []*endpoint.Endpoint | ||
| expectError bool | ||
| expectedLogs []string | ||
| expectedAbsentLogs []string | ||
| }{ | ||
| { | ||
| title: "node with short hostname returns one endpoint", | ||
|
|
@@ -363,16 +367,40 @@ func testNodeSourceEndpoints(t *testing.T) { | |
| }, | ||
| }, | ||
| { | ||
| title: "unschedulable node return nothing with excludeUnschedulable=true", | ||
| nodeName: "node1", | ||
| exposeInternalIPv6: true, | ||
| nodeAddresses: []v1.NodeAddress{{Type: v1.NodeExternalIP, Address: "1.2.3.4"}}, | ||
| unschedulable: true, | ||
| excludeUnschedulable: true, | ||
| expected: []*endpoint.Endpoint{}, | ||
| expectedLogs: []string{ | ||
| "Skipping node node1 because it is unschedulable", | ||
| }, | ||
| }, | ||
| { | ||
| title: "unschedulable node returns node with excludeUnschedulable=false", | ||
| nodeName: "node1", | ||
| nodeAddresses: []v1.NodeAddress{{Type: v1.NodeExternalIP, Address: "1.2.3.4"}}, | ||
| unschedulable: true, | ||
| excludeUnschedulable: false, | ||
| expected: []*endpoint.Endpoint{ | ||
| {RecordType: "A", DNSName: "node1", Targets: endpoint.Targets{"1.2.3.4"}}, | ||
| }, | ||
| expectedAbsentLogs: []string{ | ||
| "Skipping node node1 because it is unschedulable", | ||
| }, | ||
| }, | ||
| } { | ||
| tc := tc | ||
| t.Run(tc.title, func(t *testing.T) { | ||
| var buf *bytes.Buffer | ||
| if len(tc.expectedLogs) == 0 && len(tc.expectedAbsentLogs) == 0 { | ||
| t.Parallel() | ||
| } else { | ||
| buf = testutils.LogsToBuffer(log.DebugLevel, t) | ||
| } | ||
|
Comment on lines
+397
to
+402
There was a problem hiding this comment. There is a random data race since this PR has been merged, which can be seen on other PRs. @ivankatliarchuk Do you think this section can be a potential cause ? There was a problem hiding this comment. I opened a small PR which should fix the CI, see #5268 There was a problem hiding this comment. I'll review the whole |
||
|
|
||
| labelSelector := labels.Everything() | ||
| if tc.labelSelector != "" { | ||
| var err error | ||
|
|
@@ -408,6 +436,7 @@ func testNodeSourceEndpoints(t *testing.T) { | |
| tc.fqdnTemplate, | ||
| labelSelector, | ||
| tc.exposeInternalIPv6, | ||
| tc.excludeUnschedulable, | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
|
|
@@ -420,24 +449,33 @@ func testNodeSourceEndpoints(t *testing.T) { | |
|
|
||
| // Validate returned endpoints against desired endpoints. | ||
| validateEndpoints(t, endpoints, tc.expected) | ||
|
|
||
| for _, entry := range tc.expectedLogs { | ||
| assert.Contains(t, buf.String(), entry) | ||
| } | ||
|
|
||
| for _, entry := range tc.expectedAbsentLogs { | ||
| assert.NotContains(t, buf.String(), entry) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func testNodeEndpointsWithIPv6(t *testing.T) { | ||
| for _, tc := range []struct { | ||
| title string | ||
| annotationFilter string | ||
| labelSelector string | ||
| fqdnTemplate string | ||
| nodeName string | ||
| nodeAddresses []v1.NodeAddress | ||
| labels map[string]string | ||
| annotations map[string]string | ||
| excludeUnschedulable bool // defaults to false | ||
| exposeInternalIPv6 bool // default to true for this version. Change later when the next minor version is released. | ||
| unschedulable bool // default to false | ||
| expected []*endpoint.Endpoint | ||
| expectError bool | ||
| }{ | ||
| { | ||
| title: "node with only internal IPs should return internal IPvs irrespective of exposeInternalIPv6", | ||
|
|
@@ -516,6 +554,7 @@ func testNodeEndpointsWithIPv6(t *testing.T) { | |
| tc.fqdnTemplate, | ||
| labelSelector, | ||
| tc.exposeInternalIPv6, | ||
| tc.excludeUnschedulable, | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
|
|
||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add tests that capture debug logging?
external-dns/internal/testutils/log.go
Line 36 in e64e536
You could search for example usages in the code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the late response, but I've been pretty busy the last couple weeks.
I've now added an example of how this could be implemented in the existing test method (which would allow the other testcases to check for logs, as well. Not quite ideal, as this requires disabling parallelism for these testcases, but the alternative would be having to duplicate more of the test logic, which I'm not really a fan of, either.