platform/metal: document installerConfig struct

jlebon · jlebon · commit 57528fcb1246 · 2025-08-21T09:04:29.000-04:00
Haven't looked at this code in a while. It took me a second to realize
this was talking about the coreos-installer config file.
diff --git a/mantle/platform/metal.go b/mantle/platform/metal.go
@@ -587,6 +587,8 @@ func (inst *Install) runPXE(kern *kernelSetup, offline bool) (*InstalledMachine,
 	return &instmachine, nil
 }
 
+// This object gets serialized to YAML and fed to coreos-installer:
+// https://coreos.github.io/coreos-installer/customizing-install/#config-file-format
 type installerConfig struct {
 	ImageURL     string   `yaml:"image-url,omitempty"`
 	IgnitionFile string   `yaml:"ignition-file,omitempty"`

Original file line number	Diff line number	Diff line change
`@@ -587,6 +587,8 @@ func (inst Install) runPXE(kern kernelSetup, offline bool) (*InstalledMachine,`
`587`	`587`	`return &instmachine, nil`
`588`	`588`	`}`
`589`	`589`
	`590`	`+// This object gets serialized to YAML and fed to coreos-installer:`
	`591`	`+// https://coreos.github.io/coreos-installer/customizing-install/#config-file-format`
`590`	`592`	`type installerConfig struct {`
`591`	`593`	ImageURL string `yaml:"image-url,omitempty"`
`592`	`594`	IgnitionFile string `yaml:"ignition-file,omitempty"`