Skip to content

Pass imagePullSecrets from ImageSpec to Deployments #230

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
madmecodes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Pass imagePullSecrets from ImageSpec to Deployments #230

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
5 changes: 3 additions & 2 deletions internal/resources/cacheserver/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ func DeploymentReconciler(server *operatorv1alpha1.CacheServer) reconciling.Name

dep.Spec.Template.SetLabels(labels)

// TODO: Why do we discard the imagePullSecrets?
image, _, version := resources.GetImageSettings(server.Spec.Image)
// Pass imagePullSecrets from the image spec to the pod spec.
image, imagePullSecrets, version := resources.GetImageSettings(server.Spec.Image)

volumes, volumeMounts := getVolumeMounts(server)

Expand Down Expand Up @@ -163,6 +163,7 @@ func DeploymentReconciler(server *operatorv1alpha1.CacheServer) reconciling.Name
},
}}
dep.Spec.Template.Spec.Volumes = volumes
dep.Spec.Template.Spec.ImagePullSecrets = imagePullSecrets

dep = utils.ApplyDeploymentTemplate(dep, server.Spec.DeploymentTemplate)

Expand Down
4 changes: 3 additions & 1 deletion internal/resources/frontproxy/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func (r *reconciler) deploymentReconciler() reconciling.NamedDeploymentReconcile
}
dep.Spec.Template.SetLabels(r.resourceLabels)

image, _, _ := resources.GetImageSettings(imageSpec)
image, imagePullSecrets, _ := resources.GetImageSettings(imageSpec)
args := r.getArgs()

container := corev1.Container{
Expand Down Expand Up @@ -213,6 +213,8 @@ func (r *reconciler) deploymentReconciler() reconciling.NamedDeploymentReconcile
utils.ApplyResources(container, depResources),
}

dep.Spec.Template.Spec.ImagePullSecrets = imagePullSecrets

dep = utils.ApplyDeploymentTemplate(dep, template)

if r.frontProxy != nil {
Expand Down
65 changes: 65 additions & 0 deletions internal/resources/frontproxy/deployment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,71 @@ func TestDeploymentReconciler(t *testing.T) {
require.Equal(t, "/etc/kcp/tls/ca/ca-bundle", caBundleMountPath)
},
},
{
name: "imagePullSecrets from image spec are passed to deployment",
frontProxy: &operatorv1alpha1.FrontProxy{
ObjectMeta: metav1.ObjectMeta{
Name: "test-front-proxy",
},
Spec: operatorv1alpha1.FrontProxySpec{
RootShard: operatorv1alpha1.RootShardConfig{
Reference: &corev1.LocalObjectReference{
Name: "test-root-shard",
},
},
Image: &operatorv1alpha1.ImageSpec{
Repository: "private-registry.example.com/kcp",
Tag: "v1.0.0",
ImagePullSecrets: []corev1.LocalObjectReference{
{Name: "registry-secret-1"},
{Name: "registry-secret-2"},
},
},
},
},
rootShard: &operatorv1alpha1.RootShard{
ObjectMeta: metav1.ObjectMeta{
Name: "test-root-shard",
},
},
expectedName: resources.GetFrontProxyDeploymentName(&operatorv1alpha1.FrontProxy{
ObjectMeta: metav1.ObjectMeta{Name: "test-front-proxy"},
}),
validateDeploy: func(t *testing.T, dep *appsv1.Deployment) {
container := dep.Spec.Template.Spec.Containers[0]
assert.Equal(t, "private-registry.example.com/kcp:v1.0.0", container.Image)

require.Len(t, dep.Spec.Template.Spec.ImagePullSecrets, 2)
assert.Equal(t, "registry-secret-1", dep.Spec.Template.Spec.ImagePullSecrets[0].Name)
assert.Equal(t, "registry-secret-2", dep.Spec.Template.Spec.ImagePullSecrets[1].Name)
},
},
{
name: "no imagePullSecrets when image spec has none",
frontProxy: &operatorv1alpha1.FrontProxy{
ObjectMeta: metav1.ObjectMeta{
Name: "test-front-proxy",
},
Spec: operatorv1alpha1.FrontProxySpec{
RootShard: operatorv1alpha1.RootShardConfig{
Reference: &corev1.LocalObjectReference{
Name: "test-root-shard",
},
},
},
},
rootShard: &operatorv1alpha1.RootShard{
ObjectMeta: metav1.ObjectMeta{
Name: "test-root-shard",
},
},
expectedName: resources.GetFrontProxyDeploymentName(&operatorv1alpha1.FrontProxy{
ObjectMeta: metav1.ObjectMeta{Name: "test-front-proxy"},
}),
validateDeploy: func(t *testing.T, dep *appsv1.Deployment) {
assert.Empty(t, dep.Spec.Template.Spec.ImagePullSecrets)
},
},
}

for _, tt := range tests {
Expand Down
6 changes: 3 additions & 3 deletions internal/resources/utils/shard.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,10 @@ func ApplyCommonShardConfig(deployment *appsv1.Deployment, spec *operatorv1alpha
deployment.Spec.Replicas = ptr.To[int32](2)
}

// set container image
image, _, _ := resources.GetImageSettings(spec.Image)
// set container image and imagePullSecrets
image, imagePullSecrets, _ := resources.GetImageSettings(spec.Image)
container.Image = image

deployment.Spec.Template.Spec.ImagePullSecrets = imagePullSecrets
deployment.Spec.Template.Spec.Containers[0] = container

deployment = applyEtcdConfiguration(deployment, spec.Etcd)
Expand Down
3 changes: 2 additions & 1 deletion internal/resources/virtualworkspace/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ func DeploymentReconciler(vw *operatorv1alpha1.VirtualWorkspace, rootShard *oper
volumeMounts = append(volumeMounts, vm)
}

image, _, _ := resources.GetImageSettings(vw.Spec.Image)
image, imagePullSecrets, _ := resources.GetImageSettings(vw.Spec.Image)

container := corev1.Container{
Name: ServerContainerName,
Expand All @@ -196,6 +196,7 @@ func DeploymentReconciler(vw *operatorv1alpha1.VirtualWorkspace, rootShard *oper

dep.Spec.Template.Spec.Containers = []corev1.Container{container}
dep.Spec.Template.Spec.Volumes = volumes
dep.Spec.Template.Spec.ImagePullSecrets = imagePullSecrets

if vw.Spec.Replicas != nil {
dep.Spec.Replicas = vw.Spec.Replicas
Expand Down