Skip to content

Update docs for prior PRs #3512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stoo-davies wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −1
Open

Update docs for prior PRs #3512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/development/build-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Two git submodules are pinned to known-good versions:
| Submodule | Path | Pinned version |
|-----------|------|----------------|
| mkosi | `pxe/mkosi` | `v25` |
| iPXE (secboot fork) | `pxe/ipxe/upstream` | `secboot-ioactive-20221109-302-gd7e58c5a8` |
| iPXE (upstream) | `pxe/ipxe/upstream` | `v2.0.0-130-gbbd7821bd8` |

@coderabbitai coderabbitai Bot Jul 14, 2026

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.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

remote="https://github.com/ipxe/ipxe.git"
ref="v2.0.0-130-gbbd7821bd8"

git ls-remote --exit-code "$remote" "refs/tags/$ref" >/dev/null ||
  git ls-remote "$remote" | awk '$1 ~ /^bbd7821bd8/ { found=1 } END { exit !found }'

Repository: NVIDIA/infra-controller

Length of output: 161

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n--- docs/development/build-guide.md (around line 12) ---\n'
sed -n '1,40p' docs/development/build-guide.md

printf '\n--- submodule metadata ---\n'
if [ -f .gitmodules ]; then
  cat -n .gitmodules
fi

printf '\n--- repo references to v2.0.0-130-gbbd7821bd8 ---\n'
rg -n "v2\.0\.0-130-gbbd7821bd8|pxe/ipxe/upstream|ipxe" docs .gitmodules . || true

Repository: NVIDIA/infra-controller

Length of output: 50383

🌐 Web query:

iPXE "v2.0.0-130-gbbd7821bd8" tag or commit

💡 Result:

The string v2.0.0-130-gbbd7821bd8 is not a recognized tag or official release version for iPXE [1][2]. iPXE uses a versioning format for rolling releases generated from the Git repository, typically following the pattern v<last_tag>-<number_of_commits_since_tag>-g<commit_hash>. Based on the official iPXE repository, the version v2.0.0 was released on March 6, 2026, with the commit SHA 12798ec29aa8a64d8675c4378b99f5fe28447afb [1][3]. The specific string v2.0.0-130-gbbd7821bd8 appears to be a misidentified or non-existent build string in the context of the iPXE project. While v2.0.0 is the current stable major release, there is no evidence of a build with that specific commit hash (bbd7821bd8) in the official iPXE codebase [1][3]. Furthermore, searches indicate that the hex code bbd782 corresponds to a color, and similar versioning strings appear in unrelated repositories, such as the AWS CDK, which uses v2.130.0 [4][5].

Citations:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '--- superproject gitlink for pxe/ipxe/upstream ---\n'
git ls-tree HEAD pxe/ipxe/upstream || true

printf '\n--- submodule repository presence ---\n'
if [ -d .git/modules/pxe/ipxe/upstream ]; then
  echo ".git/modules/pxe/ipxe/upstream exists"
  git --git-dir=.git/modules/pxe/ipxe/upstream rev-parse --verify HEAD
  printf '\nrecent refs (if any):\n'
  git --git-dir=.git/modules/pxe/ipxe/upstream show-ref --head | tail -n 20
else
  echo "submodule repo not present"
fi

Repository: NVIDIA/infra-controller

Length of output: 252

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo '--- gitlink for pxe/ipxe/upstream in HEAD ---'
git ls-tree HEAD pxe/ipxe/upstream || true

echo
echo '--- submodule directory check ---'
if [ -d pxe/ipxe/upstream ]; then
  echo 'pxe/ipxe/upstream exists'
  if [ -d .git/modules/pxe/ipxe/upstream ]; then
    echo 'submodule gitdir exists'
    git --git-dir=.git/modules/pxe/ipxe/upstream rev-parse --verify HEAD
    echo
    echo 'HEAD commit object type:'
    git --git-dir=.git/modules/pxe/ipxe/upstream cat-file -t HEAD
  else
    echo 'submodule gitdir missing'
  fi
else
  echo 'pxe/ipxe/upstream directory missing'
fi

echo
echo '--- iPXE version string references in repo (limited) ---'
rg -n --max-count 20 'v2\.0\.0-130-gbbd7821bd8|pxe/ipxe/upstream|iPXE \(upstream\)' docs .gitmodules || true

Repository: NVIDIA/infra-controller

Length of output: 773

Update the iPXE pin in docs/development/build-guide.md:12 The table entry should match the submodule gitlink (bbd7821bd42da5456ee068a471ef73d525ea26a1). v2.0.0-130-gbbd7821bd8 does not identify that pinned commit, so use the full SHA or the exact describe string for the commit.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/development/build-guide.md` at line 12, Update the iPXE version entry in
the build-guide table to identify submodule commit
bbd7821bd42da5456ee068a471ef73d525ea26a1, using either the full SHA or its exact
describe string, while leaving the submodule path unchanged.

Source: Path instructions


To update a submodule to a newer version:

Expand Down
6 changes: 6 additions & 0 deletions docs/playbooks/stuck_objects/network_connectivity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ Common causes:
| Request but no lease | no matching reservation or exhausted pool. |
| Lease assigned but no progress | PXE/HTTP boot, scout, or API reachability failure. |

A prior DHCPDECLINE can make Kea reject the correct address with a NAK
because the lease is temporarily marked unavailable.
nico-dhcp.config.kea.declineProbationPeriod now defaults to 900 seconds,
instead of the kea default of 24 hours, limiting how long the address
remains quarantined.
Comment on lines +65 to +69

@coderabbitai coderabbitai Bot Jul 14, 2026

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.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Qualify the probation period as the chart default.

The Helm configuration allows declineProbationPeriod to be overridden, so this should say “defaults to 900 seconds when unset.” Also capitalize Kea for consistency.

Proposed wording 
- nico-dhcp.config.kea.declineProbationPeriod now defaults to 900 seconds,
- instead of the kea default of 24 hours, limiting how long the address
+ When unset, nico-dhcp.config.kea.declineProbationPeriod defaults to 900 seconds,
+ instead of Kea's default of 24 hours, limiting how long the address

As per path instructions, documentation must accurately reflect current deployment configuration and remain clear for operators.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
A prior DHCPDECLINE can make Kea reject the correct address with a NAK
because the lease is temporarily marked unavailable.
nico-dhcp.config.kea.declineProbationPeriod now defaults to 900 seconds,
instead of the kea default of 24 hours, limiting how long the address
remains quarantined.
A prior DHCPDECLINE can make Kea reject the correct address with a NAK
because the lease is temporarily marked unavailable.
When unset, nico-dhcp.config.kea.declineProbationPeriod defaults to 900 seconds,
instead of Kea's default of 24 hours, limiting how long the address
remains quarantined.
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/playbooks/stuck_objects/network_connectivity.md` around lines 65 - 69,
Update the DHCPDECLINE documentation to capitalize “Kea” consistently and state
that nico-dhcp.config.kea.declineProbationPeriod defaults to 900 seconds only
when unset, while preserving the explanation of the temporary quarantine
behavior.

Source: Path instructions


## PXE and HTTP Boot

`nico-pxe` serves discovery images, iPXE scripts, cloud-init, kickstart, BFB
Expand Down
Loading