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: Update Documentation on Deny Policy Bug Fix #23468
docs: Update Documentation on Deny Policy Bug Fix #23468
Conversation
b71217a
to
50c4368
Compare
blocked by #22966 |
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.
Commit log: s/remenant/remnant/
Do we need to keep the warning at all? The limitation should still be visible in earlier versions of the docs. I don't think we usually keep documenting former limitations after they've been addressed on newer versions?
I'm moving this to draft as it's blocked on another PR. @nathanjsweet Feel free to mark it as ready for review once 22966 is merged.
|
50c4368
to
5e15273
Compare
5e15273
to
90e608c
Compare
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.
Same comment as Quentin.
90e608c
to
03e893d
Compare
cilium issue "15198" required Cilium to document the shortcoming of CIDR deny policies. Since the bug has been fixed this documentation is incorrect, it should be removed with a remenant warning about the shortcoming in prior versions. Signed-off-by: Nate Sweet <nathanjsweet@pm.me>
03e893d
to
18da496
Compare
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.
I'm fine with this. I agree that the version of the docs generated from this page will be for 1.14, so typically we don't document the behaviour of earlier versions in the newer docs.. but I also don't think it hurts to be a little more explicit. Sometimes users will read one version of the docs, then search for the corresponding section in a newer version and get confused about whether the issue still applies, because the newer docs don't have an explicit section to describe that the previous limitation no longer exists.
Presumably we'll want to strip out this statement at some point in future when we no longer support the older versions. That said, given that this text references 1.14
, it should be easy enough for us to find any such references in future in order to clean them up when we want to do so.
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.
Thanks!
@nathanjsweet does this need to be backported to older branches and maybe with the version edited, since #22966 was backported? Currently the v1.13 docs present that known issue which is probably no longer a limitation? |
docs: Update Documentation on Deny Policy Bug Fix
#15198 required Cilium to document the shortcoming
of CIDR deny policies. Since the bug has been fixed
this documentation is incorrect, it should be removed
with a remenant warning about the shortcoming in
prior versions.
Signed-off-by: Nate Sweet nathanjsweet@pm.me