Skip to content

CNTRLPLANE-3361: kms: generalize ensureVolumeMountInContainer helper #2253

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
openshift-merge-bot merged 1 commit into from
Jun 2, 2026
+35 −17
Merged

CNTRLPLANE-3361: kms: generalize ensureVolumeMountInContainer helper #2253

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
35 changes: 18 additions & 17 deletions pkg/operator/encryption/kms/pluginlifecycle/sidecar.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,18 @@ import (
"github.com/openshift/library-go/pkg/operator/configobserver/featuregates"
"github.com/openshift/library-go/pkg/operator/encryption/encryptiondata"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
"k8s.io/klog/v2"
)

const (
kmsPluginSocketVolumeName = "kms-plugin-socket"
kmsPluginSocketMountPath = "/var/run/kmsplugin"
)

// sidecarProvider abstracts the construction of a KMS plugin sidecar container for a specific provider (e.g. Vault).
type sidecarProvider interface {
// Name returns the identifier used to name the sidecar container and locate its volume mounts.
Expand Down Expand Up @@ -83,6 +89,7 @@ func AddKMSPluginSidecarToPodSpec(ctx context.Context, podSpec *corev1.PodSpec,

klog.V(4).Infof("injecting %d KMS sidecar(s)", len(kmsConfigurations))

socketVolumeMount := corev1.VolumeMount{Name: kmsPluginSocketVolumeName, MountPath: kmsPluginSocketMountPath, ReadOnly: false}
for _, kmsConfiguration := range kmsConfigurations {
// ExtractUniqueAndSortedKMSConfigurations function rewrites the .Name field to include only the key ID
keyID := kmsConfiguration.Name
Expand All @@ -102,12 +109,12 @@ func AddKMSPluginSidecarToPodSpec(ctx context.Context, podSpec *corev1.PodSpec,
return err
}

if err := ensureSocketVolumeMountInContainer(podSpec.InitContainers, sidecarProvider.Name()); err != nil {
if err := ensureVolumeMountInContainer(podSpec.InitContainers, sidecarProvider.Name(), socketVolumeMount); err != nil {
return err
}
}

if err := ensureSocketVolumeMountInContainer(podSpec.Containers, containerName); err != nil {
if err := ensureVolumeMountInContainer(podSpec.Containers, containerName, socketVolumeMount); err != nil {
return err
}

Expand All @@ -134,7 +141,7 @@ func ensureSidecarContainer(podSpec *corev1.PodSpec, provider sidecarProvider) e
return nil
}

func ensureSocketVolumeMountInContainer(containers []corev1.Container, containerName string) error {
func ensureVolumeMountInContainer(containers []corev1.Container, containerName string, volumeMount corev1.VolumeMount) error {
containerIndex := -1
for i, container := range containers {
if container.Name == containerName {
Expand All @@ -147,35 +154,29 @@ func ensureSocketVolumeMountInContainer(containers []corev1.Container, container
return fmt.Errorf("container %s not found", containerName)
}

foundMount := false
container := &containers[containerIndex]
for _, m := range container.VolumeMounts {
if m.Name == "kms-plugin-socket" {
foundMount = true
break
if m.Name == volumeMount.Name {
if !equality.Semantic.DeepEqual(m, volumeMount) {
return fmt.Errorf("container %s already has volume mount %s with different settings", containerName, volumeMount.Name)
}
return nil
Copy link
Copy Markdown
Contributor

@p0lyn0mial p0lyn0mial Jun 2, 2026

Choose a reason for hiding this comment

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

let's check if the existing volume has the same settings and return an err if not.

Copy link
Copy Markdown
Contributor

@p0lyn0mial p0lyn0mial Jun 2, 2026

Choose a reason for hiding this comment

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

let's also add a new test case for ^

Copy link
Copy Markdown
Member Author

@bertinatto bertinatto Jun 2, 2026

Choose a reason for hiding this comment

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

done

}
}
if !foundMount {
container.VolumeMounts = append(container.VolumeMounts,
corev1.VolumeMount{
Name: "kms-plugin-socket",
MountPath: "/var/run/kmsplugin",
},
)
}
container.VolumeMounts = append(container.VolumeMounts, volumeMount)
return nil
}

func ensureSocketVolume(podSpec *corev1.PodSpec) {
for _, volume := range podSpec.Volumes {
if volume.Name == "kms-plugin-socket" {
if volume.Name == kmsPluginSocketVolumeName {
return
}
}

podSpec.Volumes = append(podSpec.Volumes,
corev1.Volume{
Name: "kms-plugin-socket",
Name: kmsPluginSocketVolumeName,
VolumeSource: corev1.VolumeSource{
EmptyDir: &corev1.EmptyDirVolumeSource{},
},
Expand Down
17 changes: 17 additions & 0 deletions pkg/operator/encryption/kms/pluginlifecycle/sidecar_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,23 @@ func TestAddKMSPluginSidecarToPodSpec(t *testing.T) {
secretClient: secretClient(f.encryptionConfigSecret),
featureGateAccessor: featuregates.NewHardcodedFeatureGateAccess([]configv1.FeatureGateName{features.FeatureGateKMSEncryption}, nil),
},
{
name: "conflicting volume mount on API server container",
actualPodSpec: &corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "kube-apiserver",
VolumeMounts: []corev1.VolumeMount{
{Name: "kms-plugin-socket", MountPath: "/other/path"},
},
},
},
Volumes: []corev1.Volume{f.resourceDirVolume},
},
secretClient: secretClient(f.encryptionConfigSecret),
featureGateAccessor: featuregates.NewHardcodedFeatureGateAccess([]configv1.FeatureGateName{features.FeatureGateKMSEncryption}, nil),
wantErr: "already has volume mount kms-plugin-socket with different settings",
},
}

for _, tt := range tests {
Expand Down