-
Notifications
You must be signed in to change notification settings - Fork 55
feat: Added Custom Ingress Network Policy docs #1430
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
base: main
Are you sure you want to change the base?
feat: Added Custom Ingress Network Policy docs #1430
Conversation
✅ Deploy Preview for vcluster-docs-site ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
c348b1b to
1bb15bf
Compare
73572c4 to
b4203eb
Compare
b4203eb to
819c0d6
Compare
819c0d6 to
8e25500
Compare
Piotr1215
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! A few small suggestions. Could you please include a preview link in the PR description? It makes it easier for reviewers.
Co-authored-by: Piotr <[email protected]>
….mdx Co-authored-by: Piotr <[email protected]>
Co-authored-by: Piotr <[email protected]>
Co-authored-by: Piotr <[email protected]>
7a44f1f to
e68a47f
Compare
vcluster/configure/vcluster-yaml/control-plane/components/backing-store/database/external.mdx
Outdated
Show resolved
Hide resolved
|
I didn't review the preview, but here are the general comments that @guowenatk and @Piotr1215 should be considering when reviewing this doc based on the enablement session:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The network policy examples across different integration pages look good. A few suggestions to improve the main network-policy.mdx page - mainly around adding prerequisite info and showing what gets deployed by default.
Maybe to make the intro a bit more clear we could write something like:
Enabling this creates Kubernetes NetworkPolicy resources in the host namespace that control how vCluster pods (both control plane and workloads) communicate with each other and with other pods on the host cluster.
| # Depending on your use case, a more restrictive pod selector may be used. | ||
| - namespaceSelector: | ||
| matchLabels: | ||
| kubernetes.io/metadata.name: my-host-namespace |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this duplicate namespaceSelector intentional? It looks like it might be a copy-paste error.
| kubernetes.io/metadata.name: my-host-namespace | |
| ingress: | |
| - from: | |
| # Example allowing vcluster workload traffic from all pods in the my-host-namespace namespace. | |
| # Depending on your use case, a more restrictive pod selector may be used. | |
| - namespaceSelector: | |
| matchLabels: | |
| kubernetes.io/metadata.name: my-host-namespace |
| Control outbound traffic with specific CIDR blocks: | ||
| #### Custom ingress and egress rules {#custom-rules} | ||
| Control inbound and outbound traffic with specific ports and IP addresses for vCluster control plane and workloads: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should there be a prerequisite warning about CNI support? In the isolated workloads doc there's a warning that network policies require a CNI that supports NetworkPolicy enforcement - would be helpful to call that out here too.
| Control outbound traffic with specific CIDR blocks: | ||
| #### Custom ingress and egress rules {#custom-rules} | ||
| Control inbound and outbound traffic with specific ports and IP addresses for vCluster control plane and workloads: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens when this is disabled (the default)? It would help users to know that without network policies, vCluster pods can communicate freely with all pods on the host cluster.
| Control outbound traffic with specific CIDR blocks: | ||
| #### Custom ingress and egress rules {#custom-rules} | ||
| Control inbound and outbound traffic with specific ports and IP addresses for vCluster control plane and workloads: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add a section showing the actual NetworkPolicy resources that get created when this is enabled? Users would benefit from seeing the default YAML (like vc-work-{name} and vc-cp-{name}) and knowing that these are managed by vCluster and manual changes on the host cluster will be overwritten.
Content Description
Preview Link
https://deploy-preview-1430--vcluster-docs-site.netlify.app/docs
Internal Reference
Closes DOC-978
@netlify /docs