Skip to content

docs: Add gateway and NAT66 deployment reference docs - #446

Open
privateip wants to merge 1 commit into
mainfrom
docs/gateway-nat66-reference-docs
Open

docs: Add gateway and NAT66 deployment reference docs#446
privateip wants to merge 1 commit into
mainfrom
docs/gateway-nat66-reference-docs

Conversation

@privateip

Copy link
Copy Markdown
Contributor

Summary

Operators had no single place to learn how to deploy and configure the edge gateway or the NAT66 egress tier, and no quick way to check what config/ actually applies or which ports two co-located DaemonSets use. This adds a deploy/configure guide for galactic-gateway, a getting-started walkthrough and configuration reference for NAT66, and a cross-cutting reference of every deployable asset and its configured ports. It also fixes a few stale doc-comment cross-references left over from the DSR/anycast gateway rewrite.

Test plan

  • Docs render correctly and internal cross-links resolve
  • Port and config-field claims match the current manifests/config package

Add docs/gateway/configuration.md, a deploy/configure guide for galactic-gateway covering node labeling, RBAC bring-up, the per-node SRv6-address overlay pattern, NetworkGateway/NetworkRule configuration, and verification.

Add docs/nat66/getting-started.md and docs/nat66/configuration.md, a walkthrough and configuration reference for the sharded, stateful NAT66 egress tier.

Add docs/reference.md, a cross-cutting quick-reference table of every deployable asset in config/ and every TCP port its containers configure, so a port collision or an "is this applied cluster-wide" question can be answered without reading every component's manifests.

Clean up stale references to internal/controller/networkgateway_controller.go's publishSelfAddress in AGENTS.md, README.md, and config/galactic-gateway/base/daemonset.yaml. That function was removed in the DSR/anycast rewrite; the references now point to internal/config/gateway.go's EnvGatewaySRv6Address doc comment instead.
@privateip
privateip requested a review from a team as a code owner August 25, 2026 13:50
@privateip
privateip requested review from 0xmc, drewr, ecv, scotwells and slindseysr and removed request for drewr August 25, 2026 13:50
@ecv

ecv commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

@privateip conflicts

@ecv
ecv self-requested a review September 3, 2026 15:27
@ecv

ecv commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

@privateip erp conflicts again

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.

2 participants