Skip to content

Extend Gateway documentation#294

Open
pau-hedgehog wants to merge 3 commits intomasterfrom
pau/gateway-doc
Open

Extend Gateway documentation#294
pau-hedgehog wants to merge 3 commits intomasterfrom
pau/gateway-doc

Conversation

@pau-hedgehog
Copy link
Copy Markdown
Contributor

No description provided.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 15, 2026

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

Copy link
Copy Markdown

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

Updates Gateway documentation to better explain stateful NAT behavior and to add operational guidance for diagnosing Gateway issues.

Changes:

  • Add a new “Flow Table and Stateful Processing” section to the Gateway user guide.
  • Add a new Gateway troubleshooting page with CLI, BGP, NAT, and metrics checks.
  • Extend the architecture overview with a summary of Gateway node components (dataplane/FRR/Alloy).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/user-guide/gateway.md Documents gateway flow table behavior for stateful NAT and failover implications.
docs/troubleshooting/gateway.md New runbook-style troubleshooting guide for Gateway pods, CLI, FRR/BGP, NAT, and metrics.
docs/architecture/overview.md Adds a high-level description of Gateway node components and responsibilities.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/user-guide/gateway.md Outdated
Comment thread docs/user-guide/gateway.md Outdated
@pau-hedgehog pau-hedgehog force-pushed the pau/gateway-doc branch 9 times, most recently from 11f8a7c to a7e9a5b Compare April 15, 2026 22:56
pau-hedgehog and others added 2 commits April 16, 2026 01:00
The architecture page described Control Node and SONiC Switch components
but did not mention the gateway. Add a Gateway Node Components section
covering the dataplane, FRR, and Alloy pods.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
Document the gateway flow table behavior: timeout-based eviction,
capacity configuration, and per-gateway state scope. This helps users
understand sizing, failover implications, and the importance of
keepalives for long-lived connections through stateful NAT.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
@pau-hedgehog pau-hedgehog force-pushed the pau/gateway-doc branch 4 times, most recently from 51120f9 to 165f411 Compare April 16, 2026 22:02
@pau-hedgehog pau-hedgehog changed the title Pau/gateway doc Extend Gateway documentation Apr 16, 2026
@pau-hedgehog pau-hedgehog marked this pull request as ready for review April 17, 2026 13:42
@pau-hedgehog pau-hedgehog requested a review from a team as a code owner April 17, 2026 13:42
Comment thread docs/troubleshooting/gateway.md Outdated
Add troubleshooting guide covering: pod health checks, dataplane CLI
usage (flow table, NAT state, flow filter, routing), FRR/BGP inspection
via vtysh, common issues (traffic not flowing, NAT problems, failover),
and Prometheus metrics.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
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.

3 participants