Add the ability to automate and schedule backups

.buildkite/pipeline.yml

@@ -1,16 +1,19 @@
 agents:
   queue: "public"
 
+env:
+  GO_VERSION_FILE: "go1.22.3.linux-amd64.tar.gz"
+
 # Mount the docker.sock as to the docker container, so that we are able to
 # run docker build command and kind is spawned as a sibling container.
 steps:
   - name: "Upgrade Test"
     command:
     - apk add g++ make bash gcompat curl mysql mysql-client libc6-compat
-    - wget https://golang.org/dl/go1.22.3.linux-amd64.tar.gz
-    - tar -C /usr/local -xzf go1.22.3.linux-amd64.tar.gz
+    - wget https://golang.org/dl/$GO_VERSION_FILE
+    - tar -C /usr/local -xzf $GO_VERSION_FILE
     - export PATH=$PATH:/usr/local/go/bin
-    - rm go1.22.3.linux-amd64.tar.gz
+    - rm $GO_VERSION_FILE
     - ln -s /lib/libc.so.6 /usr/lib/libresolv.so.2
     - make upgrade-test
     concurrency: 1
@@ -26,10 +29,10 @@ steps:
   - name: "Backup Restore Test"
     command:
     - apk add g++ make bash gcompat curl mysql mysql-client libc6-compat
-    - wget https://golang.org/dl/go1.22.3.linux-amd64.tar.gz
-    - tar -C /usr/local -xzf go1.22.3.linux-amd64.tar.gz
+    - wget https://golang.org/dl/$GO_VERSION_FILE
+    - tar -C /usr/local -xzf $GO_VERSION_FILE
     - export PATH=$PATH:/usr/local/go/bin
-    - rm go1.22.3.linux-amd64.tar.gz
+    - rm $GO_VERSION_FILE
     - ln -s /lib/libc.so.6 /usr/lib/libresolv.so.2
     - make backup-restore-test
     concurrency: 1
@@ -42,13 +45,32 @@ steps:
           volumes:
             - "/var/run/docker.sock:/var/run/docker.sock"
 
+  - name: "Backup Schedule Test"
+    command:
+      - apk add g++ make bash gcompat curl mysql mysql-client libc6-compat
+      - wget https://golang.org/dl/$GO_VERSION_FILE
+      - tar -C /usr/local -xzf $GO_VERSION_FILE
+      - export PATH=$PATH:/usr/local/go/bin
+      - rm $GO_VERSION_FILE
+      - ln -s /lib/libc.so.6 /usr/lib/libresolv.so.2
+      - make backup-schedule-test
+    concurrency: 1
+    concurrency_group: 'vtop/backup-schedule-test'
+    timeout_in_minutes: 60
+    plugins:
+      - docker#v3.12.0:
+          image: "docker:latest"
+          propagate-environment: true
+          volumes:
+            - "/var/run/docker.sock:/var/run/docker.sock"
+
   - name: "VTOrc and VTAdmin Test"
     command:
     - apk add g++ make bash gcompat curl mysql mysql-client libc6-compat chromium
-    - wget https://golang.org/dl/go1.22.3.linux-amd64.tar.gz
-    - tar -C /usr/local -xzf go1.22.3.linux-amd64.tar.gz
+    - wget https://golang.org/dl/$GO_VERSION_FILE
+    - tar -C /usr/local -xzf $GO_VERSION_FILE
     - export PATH=$PATH:/usr/local/go/bin
-    - rm go1.22.3.linux-amd64.tar.gz
+    - rm $GO_VERSION_FILE
     - ln -s /lib/libc.so.6 /usr/lib/libresolv.so.2
     - make vtorc-vtadmin-test
     concurrency: 1

.gitignore

@@ -79,3 +79,5 @@ tags
 ### Intellij IDEs ###
 .idea/*
 # End of https://www.gitignore.io/api/go,vim,emacs,visualstudiocode
+
+**/vtdataroot

Makefile

@@ -66,6 +66,10 @@ backup-restore-test: build e2e-test-setup
 	echo "Running Backup-Restore test"
 	test/endtoend/backup_restore_test.sh
 
+backup-schedule-test: build e2e-test-setup
+	echo "Running Backup-Schedule test"
+	test/endtoend/backup_schedule_test.sh
+
 vtorc-vtadmin-test: build e2e-test-setup
 	echo "Running VTOrc and VtAdmin test"
 	test/endtoend/vtorc_vtadmin_test.sh

deploy/crds/planetscale.com_vitessbackupschedules.yaml

@@ -0,0 +1,171 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.11.3
+  creationTimestamp: null
+  name: vitessbackupschedules.planetscale.com
+spec:
+  group: planetscale.com
+  names:
+    kind: VitessBackupSchedule
+    listKind: VitessBackupScheduleList
+    plural: vitessbackupschedules
+    singular: vitessbackupschedule
+  scope: Namespaced
+  versions:
+  - name: v2
+    schema:
+      openAPIV3Schema:
+        properties:
+          apiVersion:
+            type: string
+          kind:
+            type: string
+          metadata:
+            type: object
+          spec:
+            properties:
+              affinity:
+                x-kubernetes-preserve-unknown-fields: true
+              allowedMissedRun:
+                minimum: 0
+                type: integer
+              annotations:
+                additionalProperties:
+                  type: string
+                type: object
+              cluster:
+                type: string
+              concurrencyPolicy:
+                enum:
+                - Allow
+                - Forbid
+                example: Forbid
+                type: string
+              failedJobsHistoryLimit:
+                format: int32
+                minimum: 0
+                type: integer
+              image:
+                type: string
+              imagePullPolicy:
+                type: string
+              jobTimeoutMinute:
+                default: 10
+                format: int32
+                minimum: 0
+                type: integer
+              name:
+                example: every-day
+                minLength: 1
+                pattern: ^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?$
+                type: string
+              resources:
+                properties:
+                  claims:
+                    items:
+                      properties:
+                        name:
+                          type: string
+                      required:
+                      - name
+                      type: object
+                    type: array
+                    x-kubernetes-list-map-keys:
+                    - name
+                    x-kubernetes-list-type: map
+                  limits:
+                    additionalProperties:
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                      x-kubernetes-int-or-string: true
+                    type: object
+                  requests:
+                    additionalProperties:
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                      x-kubernetes-int-or-string: true
+                    type: object
+                type: object
+              schedule:
+                example: 0 0 * * *
+                minLength: 0
+                type: string
+              startingDeadlineSeconds:
+                format: int64
+                minimum: 0
+                type: integer
+              strategies:
+                items:
+                  properties:
+                    extraFlags:
+                      additionalProperties:
+                        type: string
+                      type: object
+                    keyspace:
+                      example: commerce
+                      type: string
+                    name:
+                      enum:
+                      - BackupShard
+                      type: string
+                    shard:
+                      example: '-'
+                      type: string
+                  required:
+                  - keyspace
+                  - name
+                  - shard
+                  type: object
+                minItems: 1
+                type: array
+              successfulJobsHistoryLimit:
+                format: int32
+                minimum: 0
+                type: integer
+              suspend:
+                type: boolean
+            required:
+            - cluster
+            - name
+            - resources
+            - schedule
+            - strategies
+            type: object
+          status:
+            properties:
+              active:
+                items:
+                  properties:
+                    apiVersion:
+                      type: string
+                    fieldPath:
+                      type: string
+                    kind:
+                      type: string
+                    name:
+                      type: string
+                    namespace:
+                      type: string
+                    resourceVersion:
+                      type: string
+                    uid:
+                      type: string
+                  type: object
+                  x-kubernetes-map-type: atomic
+                type: array
+              lastScheduledTime:
+                format: date-time
+                type: string
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}

deploy/crds/planetscale.com_vitessclusters.yaml

@@ -152,6 +152,114 @@ spec:
                       type: object
                     minItems: 1
                     type: array
+                  schedules:
+                    items:
+                      properties:
+                        affinity:
+                          x-kubernetes-preserve-unknown-fields: true
+                        allowedMissedRun:
+                          minimum: 0
+                          type: integer
+                        annotations:
+                          additionalProperties:
+                            type: string
+                          type: object
+                        concurrencyPolicy:
+                          enum:
+                          - Allow
+                          - Forbid
+                          example: Forbid
+                          type: string
+                        failedJobsHistoryLimit:
+                          format: int32
+                          minimum: 0
+                          type: integer
+                        jobTimeoutMinute:
+                          default: 10
+                          format: int32
+                          minimum: 0
+                          type: integer
+                        name:
+                          example: every-day
+                          minLength: 1
+                          pattern: ^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?$
+                          type: string
+                        resources:
+                          properties:
+                            claims:
+                              items:
+                                properties:
+                                  name:
+                                    type: string
+                                required:
+                                - name
+                                type: object
+                              type: array
+                              x-kubernetes-list-map-keys:
+                              - name
+                              x-kubernetes-list-type: map
+                            limits:
+                              additionalProperties:
+                                anyOf:
+                                - type: integer
+                                - type: string
+                                pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                                x-kubernetes-int-or-string: true
+                              type: object
+                            requests:
+                              additionalProperties:
+                                anyOf:
+                                - type: integer
+                                - type: string
+                                pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                                x-kubernetes-int-or-string: true
+                              type: object
+                          type: object
+                        schedule:
+                          example: 0 0 * * *
+                          minLength: 0
+                          type: string
+                        startingDeadlineSeconds:
+                          format: int64
+                          minimum: 0
+                          type: integer
+                        strategies:
+                          items:
+                            properties:
+                              extraFlags:
+                                additionalProperties:
+                                  type: string
+                                type: object
+                              keyspace:
+                                example: commerce
+                                type: string
+                              name:
+                                enum:
+                                - BackupShard
+                                type: string
+                              shard:
+                                example: '-'
+                                type: string
+                            required:
+                            - keyspace
+                            - name
+                            - shard
+                            type: object
+                          minItems: 1
+                          type: array
+                        successfulJobsHistoryLimit:
+                          format: int32
+                          minimum: 0
+                          type: integer
+                        suspend:
+                          type: boolean
+                      required:
+                      - name
+                      - resources
+                      - schedule
+                      - strategies
+                      type: object
+                    type: array
                   subcontroller:
                     properties:
                       serviceAccountName:

deploy/kustomization.yaml

@@ -11,3 +11,4 @@ resources:
 - crds/planetscale.com_vitessbackups.yaml
 - crds/planetscale.com_vitessbackupstorages.yaml
 - crds/planetscale.com_etcdlockservers.yaml
+- crds/planetscale.com_vitessbackupschedules.yaml

deploy/role.yaml

@@ -68,5 +68,14 @@ rules:
   - vitessbackupstorages
   - vitessbackupstorages/status
   - vitessbackupstorages/finalizers
+  - vitessbackupschedules
+  - vitessbackupschedules/status
+  - vitessbackupschedules/finalizers
+  verbs:
+  - '*'
+- apiGroups:
+  - batch
+  resources:
+  - jobs
   verbs:
   - '*'