Commit de058da
DOC-1613: Document BYOC AWS centralized egress with Transit Gateway (#587)
* DOC-1613: Document BYOC AWS centralized egress with Transit Gateway
Add two new pages under networking/byoc/aws for the beta NAT
Gateway-free egress feature: a concept + how-to page for
configuring centralized egress on a BYOC cluster, and a hub-side
setup guide for the customer's Transit Gateway, NAT Gateway, and
AWS RAM share. Update nav and link from the existing BYOC create
and BYOVPC pages. The Cloud API path is gated behind
ifdef::show-preview-api[] while egress_spec is in PREVIEW.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* reorder sections
* add blurb to What's New
* Add preview-gated AWS Transit Gateway egress example to Control Plane API
Document `egress_spec.aws.transit_gateway_id` on AWS BYOC networks in the
Control Plane API partial behind `:show-preview-api:`, and cross-link the
full API workflow from the centralized-egress page.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Note private-networking requirement for centralized egress
Centralized egress is only available on AWS BYOC clusters with a private
connection type. Add the constraint to the Prerequisites list on the
centralized-egress page and to the Transit Gateway TIP callout on the
create-cluster page.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Clarify centralized egress switch-back guidance
Trim the IMPORTANT callout to keep only the actionable instruction
(create new network + cluster, then migrate data), since the
"immutable" point is already covered in the Limitations section.
Reassign the RAM share invitation acceptance to the Customer owner.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Clarify that the customer accepts the AWS RAM share invitation
Redpanda does not accept the Transit Gateway RAM share -- the customer
accepts the invitation in the BYOC AWS account before creating the
cluster (auto-accepted within an AWS Organization). Correct the
Prerequisites bullet, the Console procedure step, and both
troubleshooting rows that previously implied Redpanda accepts the share.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Note that the Network page CIDR must route on the hub side
Add a NOTE next to the Transit Gateway ID UI step clarifying that the
CIDR block customers enter on the Network page is the Redpanda spoke
CIDR, and that a matching static route must exist on the hub public
route table for reply traffic to reach the cluster. The Transit
Gateway's own route table picks up the spoke CIDR via propagation.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Rewrite centralized egress troubleshooting from customer POV
The previous six-row table mixed customer-observable symptoms with
internal framings (agent logs, packets in the Redpanda VPC) that
customers cannot inspect. Replace it with two rows whose symptoms
are visible in the Cloud UI or the customer's own AWS account, and
fold the four hub misconfiguration causes into a single
"cluster creation does not complete" checklist.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Document TGW auto-accept setting as a customer prerequisite
The page assumed the customer knew their existing Transit Gateway
would auto-accept the Redpanda spoke attachment. Spell out both cases
in Prerequisites and split the conflated troubleshooting row that
mislabeled a pendingAcceptance attachment as a RAM share issue.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Update modules/networking/pages/byoc/aws/nat-free-egress.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* Update modules/networking/pages/byoc/aws/aws-hub-egress.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* Update modules/networking/pages/byoc/aws/aws-hub-egress.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* incorporate review feedback
* Update modules/manage/partials/controlplane-api.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* Update modules/get-started/pages/whats-new-cloud.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* Update modules/networking/pages/byoc/aws/aws-hub-egress.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* Update modules/networking/pages/byoc/aws/aws-hub-egress.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* Update modules/networking/pages/byoc/aws/aws-hub-egress.adoc
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
* Address open review comments on the hub egress page
- Add an xref to "What are CIDRs?" from the hub-and-spoke CIDR overlap warning.
- Explain why the hub needs private subnets and an Internet Gateway in the
two sections that previously jumped straight from heading to tabs.
- Drop the "in preview on AWS BYOC networks only" qualifier from the
centralized-egress API note, since there is no central definition of
"preview" to link to.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Spell out Transit Gateway instead of the TGW acronym
AWS official documentation does not use the TGW acronym in prose. It
appears only in URL paths and resource-ID prefixes. Match that
convention: replace bare-word TGW in prose, numbered traffic-flow
steps, ASCII diagrams, and echo strings in CLI examples. Shell
variables ($TGW_ID, $TGW_ARN) and resource-ID prefixes (tgw-...)
are left unchanged.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* style edit
* style edit
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>1 parent 25cabfc commit de058da
7 files changed
Lines changed: 848 additions & 3 deletions
File tree
- modules
- ROOT
- get-started/pages
- cluster-types/byoc/aws
- manage/partials
- networking/pages/byoc/aws
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
453 | 453 | | |
454 | 454 | | |
455 | 455 | | |
| 456 | + | |
| 457 | + | |
456 | 458 | | |
457 | 459 | | |
458 | 460 | | |
| |||
Lines changed: 5 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
46 | 51 | | |
47 | 52 | | |
48 | 53 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | | - | |
| 114 | + | |
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
11 | 15 | | |
12 | 16 | | |
13 | 17 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
128 | | - | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
129 | 139 | | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
130 | 159 | | |
131 | 160 | | |
132 | | - | |
| 161 | + | |
133 | 162 | | |
134 | 163 | | |
135 | 164 | | |
| |||
0 commit comments