Move Backup registry to nested struct

A registry configuration is now stored under a separated nested struct.

Signed-off-by: Ales Raszka <[email protected]>

Author: Allda

apis/controller/v1alpha1/devworkspaceoperatorconfig_types.go

@@ -72,25 +72,30 @@ type CleanupCronJobConfig struct {
 	Schedule string `json:"schedule,omitempty"`
 }
 
+type RegistryConfig struct {
+	// A registry where backup images are stored. Images are stored
+	// in {registry}/backup-${DEVWORKSPACE_NAMESPACE}-${DEVWORKSPACE_NAME}
+	// +kubebuilder:validation:Required
+	Path string `json:"path,omitempty"`
+	// AuthSecret is the name of a Kubernetes secret of
+	// type kubernetes.io/dockerconfigjson
+	// +kubebuilder:validation:Optional
+	AuthSecret string `json:"authSecret,omitempty"`
+}
+
 type BackupCronJobConfig struct {
 	// Enable determines whether backup CronJobs should be created for workspace PVCs.
 	// Defaults to false if not specified.
 	// +kubebuilder:validation:Optional
 	Enable *bool `json:"enable,omitempty"`
+	// RegistryConfig defines the registry configuration where backup images are stored.
+	// +kubebuilder:validation:Required
+	Registry *RegistryConfig `json:"registry,omitempty"`
 	// Schedule specifies the cron schedule for the backup cron job.
 	// For example, "0 2 * * *" runs daily at 2 AM.
 	// +kubebuilder:default:="0 2 * * *"
 	// +kubebuilder:validation:Optional
 	Schedule string `json:"schedule,omitempty"`
-	// A registry where backup images are stored. Images are stored
-	// in {registry}/backup-${DEVWORKSPACE_NAMESPACE}-${DEVWORKSPACE_NAME}
-	// +kubebuilder:validation:Required
-	Registry string `json:"registry,omitempty"`
-
-	// RegistryAuthSecret is the name of a Kubernetes secret of
-	// type kubernetes.io/dockerconfigjson
-	// +kubebuilder:validation:Optional
-	RegistryAuthSecret string `json:"registryAuthSecret,omitempty"`
 }
 
 type RoutingConfig struct {

apis/controller/v1alpha1/zz_generated.deepcopy.go

@@ -17,6 +17,7 @@ package controllers
 
 import (
 	"context"
+	"reflect"
 
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
@@ -72,27 +73,7 @@ func shouldReconcileOnUpdate(e event.UpdateEvent, log logr.Logger) bool {
 	oldBackup := oldConfig.Config.Workspace.BackupCronJob
 	newBackup := newConfig.Config.Workspace.BackupCronJob
 
-	if oldBackup == nil && newBackup == nil {
-		return false
-	}
-	if (oldBackup == nil && newBackup != nil) || (oldBackup != nil && newBackup == nil) {
-		return true
-	}
-	if !ptr.Equal(oldBackup.Enable, newBackup.Enable) {
-		return true
-	}
-
-	if oldBackup.Schedule != newBackup.Schedule {
-		return true
-	}
-	if oldBackup.Registry != newBackup.Registry {
-		return true
-	}
-	if oldBackup.RegistryAuthSecret != newBackup.RegistryAuthSecret {
-		return true
-	}
-
-	return false
+	return !reflect.DeepEqual(oldBackup, newBackup)
 }
 
 // SetupWithManager sets up the controller with the Manager.
@@ -282,16 +263,16 @@ func (r *BackupCronJobReconciler) executeBackupSync(ctx context.Context, dwOpera
 
 func (r *BackupCronJobReconciler) getRegistryAuthSecret(ctx context.Context, dwOperatorConfig *controllerv1alpha1.DevWorkspaceOperatorConfig, log logr.Logger) (*corev1.Secret, error) {
 	registryAuthSecret := &corev1.Secret{}
-	if dwOperatorConfig.Config.Workspace.BackupCronJob.RegistryAuthSecret != "" {
+	if dwOperatorConfig.Config.Workspace.BackupCronJob.Registry.AuthSecret != "" {
 		err := r.NonCachingClient.Get(ctx, client.ObjectKey{
-			Name:      dwOperatorConfig.Config.Workspace.BackupCronJob.RegistryAuthSecret,
+			Name:      dwOperatorConfig.Config.Workspace.BackupCronJob.Registry.AuthSecret,
 			Namespace: dwOperatorConfig.Namespace,
 		}, registryAuthSecret)
 		if err != nil {
-			log.Error(err, "Failed to get registry auth secret for backup job", "secretName", dwOperatorConfig.Config.Workspace.BackupCronJob.RegistryAuthSecret)
+			log.Error(err, "Failed to get registry auth secret for backup job", "secretName", dwOperatorConfig.Config.Workspace.BackupCronJob.Registry.AuthSecret)
 			return nil, err
 		}
-		log.Info("Successfully retrieved registry auth secret for backup job", "secretName", dwOperatorConfig.Config.Workspace.BackupCronJob.RegistryAuthSecret)
+		log.Info("Successfully retrieved registry auth secret for backup job", "secretName", dwOperatorConfig.Config.Workspace.BackupCronJob.Registry.AuthSecret)
 		return registryAuthSecret, nil
 	}
 	return nil, nil
@@ -384,7 +365,7 @@ func (r *BackupCronJobReconciler) createBackupJob(
 								},
 								{Name: "STORAGE_DRIVER", Value: "overlay"},
 								{Name: "BUILDAH_ISOLATION", Value: "chroot"},
-								{Name: "DEVWORKSPACE_BACKUP_REGISTRY", Value: backUpConfig.Registry},
+								{Name: "DEVWORKSPACE_BACKUP_REGISTRY", Value: backUpConfig.Registry.Path},
 								{Name: "BUILDAH_PUSH_OPTIONS", Value: "--tls-verify=false"},
 							},
 							Image: images.GetProjectBackupImage(),

controllers/backupcronjob/backupcronjob_controller.go

@@ -308,10 +308,12 @@ var _ = Describe("BackupCronJobReconciler", func() {
 				Config: &controllerv1alpha1.OperatorConfiguration{
 					Workspace: &controllerv1alpha1.WorkspaceConfig{
 						BackupCronJob: &controllerv1alpha1.BackupCronJobConfig{
-							Enable:             &enabled,
-							Schedule:           schedule,
-							Registry:           "my-registry:5000",
-							RegistryAuthSecret: "my-secret",
+							Enable:   &enabled,
+							Schedule: schedule,
+							Registry: &controllerv1alpha1.RegistryConfig{
+								Path:       "my-registry:5000",
+								AuthSecret: "my-secret",
+							},
 						},
 					},
 				},
@@ -444,6 +446,11 @@ var _ = Describe("DevWorkspaceOperatorConfig UpdateFunc Tests", func() {
 			&controllerv1alpha1.BackupCronJobConfig{Schedule: "1 * * * *"},
 			true,
 		),
+		Entry("Registry differs => changed",
+			&controllerv1alpha1.BackupCronJobConfig{Registry: &controllerv1alpha1.RegistryConfig{Path: "fake"}},
+			&controllerv1alpha1.BackupCronJobConfig{Registry: &controllerv1alpha1.RegistryConfig{Path: "fake-different"}},
+			true,
+		),
 		Entry("All fields match => no change",
 			&controllerv1alpha1.BackupCronJobConfig{
 				Enable:   pointer.Bool(true),