Skip to content
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

docs: Clarify use of the eni.subnetTagsFilter option #19276

Merged
merged 1 commit into from
Apr 1, 2022

Conversation

gandro
Copy link
Member

@gandro gandro commented Mar 30, 2022

The eni.subnetTagsFilter option is notoriously hard to use correctly.
If it is used with tags that don't match the subnet of the pre-attached
ENI, Cilium agent will never become ready (#18239).

This PR removes it from the ENI documentation (which most users will use
as a reference configuration) such that no one enables this option
without being aware of its requirements. This PR also adds additional
context the Helm value. We might deprecate and remove the option in the
future as well (#19181).

Signed-off-by: Sebastian Wicki sebastian@isovalent.com

@gandro gandro added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/eni Impacts ENI based IPAM. release-note/misc This PR makes changes that have no direct user impact. labels Mar 30, 2022
@gandro gandro requested a review from a team March 30, 2022 14:37
@gandro gandro requested a review from a team as a code owner March 30, 2022 14:37
@gandro gandro requested a review from a team March 30, 2022 14:37
@gandro gandro requested review from a team as code owners March 30, 2022 14:37
The `eni.subnetTagsFilter` option is notoriously hard to use correctly.
If it is used with tags that don't match the subnet of the pre-attached
ENI, Cilium agent will never become ready (cilium#18239).

This PR removes it from the ENI documentation (which most users will use
as a reference configuration) such that no one enables this option
without being aware of its requirements. This PR also adds additional
context the Helm value. We might deprecate and remove the option in the
future as well (cilium#19181).

Signed-off-by: Sebastian Wicki <sebastian@isovalent.com>
Copy link
Member

@sayboras sayboras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@gandro gandro mentioned this pull request Apr 1, 2022
6 tasks
@borkmann borkmann added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Apr 1, 2022
@nbusseneau nbusseneau added backport-done/1.10 backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. and removed backport-pending/1.10 labels Apr 12, 2022
@nbusseneau
Copy link
Member

@gandro I am dropping the backport to v1.9 because this PR cannot be applied on top of v1.9 due to missing (at least) the structure changes introduced by #15695 in v1.10. If we need this in v1.9 then we need first to backport the dependent PRs :)

@gandro
Copy link
Member Author

gandro commented Apr 12, 2022

Thanks for the heads up. I'll do a manual backport, thanks.

I don't think we need the dependent PR (which is a breaking change, thus cannot be backported) as all of this is docs only, just need to find the proper place to add the Helm docs.

@gandro
Copy link
Member Author

gandro commented Apr 12, 2022

Oh, I confused some PRs here. Looking at the current v1.9 branch, yeah I agree that the backport is not needed. Sorry for the noise 🙇‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/eni Impacts ENI based IPAM. backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.