add vtbackup extraflags support

Signed-off-by: Jeremy Doupe <[email protected]>
Signed-off-by: Jeremy Doupe <[email protected]>

Author: jdoupe

deploy/crds/planetscale.com_vitessclusters.yaml

@@ -2115,6 +2115,10 @@ spec:
                                               terminationGracePeriodSeconds:
                                                 format: int64
                                                 type: integer
+                                              vtbackupExtraFlags:
+                                                additionalProperties:
+                                                  type: string
+                                                type: object
                                             required:
                                             - resources
                                             type: object
@@ -2558,6 +2562,10 @@ spec:
                                             terminationGracePeriodSeconds:
                                               format: int64
                                               type: integer
+                                            vtbackupExtraFlags:
+                                              additionalProperties:
+                                                type: string
+                                              type: object
                                           required:
                                           - resources
                                           type: object

deploy/crds/planetscale.com_vitesskeyspaces.yaml

@@ -656,6 +656,10 @@ spec:
                                         terminationGracePeriodSeconds:
                                           format: int64
                                           type: integer
+                                        vtbackupExtraFlags:
+                                          additionalProperties:
+                                            type: string
+                                          type: object
                                       required:
                                       - resources
                                       type: object
@@ -1099,6 +1103,10 @@ spec:
                                       terminationGracePeriodSeconds:
                                         format: int64
                                         type: integer
+                                      vtbackupExtraFlags:
+                                        additionalProperties:
+                                          type: string
+                                        type: object
                                     required:
                                     - resources
                                     type: object

deploy/crds/planetscale.com_vitessshards.yaml

@@ -639,6 +639,10 @@ spec:
                         terminationGracePeriodSeconds:
                           format: int64
                           type: integer
+                        vtbackupExtraFlags:
+                          additionalProperties:
+                            type: string
+                          type: object
                       required:
                       - resources
                       type: object

docs/api.md

@@ -8805,6 +8805,21 @@ set the string value to either &ldquo;true&rdquo; or &ldquo;false&rdquo;.</p>
 </tr>
 <tr>
 <td>
+<code>vtbackupExtraFlags</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<p>VtbackupExtraFlags can optionally be used to pass additional flags only to vtbackup.
+Use this to avoid sending vttablet-only flags to vtbackup, which may not support them.
+All entries must be key-value string pairs of the form &ldquo;flag&rdquo;: &ldquo;value&rdquo;. The flag name should
+not have any prefix (just &ldquo;flag&rdquo;, not &ldquo;-flag&rdquo;). To set a boolean flag, set the string value
+to either &ldquo;true&rdquo; or &ldquo;false&rdquo;.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>lifecycle</code><br>
 <em>
 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#lifecycle-v1-core">

docs/api/index.html

@@ -8807,6 +8807,21 @@ <h3 id="planetscale.com/v2.VttabletSpec">VttabletSpec
 </tr>
 <tr>
 <td>
+<code>vtbackupExtraFlags</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<p>VtbackupExtraFlags can optionally be used to pass additional flags only to vtbackup.
+Use this to avoid sending vttablet-only flags to vtbackup, which may not support them.
+All entries must be key-value string pairs of the form &ldquo;flag&rdquo;: &ldquo;value&rdquo;. The flag name should
+not have any prefix (just &ldquo;flag&rdquo;, not &ldquo;-flag&rdquo;). To set a boolean flag, set the string value
+to either &ldquo;true&rdquo; or &ldquo;false&rdquo;.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>lifecycle</code><br>
 <em>
 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#lifecycle-v1-core">

pkg/apis/planetscale/v2/vitessshard_types.go

@@ -291,6 +291,13 @@ type VttabletSpec struct {
 	// set the string value to either "true" or "false".
 	ExtraFlags map[string]string `json:"extraFlags,omitempty"`
 
+        // VtbackupExtraFlags can optionally be used to pass additional flags only to vtbackup.
+        // Use this to avoid sending vttablet-only flags to vtbackup, which may not support them.
+        // All entries must be key-value string pairs of the form "flag": "value". The flag name should
+        // not have any prefix (just "flag", not "-flag"). To set a boolean flag, set the string value
+        // to either "true" or "false".
+        VtbackupExtraFlags map[string]string `json:"vtbackupExtraFlags,omitempty"`
+
 	// Lifecycle can optionally be used to add container lifecycle hooks
 	// to vttablet container
 	// +kubebuilder:validation:Schemaless

pkg/apis/planetscale/v2/zz_generated.deepcopy.go

@@ -233,6 +233,8 @@ func vtbackupSpec(key client.ObjectKey, vts *planetscalev2.VitessShard, parentLa
 		InitContainers:           pool.InitContainers,
 		SidecarContainers:        pool.SidecarContainers,
 		ExtraEnv:                 pool.ExtraEnv,
+		ExtraVolumes:             pool.ExtraVolumes,
+		ExtraVolumeMounts:        pool.ExtraVolumeMounts,
 		Annotations:              annotations,
 		Affinity:                 pool.Affinity,
 		Tolerations:              pool.Tolerations,

pkg/controller/vitessshard/reconcile_backup_job.go

@@ -18,6 +18,7 @@ package vttablet
 
 import (
 	"strconv"
+	"strings"
 	"time"
 
 	corev1 "k8s.io/api/core/v1"
@@ -134,6 +135,11 @@ func NewBackupPod(key client.ObjectKey, backupSpec *BackupSpec, mysqldImage stri
 	update.ResourceRequirements(&containerResources, &tabletSpec.Mysqld.Resources)
 
 	vtbackupAllFlags := vtbackupFlags.Get(backupSpec)
+	// Merge vtbackup-specific extra flags only.
+	for key, value := range tabletSpec.Vttablet.VtbackupExtraFlags {
+		key = strings.TrimLeft(key, "-")
+		vtbackupAllFlags[key] = value
+	}
 	mysql.UpdateMySQLServerVersion(vtbackupAllFlags, mysqldImage)
 	pod := &corev1.Pod{
 		ObjectMeta: metav1.ObjectMeta{
@@ -184,6 +190,18 @@ func NewBackupPod(key client.ObjectKey, backupSpec *BackupSpec, mysqldImage stri
 		},
 	}
 
+	// Allow user-provided extra volumes and mounts to be applied last.
+	update.Volumes(&pod.Spec.Volumes, tabletSpec.ExtraVolumes)
+	update.VolumeMounts(&volumeMounts, tabletSpec.ExtraVolumeMounts)
+
+	// Apply the updated volume mounts to the vtbackup container
+	for i := range pod.Spec.Containers {
+		if pod.Spec.Containers[i].Name == vtbackupContainerName {
+			pod.Spec.Containers[i].VolumeMounts = volumeMounts
+			break
+		}
+	}
+
 	if planetscalev2.DefaultVitessServiceAccount != "" {
 		pod.Spec.ServiceAccountName = planetscalev2.DefaultVitessServiceAccount
 	}