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: Update Documentation on Deny Policy Bug Fix #23468

Merged

Conversation

nathanjsweet
Copy link
Member

@nathanjsweet nathanjsweet commented Jan 30, 2023

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

@nathanjsweet nathanjsweet requested review from a team as code owners January 30, 2023 18:02
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jan 30, 2023
@nathanjsweet nathanjsweet added release-note/misc This PR makes changes that have no direct user impact. and removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Jan 30, 2023
@nathanjsweet nathanjsweet force-pushed the pr/nathanjsweet/reframe-cidr-deny-bug-documentation branch from b71217a to 50c4368 Compare January 30, 2023 18:05
@nathanjsweet nathanjsweet added the dont-merge/blocked Another PR must be merged before this one. label Jan 30, 2023
@nathanjsweet
Copy link
Member Author

blocked by #22966

Copy link
Member

@qmonnet qmonnet left a 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?

Documentation/security/policy/language.rst Outdated Show resolved Hide resolved
@aditighag
Copy link
Member

aditighag commented Feb 3, 2023

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.

blocked by #22966

@aditighag aditighag marked this pull request as draft February 3, 2023 17:12
@nathanjsweet nathanjsweet force-pushed the pr/nathanjsweet/reframe-cidr-deny-bug-documentation branch from 50c4368 to 5e15273 Compare February 13, 2023 18:34
@nathanjsweet nathanjsweet marked this pull request as ready for review February 13, 2023 18:34
@nathanjsweet nathanjsweet removed the dont-merge/blocked Another PR must be merged before this one. label Feb 13, 2023
@nathanjsweet nathanjsweet force-pushed the pr/nathanjsweet/reframe-cidr-deny-bug-documentation branch from 5e15273 to 90e608c Compare February 13, 2023 18:36
Copy link
Member

@aditighag aditighag left a 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.

@nathanjsweet nathanjsweet force-pushed the pr/nathanjsweet/reframe-cidr-deny-bug-documentation branch from 90e608c to 03e893d Compare February 14, 2023 20:12
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>
@nathanjsweet nathanjsweet force-pushed the pr/nathanjsweet/reframe-cidr-deny-bug-documentation branch from 03e893d to 18da496 Compare February 14, 2023 20:34
Copy link
Member

@joestringer joestringer left a 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.

Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks!

@nathanjsweet nathanjsweet added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Feb 15, 2023
@pchaigno pchaigno merged commit 9e00c0c into master Feb 15, 2023
@pchaigno pchaigno deleted the pr/nathanjsweet/reframe-cidr-deny-bug-documentation branch February 15, 2023 21:50
@joestringer
Copy link
Member

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

None yet

5 participants