Fix passing incompatible parameters to fdbbackup and fdbrestore via CustomParameters (#2348)

CustomParameters in FoundationDBBackup and FoundationdbRestore CRDs are meant to be passed to backup agents. However, they are also passed to fdbbackup and fdbrestore commands when admincli object is built. An incompatible backup_agent parameter will be rejected by fdbbackup/restore, causing the fdbbackup to never reconcile. We filter out the parameters that are exclusive to backup_agents.

Author: dig-whois

api/v1beta2/foundationdb_custom_parameter.go

@@ -45,6 +45,22 @@ func (customParameters FoundationDBCustomParameters) GetKnobsForCLI() []string {
 	return args
 }
 
+// GetKnobsForBackupRestoreCLI returns the list of knobs that should be provided to the fdbbackup and fdbrestore
+// when running them over the admin client. It filters out the incompatible ones.
+func (customParameters FoundationDBCustomParameters) GetKnobsForBackupRestoreCLI() []string {
+	args := make([]string, 0, len(customParameters))
+
+	for _, arg := range customParameters {
+		parameterName := strings.Split(string(arg), "=")[0]
+		parameterName = strings.TrimSpace(parameterName)
+		if _, ok := backupAgentExclusiveParameters[parameterName]; ok {
+			continue
+		}
+		args = append(args, fmt.Sprintf("--%s", arg))
+	}
+	return args
+}
+
 var (
 	protectedParameters = map[string]None{
 		"datadir": {},
@@ -62,6 +78,11 @@ var (
 		"user":                         {},
 		"group":                        {},
 	}
+	// these parameters are supported by backup_agents but not by fdbbackup and fdbrestore.
+	backupAgentExclusiveParameters = map[string]None{
+		"locality-data_hall":   {},
+		"locality_data_center": {},
+	}
 )
 
 // ValidateCustomParameters ensures that no duplicate values are set and that no

api/v1beta2/foundationdb_custom_parameter_test.go

@@ -47,6 +47,26 @@ var _ = Describe("FoundationDBCustomParameters", func() {
 		})
 	})
 
+	When("getting the custom parameters for the fdbbackup and fdbrestore CLI", func() {
+		var customParameters FoundationDBCustomParameters
+		BeforeEach(func() {
+			customParameters = []FoundationDBCustomParameter{
+				"knob_http_verbose_level=3",
+				"locality-data_hall=az1",
+			}
+		})
+
+		It("", func() {
+			expected := []string{
+				"--knob_http_verbose_level=3",
+			}
+
+			result := customParameters.GetKnobsForBackupRestoreCLI()
+			Expect(result).To(ContainElements(expected))
+			Expect(len(result)).To(Equal(len(expected)))
+		})
+	})
+
 	When("Validating the custom parameters", func() {
 		DescribeTable("should print the correct string",
 			func(customParameters FoundationDBCustomParameters, expected error) {

controllers/backup_controller.go

@@ -140,7 +140,7 @@ func (r *FoundationDBBackupReconciler) adminClientForBackup(
 		return nil, err
 	}
 
-	adminClient.SetKnobs(backup.Spec.CustomParameters.GetKnobsForCLI())
+	adminClient.SetKnobs(backup.Spec.CustomParameters.GetKnobsForBackupRestoreCLI())
 
 	return adminClient, nil
 }

controllers/restore_controller.go

@@ -141,7 +141,7 @@ func (r *FoundationDBRestoreReconciler) adminClientForRestore(
 		return nil, err
 	}
 
-	adminClient.SetKnobs(restore.Spec.CustomParameters.GetKnobsForCLI())
+	adminClient.SetKnobs(restore.Spec.CustomParameters.GetKnobsForBackupRestoreCLI())
 
 	return adminClient, nil
 }