feat: get watch CLI flags from environment

haininghu · haininghu · commit 137a7b6786a7 · 2026-03-16T12:09:03.000+01:00
diff --git a/README.md b/README.md
@@ -7,30 +7,64 @@ Argo Values is a Config Management Plugin (CMP) for Argo CD that enhances Helm-b
 ## Features
 
 - **Dynamic Value Injection**: Merge values from ConfigMaps and Secrets into Helm template application files
-- **Environment Variable Substitution**: Replace `${VAR_NAME}` placeholders in application files with actual values
+- **Environment Variable Substitution**: Replace variable placeholders in application files with actual values
 - **Automatic Refresh**: Watch for ConfigMap/Secret changes and trigger application refreshes
 - **Helm Integration**: Full compatibility with Helm charts and templating
 - **Selective Processing**: Respect `.helmignore` patterns
 
-## Example
+## Installation with ArgoCD Helm chart
 
-Install ArgoCD with CMP and an example application:
-```bash
-helm upgrade --install argocd argo/argo-cd -n argocd -f values.yaml
-```
+### Configure argo-values CMP
 
-values.yaml:
+Add the following snippet to your `values.yaml` to configure argo-values as CMP:
 ```yaml
+extraObjects:
+  - apiVersion: v1
+    kind: ConfigMap
+    metadata:
+      name: argocd-cmp-plugin-config
+      namespace: argocd               
+    data:
+      plugin.yaml: |
+        apiVersion: argoproj.io/v1alpha1
+        kind: ConfigManagementPlugin
+        metadata:
+          name: argo-values
+        spec:
+          version: v1.0
+          init:
+            command: [argo-values]
+            args: [init]
+          generate:
+            command: [argo-values]
+            args: [generate]
+          discover:
+            find:
+              command: [argo-values]
+              args: [discover]
+```
+
+### Add argo-values to ArgoCD application controller (optional)
 
-# add argo-values as sidecar to Argo controller for automatic application refresh
+To trigger application refresh automatically every time a ConfigMap or Secret changed, add the following snippet to your `values.yaml`:
+```yaml
 controller:
   extraContainers:
     - name: argo-values
-      image: argo-values:latest
+      image: ghcr.io/hbtgmbh/argo-values:latest
       command: [argo-values]
       args: [watch]
+      env:
+        - name: ARGOCD_VALUES_REFRESH_SECONDS
+          value: "3"
+        - name: ARGOCD_VALUES_NAMESPACES
+          value: "argocd,default"
+```
 
-# add argo-values as CMP to Argo's repo-server
+### Add argo-values to ArgoCD repo server
+
+To run argo-values as sidecar with the repo server, add the following snippet to your `values.yaml`:
+```yaml
 repoServer:
   initContainers:
     - name: copy-cmp-server
@@ -41,7 +75,7 @@ repoServer:
           mountPath: /custom-tools
   extraContainers:
     - name: argo-values
-      image: argo-values:latest
+      image: ghcr.io/hbtgmbh/argo-values:latest
       command: [/custom-tools/argocd-cmp-server]
       imagePullPolicy: Always
       securityContext:
@@ -67,72 +101,59 @@ repoServer:
       emptyDir: {}
     - name: custom-tools
       emptyDir: {}
+```
 
-# the CMP configuration
-extraObjects:
-  - apiVersion: v1
-    kind: ConfigMap
-    metadata:
-      name: argocd-cmp-plugin-config
-      namespace: argocd                     
-    data:
-      plugin.yaml: |
-        apiVersion: argoproj.io/v1alpha1
-        kind: ConfigManagementPlugin
-        metadata:
-          name: argo-values
-        spec:
-          version: v1.0
-          init:
-            command: [argo-values]
-            args: [init]
-          generate:
-            command: [argo-values]
-            args: [generate]
-          discover:
-            find:
-              command: [argo-values]
-              args: [discover]
-        
-# an example application with two additional ConfigMaps
-  - apiVersion: argoproj.io/v1alpha1
-    kind: Application
-    metadata:
-      name: nginx-example
-      namespace: argocd
-    spec:
-      project: default
-      source:
-        repoURL: https://github.com/argoproj/argocd-example-apps.git
-        targetRevision: HEAD
-        path: helm-guestbook
-        plugin:
-          env:
-            - name: env-configs
-              value: test-env
-            - name: value-configs
-              value: test-values
-      destination:
-        server: https://kubernetes.default.svc  # Targets the same cluster as Argo CD
-        namespace: default
-  - apiVersion: v1
-    kind: ConfigMap
-    metadata:
-      name: test-env
-      namespace: default
-    data:
-      values.yaml: |
-        cpu: "100m"
-  - apiVersion: v1
-    kind: ConfigMap
-    metadata:
-      name: test-values
-      namespace: default
-    data:
-      values.yaml: |
-        resources:
-          requests:
-            cpu: "${CPU}"
+## Examples
+
+### Add additional values.yaml from ConfigMap to Helm chart
+
+```yaml
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  name: nginx-example
+  namespace: argocd
+spec:
+  project: default
+  source:
+    repoURL: https://github.com/argoproj/argocd-example-apps.git
+    targetRevision: HEAD
+    path: helm-guestbook
+    plugin:
+      env:
+        - name: value-configs
+          value: default/application-values # <- list of ConfigMaps or namespace/ConfigMap separated by ","
+        - name: env-configs
+          value: default/application-variables # <- list of ConfigMaps or namespace/ConfigMap separated by ","
+```
+
+Every ConfigMap from `value-configs` or Secret from `value-secrets` will be added directly to the Helm templates of the application:
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: application-values
+  namespace: default
+data:  
+  # additional values.yaml
+  values.yaml: |
+    resources:
+      requests:
+        cpu: "${CPU}"
+        memory: "100Mi"
+```
+
+All values from `env-configs` or `value-secrets` are available as environment variables and substituted in the Helm templates of the application:
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: application-variables
+  namespace: default
+data:  
+  cpu: "123m"
 ```
 
 ## License
diff --git a/cmd/argo-values/main.go b/cmd/argo-values/main.go
@@ -25,16 +25,23 @@ var RootCmd = &cobra.Command{
 
 func init() {
 	// Add global flags
-	RootCmd.PersistentFlags().StringVarP(&config.LogLevel, "log-level", "l", env.GetString("LOG_LEVEL", "debug"), "Log level (debug, info, warn, error, fatal, panic)")
-	RootCmd.PersistentFlags().StringVar(&config.LogFormat, "log-format", env.GetString("LOG_FORMAT", "json"), "Log format (text, json)")
-	RootCmd.PersistentFlags().StringVar(&config.LogOutput, "log-output", env.GetString("LOG_OUTPUT", "stdout"), "Log output (stderr, stdout)")
-
-	RootCmd.PersistentFlags().StringVarP(&config.KubeConfigPath, "kubeconfig", "k", "", "Path to kubeconfig file")
-
-	RootCmd.PersistentFlags().StringVarP(&config.ValuesFileName, "file-values", "v", "app-values.yaml", "Path to values file")
-	RootCmd.PersistentFlags().StringVarP(&config.TargetDirectory, "file-target", "t", ".", "Path to application files")
-
-	RootCmd.PersistentFlags().BoolVarP(&config.DryRun, "dry-run", "d", false, "dry-run enabled (true, false)")
+	RootCmd.PersistentFlags().StringVarP(&config.LogLevel, "log-level", "l",
+		env.GetString("LOG_LEVEL", "debug"), "Log level (debug, info, warn, error, fatal, panic)")
+	RootCmd.PersistentFlags().StringVar(&config.LogFormat, "log-format",
+		env.GetString("LOG_FORMAT", "json"), "Log format (text, json)")
+	RootCmd.PersistentFlags().StringVar(&config.LogOutput, "log-output",
+		env.GetString("LOG_OUTPUT", "stdout"), "Log output (stderr, stdout)")
+
+	RootCmd.PersistentFlags().StringVarP(&config.KubeConfigPath, "kubeconfig", "k",
+		"", "Path to kubeconfig file")
+
+	RootCmd.PersistentFlags().StringVarP(&config.ValuesFileName, "file-values", "v",
+		"app-values.yaml", "Path to values file")
+	RootCmd.PersistentFlags().StringVarP(&config.TargetDirectory, "file-target", "t",
+		".", "Path to application files")
+
+	RootCmd.PersistentFlags().BoolVarP(&config.DryRun, "dry-run", "d",
+		false, "dry-run enabled (true, false)")
 
 	// Add subcommands
 	RootCmd.AddCommand(commands.DiscoverCommand)
diff --git a/internal/commands/generate.go b/internal/commands/generate.go
@@ -16,8 +16,10 @@ var (
 )
 
 func init() {
-	GenerateCmd.Flags().StringVar(&appName, "app-name", env.GetString("ARGOCD_APP_NAME", ""), "Name of the Argo CD application")
-	GenerateCmd.Flags().StringVar(&appNamespace, "app-namespace", env.GetString("ARGOCD_APP_NAMESPACE", ""), "Namespace of the Argo CD application")
+	GenerateCmd.Flags().StringVar(&appName, "app-name",
+		env.GetString("ARGOCD_APP_NAME", ""), "Name of the Argo CD application")
+	GenerateCmd.Flags().StringVar(&appNamespace, "app-namespace",
+		env.GetString("ARGOCD_APP_NAMESPACE", "argocd"), "Namespace of the Argo CD application")
 }
 
 var GenerateCmd = &cobra.Command{
diff --git a/internal/commands/init.go b/internal/commands/init.go
@@ -23,10 +23,14 @@ var (
 )
 
 func init() {
-	InitCmd.Flags().StringArrayVar(&valueConfigs, "value-maps", []string{}, "ConfigMaps containing values to merge into the application files")
-	InitCmd.Flags().StringArrayVar(&envConfigs, "env-maps", []string{}, "ConfigMaps containing environment variables to inject into application files")
-	InitCmd.Flags().StringArrayVar(&valueSecrets, "value-secrets", []string{}, "Secrets containing values to merge into the application files")
-	InitCmd.Flags().StringArrayVar(&envSecrets, "env-secrets", []string{}, "Secrets containing environment variables to inject into application files")
+	InitCmd.Flags().StringArrayVar(&valueConfigs, "value-maps",
+		[]string{}, "ConfigMaps containing values to merge into the application files")
+	InitCmd.Flags().StringArrayVar(&envConfigs, "env-maps",
+		[]string{}, "ConfigMaps containing environment variables to inject into application files")
+	InitCmd.Flags().StringArrayVar(&valueSecrets, "value-secrets",
+		[]string{}, "Secrets containing values to merge into the application files")
+	InitCmd.Flags().StringArrayVar(&envSecrets, "env-secrets",
+		[]string{}, "Secrets containing environment variables to inject into application files")
 }
 
 var InitCmd = &cobra.Command{
diff --git a/internal/commands/watch.go b/internal/commands/watch.go
@@ -24,8 +24,10 @@ var (
 )
 
 func init() {
-	WatchCmd.Flags().DurationVarP(&debounceDuration, "event-interval", "i", 2*time.Second, "Debounce interval for resource change events")
-	WatchCmd.Flags().StringArrayVar(&namespaces, "namespaces", config.GetArrayFromEnv("ARGOCD_VALUES_NAMESPACES", []string{"argocd", "default"}), "Namespaces to watch for resource changes")
+	WatchCmd.Flags().DurationVarP(&debounceDuration, "refresh-interval", "i",
+		config.GetSecondsFromEnv("ARGOCD_VALUES_REFRESH_SECONDS", 2*time.Second), "Debounce interval for resource change events")
+	WatchCmd.Flags().StringArrayVar(&namespaces, "namespaces",
+		config.GetArrayFromEnv("ARGOCD_VALUES_NAMESPACES", []string{"argocd", "default"}), "Namespaces to watch for resource changes")
 }
 
 var WatchCmd = &cobra.Command{
@@ -36,7 +38,7 @@ Argo CD applications when their dependent resources (ConfigMaps, Secrets) change
 
 This command establishes watches on ConfigMaps and Secrets in the specified namespaces
 and triggers application refreshes when any watched resource changes. The refresh
-debounce multiple rapid changes according to the event-interval flag.
+debounce multiple rapid changes according to the refresh-interval flag.
 
 The command maintains a mapping of which applications depend on which resources and
 only refreshes applications that are affected by the specific resource changes.
diff --git a/internal/config/plugin.go b/internal/config/plugin.go
@@ -5,7 +5,9 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"strconv"
 	"strings"
+	"time"
 
 	"k8s.io/utils/env"
 )
@@ -76,6 +78,14 @@ func GetStringFromEnv(name string, def string) string {
 	return def
 }
 
+func GetSecondsFromEnv(name string, def time.Duration) time.Duration {
+	secondsFromEnv := GetStringFromEnv(name, "")
+	if seconds, err := strconv.Atoi(secondsFromEnv); err == nil {
+		return time.Duration(seconds) * time.Second
+	}
+	return def
+}
+
 func GetArrayFromEnv(name string, def []string) []string {
 	arrayFromEnv := strings.Split(GetStringFromEnv(name, ""), ",")
 	arrayFiltered := utils.NonEmpty(arrayFromEnv)

Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,10 @@ var (`
`16`	`16`	`)`
`17`	`17`
`18`	`18`	`func init() {`
`19`		`- GenerateCmd.Flags().StringVar(&appName, "app-name", env.GetString("ARGOCD_APP_NAME", ""), "Name of the Argo CD application")`
`20`		`- GenerateCmd.Flags().StringVar(&appNamespace, "app-namespace", env.GetString("ARGOCD_APP_NAMESPACE", ""), "Namespace of the Argo CD application")`
	`19`	`+ GenerateCmd.Flags().StringVar(&appName, "app-name",`
	`20`	`+ env.GetString("ARGOCD_APP_NAME", ""), "Name of the Argo CD application")`
	`21`	`+ GenerateCmd.Flags().StringVar(&appNamespace, "app-namespace",`
	`22`	`+ env.GetString("ARGOCD_APP_NAMESPACE", "argocd"), "Namespace of the Argo CD application")`
`21`	`23`	`}`
`22`	`24`
`23`	`25`	`var GenerateCmd = &cobra.Command{`