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: reword incorrect L7 policy description #26092

Merged
merged 1 commit into from
Jun 20, 2023
Merged

docs: reword incorrect L7 policy description #26092

merged 1 commit into from
Jun 20, 2023

Conversation

peterj
Copy link
Contributor

@peterj peterj commented Jun 9, 2023

Remove the extra $ characters in the paths (I didn't see this documented anywhere, so I am assuming it might be a left over from previous versions?).

Also, I am fixing incorrect description of the GET /public policy in the L7 section.

@peterj peterj requested review from a team as code owners June 9, 2023 22:26
@peterj peterj requested review from qmonnet and aditighag June 9, 2023 22:26
@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 Jun 9, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Jun 9, 2023
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.

The fix for the description of the GET /public sounds good.

For the dollars, I'm not sure this is a mistake, maybe just something that's missing documentation. I can see some other examples using it, including in tests (pkg/policy/api/utils_test.go). My guess is that it means the path should match until the end, and not just be a prefix. So please let's clarify whether this is actually something that needs an update before removing these $.

@qmonnet
Copy link
Member

qmonnet commented Jun 12, 2023

From a quick look at the doc (https://docs.cilium.io/en/latest/security/policy/language/#layer-7-examples):

Path is an extended POSIX regex matched against the path of a request.

So probably nothing to change on that side.

Fixing incorrect description of the GET /public policy in
the L7 section.

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
@peterj
Copy link
Contributor Author

peterj commented Jun 12, 2023

Thanks @qmonnet -- I removed those 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.

Looks good, thank you!

@qmonnet qmonnet 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.11 needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch labels Jun 13, 2023
@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 Jun 13, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.11.18 Jun 13, 2023
@qmonnet qmonnet added this to Needs backport from main in 1.12.12 Jun 13, 2023
@qmonnet qmonnet added this to Needs backport from main in 1.13.5 Jun 13, 2023
@michi-covalent michi-covalent added this to Needs backport from main in 1.11.19 Jun 14, 2023
@michi-covalent michi-covalent removed this from Needs backport from main in 1.11.18 Jun 14, 2023
@ti-mo ti-mo merged commit 68bff35 into cilium:main Jun 20, 2023
38 checks passed
@nbusseneau nbusseneau mentioned this pull request Jun 22, 2023
7 tasks
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Backport pending to v1.11 in 1.11.18 Jun 22, 2023
@nbusseneau nbusseneau mentioned this pull request Jun 22, 2023
10 tasks
@nbusseneau nbusseneau mentioned this pull request Jun 22, 2023
19 tasks
@nbusseneau nbusseneau 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 Jun 22, 2023
@tklauser tklauser added backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. and removed backport-pending/1.11 labels Jun 29, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.11 to Backport done to v1.11 in 1.11.18 Jun 29, 2023
@tklauser tklauser added backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. and removed backport-pending/1.12 backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. labels Jun 29, 2023
@gentoo-root gentoo-root moved this from Needs backport from main to Backport done to v1.11 in 1.11.19 Jul 26, 2023
@gentoo-root gentoo-root moved this from Needs backport from main to Backport done to v1.12 in 1.12.12 Jul 26, 2023
@gentoo-root gentoo-root moved this from Needs backport from main to Backport done to v1.13 in 1.13.5 Jul 26, 2023
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. backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. kind/community-contribution This was a contribution made by a community member. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.11.18
Backport done to v1.11
1.11.19
Backport done to v1.11
1.12.12
Backport done to v1.12
1.13.5
Backport done to v1.13
Development

Successfully merging this pull request may close these issues.

None yet

5 participants