📖 Add NetworkPolicy doc #1973
📖 Add NetworkPolicy doc #1973
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1973 +/- ##
==========================================
- Coverage 69.10% 69.10% -0.01%
==========================================
Files 79 79
Lines 7011 7023 +12
==========================================
+ Hits 4845 4853 +8
- Misses 1885 1888 +3
- Partials 281 282 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| * Verify NetworkPolicy support: Ensure your cluster has a CNI plugin that supports NetworkPolicy | ||
| * Check pod labels: Confirm that catalogd and operator-controller pods have the correct labels for NetworkPolicy selection | ||
| * Inspect logs: Check component logs for connection errors | ||
| * Test connectivity: Run test pods that attempt to communicate with OLMv1 components |
There was a problem hiding this comment.
Could we add an example here with the commands to help the user and us to know how to do those checks?
There was a problem hiding this comment.
I'd actually started doing this, but it got very complicated very soon. That made me lean towards removing this line altogether, to keep this doc simple for now. We could either
- keep this out till we see the need to add this point with enhanced examples because end users are getting into this situation a lot, or
- add this section in a follow up PR.
I'm definitely leaning toward 1 over 2.
| * Catalogd's HTTPS server (on port 8443) | ||
| * Image registries specified in bundle metadata | ||
|
|
||
| Currently, all egress traffic from operator-controller is allowed to support communication with arbitrary image registries that aren't known at install time. |
There was a problem hiding this comment.
What do you think about linking the code from the repo?
So, those looking can easily check the NPs by clicking on them.
There was a problem hiding this comment.
I don't know how I feel about that tbh. If we just link the yaml file, that's self documenting 😄.
This doc is to expand on that yaml file, in words.
I feel like users who're adept enough at reading yaml files will find that file and know how to read it anyway, and this is for those users who will need help understanding that yaml file.
Which is why I didn't include the link to the yaml file in the first place.
There was a problem hiding this comment.
I don't know how I feel about that tbh. If we just link the yaml file, that's self documenting 😄.
Yes, can we link the YAMLs?
For me, for example, it would be much easier to check the NP directly rather than reading the documentation.
As a new contributor and user, I might not even know where they live in the repo.
So the suggestion here is simply to add a direct link to the YAML files.
There was a problem hiding this comment.
Added links to the NetworkPolicy yaml files from the repo in the overview section 👍🏽
anik120
force-pushed
the
networkpolicy-docs
branch
from
2de220b to
5f35624
Compare
anik120
force-pushed
the
networkpolicy-docs
branch
from
5f35624 to
f412606
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
openshift-merge-bot
bot
merged commit 10314ff
into
operator-framework:main
| @@ -0,0 +1,94 @@ | |||
| # NetworkPolicy in OLMv1 | |||
There was a problem hiding this comment.
@michaelryanpeter I think it would be nice to get your help with.
Description
Reviewer Checklist