Skip to content

Conversation

@edipascale
Copy link
Contributor

Fix #247

@edipascale edipascale requested a review from Copilot January 30, 2026 15:40
@github-actions
Copy link

github-actions bot commented Jan 30, 2026

🚀 Deployed on https://preview-265--hedgehog-docs.netlify.app

Copy link

Copilot AI left a 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: true and 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.

Copy link

Copilot AI left a 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.

@edipascale edipascale marked this pull request as ready for review February 10, 2026 12:56
@edipascale edipascale requested a review from a team as a code owner February 10, 2026 12:56
@mrbojangles3
Copy link
Contributor

I think we should add a section on how to verify the host has the correct settings. Like can a user check ip route show to see correct settings? Perhaps the docker exec -it hostbgp vtysh -c show running-config or similar?

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>
@edipascale
Copy link
Contributor Author

I think we should add a section on how to verify the host has the correct settings. Like can a user check ip route show to see correct settings? Perhaps the docker exec -it hostbgp vtysh -c show running-config or similar?

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.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Host BGP

2 participants