addExtraArgsOverrideDefaults: add dashes argument

Set it to `-` for all VictoriaMetrics processes, and to `--` for alertmanager. This fixes ExtraArgs in the VMAlertmanager resource. Previously, their keys had to start with an extra `-`. Fixes #502.
VictoriaMetrics · Jul 22, 2022 · e0e7c1e · e0e7c1e
1 parent 66ca926
commit e0e7c1e
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 13 deletions.
diff --git a/controllers/factory/alertmanager.go b/controllers/factory/alertmanager.go
@@ -391,7 +391,7 @@ func makeStatefulSetSpec(cr *victoriametricsv1beta1.VMAlertmanager, c *config.Ba
 		return path.Clean(webRoutePrefix + "/-/healthy")
 	}
 
-	amArgs = addExtraArgsOverrideDefaults(amArgs, cr.Spec.ExtraArgs)
+	amArgs = addExtraArgsOverrideDefaults(amArgs, cr.Spec.ExtraArgs, "--")
 	sort.Strings(amArgs)
 
 	envs := []v1.EnvVar{

diff --git a/controllers/factory/builders.go b/controllers/factory/builders.go
@@ -430,7 +430,8 @@ func CreateOrUpdatePodDisruptionBudget(ctx context.Context, rclient client.Clien
 // addExtraArgsOverrideDefaults adds extraArgs for given source args
 // it trims in-place args if it was set via extraArgs
 // no need to check for extraEnvs, it has priority over args at VictoriaMetrics apps
-func addExtraArgsOverrideDefaults(args []string, extraArgs map[string]string) []string {
+// dashes is either "-" or "--", depending on the process. altermanager needs two dashes.
+func addExtraArgsOverrideDefaults(args []string, extraArgs map[string]string, dashes string) []string {
 	if len(extraArgs) == 0 {
 		// fast path
 		return args
@@ -460,9 +461,9 @@ func addExtraArgsOverrideDefaults(args []string, extraArgs map[string]string) []
 	for argKey, argValue := range extraArgs {
 		// special hack for https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1145
 		if argKey == "rule" {
-			args = append(args, fmt.Sprintf("-%s=%q", argKey, argValue))
+			args = append(args, fmt.Sprintf("%s%s=%q", dashes, argKey, argValue))
 		} else {
-			args = append(args, fmt.Sprintf("-%s=%s", argKey, argValue))
+			args = append(args, fmt.Sprintf("%s%s=%s", dashes, argKey, argValue))
 		}
 	}
 	return args

diff --git a/controllers/factory/builders_test.go b/controllers/factory/builders_test.go
@@ -505,6 +505,7 @@ func Test_addExtraArgsOverrideDefaults(t *testing.T) {
 	type args struct {
 		args      []string
 		extraArgs map[string]string
+		dashes    string
 	}
 	tests := []struct {
 		name string
@@ -514,7 +515,8 @@ func Test_addExtraArgsOverrideDefaults(t *testing.T) {
 		{
 			name: "no changes",
 			args: args{
-				args: []string{"-http.ListenAddr=:8081"},
+				args:   []string{"-http.ListenAddr=:8081"},
+				dashes: "-",
 			},
 			want: []string{"-http.ListenAddr=:8081"},
 		},
@@ -523,6 +525,7 @@ func Test_addExtraArgsOverrideDefaults(t *testing.T) {
 			args: args{
 				args:      []string{"-http.ListenAddr=:8081"},
 				extraArgs: map[string]string{"http.ListenAddr": "127.0.0.1:8085"},
+				dashes:    "-",
 			},
 			want: []string{"-http.ListenAddr=127.0.0.1:8085"},
 		},
@@ -531,13 +534,27 @@ func Test_addExtraArgsOverrideDefaults(t *testing.T) {
 			args: args{
 				args:      []string{"-http.ListenAddr=:8081", "-promscrape.config=/opt/vmagent.yml"},
 				extraArgs: map[string]string{"http.ListenAddr": "127.0.0.1:8085"},
+				dashes:    "-",
 			},
 			want: []string{"-promscrape.config=/opt/vmagent.yml", "-http.ListenAddr=127.0.0.1:8085"},
 		},
+		{
+			name: "two dashes, override default",
+			args: args{
+				args:      []string{"--log.level=info"},
+				extraArgs: map[string]string{"log.level": "debug"},
+				dashes:    "--",
+			},
+			want: []string{"--log.level=debug"},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			assert.Equalf(t, tt.want, addExtraArgsOverrideDefaults(tt.args.args, tt.args.extraArgs), "addExtraArgsOverrideDefaults(%v, %v)", tt.args.args, tt.args.extraArgs)
+			assert.Equalf(
+				t,
+				tt.want,
+				addExtraArgsOverrideDefaults(tt.args.args, tt.args.extraArgs, tt.args.dashes),
+				"addExtraArgsOverrideDefaults(%v, %v)", tt.args.args, tt.args.extraArgs)
 		})
 	}
 }
diff --git a/controllers/factory/vmagent.go b/controllers/factory/vmagent.go
@@ -440,7 +440,7 @@ func makeSpecForVMAgent(cr *victoriametricsv1beta1.VMAgent, c *config.BaseOperat
 		// limit to 1GB
 		args = append(args, "-remoteWrite.maxDiskUsagePerURL=1073741824")
 	}
-	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs)
+	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs, "-")
 	sort.Strings(args)
 
 	vmagentContainer := corev1.Container{

diff --git a/controllers/factory/vmalert.go b/controllers/factory/vmalert.go
@@ -479,7 +479,7 @@ func buildVMAlertArgs(cr *victoriametricsv1beta1.VMAlert, ruleConfigMapNames []s
 	if len(cr.Spec.ExtraEnvs) > 0 {
 		args = append(args, "-envflag.enable=true")
 	}
-	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs)
+	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs, "-")
 	sort.Strings(args)
 	return args
 }

diff --git a/controllers/factory/vmauth.go b/controllers/factory/vmauth.go
@@ -227,7 +227,7 @@ func makeSpecForVMAuth(cr *victoriametricsv1beta1.VMAuth, c *config.BaseOperator
 		})
 	}
 
-	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs)
+	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs, "-")
 	sort.Strings(args)
 
 	vmauthContainer := corev1.Container{

diff --git a/controllers/factory/vmcluster.go b/controllers/factory/vmcluster.go
@@ -480,7 +480,7 @@ func makePodSpecForVMSelect(cr *v1beta1.VMCluster, c *config.BaseOperatorConf) (
 		})
 	}
 
-	args = addExtraArgsOverrideDefaults(args, cr.Spec.VMSelect.ExtraArgs)
+	args = addExtraArgsOverrideDefaults(args, cr.Spec.VMSelect.ExtraArgs, "-")
 	sort.Strings(args)
 	vmselectContainer := corev1.Container{
 		Name:                     "vmselect",
@@ -750,7 +750,7 @@ func makePodSpecForVMInsert(cr *v1beta1.VMCluster, c *config.BaseOperatorConf) (
 			MountPath: path.Join(ConfigMapsDir, c),
 		})
 	}
-	args = addExtraArgsOverrideDefaults(args, cr.Spec.VMInsert.ExtraArgs)
+	args = addExtraArgsOverrideDefaults(args, cr.Spec.VMInsert.ExtraArgs, "-")
 	sort.Strings(args)
 
 	vminsertContainer := corev1.Container{
@@ -1037,7 +1037,7 @@ func makePodSpecForVMStorage(cr *v1beta1.VMCluster, c *config.BaseOperatorConf)
 		})
 	}
 
-	args = addExtraArgsOverrideDefaults(args, cr.Spec.VMStorage.ExtraArgs)
+	args = addExtraArgsOverrideDefaults(args, cr.Spec.VMStorage.ExtraArgs, "-")
 	sort.Strings(args)
 	vmstorageContainer := corev1.Container{
 		Name:                     "vmstorage",

diff --git a/controllers/factory/vmsingle.go b/controllers/factory/vmsingle.go
@@ -253,7 +253,7 @@ func makeSpecForVMSingle(cr *victoriametricsv1beta1.VMSingle, c *config.BaseOper
 		})
 	}
 
-	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs)
+	args = addExtraArgsOverrideDefaults(args, cr.Spec.ExtraArgs, "-")
 	sort.Strings(args)
 	vmsingleContainer := corev1.Container{
 		Name:                     "vmsingle",