Skip to content

Preserve runconfig-checksum on pod template overrides #5149

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
jhrozek merged 2 commits into from
May 5, 2026
+102 −1
Merged

Preserve runconfig-checksum on pod template overrides #5149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e9e798
Preserve runconfig-checksum on pod template overrides
jhrozek May 1, 2026
2ed1649
Merge branch 'main' into worktree-operator-annotations-fix
ChrisJBurns May 3, 2026
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
2 changes: 1 addition & 1 deletion cmd/thv-operator/controllers/mcpserver_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1218,7 +1218,7 @@ func (r *MCPServerReconciler) deploymentForMCPServer(
m.Spec.ResourceOverrides.ProxyDeployment.PodTemplateMetadataOverrides.Labels)
}
if m.Spec.ResourceOverrides.ProxyDeployment.PodTemplateMetadataOverrides.Annotations != nil {
deploymentTemplateAnnotations = ctrlutil.MergeAnnotations(deploymentAnnotations,
deploymentTemplateAnnotations = ctrlutil.MergeAnnotations(deploymentTemplateAnnotations,
m.Spec.ResourceOverrides.ProxyDeployment.PodTemplateMetadataOverrides.Annotations)
}
}
Expand Down
101 changes: 101 additions & 0 deletions cmd/thv-operator/controllers/mcpserver_resource_overrides_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (

mcpv1beta1 "github.com/stacklok/toolhive/cmd/thv-operator/api/v1beta1"
ctrlutil "github.com/stacklok/toolhive/cmd/thv-operator/pkg/controllerutil"
checksum "github.com/stacklok/toolhive/cmd/thv-operator/pkg/runconfig/configmap/checksum"
"github.com/stacklok/toolhive/pkg/container/kubernetes"
)

Expand Down Expand Up @@ -223,6 +224,7 @@ func TestResourceOverrides(t *testing.T) {
mcpServer *mcpv1beta1.MCPServer
expectedDeploymentLabels map[string]string
expectedDeploymentAnns map[string]string
expectedPodTemplateAnns map[string]string
expectedServiceLabels map[string]string
expectedServiceAnns map[string]string
}{
Expand All @@ -246,6 +248,9 @@ func TestResourceOverrides(t *testing.T) {
"toolhive-name": "test-server",
},
expectedDeploymentAnns: map[string]string{},
expectedPodTemplateAnns: map[string]string{
"toolhive.stacklok.dev/runconfig-checksum": "test-checksum",
},
expectedServiceLabels: map[string]string{
"app": "mcpserver",
"app.kubernetes.io/name": "mcpserver",
Expand Down Expand Up @@ -306,6 +311,9 @@ func TestResourceOverrides(t *testing.T) {
"custom-annotation": "deployment-annotation",
"monitoring/scrape": "true",
},
expectedPodTemplateAnns: map[string]string{
"toolhive.stacklok.dev/runconfig-checksum": "test-checksum",
},
expectedServiceLabels: map[string]string{
"app": "mcpserver",
"app.kubernetes.io/name": "mcpserver",
Expand Down Expand Up @@ -364,6 +372,9 @@ func TestResourceOverrides(t *testing.T) {
"environment": "test",
},
expectedDeploymentAnns: map[string]string{},
expectedPodTemplateAnns: map[string]string{
"toolhive.stacklok.dev/runconfig-checksum": "test-checksum",
},
expectedServiceLabels: map[string]string{
"app": "mcpserver",
"app.kubernetes.io/name": "mcpserver",
Expand Down Expand Up @@ -400,6 +411,9 @@ func TestResourceOverrides(t *testing.T) {
"toolhive-name": "test-server",
},
expectedDeploymentAnns: map[string]string{},
expectedPodTemplateAnns: map[string]string{
"toolhive.stacklok.dev/runconfig-checksum": "test-checksum",
},
expectedServiceLabels: map[string]string{
"app": "mcpserver",
"app.kubernetes.io/name": "mcpserver",
Expand Down Expand Up @@ -463,6 +477,9 @@ func TestResourceOverrides(t *testing.T) {
"monitoring/enabled": "true",
"version": "v1.2.3",
},
expectedPodTemplateAnns: map[string]string{
"toolhive.stacklok.dev/runconfig-checksum": "test-checksum",
},
expectedServiceLabels: map[string]string{
"app": "mcpserver",
"app.kubernetes.io/name": "mcpserver",
Expand Down Expand Up @@ -504,6 +521,11 @@ func TestResourceOverrides(t *testing.T) {
"toolhive-name": "test-server",
},
expectedDeploymentAnns: map[string]string{},
expectedPodTemplateAnns: map[string]string{
"vault.hashicorp.com/agent-inject": "true",
"vault.hashicorp.com/role": "toolhive-mcp-workloads",
"toolhive.stacklok.dev/runconfig-checksum": "test-checksum",
},
expectedServiceLabels: map[string]string{
"app": "mcpserver",
"app.kubernetes.io/name": "mcpserver",
Expand All @@ -529,6 +551,8 @@ func TestResourceOverrides(t *testing.T) {

assert.Equal(t, tt.expectedDeploymentLabels, deployment.Labels)
assert.Equal(t, tt.expectedDeploymentAnns, deployment.Annotations)
assert.Equal(t, tt.expectedPodTemplateAnns, deployment.Spec.Template.Annotations,
"pod template annotations must contain user overrides plus the runconfig-checksum")

// Test service creation
service := r.serviceForMCPServer(t.Context(), tt.mcpServer)
Expand Down Expand Up @@ -593,6 +617,83 @@ func TestResourceOverrides(t *testing.T) {
}
}

func TestDeploymentForMCPServer_PodTemplateOverridesPreserveRunConfigChecksum(t *testing.T) {
t.Parallel()

scheme := runtime.NewScheme()
require.NoError(t, mcpv1beta1.AddToScheme(scheme))
require.NoError(t, corev1.AddToScheme(scheme))

client := fake.NewClientBuilder().WithScheme(scheme).Build()
r := newTestMCPServerReconciler(client, scheme, kubernetes.PlatformKubernetes)

mcpServer := &mcpv1beta1.MCPServer{
ObjectMeta: metav1.ObjectMeta{Name: "test-server", Namespace: "default"},
Spec: mcpv1beta1.MCPServerSpec{
Image: "test:latest",
ResourceOverrides: &mcpv1beta1.ResourceOverrides{
ProxyDeployment: &mcpv1beta1.ProxyDeploymentOverrides{
PodTemplateMetadataOverrides: &mcpv1beta1.ResourceMetadataOverrides{
Annotations: map[string]string{
"user.example.com/some-key": "value",
},
},
},
},
},
}

deployment := r.deploymentForMCPServer(t.Context(), mcpServer, "C1")
require.NotNil(t, deployment)

assert.Equal(t, "C1",
deployment.Spec.Template.Annotations[checksum.RunConfigChecksumAnnotation],
"runconfig-checksum must survive when PodTemplateMetadataOverrides.Annotations is set")
assert.Equal(t, "value",
deployment.Spec.Template.Annotations["user.example.com/some-key"],
"user override must survive")
assert.Len(t, deployment.Spec.Template.Annotations, 2,
"no extra keys should leak into the pod template")
}

func TestDeploymentNeedsUpdate_StableAfterBuildWithPodTemplateOverrides(t *testing.T) {
t.Parallel()

scheme := runtime.NewScheme()
require.NoError(t, mcpv1beta1.AddToScheme(scheme))
require.NoError(t, corev1.AddToScheme(scheme))

client := fake.NewClientBuilder().WithScheme(scheme).Build()
r := newTestMCPServerReconciler(client, scheme, kubernetes.PlatformKubernetes)

mcpServer := &mcpv1beta1.MCPServer{
ObjectMeta: metav1.ObjectMeta{Name: "test-server", Namespace: "default"},
Spec: mcpv1beta1.MCPServerSpec{
Image: "test:latest",
ResourceOverrides: &mcpv1beta1.ResourceOverrides{
ProxyDeployment: &mcpv1beta1.ProxyDeploymentOverrides{
PodTemplateMetadataOverrides: &mcpv1beta1.ResourceMetadataOverrides{
Annotations: map[string]string{
"vault.hashicorp.com/agent-inject": "true",
"vault.hashicorp.com/role": "toolhive-mcp-workloads",
},
},
},
},
},
}

const runConfigChecksum = "stable-checksum"
built := r.deploymentForMCPServer(t.Context(), mcpServer, runConfigChecksum)
require.NotNil(t, built)

// Constructor and comparator must agree on the same input — otherwise the
// operator gets stuck in a perpetual r.Update loop on every reconcile.
needsUpdate := r.deploymentNeedsUpdate(t.Context(), built, mcpServer, runConfigChecksum)
assert.False(t, needsUpdate,
"deploymentNeedsUpdate must report no drift immediately after deploymentForMCPServer with the same checksum and overrides")
}

func TestMergeStringMaps(t *testing.T) {
t.Parallel()

Expand Down
Loading