docs: document missing entity 'ingress' #25665
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhofstetter
added
area/documentation
mhofstetter
added
the
needs-backport/1.13
jrajahalme
approved these changes
May 25, 2023
zacharysarah
approved these changes
May 25, 2023
There was a problem hiding this comment.
@mhofstetter Good work. Some nits to fix, otherwise LGTM. I'm approving with the understanding that changes are required prior to merge.
Comment on lines
333
to
335
| The ingress entity represents the Cilium Envoy instance which handles ingress | ||
| L7 traffic. Be aware that this also applies for pod-to-pod traffic within | ||
| the same cluster when using ingress endpoints (hairpinning). |
There was a problem hiding this comment.
Deep into the nitty weeds: s/which/that, some small clarification, italics when introducing a new term
Suggested change
| The ingress entity represents the Cilium Envoy instance which handles ingress | |
| L7 traffic. Be aware that this also applies for pod-to-pod traffic within | |
| the same cluster when using ingress endpoints (hairpinning). | |
| The ingress entity represents the Cilium Envoy instance that handles ingress | |
| L7 traffic. Be aware that this also applies for pod-to-pod traffic within | |
| the same cluster when using ingress endpoints (also known as *hairpinning*). |
There was a problem hiding this comment.
Handy guidance for "which" vs. "that":
If your sentence has a clause but does not need it, use “which”; if the sentence does need the clause, use “that.”
There was a problem hiding this comment.
@zacharysarah thanks for your review - i adapted your recommendations. special thanks for the which/that guidance - definitely an important one for me. will try to remember next time! 🧠
The entity `ingress` is missing from the list of pre-defined entities which are available when defining policies which `fromEntities` and `toEntities`. This commits fixes this. Signed-off-by: Marco Hofstetter <marco.hofstetter@isovalent.com>
mhofstetter
force-pushed
the
pr/mhofstetter/docs-ingress-entity
branch
from
255d98f
to
2130a57
Compare
jrajahalme
approved these changes
May 26, 2023
|
change in the documentation doesn't require running the full ci test suite -> adding label |
mhofstetter
added
the
ready-to-merge
sayboras
added
the
backport-pending/1.13
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.12
in 1.12.10
sayboras
added
backport-done/1.13
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport done to v1.13
in 1.13.3
This was referenced Jun 9, 2023
julianwiedmann
added
backport-done/1.12
maintainer-s-little-helper
bot
moved this from Backport pending to v1.12
to Backport done to v1.12
in 1.12.10
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The entity
ingressis missing from the list of pre-defined entities which are available when defining policies whichfromEntitiesandtoEntities.This PR documents the missing entity.
❗ backport info 1.12: note that the ingress entity only applies to cluster external traffic