Skip to content

VIP networks nic_grouping#897

Open
neddp wants to merge 7 commits intomasterfrom
nic_grouping_for_vip_networks
Open

VIP networks nic_grouping#897
neddp wants to merge 7 commits intomasterfrom
nic_grouping_for_vip_networks

Conversation

@neddp
Copy link
Copy Markdown
Member

@neddp neddp commented Mar 10, 2026

This documents the new feature that allows the user to specify an interface for the VIP network.
And fix some markdown formatting issues.

Follows:

@neddp neddp changed the title Enhance documentation for VIP networks and NIC grouping support VIP networks nic_grouping Mar 10, 2026
@aramprice aramprice moved this from Inbox to Pending Review | Discussion in Foundational Infrastructure Working Group Mar 12, 2026
@aramprice
Copy link
Copy Markdown
Member

Pending CPI release

@aramprice aramprice requested review from a team, KauzClay and fmoehler and removed request for a team March 12, 2026 16:17
@rkoster
Copy link
Copy Markdown
Contributor

rkoster commented Mar 27, 2026

Trying to trigger coderabbit.ai

@rkoster rkoster closed this Mar 27, 2026
@github-project-automation github-project-automation bot moved this from Pending Review | Discussion to Done in Foundational Infrastructure Working Group Mar 27, 2026
@rkoster rkoster reopened this Mar 27, 2026
@rkoster
Copy link
Copy Markdown
Contributor

rkoster commented Mar 27, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

Added documentation describing how to assign VIPs to a specific NIC in multi‑NIC deployments by specifying nic_group on a VIP network entry in deployment manifests, including an example manifest. Documented CPI runtime behavior: if a VIP nic_group is omitted or does not match any network nic_group, the VIP association falls back to the primary NIC (device_index 0). Updated AWS CPI limitations to indicate VIP support for nic_group-based NIC grouping and adjusted related AWS network feature table and notes.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'VIP networks nic_grouping' directly relates to the main change: documenting the new nic_group feature for VIP networks to specify which network interface receives the virtual IP.
Description check ✅ Passed The description accurately explains the PR's purpose: documenting the new VIP network interface specification feature and fixing Markdown formatting, which aligns with the actual changes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nic_grouping_for_vip_networks

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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: 1

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

Inline comments:
In `@content/networks.md`:
- Around line 388-389: Update the note in the triple-bang "note" block that
currently reads "Available as of BOSH Director version v282.1.3 and AWS CPI
version TBD" by replacing "AWS CPI version TBD" with a concrete minimum released
CPI version; set it to "AWS CPI version v107.0.0" (or v107.0.1 if you prefer the
latest release) so the note reads e.g. "Available as of BOSH Director version
v282.1.3 and AWS CPI version v107.0.0".
🪄 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: ASSERTIVE

Plan: Pro

Run ID: 5807efb3-b2f0-472c-ab47-8ece0db944da

📥 Commits

Reviewing files that changed from the base of the PR and between 9dfb5b8 and d735dc9.

📒 Files selected for processing (2)
  • content/network-interface-groups.md
  • content/networks.md

@github-project-automation github-project-automation bot moved this from Done to Waiting for Changes | Open for Contribution in Foundational Infrastructure Working Group Mar 27, 2026
@beyhan
Copy link
Copy Markdown
Member

beyhan commented Apr 2, 2026

This is waiting for a release of bosh-aws-cpi.

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 `@content/networks.md`:
- Line 491: The table row that lists "vip" nic grouping support is missing the
version qualifier and should match the earlier statement that AWS CPI VIP NIC
grouping is available from v107.0.2; update the table cell containing "vip" in
networks.md to include the version qualifier (e.g., "vip (from v107.0.2)") so
the documentation consistently indicates the minimum AWS CPI version for VIP nic
grouping support, and verify the text around "AWS CPI v107.0.2" (mentioned
earlier) remains consistent with the updated table entry.
- Line 386: The new subsection "VIP Networks in Multi-NIC Configurations" needs
an explicit anchor so cross-doc links can target it; add an ID to the header
(for example change the header to include a Markdown/HTML anchor like
{`#vip-multi-nic`} or add an <a id="vip-multi-nic"></a> immediately above the "###
VIP Networks in Multi-NIC Configurations" header) and, if necessary, update the
link in content/network-interface-groups.md to point to `#vip-multi-nic` instead
of `#vip`.
🪄 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: ASSERTIVE

Plan: Pro

Run ID: 60cf19c0-2cfa-42bb-809d-bfb79773985e

📥 Commits

Reviewing files that changed from the base of the PR and between d735dc9 and ddffd04.

📒 Files selected for processing (1)
  • content/networks.md

Updated header for VIP Networks section with anchor.
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.

♻️ Duplicate comments (3)
content/networks.md (3)

386-396: ⚠️ Potential issue | 🟡 Minor

Update cross-doc link target to the new subsection anchor.

content/network-interface-groups.md still points to networks.md#vip, which does not target this new subsection.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/networks.md` around lines 386 - 396, Update the cross-doc link in
content/network-interface-groups.md that currently points to networks.md#vip so
it targets the new subsection anchor
networks.md#vip-networks-in-multi-nic-configurations; search for the existing
link text (the reference to "#vip") and replace it with
"#vip-networks-in-multi-nic-configurations" so the link resolves to the VIP
Networks in Multi-NIC Configurations section in networks.md.

386-386: ⚠️ Potential issue | 🟡 Minor

Fix invalid heading ID attribute syntax (backticks break anchor generation).

The subsection ID is wrapped in backticks; use a plain attribute list ID so fragment links resolve reliably.

🔧 Proposed fix
-### VIP Networks in Multi-NIC Configurations {: `#vip-networks-in-multi-nic-configurations` }
+### VIP Networks in Multi-NIC Configurations {: `#vip-networks-in-multi-nic-configurations` }
#!/bin/bash
# Verify heading-ID syntax and fragment references are consistent.
rg -n 'VIP Networks in Multi-NIC Configurations|#vip-networks-in-multi-nic-configurations|networks\.md#vip' content/networks.md content/network-interface-groups.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/networks.md` at line 386, The heading "VIP Networks in Multi-NIC
Configurations" currently includes a backticked ID which breaks anchor
generation; remove the backticks and use a plain attribute list by changing the
heading from '### VIP Networks in Multi-NIC Configurations {:
`#vip-networks-in-multi-nic-configurations` }' to '### VIP Networks in Multi-NIC
Configurations {`#vip-networks-in-multi-nic-configurations`}' so fragment links
resolve correctly.

491-491: ⚠️ Potential issue | 🟠 Major

Keep AWS VIP nic-grouping version gating consistent in the limitations table.

Line 389 gates VIP nic-grouping at AWS CPI v107.0.2, but this cell lists vip without the same qualifier.

🔧 Proposed fix
-| AWS       | Multiple per instance group<sup>1</sup> (from v107.0.0)         | Single per instance group   | Single, corresponds to an elastic IP |manual<sup>2</sup>, vip                  | manual<sup>3</sup>                           |
+| AWS       | Multiple per instance group<sup>1</sup> (from v107.0.0)         | Single per instance group   | Single, corresponds to an elastic IP |manual<sup>2</sup>, vip (from v107.0.2)  | manual<sup>3</sup>                           |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/networks.md` at line 491, The AWS row in the limitations table lists
"vip" without the version qualifier while VIP nic-grouping is gated at AWS CPI
v107.0.2 elsewhere; update the AWS table cell that currently reads
"manual<sup>2</sup>, vip" to include the same version qualifier (e.g.,
"manual<sup>2</sup>, vip (from v107.0.2)") so the VIP nic-grouping gating is
consistent with the note at v107.0.2.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@content/networks.md`:
- Around line 386-396: Update the cross-doc link in
content/network-interface-groups.md that currently points to networks.md#vip so
it targets the new subsection anchor
networks.md#vip-networks-in-multi-nic-configurations; search for the existing
link text (the reference to "#vip") and replace it with
"#vip-networks-in-multi-nic-configurations" so the link resolves to the VIP
Networks in Multi-NIC Configurations section in networks.md.
- Line 386: The heading "VIP Networks in Multi-NIC Configurations" currently
includes a backticked ID which breaks anchor generation; remove the backticks
and use a plain attribute list by changing the heading from '### VIP Networks in
Multi-NIC Configurations {: `#vip-networks-in-multi-nic-configurations` }' to
'### VIP Networks in Multi-NIC Configurations
{`#vip-networks-in-multi-nic-configurations`}' so fragment links resolve
correctly.
- Line 491: The AWS row in the limitations table lists "vip" without the version
qualifier while VIP nic-grouping is gated at AWS CPI v107.0.2 elsewhere; update
the AWS table cell that currently reads "manual<sup>2</sup>, vip" to include the
same version qualifier (e.g., "manual<sup>2</sup>, vip (from v107.0.2)") so the
VIP nic-grouping gating is consistent with the note at v107.0.2.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4d35abd7-e1fb-4d42-9c38-c6d5a6396544

📥 Commits

Reviewing files that changed from the base of the PR and between ddffd04 and 629b694.

📒 Files selected for processing (1)
  • content/networks.md

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 `@content/networks.md`:
- Line 426: The sentence describes fallback behavior but uses plain text for
device_index 0; update the docs so the technical identifier is inline code:
replace the two occurrences of "device_index 0" with inline code formatting
(`device_index 0`) and ensure consistency with other identifiers like
`nic_group` and VIP network references.
- Line 492: Replace the non-descriptive link text "here" in the sentence about
attaching more IP addresses with a descriptive label that explains the
destination (e.g., "the nic_group configuration in the networks section of
manifest-v2.md" or "nic_group configuration (manifest-v2.md#instance-groups)");
locate the sentence referencing nic_group and the current "here" link and update
the anchor text to clearly state the target instead of using "here".
🪄 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: ASSERTIVE

Plan: Pro

Run ID: 00a107b2-987b-4336-b0b2-3bd2f1866eda

📥 Commits

Reviewing files that changed from the base of the PR and between 629b694 and 343a888.

📒 Files selected for processing (1)
  • content/networks.md

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.

♻️ Duplicate comments (1)
content/networks.md (1)

426-426: ⚠️ Potential issue | 🟡 Minor

Inconsistent code formatting for technical identifier.

The first occurrence of device_index 0 is correctly formatted as inline code, but the second occurrence at the end of the sentence lacks code formatting.

📝 Proposed formatting fix
-When `nic_group` is not specified on a VIP network, the CPI defaults to associating the virtual IP with the primary NIC (`device_index 0`). If `nic_group` is set on the VIP network but does not match any manual or dynamic network's `nic_group`, the CPI also falls back to device_index 0.
+When `nic_group` is not specified on a VIP network, the CPI defaults to associating the virtual IP with the primary NIC (`device_index 0`). If `nic_group` is set on the VIP network but does not match any manual or dynamic network's `nic_group`, the CPI also falls back to `device_index 0`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/networks.md` at line 426, The sentence has an inconsistency in
formatting for the technical identifier: wrap the second occurrence of
device_index 0 in inline code formatting just like the first occurrence; locate
the sentence mentioning nic_group and VIP network and change the trailing
"device_index 0" text to "`device_index 0`" so both mentions use the same inline
code style.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@content/networks.md`:
- Line 426: The sentence has an inconsistency in formatting for the technical
identifier: wrap the second occurrence of device_index 0 in inline code
formatting just like the first occurrence; locate the sentence mentioning
nic_group and VIP network and change the trailing "device_index 0" text to
"`device_index 0`" so both mentions use the same inline code style.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3072aeff-eae1-4ce4-839e-b0e435e8303b

📥 Commits

Reviewing files that changed from the base of the PR and between 343a888 and 41c6b1e.

📒 Files selected for processing (1)
  • content/networks.md

@github-project-automation github-project-automation bot moved this from Waiting for Changes | Open for Contribution to Pending Merge | Prioritized in Foundational Infrastructure Working Group Apr 3, 2026
@neddp
Copy link
Copy Markdown
Member Author

neddp commented Apr 3, 2026

The CPI version is now populated. I also took the initiative to split the CPI limitation table into two separate ones so it is easier to read.
image

Plus some formatting.

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

Labels

None yet

Projects

Status: Pending Merge | Prioritized

Development

Successfully merging this pull request may close these issues.

4 participants