Skip to content

Fixes for blueprint option validation in Fedora [HMS-6871] #1823

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

Merged
achilleas-k merged 3 commits into from
Sep 4, 2025
Merged

Fixes for blueprint option validation in Fedora [HMS-6871] #1823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24ee165
distro/generic: fix ostree url requirement for Fedora IoT disk images
achilleas-k Sep 2, 2025
8134f64
distro/generic: remove image type name condition
achilleas-k Sep 2, 2025
6fe83c2
distrodefs/fedora: support containers on ostree commits
achilleas-k Sep 3, 2025
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
1 change: 1 addition & 0 deletions data/distrodefs/fedora/imagetypes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -789,6 +789,7 @@
- "modules"
- "groups"
- "minimal"
- "containers"
- "customizations.directories"
- "customizations.files"
- "customizations.fips"
Expand Down
2 changes: 1 addition & 1 deletion pkg/distro/generic/fedora_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ func TestFedoraDistro_ManifestError(t *testing.T) {
case "iot-simplified-installer":
assert.EqualError(t, err, fmt.Sprintf("blueprint validation failed for image type %q: customizations.installation_device: required", imgTypeName))
case "iot-raw-xz", "iot-qcow2":
assert.EqualError(t, err, fmt.Sprintf("%s: ostree commit URL required", imgTypeName))
assert.EqualError(t, err, fmt.Sprintf("options validation failed for image type %q: ostree.url: required", imgTypeName))
case "container", "wsl", "iot-bootable-container":
assert.EqualError(t, err, fmt.Sprintf("blueprint validation failed for image type %q: customizations: not supported", imgTypeName))
default:
Expand Down
59 changes: 26 additions & 33 deletions pkg/distro/generic/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,46 +542,39 @@ func checkOptionsFedora(t *imageType, bp *blueprint.Blueprint, options distro.Im
}
}

if t.BootISO && t.RPMOSTree {
if (t.BootISO || t.Bootable) && t.RPMOSTree {
// ostree-based ISOs require a URL from which to pull a payload commit
if options.OSTree == nil || options.OSTree.URL == "" {
return warnings, fmt.Errorf("options validation failed for image type %q: ostree.url: required", t.Name())
}
}

// BootISOs have limited support for customizations.
// TODO: Support kernel name selection for image-installer
if t.BootISO {
if t.Name() == "iot-simplified-installer" {
// FDO is optional, but when specified has some restrictions
if customizations.GetFDO() != nil {
if customizations.GetFDO().ManufacturingServerURL == "" {
return warnings, fmt.Errorf("%s: customizations.fdo.manufacturing_server_url: required when using fdo", errPrefix)
}
var diunSet int
if customizations.GetFDO().DiunPubKeyHash != "" {
diunSet++
}
if customizations.GetFDO().DiunPubKeyInsecure != "" {
diunSet++
}
if customizations.GetFDO().DiunPubKeyRootCerts != "" {
diunSet++
}
if diunSet != 1 {
return warnings, fmt.Errorf("%s: one of customizations.fdo.diun_pub_key_hash, customizations.fdo.diun_pub_key_insecure, customizations.fdo.diun_pub_key_root_certs: required when using fdo", errPrefix)
}
}
// FDO is optional, but when specified has some restrictions
if customizations.GetFDO() != nil {
if customizations.GetFDO().ManufacturingServerURL == "" {
return warnings, fmt.Errorf("%s: customizations.fdo.manufacturing_server_url: required when using fdo", errPrefix)
}
var diunSet int
if customizations.GetFDO().DiunPubKeyHash != "" {
diunSet++
}
if customizations.GetFDO().DiunPubKeyInsecure != "" {
diunSet++
}
if customizations.GetFDO().DiunPubKeyRootCerts != "" {
diunSet++
}
if diunSet != 1 {
return warnings, fmt.Errorf("%s: one of customizations.fdo.diun_pub_key_hash, customizations.fdo.diun_pub_key_insecure, customizations.fdo.diun_pub_key_root_certs: required when using fdo", errPrefix)
Copy link
Contributor

@mvo5 mvo5 Sep 3, 2025

Choose a reason for hiding this comment

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

(nitpick) maybe %s: exactly one of ... required, got: %v (or even just collect the extra ones in a var diunSet []string (but that is probably overdoing it :)

Copy link
Member Author

@achilleas-k achilleas-k Sep 4, 2025

Choose a reason for hiding this comment

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

Yeah that's a nice change. I'll include it in the next batch.

}
}

// ignition is optional, we might be using FDO
if customizations.GetIgnition() != nil {
if customizations.GetIgnition().Embedded != nil && customizations.GetIgnition().FirstBoot != nil {
return warnings, fmt.Errorf("%s: customizations.ignition.embedded cannot be used with customizations.ignition.firstboot", errPrefix)
}
if customizations.GetIgnition().FirstBoot != nil && customizations.GetIgnition().FirstBoot.ProvisioningURL == "" {
return warnings, fmt.Errorf("%s: customizations.ignition.firstboot requires customizations.ignition.firstboot.provisioning_url", errPrefix)
}
}
if customizations.GetIgnition() != nil {
if customizations.GetIgnition().Embedded != nil && customizations.GetIgnition().FirstBoot != nil {
return warnings, fmt.Errorf("%s: customizations.ignition.embedded cannot be used with customizations.ignition.firstboot", errPrefix)
}
if customizations.GetIgnition().FirstBoot != nil && customizations.GetIgnition().FirstBoot.ProvisioningURL == "" {
return warnings, fmt.Errorf("%s: customizations.ignition.firstboot requires customizations.ignition.firstboot.provisioning_url", errPrefix)
}
}

Expand Down
12 changes: 7 additions & 5 deletions pkg/distro/generic/options_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ func TestCheckOptions(t *testing.T) {
"f42/ostree-disk-supported": {
distro: "fedora-42",
it: "iot-qcow2",
options: distro.ImageOptions{
OSTree: &ostree.ImageOptions{
URL: "https://example.org/repo",
},
},
bp: blueprint.Blueprint{
Customizations: &blueprint.Customizations{
User: []blueprint.UserCustomization{{Name: "root"}},
Expand All @@ -75,7 +80,6 @@ func TestCheckOptions(t *testing.T) {
FIPS: common.ToPtr(true),
},
},
// NOTE: this should also require an ostree URL
},
"f42/ostree-disk-not-supported": {
distro: "fedora-42",
Expand Down Expand Up @@ -509,17 +513,15 @@ func TestCheckOptions(t *testing.T) {
expErr: "blueprint validation failed for image type \"server-vhd\": customizations.oscap.profile_id: required when using customizations.oscap",
},

// NOTE: the following tests verify the current behaviour of the
// function, but the behaviour itself is wrong
"f42/ostree-disk-requires-ostree-url": {
distro: "fedora-42",
it: "iot-qcow2",
expErr: "", // NOTE: it should require a URL
expErr: "options validation failed for image type \"iot-qcow2\": ostree.url: required",
},
"f42/ostree-disk2-requires-ostree-url": {
distro: "fedora-42",
it: "iot-raw-xz",
expErr: "", // NOTE: it should require a URL
expErr: "options validation failed for image type \"iot-raw-xz\": ostree.url: required",
},

"r8/ami-ok": {
Expand Down
Loading