Skip to content

Fix collision between sofdep unloading and hard symbol dependency #1301

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
kubernetes-prow merged 1 commit into from
Jul 2, 2026
+59 −31
Merged

Fix collision between sofdep unloading and hard symbol dependency #1301

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
8 changes: 2 additions & 6 deletions internal/pod/workerpodmanager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ func (wpmi *workerPodManagerImpl) LoaderPodTemplate(ctx context.Context, nmc cli
return nil, fmt.Errorf("could not create the base Pod: %v", err)
}

if nms.Config.Modprobe.ModulesLoadingOrder != nil {
if len(nms.Config.Modprobe.ModulesLoadingOrder) > 0 {
if err = setWorkerSofdepConfig(pod, nms.Config.Modprobe.ModulesLoadingOrder); err != nil {
return nil, fmt.Errorf("could not set software dependency for mulitple modules: %v", err)
}
Expand Down Expand Up @@ -238,11 +238,7 @@ func (wpmi *workerPodManagerImpl) UnloaderPodTemplate(ctx context.Context, nmc c
return nil, fmt.Errorf("could not set the worker Pod's security context: %v", err)
}

if nms.Config.Modprobe.ModulesLoadingOrder != nil {
if err = setWorkerSofdepConfig(pod, nms.Config.Modprobe.ModulesLoadingOrder); err != nil {
return nil, fmt.Errorf("could not set software dependency for mulitple modules: %v", err)
}
}
// we skip the softdep configuration, since in unload we will do it with one "modprobe -r" call

if nms.Config.Modprobe.FirmwarePath != "" {
firmwareHostPath := wpmi.workerCfg.FirmwareHostPath
Expand Down
50 changes: 29 additions & 21 deletions internal/pod/workerpodmanager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,13 @@ cp -R /firmware-path/* /tmp/firmware-path;
configAnnotationValue = strings.ReplaceAll(configAnnotationValue, "firmwarePath: /firmware-path\n ", "")
}
tolerationAnotationValue := "- effect: NoExecute\n key: test-key\n value: test-value\n"
annotations := map[string]string{
configAnnotationKey: configAnnotationValue,
tolerationsAnnotationKey: tolerationAnotationValue,
}
if isLoaderPod {
annotations[modulesOrderKey] = modulesOrderValue
}
pod := v1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: WorkerPodName(nmcName, moduleName),
Expand All @@ -495,11 +502,7 @@ cp -R /firmware-path/* /tmp/firmware-path;
actionLabelKey: string(action),
constants.ModuleNameLabel: moduleName,
},
Annotations: map[string]string{
configAnnotationKey: configAnnotationValue,
modulesOrderKey: modulesOrderValue,
tolerationsAnnotationKey: tolerationAnotationValue,
},
Annotations: annotations,
},
Spec: v1.PodSpec{
Tolerations: []v1.Toleration{
Expand Down Expand Up @@ -559,11 +562,6 @@ cp -R /firmware-path/* /tmp/firmware-path;
MountPath: sharedFilesDir,
ReadOnly: true,
},
{
Name: "modules-order",
ReadOnly: true,
MountPath: "/etc/modprobe.d",
},
},
},
},
Expand Down Expand Up @@ -601,21 +599,31 @@ cp -R /firmware-path/* /tmp/firmware-path;
EmptyDir: &v1.EmptyDirVolumeSource{},
},
},
{
Name: "modules-order",
VolumeSource: v1.VolumeSource{
DownwardAPI: &v1.DownwardAPIVolumeSource{
Items: []v1.DownwardAPIVolumeFile{
{
Path: "softdep.conf",
FieldRef: &v1.ObjectFieldSelector{FieldPath: fmt.Sprintf("metadata.annotations['%s']", modulesOrderKey)},
},
},
},
},
}

if isLoaderPod {
softDepVolumeMount := v1.VolumeMount{
Name: "modules-order",
ReadOnly: true,
MountPath: "/etc/modprobe.d",
}
pod.Spec.Containers[0].VolumeMounts = append(pod.Spec.Containers[0].VolumeMounts, softDepVolumeMount)
softdepVolume := v1.Volume{
Name: "modules-order",
VolumeSource: v1.VolumeSource{
DownwardAPI: &v1.DownwardAPIVolumeSource{
Items: []v1.DownwardAPIVolumeFile{
{
Path: "softdep.conf",
FieldRef: &v1.ObjectFieldSelector{FieldPath: fmt.Sprintf("metadata.annotations['%s']", modulesOrderKey)},
},
},
},
},
},
}
pod.Spec.Volumes = append(pod.Spec.Volumes, softdepVolume)
}

if withFirmware {
Expand Down
13 changes: 9 additions & 4 deletions internal/worker/worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,14 +146,19 @@ func (w *worker) UnloadKmod(ctx context.Context, cfg *kmmv1beta1.ModuleConfig, f
if cfg.Modprobe.Args != nil {
args = append(args, cfg.Modprobe.Args.Unload...)
}

args = append(args, moduleName)
if len(cfg.Modprobe.ModulesLoadingOrder) > 0 {

@TomerNewman TomerNewman Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

in here
we check with ModulesLoadingOrder != nil, in order to be consistent with the code I would change to
cfg.Modprobe.ModulesLoadingOrder != nil

@yevgeny-shnaidman yevgeny-shnaidman Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

using len is safer

@TomerNewman TomerNewman Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

so lets change it here to be consistent

@yevgeny-shnaidman yevgeny-shnaidman Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

fixed

w.logger.Info("Preparing to unload multiple modules", "modules", cfg.Modprobe.ModulesLoadingOrder)
args = append(args, cfg.Modprobe.ModulesLoadingOrder...)
} else {
w.logger.Info("Preparing to unload single module", "moduleName", moduleName)
args = append(args, moduleName)
}
}

w.logger.Info("Unloading module", "name", moduleName)
w.logger.Info("Starting unloading", "args", args)

if err := w.mr.Run(ctx, args...); err != nil {
return fmt.Errorf("could not unload module %s: %v", moduleName, err)
return fmt.Errorf("failed to unload module %q: %v", args, err)
}

//remove firmware files only (no directories)
Expand Down
19 changes: 19 additions & 0 deletions internal/worker/worker_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,25 @@ var _ = Describe("worker_UnloadKmod", func() {
)
})

It("should use ModulesLoadingOrder when set", func() {
cfg := v1beta1.ModuleConfig{
ContainerImage: imageName,
Modprobe: v1beta1.ModprobeSpec{
ModuleName: moduleName,
DirName: dirName,
ModulesLoadingOrder: []string{"a", "b", "c"},
},
}

mr.EXPECT().Run(ctx, "-rvd", filepath.Join(sharedFilesDir, dirName), "a", "b", "c")

Expect(
w.UnloadKmod(ctx, &cfg, ""),
).NotTo(
HaveOccurred(),
)
})

It("should remove all firmware file only", func() {
cfg := v1beta1.ModuleConfig{
ContainerImage: imageName,
Expand Down
Loading