Add ability to schedule recurring incremental backups

api/v1beta1/solrbackup_types.go

@@ -51,6 +51,13 @@ type SolrBackupSpec struct {
 	// +optional
 	Location string `json:"location,omitempty"`
 
+	// Set this backup to be taken recurrently, with options for scheduling and storage.
+	//
+	// NOTE: This is only supported for Solr Clouds version 8.9+, as it uses the incremental backup API.
+	//
+	// +optional
+	Recurrence *BackupRecurrence `json:"recurrence,omitempty"`
+
 	// Persistence is the specification on how to persist the backup data.
 	// +optional
 	Persistence *PersistenceSource `json:"persistence,omitempty"`
@@ -64,6 +71,29 @@ func (spec *SolrBackupSpec) withDefaults(backupName string) (changed bool) {
 	return changed
 }
 
+// BackupRecurrence defines the recurrence of the incremental backup
+type BackupRecurrence struct {
+	// Perform a backup on the given schedule, in CRON format.
+	//
+	// Multiple CRON syntaxes are supported
+	//   - Standard CRON (e.g. "CRON_TZ=Asia/Seoul 0 6 * * ?")
+	//   - Predefined Schedules (e.g. "@yearly", "@weekly", "@daily", etc.)
+	//   - Intervals (e.g. "@every 10h30m")
+	//
+	// For more information please check this reference:
+	// https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format
+	Schedule string `json:"schedule"`
+
+	// Define the number of backup points to save for this backup at any given time.
+	// The oldest backups will be deleted if too many exist when a backup is taken.
+	// If not provided, this defaults to 10.
+	//
+	// +kubebuilder:default:=10
+	// +kubebuilder:validation:Minimum:=1
+	// +optional
+	MaxSaved int `json:"maxSaved,omitempty"`
+}
+
 // PersistenceSource defines the location and method of persisting the backup data.
 // Exactly one member must be specified.
 type PersistenceSource struct {
@@ -198,9 +228,27 @@ func (spec *VolumePersistenceSource) withDefaults(backupName string) (changed bo
 
 // SolrBackupStatus defines the observed state of SolrBackup
 type SolrBackupStatus struct {
+	// The current Backup Status, which all fields are added to this struct
+	Current IndividualSolrBackupStatus `json:",inline"`
+
+	// The scheduled time for the next backup to occur
+	// +optional
+	NextScheduledTime *metav1.Time `json:"nextScheduledTime,omitempty"`
+
+	// The status history of recurring backups
+	// +optional
+	History []IndividualSolrBackupStatus `json:"history,omitempty"`
+}
+
+// IndividualSolrBackupStatus defines the observed state of a single issued SolrBackup
+type IndividualSolrBackupStatus struct {
 	// Version of the Solr being backed up
 	SolrVersion string `json:"solrVersion"`
 
+	// The time that this backup was initiated
+	// +optional
+	StartTime metav1.Time `json:"startTimestamp,omitempty"`
+
 	// The status of each collection's backup progress
 	// +optional
 	CollectionBackupStatuses []CollectionBackupStatus `json:"collectionBackupStatuses,omitempty"`

api/v1beta1/solrcloud_types.go

@@ -35,7 +35,6 @@ const (
 	DefaultSolrReplicas = int32(3)
 	DefaultSolrRepo     = "library/solr"
 	DefaultSolrVersion  = "8.9"
-	DefaultSolrStorage  = "5Gi"
 	DefaultSolrJavaMem  = "-Xms1g -Xmx2g"
 	DefaultSolrOpts     = ""
 	DefaultSolrLogLevel = "INFO"

config/crd/bases/solr.apache.org_solrbackups.yaml

@@ -1051,6 +1051,20 @@ spec:
                     - source
                     type: object
                 type: object
+              recurrence:
+                description: "Set this backup to be taken recurrently, with options for scheduling and storage. \n NOTE: This is only supported for Solr Clouds version 8.9+, as it uses the incremental backup API."
+                properties:
+                  maxSaved:
+                    default: 10
+                    description: Define the number of backup points to save for this backup at any given time. The oldest backups will be deleted if too many exist when a backup is taken. If not provided, this defaults to 10.
+                    minimum: 1
+                    type: integer
+                  schedule:
+                    description: "Perform a backup on the given schedule, in CRON format. \n Multiple CRON syntaxes are supported   - Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\")   - Predefined Schedules (e.g. \"@yearly\", \"@weekly\", \"@daily\", etc.)   - Intervals (e.g. \"@every 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
+                    type: string
+                required:
+                - schedule
+                type: object
               repositoryName:
                 description: The name of the repository to use for the backup.  Defaults to "legacy_local_repository" if not specified (the auto-configured repository for legacy singleton volumes).
                 type: string
@@ -1105,6 +1119,92 @@ spec:
               finished:
                 description: Whether the backup has finished
                 type: boolean
+              history:
+                description: The status history of recurring backups
+                items:
+                  description: IndividualSolrBackupStatus defines the observed state of a single issued SolrBackup
+                  properties:
+                    collectionBackupStatuses:
+                      description: The status of each collection's backup progress
+                      items:
+                        description: CollectionBackupStatus defines the progress of a Solr Collection's backup
+                        properties:
+                          asyncBackupStatus:
+                            description: The status of the asynchronous backup call to solr
+                            type: string
+                          backupName:
+                            description: BackupName of this collection's backup in Solr
+                            type: string
+                          collection:
+                            description: Solr Collection name
+                            type: string
+                          finishTimestamp:
+                            description: Time that the collection backup finished at
+                            format: date-time
+                            type: string
+                          finished:
+                            description: Whether the backup has finished
+                            type: boolean
+                          inProgress:
+                            description: Whether the collection is being backed up
+                            type: boolean
+                          startTimestamp:
+                            description: Time that the collection backup started at
+                            format: date-time
+                            type: string
+                          successful:
+                            description: Whether the backup was successful
+                            type: boolean
+                        required:
+                        - collection
+                        type: object
+                      type: array
+                    finishTimestamp:
+                      description: Version of the Solr being backed up
+                      format: date-time
+                      type: string
+                    finished:
+                      description: Whether the backup has finished
+                      type: boolean
+                    persistenceStatus:
+                      description: Whether the backups are in progress of being persisted
+                      properties:
+                        finishTimestamp:
+                          description: Time that the collection backup finished at
+                          format: date-time
+                          type: string
+                        finished:
+                          description: Whether the persistence has finished
+                          type: boolean
+                        inProgress:
+                          description: Whether the collection is being backed up
+                          type: boolean
+                        startTimestamp:
+                          description: Time that the collection backup started at
+                          format: date-time
+                          type: string
+                        successful:
+                          description: Whether the backup was successful
+                          type: boolean
+                      type: object
+                    solrVersion:
+                      description: Version of the Solr being backed up
+                      type: string
+                    startTimestamp:
+                      description: The time that this backup was initiated
+                      format: date-time
+                      type: string
+                    successful:
+                      description: Whether the backup was successful
+                      type: boolean
+                  required:
+                  - solrVersion
+                  type: object
+                type: array
+              nextScheduledTime:
+                description: The scheduled time for the next backup to occur
+                format: date-time
+                type: string
               persistenceStatus:
                 description: Whether the backups are in progress of being persisted
                 properties:
@@ -1129,6 +1229,10 @@ spec:
               solrVersion:
                 description: Version of the Solr being backed up
                 type: string
+              startTimestamp:
+                description: The time that this backup was initiated
+                format: date-time
+                type: string
               successful:
                 description: Whether the backup was successful
                 type: boolean

controllers/common.go

@@ -24,6 +24,9 @@ import (
 
 // Set the requeueAfter if it has not been set, or is greater than the new time to requeue at
 func updateRequeueAfter(requeueOrNot *reconcile.Result, newWait time.Duration) {
+	if newWait <= 0 {
+		requeueOrNot.RequeueAfter = 0
+	}
 	if requeueOrNot.RequeueAfter <= 0 || requeueOrNot.RequeueAfter > newWait {
 		requeueOrNot.RequeueAfter = newWait
 	}