Extend Gateway documentation#294
Conversation
|
🚀 Deployed on https://preview-294--hedgehog-docs.netlify.app |
There was a problem hiding this comment.
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.
pau-hedgehog
force-pushed
the
pau/gateway-doc
branch
13 times, most recently
from
51120f9 to
165f411
Compare
pau-hedgehog
force-pushed
the
pau/gateway-doc
branch
from
165f411 to
eb17905
Compare
pau-hedgehog
force-pushed
the
pau/gateway-doc
branch
2 times, most recently
from
9da11f7 to
7e97561
Compare
pau-hedgehog
force-pushed
the
pau/gateway-doc
branch
from
7e97561 to
7a41440
Compare
pau-hedgehog
force-pushed
the
pau/gateway-doc
branch
from
7a41440 to
aae2559
Compare
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Pau Capdevila <pau@githedgehog.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Pau Capdevila <pau@githedgehog.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Pau Capdevila <pau@githedgehog.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Pau Capdevila <pau@githedgehog.com>
pau-hedgehog
force-pushed
the
pau/gateway-doc
branch
from
aae2559 to
2010b50
Compare
|
Thanks and sorry, @edipascale I added a small note after doing some troubleshooting on counters Adding @qmonnet to have someone from the dataplane reviewing these changes |
| on an expected active peering indicate traffic is not reaching the gateway. | ||
|
|
||
| !!! note | ||
| A `d:` of `0` confirms the gateway itself did not discard packets, but |
There was a problem hiding this comment.
nit: I would avoid having d as the subject here, e.g. "A value of 0 for the gateway drop counter d" or something along those lines. just a stylistic preference, feel free to ignore
qmonnet
left a comment
qmonnet
left a comment
There was a problem hiding this comment.
Looks OK from my side - I'm not familiar with all aspects of the gateway, but I didn't see anything that looks wrong in the changes, as far as I can tell.
Details like the 2-min timeout for masquerading flow table entries might be difficult to keep up-to-date if we change them in the code (I mean, it will be hard to remember that it's in the docs and should be updated).
For troubleshooting, I suppose we don't want to document the dataplane CLI for now?
No description provided.