Skip to content

docs: Deprecate Requires Fields #36649

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 15, 2025
Merged

docs: Deprecate Requires Fields #36649

merged 1 commit into from
Jan 15, 2025

Conversation

nathanjsweet
Copy link
Member

The toRequires and fromRequires fields cause confusion.
The requires fields also
can accumulate across policy as a global union. This
needs to be more intuitive and can cause problems as cluster
operators need to know what all extant requires labels
are to know the overall effect they will have.

Fixes: #issue-number

policy: Deprecating the `toRequires` and `fromRequires` fields in network policies.

@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 Dec 16, 2024
@nathanjsweet
docs: Deprecate Requires Fields
a1f3d18 
The toRequires and fromRequires fields cause confusion
and are not apparently useful in ways beyond what can
be done with matchLabels. The requires fields also
can accumulate across policy as a global union. This
is not intuitive and can cause problems as cluster
operators need to know what all extant requires labels
are in order to know the overall effect they will have.

Signed-off-by: Nate Sweet <nathanjsweet@pm.me>
@nathanjsweet nathanjsweet force-pushed the pr/nathanjsweet/deprecate-requires-fields branch from 171e071 to a1f3d18 Compare January 13, 2025 21:27
@nathanjsweet nathanjsweet added the release-note/misc This PR makes changes that have no direct user impact. label Jan 13, 2025
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jan 13, 2025
@nathanjsweet nathanjsweet marked this pull request as ready for review January 13, 2025 21:28
@nathanjsweet nathanjsweet requested review from a team as code owners January 13, 2025 21:28
@nathanjsweet nathanjsweet added needs-backport/1.17 This PR / issue needs backporting to the v1.17 branch release-blocker/1.17 This issue will prevent the release of the next version of Cilium. labels Jan 13, 2025
@joestringer joestringer added this to the 1.17 milestone Jan 13, 2025
qmonnet
qmonnet approved these changes Jan 14, 2025
View reviewed changes
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.

Change looks good, but don't we also need some log message to warn users that would keep using them?

@qmonnet
Copy link
Member

qmonnet commented Jan 14, 2025

/test

@aanm aanm added this pull request to the merge queue Jan 15, 2025
Merged via the queue into main with commit 4b61a2b Jan 15, 2025
67 checks passed
@aanm aanm deleted the pr/nathanjsweet/deprecate-requires-fields branch January 15, 2025 16:22
@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jan 15, 2025
@rastislavs rastislavs mentioned this pull request Jan 21, 2025
Merged
45 tasks
@rastislavs rastislavs added backport-pending/1.17 The backport for Cilium 1.17.x for this PR is in progress. and removed needs-backport/1.17 This PR / issue needs backporting to the v1.17 branch labels Jan 21, 2025
@github-actions github-actions bot added backport-done/1.17 The backport for Cilium 1.17.x for this PR is done. and removed backport-pending/1.17 The backport for Cilium 1.17.x for this PR is in progress. labels Jan 22, 2025
@cilium-release-bot cilium-release-bot bot mentioned this pull request Jan 24, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gandro gandro gandro approved these changes

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
backport-done/1.17 The backport for Cilium 1.17.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-blocker/1.17 This issue will prevent the release of the next version of Cilium. release-note/misc This PR makes changes that have no direct user impact.
Projects
Release blockers
Archived in project
Milestone
1.17
Development

Successfully merging this pull request may close these issues.
6 participants
@nathanjsweet @qmonnet @gandro @joestringer @aanm @rastislavs