Skip to content

Add annotation for additional GCS args #2805

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

Open
helsaawy wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −6
Open

Add annotation for additional GCS args #2805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions internal/annotations/annotations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ const (
// work to support multiple custom network routes per adapter in LCOW breaks existing
// LCOW scenarios. Ideally, this annotation should be removed if no issues are found.
NetworkingPolicyBasedRouting = "io.microsoft.virtualmachine.lcow.network.policybasedrouting"

// ExtraLCOWExecArgs specifies additional args to pass to the command exec'd by the LCOW init.
ExtraLCOWExecArgs = "io.microsoft.virtualmachine.lcow.extra-exec-command-args"
)

// WCOW uVM annotations.
Expand Down
19 changes: 13 additions & 6 deletions internal/builder/vm/lcow/kernel_args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func buildKernelArgs(
kernelDirect bool,
hasConsole bool,
rootFsFile string,
LiveMigrationSupportEnabled bool,
liveMigrationSupportEnabled bool,
) (string, error) {

log.G(ctx).WithField("rootFsFile", rootFsFile).Debug("buildKernelArgs: starting kernel arguments construction")
Expand Down Expand Up @@ -82,7 +82,8 @@ func buildKernelArgs(
args = append(args, "brd.rd_nr=0", "pmtmr=0")

// 8. Init arguments (passed after "--" separator)
initArgs := buildInitArgs(ctx, opts, writableOverlayDirs, disableTimeSyncService, processDumpLocation, rootFsFile, hasConsole, LiveMigrationSupportEnabled)
initArgs := buildInitArgs(ctx, opts, annotations,
writableOverlayDirs, disableTimeSyncService, processDumpLocation, rootFsFile, hasConsole, liveMigrationSupportEnabled)
args = append(args, "--", initArgs)

result := strings.Join(args, " ")
Expand Down Expand Up @@ -146,12 +147,13 @@ func buildConsoleArgs(hasConsole bool) []string {
func buildInitArgs(
ctx context.Context,
opts *runhcsoptions.Options,
annotations map[string]string,
writableOverlayDirs bool,
disableTimeSyncService bool,
processDumpLocation string,
rootFsFile string,
hasConsole bool,
LiveMigrationSupportEnabled bool,
liveMigrationSupportEnabled bool,
) string {
log.G(ctx).WithFields(logrus.Fields{
"rootFsFile": rootFsFile,
Expand All @@ -161,7 +163,7 @@ func buildInitArgs(
entropyArgs := fmt.Sprintf("-e %d", vmutils.LinuxEntropyVsockPort)

// Build GCS execution command
gcsCmd := buildGCSCommand(opts, disableTimeSyncService, processDumpLocation, LiveMigrationSupportEnabled)
gcsCmd := buildGCSCommand(opts, annotations, disableTimeSyncService, processDumpLocation, liveMigrationSupportEnabled)

// Construct init arguments
var initArgsList []string
Expand Down Expand Up @@ -193,9 +195,10 @@ func buildInitArgs(
// buildGCSCommand constructs the GCS (Guest Compute Service) command line.
func buildGCSCommand(
opts *runhcsoptions.Options,
annotations map[string]string,
disableTimeSyncService bool,
processDumpLocation string,
LiveMigrationSupportEnabled bool,
liveMigrationSupportEnabled bool,
) string {
// Determine log level
logLevel := "info"
Expand Down Expand Up @@ -225,6 +228,10 @@ func buildGCSCommand(
gcsParts = append(gcsParts, "-core-dump-location", processDumpLocation)
}

if s := oci.ParseAnnotationsString(annotations, iannotations.ExtraLCOWExecArgs, ""); s != "" {
gcsParts = append(gcsParts, s)
}

gcsCmd := strings.Join(gcsParts, " ")

// Live-migratable pods skip the /bin/vsockexec wrapper. The wrapper exists
Expand All @@ -233,7 +240,7 @@ func buildGCSCommand(
// does not run it for these pods.
// Without a listener, vsockexec's outbound connect would block and stall guest init,
// so we emit /bin/gcs directly instead.
if LiveMigrationSupportEnabled {
if liveMigrationSupportEnabled {
return gcsCmd
}

Expand Down
9 changes: 9 additions & 0 deletions internal/oci/uvm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,14 @@ func parseAnnotationsPreferredRootFSType(ctx context.Context, a map[string]strin
return def
}

// handleAnnotationBootFilesPath handles parsing annotations.BootFilesRootPath and setting
// implied options from the result.
func handleLCOWAnnotationExtraExecArgs(_ context.Context, a map[string]string, lopts *uvm.OptionsLCOW) {
if s := ParseAnnotationsString(a, iannotations.ExtraLCOWExecArgs, ""); s != "" {
lopts.ExecCommandLine += " " + s
}
}

// handleAnnotationBootFilesPath handles parsing annotations.BootFilesRootPath and setting
// implied options from the result.
func handleAnnotationBootFilesPath(ctx context.Context, a map[string]string, lopts *uvm.OptionsLCOW) {
Expand Down Expand Up @@ -388,6 +396,7 @@ func SpecToUVMCreateOpts(ctx context.Context, s *specs.Spec, id, owner string) (
handleAnnotationPreferredRootFSType(ctx, s.Annotations, lopts)
handleAnnotationKernelDirectBoot(ctx, s.Annotations, lopts)
handleAnnotationFullyPhysicallyBacked(ctx, s.Annotations, lopts)
handleLCOWAnnotationExtraExecArgs(ctx, s.Annotations, lopts)

// SecurityPolicy is very sensitive to other settings and will silently change those that are incompatible.
// Eg VMPem device count, overridden kernel option cannot be respected.
Expand Down
Loading