add docs for u2oInterconnection subnet isolate#573
Conversation
Signed-off-by: clyi <clyi@alauda.io>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
WalkthroughAdds documentation on isolating Underlay subnets when Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/configure/networking/how_to/kube_ovn/underlay_overlay_st.mdx`:
- Around line 59-70: Add explicit application instructions before the presented
spec YAML: tell the user to run a kubectl edit subnet <subnet-name> (or kubectl
patch subnet <subnet-name> --type=merge -p ...) to add/modify the spec fields
u2oInterconnection, private and allowSubnets, and also mention the alternative
of applying the same changes via the Kube-OVN UI subnet edit workflow; ensure
the text says "Add or modify the following fields under spec:" immediately
before the YAML so users know how to apply the config.
| ### Step 2: Configure Subnet Isolation | ||
|
|
||
| Configure the subnet with the following parameters: | ||
|
|
||
| ```yaml | ||
| spec: | ||
| u2oInterconnection: true | ||
| private: true | ||
| allowSubnets: | ||
| - 10.0.0.0/24 # CIDR of the subnet allowed for inbound access | ||
| - 172.16.0.0/16 # Node network CIDR (REQUIRED) | ||
| ``` |
There was a problem hiding this comment.
Step 2 is missing instructions on how to apply the subnet configuration.
Step 1 provides an explicit kubectl edit command, but Step 2 only presents a bare spec: YAML fragment with no guidance on how to apply it — no kubectl edit subnet <name>, no kubectl patch, and no reference to the existing UI workflow from the Procedure section above. Users unfamiliar with Kube-OVN will not know how to apply this config.
✏️ Suggested addition before the YAML block
Configure the subnet with the following parameters:
+```bash
+kubectl edit subnet <subnet-name>
+```
+
+Add or modify the following fields under `spec`:
+
```yaml
spec:
u2oInterconnection: true🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/configure/networking/how_to/kube_ovn/underlay_overlay_st.mdx` around
lines 59 - 70, Add explicit application instructions before the presented spec
YAML: tell the user to run a kubectl edit subnet <subnet-name> (or kubectl patch
subnet <subnet-name> --type=merge -p ...) to add/modify the spec fields
u2oInterconnection, private and allowSubnets, and also mention the alternative
of applying the same changes via the Kube-OVN UI subnet edit workflow; ensure
the text says "Add or modify the following fields under spec:" immediately
before the YAML so users know how to apply the config.
Signed-off-by: clyi <clyi@alauda.io>
Signed-off-by: clyi <clyi@alauda.io>
Summary by CodeRabbit