Skip to content

no-jira: docs: document dual-stack networking support on AWS#10453

Open
tthvo wants to merge 1 commit intoopenshift:mainfrom
tthvo:dualstack-docs
Open

no-jira: docs: document dual-stack networking support on AWS#10453
tthvo wants to merge 1 commit intoopenshift:mainfrom
tthvo:dualstack-docs

Conversation

@tthvo
Copy link
Copy Markdown
Member

@tthvo tthvo commented Apr 1, 2026

Description

Update user guide to document dual-stack networking in AWS. Additionally, this switches the docs to use the new vpc.subnets field instead of the deprecated subnets.

Important

AWS dual-stack networking is not yet GA. I just wanted this PR to run some testwith and get some e2e results.

Because openshift/installer/main/e2e-aws-ovn-dualstack-{ipv4,ipv6}-primary-techpreview jobs are installer-presubmits, they must include an installer PR or run in the installer repository... Thus, the job will build the installer binary always...

/label platform/aws

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Apr 1, 2026
@openshift-ci-robot
Copy link
Copy Markdown
Contributor

@tthvo: This pull request explicitly references no jira issue.

Details

In response to this:

Description

Update user guide to document dual-stack networking in AWS. Additionally, this switches the docs to use the new vpc.subnets field instead of the deprecated subnets.

Important

AWS dual-stack networking is not yet GA. I just wanted this PR to run some testwith and get some e2e results.

Because openshift/installer/main/e2e-aws-ovn-dualstack-{ipv4,ipv6}-primary-techpreview jobs are installer-presubmits, they must include an installer PR or run in the installer repository... Thus, the job will build the installer binary always...

/label platform/aws

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 1, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

Walkthrough

AWS installation documentation is updated to introduce a new platform.aws.vpc configuration object for specifying existing VPC and subnet settings, replacing the deprecated platform.aws.subnets property. Subnet definitions transition from simple ID strings to objects with id and optional roles fields. A new platform.aws.ipFamily property is added to configure IPv4-only or dual-stack networking modes, with corresponding documentation updates including dual-stack requirements and examples.

Changes

Cohort / File(s) Summary
AWS VPC Configuration Documentation
docs/user/aws/customization.md
Adds documentation for new platform.aws.vpc object with subnet objects ({ id, roles } structure), marks platform.aws.subnets as deprecated, introduces platform.aws.ipFamily property with IPv4/dual-stack options, updates constraints for dual-stack networking requirements, and provides configuration examples for both installer-provisioned and existing VPC scenarios.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/testwith openshift/installer/main/e2e-aws-ovn-dualstack-ipv4-primary-techpreview openshift/origin#30938

/testwith openshift/installer/main/e2e-aws-ovn-dualstack-ipv6-primary-techpreview openshift/origin#30938

@openshift-ci openshift-ci bot requested review from mtulio and patrickdillon April 1, 2026 00:36
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 1, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign tthvo for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/user/aws/customization.md`:
- Around line 134-137: Add a clear TechPreview/non-GA warning to the "Dual-stack
networking (installer-provisioned VPC)" section: insert a short highlighted
notice stating this dual-stack capability is not generally available and may
change, and recommend testing in non-production environments; also add the same
warning to the other dual-stack section referenced around lines 167-170 so both
occurrences explicitly state the feature's non-GA status.
- Around line 49-50: Update the docs to make the dual-stack requirement
consistent with the installer-provisioned dual-stack example by either (A)
narrowing the requirement text to say that "for dual-stack installations where
VPC/subnets already have both IPv4 and IPv6 CIDRs, networking.machineNetwork
must include matching IPv4 and IPv6 CIDRs" or (B) modify the
installer-provisioned dual-stack example (the example under the
installer-provisioned dual-stack section) to include both IPv4 and IPv6 entries
in networking.machineNetwork; ensure references to networking.machineNetwork and
the installer-provisioned dual-stack example are adjusted so the requirement and
example align.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 18a31d68-58a0-4241-806d-a367eb5cbfe1

📥 Commits

Reviewing files that changed from the base of the PR and between 3fa9ca0 and 019f2a7.

📒 Files selected for processing (1)
  • docs/user/aws/customization.md

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/skip

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 1, 2026

@tthvo: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-aws-ovn-heterogeneous 019f2a7 link false /test e2e-aws-ovn-heterogeneous
ci/prow/e2e-aws-ovn-imdsv2 019f2a7 link false /test e2e-aws-ovn-imdsv2
ci/prow/e2e-aws-ovn-edge-zones 019f2a7 link false /test e2e-aws-ovn-edge-zones

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/testwith openshift/installer/main/e2e-aws-ovn-dualstack-ipv6-primary-techpreview openshift/origin#30938

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/testwith openshift/installer/main/e2e-aws-ovn-dualstack-ipv6-primary-techpreview openshift/origin#30952

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/skip

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/testwith openshift/installer/main/e2e-aws-ovn-dualstack-ipv6-primary-techpreview openshift/origin#30952

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 1, 2026

/testwith openshift/installer/main/e2e-aws-ovn-dualstack-ipv4-primary-techpreview openshift/origin#30952

@tthvo
Copy link
Copy Markdown
Member Author

tthvo commented Apr 2, 2026

/testwith openshift/installer/main/e2e-aws-eusc-techpreview openshift/origin#30954

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. platform/aws

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants