Conversation
Add configure_bgp.mdx covering kube-ovn-speaker installation, Pod and Subnet route advertisement, announcement policies, and debugging. Content is adapted from upstream Kube-OVN BGP documentation with Service and EIP sections omitted. Link the kube-ovn-speaker overview to the new page. Made-with: Cursor
Contributor
WalkthroughA new comprehensive BGP configuration guide was added to the Kube-OVN documentation, covering how to set up Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 minutes 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 docstrings
🧪 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/en/configure/networking/how_to/kube_ovn/understanding_kube_ovn.mdx (1)
95-96: Polish wording for readability.Current phrasing is grammatically awkward (“a specific labeled nodes”, “to the external”). A small rewrite will read cleaner.
Proposed wording
-This component is a DaemonSet running on a specific labeled nodes that publish routes to the external, -allowing external access to the container directly through the Pod IP. For deployment and BGP options, see [Configure BGP](./configure_bgp.mdx). +This component is a DaemonSet running on specifically labeled nodes that publish routes to external networks, +allowing direct external access to containers via Pod IPs. For deployment and BGP options, see [Configure BGP](./configure_bgp.mdx).🤖 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/understanding_kube_ovn.mdx` around lines 95 - 96, The sentence "This component is a DaemonSet running on a specific labeled nodes that publish routes to the external, allowing external access to the container directly through the Pod IP." is awkwardly phrased; replace it with a clearer sentence such as: "This component is a DaemonSet running on specifically labeled nodes that advertise routes to external networks, allowing external access to containers directly via their Pod IPs." Keep the trailing reference unchanged: "For deployment and BGP options, see [Configure BGP](./configure_bgp.mdx)."docs/en/configure/networking/how_to/kube_ovn/configure_bgp.mdx (1)
93-94: Unify annotation value examples for clarity.Earlier examples use
ovn.kubernetes.io/bgp=true, while this section highlights...=yes. Please list both explicitly (or standardize on one) to avoid ambiguity.Proposed wording tweak
-- `ovn.kubernetes.io/bgp=cluster`, or the default `ovn.kubernetes.io/bgp=yes`, selects the **Cluster** policy. +- `ovn.kubernetes.io/bgp=cluster`, or boolean-style values such as `ovn.kubernetes.io/bgp=true` / `ovn.kubernetes.io/bgp=yes`, select the **Cluster** policy.🤖 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/configure_bgp.mdx` around lines 93 - 94, The annotation examples for ovn.kubernetes.io/bgp are inconsistent (this section shows `...=yes` while earlier examples use `...=true`); update the two lines for clarity so they either list both equivalent values or standardize to one. Specifically, change the Cluster-policy line to show both variants like `ovn.kubernetes.io/bgp=cluster` (or `ovn.kubernetes.io/bgp=true/yes`) and the Local-policy line to show `ovn.kubernetes.io/bgp=local` (or indicate `true/yes` is equivalent where applicable), ensuring the annotation key ovn.kubernetes.io/bgp and the values cluster, local, yes, true are explicitly referenced.
🤖 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/configure_bgp.mdx`:
- Around line 96-106: Add a missing "Verify/Debug with gobgp" section after the
BGP advanced options that outlines common checks and example gobgp commands to
validate peering and routes; specifically mention verifying neighbor state with
gobgp neighbor, checking global and local RIB with gobgp global and gobgp rib
(or gobgp table), using gobgp monitor for live updates, and troubleshooting tips
(verify session TCP connectivity, auth/password mismatch, MTU/ebgp-multihop, and
holdtime/graceful-restart settings). Keep the guidance concise, include sample
command usages and expected outcomes, and reference the section title
"Verify/Debug with gobgp" so reviewers can find it easily.
---
Nitpick comments:
In `@docs/en/configure/networking/how_to/kube_ovn/configure_bgp.mdx`:
- Around line 93-94: The annotation examples for ovn.kubernetes.io/bgp are
inconsistent (this section shows `...=yes` while earlier examples use
`...=true`); update the two lines for clarity so they either list both
equivalent values or standardize to one. Specifically, change the Cluster-policy
line to show both variants like `ovn.kubernetes.io/bgp=cluster` (or
`ovn.kubernetes.io/bgp=true/yes`) and the Local-policy line to show
`ovn.kubernetes.io/bgp=local` (or indicate `true/yes` is equivalent where
applicable), ensuring the annotation key ovn.kubernetes.io/bgp and the values
cluster, local, yes, true are explicitly referenced.
In `@docs/en/configure/networking/how_to/kube_ovn/understanding_kube_ovn.mdx`:
- Around line 95-96: The sentence "This component is a DaemonSet running on a
specific labeled nodes that publish routes to the external, allowing external
access to the container directly through the Pod IP." is awkwardly phrased;
replace it with a clearer sentence such as: "This component is a DaemonSet
running on specifically labeled nodes that advertise routes to external
networks, allowing external access to containers directly via their Pod IPs."
Keep the trailing reference unchanged: "For deployment and BGP options, see
[Configure BGP](./configure_bgp.mdx)."
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: fc7096c4-a915-4490-9096-712e12c0b641
📒 Files selected for processing (2)
docs/en/configure/networking/how_to/kube_ovn/configure_bgp.mdxdocs/en/configure/networking/how_to/kube_ovn/understanding_kube_ovn.mdx
Deploying alauda-container-platform with
|
| Latest commit: |
5f86e6c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://bd9eae48.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://bgp-support.alauda-container-platform.pages.dev |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This change adds an English guide for configuring BGP with Kube-OVN (
configure_bgp.mdx), adapted from the upstream Kube-OVN BGP documentation. Sections for advertising ClusterIP Services and EIPs are intentionally omitted. The BGP route debugging section is not included.Changes
docs/en/configure/networking/how_to/kube_ovn/configure_bgp.mdx: kube-ovn-speaker installation, Pod/Subnet route advertisement, Cluster vs Local announcement policies, and advanced BGP options.understanding_kube_ovn.mdx: link the kube-ovn-speaker subsection to the new page.Notes
Navigation picks up the new page via the existing Kube OVN
<Overview />index; nodoom.config.ymlexport changes are required.