Skip to content

feat: add secure boot option to instance #55

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
gabriel-samfira merged 3 commits into from
Dec 22, 2025
Merged

feat: add secure boot option to instance #55

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7647cef
feat: add secure boot option to instance
n3xt-martin Dec 16, 2025
27905d9
fix: change new specs for simple bool and add missing json definition…
n3xt-martin Dec 17, 2025
aebecda
fix: secureboot extraSpecs are not pointer to values
n3xt-martin Dec 22, 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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,22 @@ To this end, this provider supports the following extra specs schema:
"type": "boolean",
"description": "Enable boot debug on the VM."
},
"disable_updates": {
"type": "boolean",
"description": "Disable OS updates on boot."
},
"enable_secure_boot": {
"type": "boolean",
"desctipyion": "Enable Secure Boot on the VM. Requires a Shielded VM compatible image."
},
"enable_vtpm": {
"type": "boolean",
"desctipyion": "Enable virtual Trusted Platform Module (vTPM) on the VM."
},
"enable_integrity_monitoring": {
"type": "boolean",
"desctipyion": "Enable integrity monitoring on the VM."
},
"runner_install_template": {
"type": "string",
"description": "This option can be used to override the default runner install template. If used, the caller is responsible for the correctness of the template as well as the suitability of the template for the target OS. Use the extra_context extra spec if your template has variables in it that need to be expanded."
Expand Down
5 changes: 5 additions & 0 deletions internal/client/gcp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"cloud.google.com/go/compute/apiv1/computepb"
"github.com/cloudbase/garm-provider-common/params"
"github.com/cloudbase/garm-provider-gcp/config"
"github.com/cloudbase/garm-provider-gcp/internal/spec"

Check failure on line 27 in internal/client/gcp.go

View workflow job for this annotation

GitHub Actions / go-tests 

could not import github.com/cloudbase/garm-provider-gcp/internal/spec (-: # github.com/cloudbase/garm-provider-gcp/internal/spec
"github.com/cloudbase/garm-provider-gcp/internal/util"
"github.com/googleapis/gax-go/v2"
"github.com/googleapis/gax-go/v2/apierror"
Expand Down Expand Up @@ -173,6 +173,11 @@
Items: spec.NetworkTags,
},
ServiceAccounts: spec.ServiceAccounts,
ShieldedInstanceConfig: &computepb.ShieldedInstanceConfig{
EnableSecureBoot: proto.Bool(spec.EnableSecureBoot),
EnableVtpm: proto.Bool(spec.EnableVTPM),
EnableIntegrityMonitoring: proto.Bool(spec.EnableIntegrityMonitoring),
},
}

if !g.cfg.ExternalIPAccess {
Expand Down
17 changes: 17 additions & 0 deletions internal/spec/spec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@
SSHKeys []string `json:"ssh_keys,omitempty" jsonschema:"description=A list of SSH keys to be added to the instance. The format is USERNAME:SSH_KEY"`
EnableBootDebug *bool `json:"enable_boot_debug,omitempty" jsonschema:"description=Enable boot debug on the VM."`
DisableUpdates *bool `json:"disable_updates,omitempty" jsonschema:"description=Disable OS updates on boot."`
// Shielded VM options
EnableSecureBoot bool `json:"enable_secure_boot,omitempty" jsonschema:"description=Enable Secure Boot on the VM. Requires a Shielded VM compatible image."`
EnableVTPM bool `json:"enable_vtpm,omitempty" jsonschema:"description=Enable virtual Trusted Platform Module (vTPM) on the VM."`
EnableIntegrityMonitoring bool `json:"enable_integrity_monitoring,omitempty" jsonschema:"description=Enable integrity monitoring on the VM."`
// The Cloudconfig struct from common package
cloudconfig.CloudConfigSpec
}
Expand Down Expand Up @@ -197,6 +201,10 @@
SSHKeys string
EnableBootDebug bool
DisableUpdates bool
// Shielded VM options
EnableSecureBoot bool
EnableVTPM bool
EnableIntegrityMonitoring bool
}

func (r *RunnerSpec) MergeExtraSpecs(extraSpecs *extraSpecs) {
Expand Down Expand Up @@ -241,6 +249,15 @@
if extraSpecs.DisableUpdates != nil {
r.DisableUpdates = *extraSpecs.DisableUpdates
}
if extraSpecs.EnableSecureBoot {
Copy link
Copy Markdown
Member

@gabriel-samfira gabriel-samfira Dec 22, 2025

Choose a reason for hiding this comment

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

Just a nit (functionally it's the same), for bool values, you can skip the if statement. The result is the same:

  • default value for a bool is false
  • The if in this case only sets the RunnerSpec value if the extra spec is true
  • The same effect can be achieved if you simply do a blind assignment.

This is all for future reference. Saves lines of code and simplifies code paths.

r.EnableSecureBoot = *extraSpecs.EnableSecureBoot

Check failure on line 253 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableSecureBoot (variable of type bool)

Check failure on line 253 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableSecureBoot (variable of type bool)

Check failure on line 253 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableSecureBoot (variable of type bool)
Copy link
Copy Markdown
Member

@gabriel-samfira gabriel-samfira Dec 17, 2025

Choose a reason for hiding this comment

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

This will probably fail to build, as extraSpecs.EnableSecureBoot is not a pointer anymore. For these 3 values, you can just set the RunnerSpec directly. Like so:

r.EnableSecureBoot = extraSpecs.EnableSecureBoot
r.EnableVTPM = extraSpecs.EnableVTPM
r.EnableIntegrityMonitoring = extraSpecs.EnableIntegrityMonitoring

Copy link
Copy Markdown
Contributor Author

@n3xt-martin n3xt-martin Dec 22, 2025

Choose a reason for hiding this comment

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

Aaah my bad, completely forgot to change the tests. That's fixed, thank you!

}
if extraSpecs.EnableVTPM {
r.EnableVTPM = *extraSpecs.EnableVTPM

Check failure on line 256 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableVTPM (variable of type bool)

Check failure on line 256 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableVTPM (variable of type bool)

Check failure on line 256 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableVTPM (variable of type bool)
}
if extraSpecs.EnableIntegrityMonitoring {
r.EnableIntegrityMonitoring = *extraSpecs.EnableIntegrityMonitoring

Check failure on line 259 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableIntegrityMonitoring (variable of type bool) (typecheck)

Check failure on line 259 in internal/spec/spec.go

View workflow job for this annotation

GitHub Actions / go-tests 

invalid operation: cannot indirect extraSpecs.EnableIntegrityMonitoring (variable of type bool)) (typecheck)
}
}

func (r *RunnerSpec) Validate() error {
Expand Down
Loading