Registry should not be deployed when Azure SP is used (#518)

* Registry should not be deployed when Azure SP is used

* Fixing unit tests

* Adding review comments

* Fixing typos

* Adding registry label to BSL

Author: savitharaghunathan

api/v1alpha1/oadp_types.go

@@ -29,6 +29,7 @@ const ReconciledReasonError = "Error"
 const ReconcileCompleteMessage = "Reconcile complete"
 
 const OadpOperatorLabel = "openshift.io/oadp"
+const RegistryDeploymentLabel = "openshift.io/oadp-registry"
 
 type DefaultPlugin string
 

controllers/bsl.go

@@ -151,14 +151,23 @@ func (r *DPAReconciler) updateBSLFromSpec(bsl *velerov1.BackupStorageLocation, d
 	if err != nil {
 		return err
 	}
-
+	// While using Service Principal as Azure credentials, `storageAccountKeyEnvVar` value is not required to be set.
+	// However, the registry deployment fails without a valid storage account key.
+	// This logic prevents the registry pods from being deployed if Azure SP is used as an auth mechanism.
+	registryDeployment := "True"
+	if bslSpec.Provider == "azure" {
+		if len(bslSpec.Config["storageAccountKeyEnvVar"]) == 0 {
+			registryDeployment = "False"
+		}
+	}
 	bsl.Labels = map[string]string{
 		"app.kubernetes.io/name":     "oadp-operator-velero",
 		"app.kubernetes.io/instance": bsl.Name,
 		//"app.kubernetes.io/version":    "x.y.z",
-		"app.kubernetes.io/managed-by": "oadp-operator",
-		"app.kubernetes.io/component":  "bsl",
-		oadpv1alpha1.OadpOperatorLabel: "True",
+		"app.kubernetes.io/managed-by":       "oadp-operator",
+		"app.kubernetes.io/component":        "bsl",
+		oadpv1alpha1.OadpOperatorLabel:       "True",
+		oadpv1alpha1.RegistryDeploymentLabel: registryDeployment,
 	}
 	bsl.Spec = bslSpec
 

controllers/bsl_test.go

@@ -1121,9 +1121,10 @@ func TestDPAReconciler_updateBSLFromSpec(t *testing.T) {
 						"app.kubernetes.io/name":     "oadp-operator-velero",
 						"app.kubernetes.io/instance": tt.dpa.Name + "-1",
 						//"app.kubernetes.io/version":    "x.y.z",
-						"app.kubernetes.io/managed-by": "oadp-operator",
-						"app.kubernetes.io/component":  "bsl",
-						oadpv1alpha1.OadpOperatorLabel: "True",
+						"app.kubernetes.io/managed-by":       "oadp-operator",
+						"app.kubernetes.io/component":        "bsl",
+						oadpv1alpha1.OadpOperatorLabel:       "True",
+						oadpv1alpha1.RegistryDeploymentLabel: "True",
 					},
 					OwnerReferences: []metav1.OwnerReference{{
 						APIVersion:         oadpv1alpha1.SchemeBuilder.GroupVersion.String(),

controllers/registry.go

@@ -170,9 +170,10 @@ func (r *DPAReconciler) ReconcileRegistries(log logr.Logger) (bool, error) {
 	}
 
 	bslLabels := map[string]string{
-		"app.kubernetes.io/name":       "oadp-operator-velero",
-		"app.kubernetes.io/managed-by": "oadp-operator",
-		"app.kubernetes.io/component":  "bsl",
+		"app.kubernetes.io/name":             "oadp-operator-velero",
+		"app.kubernetes.io/managed-by":       "oadp-operator",
+		"app.kubernetes.io/component":        "bsl",
+		oadpv1alpha1.RegistryDeploymentLabel: "True",
 	}
 	bslListOptions := client.MatchingLabels(bslLabels)
 	backupStorageLocationList := velerov1.BackupStorageLocationList{}
@@ -306,11 +307,12 @@ func (r *DPAReconciler) buildRegistryDeployment(registryDeployment *appsv1.Deplo
 
 func (r *DPAReconciler) getRegistryBSLLabels(bsl *velerov1.BackupStorageLocation) map[string]string {
 	labels := map[string]string{
-		"app.kubernetes.io/name":       common.OADPOperatorVelero,
-		"app.kubernetes.io/instance":   registryName(bsl),
-		"app.kubernetes.io/managed-by": common.OADPOperator,
-		"app.kubernetes.io/component":  Registry,
-		oadpv1alpha1.OadpOperatorLabel: "True",
+		"app.kubernetes.io/name":             common.OADPOperatorVelero,
+		"app.kubernetes.io/instance":         registryName(bsl),
+		"app.kubernetes.io/managed-by":       common.OADPOperator,
+		"app.kubernetes.io/component":        Registry,
+		oadpv1alpha1.OadpOperatorLabel:       "True",
+		oadpv1alpha1.RegistryDeploymentLabel: "True",
 	}
 	return labels
 }

controllers/registry_test.go

@@ -294,11 +294,12 @@ func TestDPAReconciler_buildRegistryDeployment(t *testing.T) {
 					Name:      "test-registry",
 					Namespace: "test-ns",
 					Labels: map[string]string{
-						"app.kubernetes.io/name":       common.OADPOperatorVelero,
-						"app.kubernetes.io/instance":   "oadp-" + tt.bsl.Name + "-" + tt.bsl.Spec.Provider + "-registry",
-						"app.kubernetes.io/managed-by": common.OADPOperator,
-						"app.kubernetes.io/component":  Registry,
-						oadpv1alpha1.OadpOperatorLabel: "True",
+						"app.kubernetes.io/name":             common.OADPOperatorVelero,
+						"app.kubernetes.io/instance":         "oadp-" + tt.bsl.Name + "-" + tt.bsl.Spec.Provider + "-registry",
+						"app.kubernetes.io/managed-by":       common.OADPOperator,
+						"app.kubernetes.io/component":        Registry,
+						oadpv1alpha1.OadpOperatorLabel:       "True",
+						oadpv1alpha1.RegistryDeploymentLabel: "True",
 					},
 					OwnerReferences: []metav1.OwnerReference{
 						{