feat(runner): allow command+args override (#594)

michael-todorovic · web-flow · commit 235a7e0b9f1d · 2025-05-16T15:19:31.000+02:00
Signed-off-by: Michael Todorovic &lt;michael.todorovic@outlook.com&gt;
diff --git a/api/v1alpha1/common.go b/api/v1alpha1/common.go
@@ -26,6 +26,8 @@ type OverrideRunnerSpec struct {
 	VolumeMounts       []corev1.VolumeMount          `json:"volumeMounts,omitempty"`
 	Metadata           MetadataOverride              `json:"metadata,omitempty"`
 	InitContainers     []corev1.Container            `json:"initContainers,omitempty"`
+	Command            []string                      `json:"command,omitempty"`
+	Args               []string                      `json:"args,omitempty"`
 	ExtraInitArgs      ExtraArgs                     `json:"extraInitArgs,omitempty"`
 	ExtraPlanArgs      ExtraArgs                     `json:"extraPlanArgs,omitempty"`
 	ExtraApplyArgs     ExtraArgs                     `json:"extraApplyArgs,omitempty"`
@@ -114,6 +116,8 @@ func GetOverrideRunnerSpec(repository *TerraformRepository, layer *TerraformLaye
 		ServiceAccountName: chooseString(repository.Spec.OverrideRunnerSpec.ServiceAccountName, layer.Spec.OverrideRunnerSpec.ServiceAccountName),
 		ImagePullSecrets:   mergeImagePullSecrets(repository.Spec.OverrideRunnerSpec.ImagePullSecrets, layer.Spec.OverrideRunnerSpec.ImagePullSecrets),
 		InitContainers:     MergeInitContainers(repository.Spec.OverrideRunnerSpec.InitContainers, layer.Spec.OverrideRunnerSpec.InitContainers),
+		Command:            ChooseSlice(repository.Spec.OverrideRunnerSpec.Command, layer.Spec.OverrideRunnerSpec.Command),
+		Args:               ChooseSlice(repository.Spec.OverrideRunnerSpec.Args, layer.Spec.OverrideRunnerSpec.Args),
 		ExtraInitArgs:      overrideExtraArgs(repository.Spec.OverrideRunnerSpec.ExtraInitArgs, layer.Spec.OverrideRunnerSpec.ExtraInitArgs),
 		ExtraPlanArgs:      overrideExtraArgs(repository.Spec.OverrideRunnerSpec.ExtraPlanArgs, layer.Spec.OverrideRunnerSpec.ExtraPlanArgs),
 		ExtraApplyArgs:     overrideExtraArgs(repository.Spec.OverrideRunnerSpec.ExtraApplyArgs, layer.Spec.OverrideRunnerSpec.ExtraApplyArgs),
@@ -172,6 +176,13 @@ func chooseInt(a, b *int, d int) *int {
 	return &d
 }
 
+func ChooseSlice(a, b []string) []string {
+	if len(b) > 0 {
+		return b
+	}
+	return a
+}
+
 func mergeImagePullSecrets(a, b []corev1.LocalObjectReference) []corev1.LocalObjectReference {
 	result := []corev1.LocalObjectReference{}
 	temp := map[string]string{}
diff --git a/api/v1alpha1/common_test.go b/api/v1alpha1/common_test.go
@@ -2457,3 +2457,58 @@ func TestMergeInitContainers(t *testing.T) {
 		})
 	}
 }
+
+func TestChooseSlice(t *testing.T) {
+	tt := []struct {
+		name     string
+		sliceA   []string
+		sliceB   []string
+		expected []string
+	}{
+		{
+			"EmptySlices",
+			[]string{},
+			[]string{},
+			[]string{},
+		},
+		{
+			"OnlySliceA",
+			[]string{"value1", "value2"},
+			[]string{},
+			[]string{"value1", "value2"},
+		},
+		{
+			"OnlySliceB",
+			[]string{},
+			[]string{"value3", "value4"},
+			[]string{"value3", "value4"},
+		},
+		{
+			"BothSlicesWithValues_ShouldPreferB",
+			[]string{"value1", "value2"},
+			[]string{"value3", "value4"},
+			[]string{"value3", "value4"},
+		},
+		{
+			"SliceAWithValues_SliceBEmpty",
+			[]string{"value1", "value2"},
+			[]string{},
+			[]string{"value1", "value2"},
+		},
+		{
+			"SliceAEmpty_SliceBWithValues",
+			[]string{},
+			[]string{"value3", "value4"},
+			[]string{"value3", "value4"},
+		},
+	}
+
+	for _, tc := range tt {
+		t.Run(tc.name, func(t *testing.T) {
+			result := configv1alpha1.ChooseSlice(tc.sliceA, tc.sliceB)
+			if !reflect.DeepEqual(result, tc.expected) {
+				t.Errorf("expected slice %v but got %v", tc.expected, result)
+			}
+		})
+	}
+}
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/deploy/charts/burrito/README.md b/deploy/charts/burrito/README.md
@@ -37,6 +37,8 @@ A Helm chart for handling a complete burrito deployment
 | config.burrito.datastore.storage.s3.bucket | string | `""` | S3 bucket name |
 | config.burrito.hermitcrab | object | `{}` | Provider cache custom configuration |
 | config.burrito.runner.sshKnownHostsConfigMapName | string | `"burrito-ssh-known-hosts"` | Configmap name to store the SSH known hosts in the runner |
+| config.burrito.runner.args | list | `["runner", "start"]` | Override the default args for the runner container |
+| config.burrito.runner.command | list | `["burrito"]` | Override the default command for the runner container |
 | config.burrito.server.addr | string | `":8080"` | Server exposed port |
 | config.burrito.server.webhook.github.secret | string | `""` | Secret to validate webhook payload, prefer override with the BURRITO_SERVER_WEBHOOK_GITHUB_SECRET environment variable |
 | config.burrito.server.webhook.gitlab.secret | string | `""` | Secret to validate webhook payload, Prefer override with the BURRITO_SERVER_WEBHOOK_GITLAB_SECRET environment variable |
diff --git a/deploy/charts/burrito/values-debug.yaml b/deploy/charts/burrito/values-debug.yaml
@@ -5,6 +5,8 @@ config:
         repository: burrito
         tag: DEV_TAG
         pullPolicy: Never
+      # command: ["/usr/local/bin/dlv"]
+      # args: ["--listen=0.0.0.0:2346", "--headless=true", "--accept-multiclient", "--api-version=2", "--log", "exec", "/usr/local/bin/burrito", "runner", "start"]
     datastore:
       storage:
         mock: true
diff --git a/deploy/charts/burrito/values.yaml b/deploy/charts/burrito/values.yaml
@@ -86,6 +86,11 @@ config:
         repository: ghcr.io/padok-team/burrito
         tag: "" # By default use Chart's appVersion
         pullPolicy: Always
+      
+      # -- Command to run in the Burrito runner container
+      command: ["burrito"]
+      # -- Arguments to pass to the Burrito runner container
+      args: ["runner", "start"]
 
 hermitcrab:
   # -- Enable/Disable Hermitcrab (terraform provider cache in cluster)
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -201,9 +201,15 @@ First, being by installing dlv: `go install github.com/go-delve/delve/cmd/dlv@la
 
 We'll rely on `deploy/charts/burrito/values-debug.yaml` to deploy the configuration to start the debugging session.
 
-By default, the `controller` (that includes the runner) and `datastore` are commented in the Helm values. Indeed, starting the application with dlv server will hang until you connect with the dlv client so it has to be enabled only when you need it.
+By default, the different component debug configs are commented in the Helm values. Indeed, starting the application with dlv server will hang until you connect with the dlv client so it has to be enabled only when you need it.
 
 ```yaml
+# config:
+#   burrito:
+#     runner:
+#       command: ["/usr/local/bin/dlv"]
+#       args: ["--listen=0.0.0.0:2346", "--headless=true", "--accept-multiclient", "--api-version=2", "--log", "exec", "/usr/local/bin/burrito", "runner", "start"]
+
 # controllers:
 #   deployment:
 #     mode: Debug
@@ -223,6 +229,12 @@ By default, the `controller` (that includes the runner) and `datastore` are comm
 #     args: ["--listen=0.0.0.0:2348", "--headless=true", "--accept-multiclient", "--api-version=2", "--log", "exec", "/usr/local/bin/burrito", "server", "start"]
 ```
 
+!!! note
+    The runner command+args override isn't under `runner.deployment` as other components as it's not a k8s deployment
+
+!!! tip
+    You can also launch burrito with the debug build and override command+args in `overrideRunnerSpec` in a specific layer you'd like to debug.
+
 By default, we'll start the application with the usual command. If you want to debug the controller or the runner, uncomment the required block. This will open a port on the pod on which you'll connect from your computer.
 
 `mode: Debug` is removing liveness and readiness probes: they won't be able to start as dlv will await for you to start the debugging session.
@@ -258,7 +270,7 @@ kubectl port-forward $(kubectl get pods -n burrito-system | awk '/burrito-contro
 - For the runner:
 
 ```bash
-kubectl port-forward -n burrito-project <layerName> 2346:2345
+kubectl port-forward -n burrito-project <layerName> 2346:2346
 ```
 
 It will listen on the same port than the controller so we're exposing it on port 2346 on your computer so you can debug the controller and the runner if needed.
diff --git a/docs/user-guide/override-runner.md b/docs/user-guide/override-runner.md
@@ -13,8 +13,10 @@ If the field is specified for a given `TerraformLayer` it will take precedence o
 Available overrides are:
 
 |         Fields         |
-| :--------------------: |
+|:----------------------:|
 |       `Affinity`       |
+|         `Args`         |
+|       `Command`       |
 |   `ImagePullSecrets`   |
 |        `Image`         |
 |    `InitContainers`    |
diff --git a/internal/burrito/config/config.go b/internal/burrito/config/config.go
@@ -126,6 +126,8 @@ type RunnerConfig struct {
 	Image                      ImageConfig      `mapstructure:"image"`
 	RunnerBinaryPath           string           `mapstructure:"runnerBinaryPath"`
 	RepositoryPath             string           `mapstructure:"repositoryPath"`
+	Args                       []string         `mapstructure:"args"`
+	Command                    []string         `mapstructure:"command"`
 }
 
 type ImageConfig struct {
diff --git a/internal/controllers/terraformrun/pod.go b/internal/controllers/terraformrun/pod.go
@@ -263,6 +263,8 @@ func (r *Reconciler) getPod(run *configv1alpha1.TerraformRun, layer *configv1alp
 
 	defaultSpec.Tolerations = overrideSpec.Tolerations
 	defaultSpec.Affinity = overrideSpec.Affinity
+	defaultSpec.Containers[0].Args = configv1alpha1.ChooseSlice(defaultSpec.Containers[0].Args, overrideSpec.Args)
+	defaultSpec.Containers[0].Command = configv1alpha1.ChooseSlice(defaultSpec.Containers[0].Command, overrideSpec.Command)
 	defaultSpec.NodeSelector = overrideSpec.NodeSelector
 	defaultSpec.Containers[0].Env = append(defaultSpec.Containers[0].Env, overrideSpec.Env...)
 	defaultSpec.InitContainers = overrideSpec.InitContainers
@@ -369,7 +371,8 @@ func defaultPodSpec(config *config.Config, layer *configv1alpha1.TerraformLayer,
 				Name:            "runner",
 				Image:           fmt.Sprintf("%s:%s", config.Runner.Image.Repository, config.Runner.Image.Tag),
 				ImagePullPolicy: corev1.PullPolicy(config.Runner.Image.PullPolicy),
-				Args:            []string{"runner", "start"},
+				Args:            config.Runner.Args,
+				Command:         config.Runner.Command,
 				VolumeMounts: []corev1.VolumeMount{
 					{
 						MountPath: "/home/burrito/.ssh/known_hosts",
diff --git a/manifests/crds/config.terraform.padok.cloud_terraformlayers.yaml b/manifests/crds/config.terraform.padok.cloud_terraformlayers.yaml
@@ -998,6 +998,14 @@ spec:
                             x-kubernetes-list-type: atomic
                         type: object
                     type: object
+                  args:
+                    items:
+                      type: string
+                    type: array
+                  command:
+                    items:
+                      type: string
+                    type: array
                   env:
                     items:
                       description: EnvVar represents an environment variable present
diff --git a/manifests/crds/config.terraform.padok.cloud_terraformrepositories.yaml b/manifests/crds/config.terraform.padok.cloud_terraformrepositories.yaml
@@ -991,6 +991,14 @@ spec:
                             x-kubernetes-list-type: atomic
                         type: object
                     type: object
+                  args:
+                    items:
+                      type: string
+                    type: array
+                  command:
+                    items:
+                      type: string
+                    type: array
                   env:
                     items:
                       description: EnvVar represents an environment variable present
diff --git a/manifests/install.yaml b/manifests/install.yaml
@@ -998,6 +998,14 @@ spec:
                             x-kubernetes-list-type: atomic
                         type: object
                     type: object
+                  args:
+                    items:
+                      type: string
+                    type: array
+                  command:
+                    items:
+                      type: string
+                    type: array
                   env:
                     items:
                       description: EnvVar represents an environment variable present
@@ -5884,6 +5892,14 @@ spec:
                             x-kubernetes-list-type: atomic
                         type: object
                     type: object
+                  args:
+                    items:
+                      type: string
+                    type: array
+                  command:
+                    items:
+                      type: string
+                    type: array
                   env:
                     items:
                       description: EnvVar represents an environment variable present

Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,8 @@ type RunnerConfig struct {`
`126`	`126`	Image ImageConfig `mapstructure:"image"`
`127`	`127`	RunnerBinaryPath string `mapstructure:"runnerBinaryPath"`
`128`	`128`	RepositoryPath string `mapstructure:"repositoryPath"`
	`129`	+ Args []string `mapstructure:"args"`
	`130`	+ Command []string `mapstructure:"command"`
`129`	`131`	`}`
`130`	`132`
`131`	`133`	`type ImageConfig struct {`