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.

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

docs: Improve wording for labels and services policies #27171

Merged
merged 2 commits into from Aug 30, 2023
Merged

docs: Improve wording for labels and services policies #27171

merged 2 commits into from Aug 30, 2023

Conversation

joestringer
Copy link
Member

Based on user feedback, improve the way that this documentation reads in order
to clarify how these policy types apply to Cilium objects.

  • docs: Rename Labels-based endpoint policies
  • docs: Move services note about applicability higher

@joestringer joestringer requested review from a team as code owners July 31, 2023 23:36
@joestringer joestringer added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.12 needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Jul 31, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. and removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Jul 31, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.12.13 Jul 31, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.14.1 Jul 31, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.13.6 Jul 31, 2023
@joestringer
Copy link
Member Author

/test

@joestringer
Copy link
Member Author

/test

@maintainer-s-little-helper maintainer-s-little-helper bot removed this from Needs backport from main in 1.12.13 Jul 31, 2023
learnitall
learnitall reviewed Aug 2, 2023
View reviewed changes
Copy link
Contributor

@learnitall learnitall left a comment

Choose a reason for hiding this comment

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

LGTM, pending one quick question. Thanks!

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

/test

learnitall
learnitall approved these changes Aug 2, 2023
View reviewed changes
Copy link
Contributor

@learnitall learnitall left a comment

Choose a reason for hiding this comment

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

Thanks!

@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 Aug 3, 2023
nathanjsweet
nathanjsweet reviewed Aug 3, 2023
View reviewed changes
Copy link
Member

@nathanjsweet nathanjsweet left a comment

Choose a reason for hiding this comment

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

nits.

Documentation/security/policy/language.rst Outdated Show resolved Hide resolved
Documentation/security/policy/language.rst Outdated Show resolved Hide resolved
Documentation/security/policy/language.rst Outdated Show resolved Hide resolved
@joestringer joestringer marked this pull request as draft August 3, 2023 18:02
@ldelossa
Copy link
Contributor

ldelossa commented Aug 7, 2023

PR is in draft, going to remove ready-to-merge label.

@ldelossa ldelossa removed the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Aug 7, 2023
@nebril nebril added this to Needs backport from main in 1.13.7 Aug 10, 2023
@nebril nebril removed this from Needs backport from main in 1.13.6 Aug 10, 2023
@nebril nebril added this to Needs backport from main in 1.14.2 Aug 10, 2023
@nebril nebril removed this from Needs backport from main in 1.14.1 Aug 10, 2023
joestringer and others added 2 commits August 29, 2023 16:21
@joestringer @nathanjsweet
docs: Rename Labels-based endpoint policies
605d7f8 
A user pointed out that what we call "Labels-based" policies are
actually matching the labels on Endpoints, but also explicitly *not*
matching labels on Services. To make this more clear, change the name
in the docs to Endpoints based policies.

Co-authored-by: Nathan Sweet <nathanjsweet@users.noreply.github.com>
Signed-off-by: Joe Stringer <joe@cilium.io>
@joestringer
docs: Move services note about applicability higher
6633dda 
A user pointed out that the position of this callout made it seem like
the callout only applies to the first example rather than applying to
all Services based policies. Move the callout to the top of the section
to make the relationship clearer.

Signed-off-by: Joe Stringer <joe@cilium.io>
@joestringer joestringer marked this pull request as ready for review August 29, 2023 23:22
@joestringer
Copy link
Member Author

/test

@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 Aug 29, 2023
@borkmann borkmann merged commit 38b4a32 into main Aug 30, 2023
56 checks passed
@borkmann borkmann deleted the pr/joe/service-policy branch August 30, 2023 17:24
@jibi jibi mentioned this pull request Sep 4, 2023
Merged
16 tasks
@jibi jibi added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Sep 4, 2023
@jibi jibi mentioned this pull request Sep 4, 2023
Merged
10 tasks
@jibi jibi added backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. and removed needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch labels Sep 4, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.14 in 1.14.2 Sep 4, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.13 in 1.13.7 Sep 4, 2023
@jibi jibi added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Sep 7, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.14 to Backport done to v1.14 in 1.14.2 Sep 7, 2023
@michi-covalent michi-covalent mentioned this pull request Sep 9, 2023
Merged
@michi-covalent michi-covalent added backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. and removed backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. labels Sep 9, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.13 to Backport done to v1.13 in 1.13.7 Sep 9, 2023
@michi-covalent michi-covalent mentioned this pull request Sep 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nathanjsweet nathanjsweet nathanjsweet approved these changes

@learnitall learnitall learnitall approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. backport-done/1.14 The backport for Cilium 1.14.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
No open projects
1.13.7
Backport done to v1.13
1.14.2
Backport done to v1.14
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@joestringer @ldelossa @nathanjsweet @learnitall @jibi @borkmann @michi-covalent