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: Clarify from/toRequires documentation with a new example #14262

Merged
merged 1 commit into from
Dec 7, 2020

Conversation

pchaigno
Copy link
Member

@pchaigno pchaigno commented Dec 3, 2020

The difference between using toRequires+toEndpoints vs. toEndpoints+toEndpoints (i.e., first is logical AND of the rules, whereas the second is OR) is not particularly obvious when first reading the toRequires documentation.

This pull request attempts to clarify this difference by completing the fromRequires example with a fromEndpoints policy.

image

@pchaigno pchaigno 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.8 labels Dec 3, 2020
@pchaigno pchaigno requested a review from a team as a code owner December 3, 2020 18:42
@pchaigno pchaigno requested review from a team, qmonnet and jrajahalme December 3, 2020 18:42
@maintainer-s-little-helper maintainer-s-little-helper bot added this to In progress in 1.10.0 Dec 3, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.9.1 Dec 3, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.8.6 Dec 3, 2020
@pchaigno pchaigno force-pushed the pr/pchaigno/extend-fromtorequires-docs branch from 8fde470 to b2e6299 Compare December 3, 2020 18:47
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 realized after taking a look maybe this was still being worked on but if I spotted stuff I may as well point it out :)

examples/policies/l3/requires/endpoints.json Outdated Show resolved Hide resolved
examples/policies/l3/requires/endpoints.yaml Show resolved Hide resolved
examples/policies/l3/requires/endpoints.json Outdated Show resolved Hide resolved
@qmonnet qmonnet removed their assignment Dec 4, 2020
@aanm aanm added this to Needs backport from master in 1.8.7 Dec 4, 2020
@aanm aanm removed this from Needs backport from master in 1.8.6 Dec 4, 2020
@aanm aanm added this to Needs backport from master in 1.8.6 Dec 4, 2020
@aanm aanm removed this from Needs backport from master in 1.8.6 Dec 4, 2020
@aanm aanm added this to Needs backport from master in 1.8.7 Dec 4, 2020
@aanm aanm added this to Needs backport from master in 1.9.2 Dec 4, 2020
@aanm aanm removed this from Needs backport from master in 1.9.1 Dec 4, 2020
The difference between using toRequires+toEndpoints vs.
toEndpoints+toEndpoints (i.e., first is logical AND of the rules whereas
second is OR) is not particularly obvious when first reading the
toRequires documentation.

This commit attempts to clarify this difference by completing the
fromRequires example with a fromEndpoints policy.

Suggested-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Paul Chaignon <paul@cilium.io>
@pchaigno pchaigno force-pushed the pr/pchaigno/extend-fromtorequires-docs branch from 61676f4 to c4bef71 Compare December 4, 2020 17:29
@pchaigno
Copy link
Member Author

pchaigno commented Dec 4, 2020

Rebased with a minor change to address Quentin's nit. Marking as ready to merge.

@pchaigno pchaigno added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Dec 4, 2020
@kkourt kkourt merged commit c05e2fa into master Dec 7, 2020
@kkourt kkourt deleted the pr/pchaigno/extend-fromtorequires-docs branch December 7, 2020 08:12
@joestringer joestringer moved this from Needs backport from master to Backport done to v1.8 in 1.8.7 Jan 18, 2021
@joestringer joestringer moved this from Needs backport from master to Backport done to v1.9 in 1.9.2 Jan 18, 2021
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. 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.8.7
Backport done to v1.8
1.9.2
Backport done to v1.9
Development

Successfully merging this pull request may close these issues.

None yet

7 participants