Skip to content

docs: document iPXE script variables - #5647

Open
rwthompsonii wants to merge 1 commit into
NVIDIA:mainfrom
rwthompsonii:tenant-cloud-init-docs
Open

docs: document iPXE script variables#5647
rwthompsonii wants to merge 1 commit into
NVIDIA:mainfrom
rwthompsonii:tenant-cloud-init-docs

Conversation

@rwthompsonii

@rwthompsonii rwthompsonii commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

adds docs for ipxe script variables used related cloud-init.

Related issues

#5539

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Additional Notes

docs only change

@rwthompsonii
rwthompsonii enabled auto-merge (squash) September 1, 2026 20:52
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 91880110-76bf-46d9-babf-aa76f2bb1172

📥 Commits

Reviewing files that changed from the base of the PR and between 689cb8c and 73aa833.

📒 Files selected for processing (2)
  • docs/index.yml
  • docs/provisioning/ipxe-script-variables.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Summary by CodeRabbit

  • Documentation
    • Added an “iPXE Script Variables” page to the Provisioning documentation.
    • Documented variables provided by the PXE service, including artifact, tenant cloud-init, DPU, Scout, and deprecated cloud-init URLs.
    • Added guidance on installer usage, cloud-init payloads, empty userData, and migration to the tenant cloud-init variable.

Walkthrough

Added a Provisioning documentation page for iPXE script variables. The page describes PXE-provided URLs, cloud-init behavior, empty userData handling, and migration from ${cloudinit-url} to ${tenant-cloudinit-url}. The Provisioning navigation links to the new page.

Changes

iPXE provisioning documentation

Layer / File(s) Summary
Document iPXE script variables
docs/provisioning/ipxe-script-variables.md, docs/index.yml
Added documentation for PXE-provided iPXE variables, cloud-init payloads, empty userData handling, deprecated URL aliases, and migration guidance. Added the page to the Provisioning navigation.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 73aa8

This change only adds documentation for iPXE script variables and a navigation entry; no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the main change: documenting iPXE script variables.
Description check ✅ Passed The description accurately identifies this as a documentation-only change for iPXE script variables related to cloud-init and matches the changeset.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

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

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 73aa833666

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/provisioning/ipxe-script-variables.md
Comment thread docs/provisioning/ipxe-script-variables.md
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown

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.

1 participant