-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs(proposal): ipv6 internal node ip rollback plan #5081
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
k8s-ci-robot
merged 9 commits into
kubernetes-sigs:master
from
gofogo:docs-proposal-ipv6-internal-node-ip-rollback
Feb 27, 2025
Merged
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
6cbd402
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk 4e4e03e
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk 5c3f6c6
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk 8390aec
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk 8f582a7
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk fbd4210
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk 4e4642f
Merge branch 'master' into docs-proposal-ipv6-internal-node-ip-rollback
ivankatliarchuk 40e7e6e
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk 5198679
docs(proposal): ipv6 internal node ip rollback plan
ivankatliarchuk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <!-- clone me --> | ||
| ```yaml | ||
| --- | ||
| title: "Proposal: Rollback IPv6 internal Node IP exposure" | ||
| version: if applicable | ||
| authors: https://github.com/ivankatliarchuk | ||
| creation-date: 2025-01-01 | ||
| status: proposal | ||
| --- | ||
| ``` | ||
|
|
||
| # Introduce Feature Flag for IPv6 Internal Node IP Handling in ''external-dns'' and Change the behavior | ||
|
|
||
| ## Summary | ||
|
|
||
| This proposal aims to introduce a feature flag in 'external-dns' to control the handling of IPv6 internal node IPs. In the current version, the feature flag will default to the existing behavior. In the next `minor` or `minor+N` version, the default behavior will be reversed, encouraging users to adopt the new behavior while providing a transition period. | ||
|
|
||
| ## Motivation | ||
|
|
||
| The discussion in [issue#4566](https://github.com/kubernetes-sigs/external-dns/issues/4566) and the subsequent [pr#4574](https://github.com/kubernetes-sigs/external-dns/pull/4574) and [pr#4808](https://github.com/kubernetes-sigs/external-dns/pull/4808) highlighted concerns regarding the treatment of IPv6 internal node IPs. To address these concerns without causing immediate disruption, a feature flag will allow users to opt-out the current behavior, providing flexibility during the transition. | ||
|
|
||
| ## Proposal | ||
|
|
||
| - ***Introduce Feature Flag*** | ||
| - Add a feature flag, e.g., `--expose-internal-ipv6=true`, to control the handling of IPv6 internal node IPs. | ||
| - In the current version, this flag will default to `true`, maintaining the existing behavior. | ||
|
|
||
| - ***Flip Default Behavior in Next Minor Version*** | ||
| - In the subsequent minor release, change the default value of `--expose-internal-ipv6` to `false`, adopting the new behavior by default. | ||
| - Users can still override this behavior by explicitly setting the flag as needed. | ||
|
|
||
| - ***Propose/Add an annotation for this specific use case*** | ||
| - Provide support for `external-dns.alpha.kubernetes.io/expose-internal-ipv6` in follow-up releases. | ||
| - Managing dual annotation and flag may introduce complexity. | ||
|
|
||
| Proposed Changes in `source/node.go` file. | ||
|
|
||
| ```go | ||
| // IPv6 addresses are labeled as NodeInternalIP despite being usable externally as well. | ||
| if addr.Type == v1.NodeInternalIP && ns.exposeInternalIP && ... { | ||
| pv6Addresses = append(ipv6Addresses, addr.Address) | ||
| } | ||
| ``` | ||
|
|
||
| ## User Stories | ||
|
|
||
| _As a cluster Operator or Administrator_, I want to control the handling of IPv6 internal node IPs to align with defined network topology and configuration. | ||
|
|
||
| _As a SecDevOps_, I want to ensure that `external-dns` does not expose internal IPv6 node addresses via public DNS records, so that I can prevent unintended data leaks and reduce the attack surface of my Kubernetes cluster. | ||
|
|
||
| _As a SecDevOps_, I want to use a feature flag to selectively enable or disable the new IPv6 behavior in `external-dns`, so that I can evaluate its security impact before it becomes the default setting in future releases. | ||
|
|
||
| _As a SecDevOps_, I want to use a feature flag to selectively enable or disable the new IPv6 behavior in `external-dns`, so that I can detect misconfigurations, act on potential security incidents, and ensure compliance with security policies. | ||
|
|
||
| ## Implementation Steps | ||
|
|
||
| - Code Changes: | ||
| * Implement the feature flag in the 'external-dns' codebase to toggle the handling of IPv6 internal node IPs. | ||
|
|
||
| - Documentation: | ||
| * Update the 'external-dns' documentation to include information about the feature flag, its purpose, and usage examples. | ||
|
|
||
| ## Drawbacks | ||
|
|
||
| - Introducing a feature flag adds complexity to the configuration and codebase. | ||
| - Changing default behavior in a future release may still cause issues for users who are unaware of the change. | ||
|
|
||
| ## Alternatives | ||
|
|
||
| - ***Immediate Behavior Change*** | ||
| - Directly change the behavior without a feature flag, which could lead to unexpected issues for users. | ||
| - ***No Change*** | ||
| - Maintain the current behavior, potentially leaving the concerns unaddressed. | ||
| - Users may not be able to update an `external-dns` version due to security, compliance or any other concerns. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
FTM, I think I have a strong opinion against this annotation with its induced complexity.
My head hurts just trying to imagine a use case requiring this level of complexity.
Please let me know if you think you have a good one, otherwise I suggest to avoid this complexity, at least FTM.
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.
Moved to non-goal section. Basically it was based on issue and from discussion. I have no strong opinion on that stuff.
Uh oh!
There was an error while loading. Please reload this page.
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.
Just for reference, when it was proposed by maintainer
But reading more thread, could be a bit controversial