Skip to content

User ACLs documentation - #338

Merged
Frostman merged 3 commits into
masterfrom
pr/qmonnet/user-acls
Aug 7, 2026
Merged

User ACLs documentation#338
Frostman merged 3 commits into
masterfrom
pr/qmonnet/user-acls

Conversation

@qmonnet

@qmonnet qmonnet commented Jul 30, 2026

Copy link
Copy Markdown
Member
  • gateway: Split gateway peering doc out of gateway overview
  • gateway: Update NAT restrictions on peering ends
  • gateway: Add docs for user ACLs

Closes: #331

@qmonnet
qmonnet requested a review from mvachhar July 30, 2026 12:34
@qmonnet qmonnet self-assigned this Jul 30, 2026
@github-actions

Copy link
Copy Markdown

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

@qmonnet
qmonnet force-pushed the pr/qmonnet/user-acls branch from 714aec5 to 8fa6f10 Compare July 30, 2026 12:35
@qmonnet

qmonnet commented Jul 30, 2026

Copy link
Copy Markdown
Member Author

@qmonnet
qmonnet force-pushed the pr/qmonnet/user-acls branch from 8fa6f10 to e14e439 Compare July 31, 2026 23:43
@qmonnet
qmonnet marked this pull request as ready for review July 31, 2026 23:44
@qmonnet
qmonnet requested review from a team as code owners July 31, 2026 23:44
Comment thread docs/user-guide/gateway-acls.md

@edipascale edipascale left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, only minor comments and one typo

Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
@qmonnet

qmonnet commented Aug 3, 2026

Copy link
Copy Markdown
Member Author

Thank you Emanuele, I should have addressed all your comments, please take a look at the diff when you can.

edipascale
edipascale previously approved these changes Aug 3, 2026

@edipascale edipascale left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing my comments!

Comment thread docs/user-guide/gateway-peering.md
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
Comment thread docs/user-guide/gateway-acls.md Outdated
qmonnet and others added 2 commits August 4, 2026 14:59
The gateway "overview" has grown to the point it's no longer an
overview, but mostly a reference guide for the GatewayPeering
configuration.

Move the peering material into a new gateway-peering.md. The text is
carried over unchanged, apart from heading levels (and this commit is
best reviewed with some tool that shows lines moved rather than just
additions/deletions).

Section "Flow Table and Stateful Processing" gets split in two parts,
because it mixed two concerns: the flow table capacity, and observations
on the non-shared nature of flow states, are properties of the gateway
node, whereas timeout-based eviction is a per-peering NAT field. The
former stay in gateway.md, the latter (along with the keepalive tip)
move to the new gateway-peering.md in a dedicated "Flow Table"
subsection.

Minor introduction paragraphs are added to replace the section that
moved, or as introduction to the new page and subsection. We also update
relevant links, and .pages navigation.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Quentin Monnet <qmo@qmon.net>
When one side of a gateway peering uses stateful NAT (masquerade or port
forwarding), the other side cannot also use stateful NAT, but we added
support for using stateful NAT and static NAT on opposing ends of a
peering. Update the relevant limitation in the docs.

Signed-off-by: Quentin Monnet <qmo@qmon.net>
@qmonnet
qmonnet force-pushed the pr/qmonnet/user-acls branch from fc406f9 to 8067894 Compare August 4, 2026 13:59
Signed-off-by: Quentin Monnet <qmo@qmon.net>

@mvachhar mvachhar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be merged as is, but we still need to answer the questions about flow scoped rules and how they interact with packet scoped rules. I'm still in favor of my interpretation, but @qmonnet has a good point on people getting burned by a packet level deny for return traffic that gets bypassed. We should decide on final semantics and document any gotchas.

@qmonnet
qmonnet enabled auto-merge (rebase) August 5, 2026 15:19
@mrbojangles3
mrbojangles3 self-requested a review August 5, 2026 16:15
@Frostman
Frostman disabled auto-merge August 7, 2026 17:06
@Frostman
Frostman merged commit f26f06e into master Aug 7, 2026
4 checks passed
@Frostman
Frostman deleted the pr/qmonnet/user-acls branch August 7, 2026 17:06
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.

Docs for user ACLs

4 participants