feat: IPXE OS using templates and designated arguments/artifacts by pbreton · Pull Request #434 · NVIDIA/bare-metal-manager-core

pbreton · 2026-03-03T22:22:48Z

Description

Add a third variant for Operating Systems using iPXE script templates and allowing fine control on arguments and artifacts.
This is to enable local caching in the future and tighter control on Operating systems for DGX OS.
Remains compatible with existing code.

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.)

Related Issues (Optional)

Breaking Changes: NO

Testing

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

Signed-off-by: Patrice Breton <pbreton@nvidia.com> # Conflicts: # Cargo.lock

Signed-off-by: Patrice Breton <pbreton@nvidia.com>

copy-pr-bot · 2026-03-03T22:22:51Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Copilot

Pull request overview

Adds a new “template-based iPXE OS definition” variant to the OS model and RPC API, backed by a new carbide-ipxe-renderer crate that renders iPXE scripts from embedded YAML templates (with parameter/artifact validation and hashing). This is intended to enable finer control over OS boot scripts and future artifact caching/proxying while remaining compatible with existing OS flows.

Changes:

Extend Forge RPC/proto + RBAC with iPXE template discovery APIs (GetIpxeTemplate, ListIpxeTemplates) and a new OperatingSystem oneof variant (ipxe_os_def).
Introduce crates/ipxe-renderer with embedded templates.yaml and a renderer implementation + unit tests.
Wire template rendering into PXE instruction generation for the new OperatingSystemVariant::IpxeOsDefinition.

Reviewed changes

Copilot reviewed 16 out of 17 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
`crates/rpc/proto/forge.proto`	Adds new RPCs and proto messages/enums for template-based iPXE OS definitions and template listing.
`crates/rpc/build.rs`	Adds serde derives for newly introduced Forge proto types.
`crates/ipxe-renderer/src/lib.rs`	Implements template loading/rendering, validation, hashing, and local-URL fabrication; adds unit tests.
`crates/ipxe-renderer/templates.yaml`	Defines the embedded iPXE script templates.
`crates/ipxe-renderer/README.md`	Documents renderer usage, template system, and validation.
`crates/ipxe-renderer/Cargo.toml`	New crate manifest for the renderer.
`crates/api/src/ipxe.rs`	Adds rendering path for `OperatingSystemVariant::IpxeOsDefinition` in PXE instructions.
`crates/api/src/api.rs`	Implements `GetIpxeTemplate` / `ListIpxeTemplates` RPC handlers backed by the renderer.
`crates/api/src/auth/internal_rbac_rules.rs`	Grants permissions for the new template RPCs.
`crates/api/src/web/instance.rs`	Adds a match arm for the new RPC OS variant (currently returns default).
`crates/api-model/src/os.rs`	Adds the new OS variant and RPC conversion logic.
`crates/api-db/src/lib.rs`	Exposes a new `ipxe_os_definition` DB module (but see review comments).
`crates/api-db/src/instance.rs`	Adds match arms for the new OS variant during persistence (currently a no-op).
`crates/api/Cargo.toml` / `crates/api-db/Cargo.toml` / `Cargo.lock`	Wires in the new renderer crate dependency.
`crates/admin-cli/src/instance/cmds.rs`	Displays the new OS variant in instance output.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

crates/api/src/ipxe.rs

Copilot · 2026-03-03T22:29:04Z

crates/api-db/src/instance.rs

            os_ipxe_script = ipxe.ipxe_script.clone();
        }
        OperatingSystemVariant::OsImage(id) => os_image_id = Some(id),
+        OperatingSystemVariant::IpxeOsDefinition(_) => {}


The IpxeOsDefinition variant is ignored during persistence ({}), which means instances will be written with empty os_ipxe_script and NULL os_image_id. On read-back this will look like an inline iPXE OS with an empty script, and the OS-definition ID is lost. Add a DB column (e.g., os_ipxe_os_definition_id) and persist it here (and in snapshot/reads) so the new variant round-trips correctly.

Copilot · 2026-03-03T22:29:05Z

crates/ipxe-renderer/README.md

+let mut ipxeos = IpxeOs {
+    id: "test-os".to_string(),
+    name: "Ubuntu 22.04".to_string(),
+    ipxe_template_name: "qcow-image".to_string(),
+    parameters: vec![


The README example doesn’t match the actual IpxeOs struct in src/lib.rs (e.g., it sets id, which is commented out / not a field). Update the example to use only real fields (name, description, hash, tenant_id, ipxe_template_name, parameters, artifacts, ...), otherwise users copying it will hit compile errors.

crates/ipxe-renderer/README.md

crates/ipxe-renderer/templates.yaml

Copilot · 2026-03-03T22:29:06Z

crates/api-db/src/lib.rs

 pub mod instance_network_config;
 pub mod instance_type;
 pub mod ip_allocator;
+pub mod ipxe_os_definition;


pub mod ipxe_os_definition; is added, but there is no corresponding ipxe_os_definition.rs (or ipxe_os_definition/mod.rs) in crates/api-db/src. As-is, this will fail to compile; either add the missing module file(s) or remove the module declaration until the implementation is included.

Suggested change

pub mod ipxe_os_definition;

Copilot · 2026-03-03T22:29:06Z

crates/ipxe-renderer/src/lib.rs

+            for value in values {
+                if let Some(pos) = result.find(&placeholder) {
+                    result.replace_range(pos..pos + placeholder.len(), value);


Placeholder substitution only replaces the first occurrence of each {{name}} (via find + replace_range). Several templates include the same placeholder multiple times (e.g., discovery-scout-aarch64-dpu uses {{base_url}} twice), which will leave unreplaced placeholders and cause render failures. Replace all occurrences (e.g., loop while find returns Some, or use replace when the same value should fill every occurrence).

Suggested change

for value in values {

if let Some(pos) = result.find(&placeholder) {

result.replace_range(pos..pos + placeholder.len(), value);

if values.len() == 1 {

// If there is a single value, replace all occurrences of this placeholder with it

let value = &values[0];

result = result.replace(&placeholder, value);

} else {

// If there are multiple values, replace one occurrence per value (preserve existing behavior)

for value in values {

if let Some(pos) = result.find(&placeholder) {

result.replace_range(pos..pos + placeholder.len(), value);

}

Copilot · 2026-03-03T22:29:06Z

crates/api-db/src/instance.rs

            os_ipxe_script = ipxe.ipxe_script.clone();
        }
        OperatingSystemVariant::OsImage(id) => os_image_id = Some(id),
+        OperatingSystemVariant::IpxeOsDefinition(_) => {}


The IpxeOsDefinition variant is ignored during persistence ({}), which means instances will be written with empty os_ipxe_script and NULL os_image_id. On read-back this will look like an inline iPXE OS with an empty script, and the OS-definition ID is lost. Add a DB column (e.g., os_ipxe_os_definition_id) and persist it here (and in snapshot/reads) so the new variant round-trips correctly.

Copilot · 2026-03-03T22:29:07Z

crates/api-db/src/instance.rs

                os_ipxe_script = ipxe.ipxe_script.clone();
            }
            OperatingSystemVariant::OsImage(id) => os_image_id = Some(*id),
+            OperatingSystemVariant::IpxeOsDefinition(_) => {}


The IpxeOsDefinition variant is ignored during persistence ({}), which means instances will be written with empty os_ipxe_script and NULL os_image_id. On read-back this will look like an inline iPXE OS with an empty script, and the OS-definition ID is lost. Add a DB column (e.g., os_ipxe_os_definition_id) and persist it here (and in snapshot/reads) so the new variant round-trips correctly.

Copilot · 2026-03-03T22:29:07Z

crates/ipxe-renderer/src/lib.rs

+
+        let has_extra_params = ipxeos
+            .parameters
+            .iter()


has_extra_params treats any parameter not listed in required_params/reserved_params as an extra param, even when its value is empty. Since rendering already ignores empty values, this can incorrectly reject OS definitions (when the template lacks {{extra}}) due solely to empty optional inputs. Consider filtering has_extra_params to only count non-empty parameters.

Suggested change

let has_extra_params = ipxeos

.parameters

.iter()

// Only treat parameters with non-empty values as "provided" when checking for extras,

// since rendering already ignores empty-valued parameters.

let has_extra_params = ipxeos

.parameters

.iter()

.filter(|p| !p.value.is_empty())

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: pbreton <pbreton@users.noreply.github.com>

pbreton added 7 commits February 23, 2026 08:55

feat: add crate for ipxe_renderer

f43f1ad

Signed-off-by: Patrice Breton <pbreton@nvidia.com> # Conflicts: # Cargo.lock

integrate ipxe_renderer with get_pxe_instruction_for_arch

ea3a9ac

Signed-off-by: Patrice Breton <pbreton@nvidia.com>

add raw-ipxe script template

658fda8

Signed-off-by: Patrice Breton <pbreton@nvidia.com>

removed render_with_artifact_substitution

d4810fc

Signed-off-by: Patrice Breton <pbreton@nvidia.com>

add ipxe renderer templates covering most production use cases

0ad1523

Signed-off-by: Patrice Breton <pbreton@nvidia.com>

cleanup

e17f76a

Signed-off-by: Patrice Breton <pbreton@nvidia.com>

fix tests

ebd5a08

Signed-off-by: Patrice Breton <pbreton@nvidia.com>

Copilot AI review requested due to automatic review settings March 3, 2026 22:22

pbreton requested a review from a team as a code owner March 3, 2026 22:22

pbreton changed the title ~~feat: IPXE OS using templates and designated arguments and artifacts~~ feat: IPXE OS using templates and designated arguments/artifacts Mar 3, 2026

Copilot started reviewing on behalf of pbreton March 3, 2026 22:23 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

pbreton and others added 3 commits March 3, 2026 16:00

Update crates/api/src/ipxe.rs

a367283

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: pbreton <pbreton@users.noreply.github.com>

Update crates/ipxe-renderer/README.md

0b5255a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: pbreton <pbreton@users.noreply.github.com>

Update crates/ipxe-renderer/templates.yaml

90a5b7c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: pbreton <pbreton@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: IPXE OS using templates and designated arguments/artifacts #434

feat: IPXE OS using templates and designated arguments/artifacts #434
pbreton wants to merge 10 commits intoNVIDIA:mainfrom
pbreton:feat/ipxe-template-renderer

pbreton commented Mar 3, 2026

Uh oh!

copy-pr-bot bot commented Mar 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

pbreton commented Mar 3, 2026

Description

Type of Change

Related Issues (Optional)

Breaking Changes: NO

Testing

Uh oh!

copy-pr-bot bot commented Mar 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants