-
Notifications
You must be signed in to change notification settings - Fork 8
document hostBGP subnets and container #265
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: master
Are you sure you want to change the base?
Conversation
|
🚀 Deployed on https://preview-265--hedgehog-docs.netlify.app |
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.
Pull request overview
This PR extends the user documentation to describe HostBGP-capable subnets and how to run the accompanying host-side BGP container, addressing Issue #247.
Changes:
- Adds an example VPC subnet configured with
hostBGP: trueand a detailed “HostBGP subnets” section explaining the topology and behavior. - Documents the HostBGP helper container image, including how to pull it, run it with appropriate parameters, and manage its lifecycle.
- Cross-links the new HostBGP subnet documentation with the host settings page for easier navigation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/user-guide/vpcs.md | Documents HostBGP subnets, including configuration in the VPC spec and conceptual explanation of host–fabric BGP peering, and links to host configuration details. |
| docs/user-guide/host-settings.md | Adds a “HostBGP container” section describing how to obtain and run the host BGP helper container, required parameters, and basic troubleshooting/management commands. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cfc62d1 to
b0b6755
Compare
b0b6755 to
06414ca
Compare
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.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
06414ca to
eaf39a4
Compare
|
I think we should add a section on how to verify the host has the correct settings. Like can a user check I think it would be worthwhile to mention to the use they should auto start the container at system boot up, but I don't think we need to tell them how to do that. |
Signed-off-by: Emanuele Di Pascale <emanuele@githedgehog.com>
eaf39a4 to
af11b87
Compare
great points! I've added an example of how to show the generated config via vtysh and a note on automating the container at startup. I purposely avoided mentioning more bgp troubleshooting commands because expert users should know about those and people who don't know about networking are probably not going to be able to do much anyway / should not mess around with vtysh, but I'm happy to add an extended troubleshooting session if there's a consensus for it |
Fix #247