add backupVersion to restore spec

Author: Milla Samuel

api/v1beta2/foundationdbrestore_types.go

@@ -65,6 +65,9 @@ type FoundationDBRestoreSpec struct {
 	// The path to the encryption key used to encrypt the backup.
 	// +kubebuilder:validation:MaxLength=4096
 	EncryptionKeyPath string `json:"encryptionKeyPath,omitempty"`
+
+	// Instead of the latest version the backup can be restored to, restore to BackupVersion.
+	BackupVersion string `json:"backupVersion,omitempty"`
 }
 
 // FoundationDBRestoreStatus describes the current status of the restore for a cluster.

config/crd/bases/apps.foundationdb.org_foundationdbrestores.yaml

@@ -36,6 +36,8 @@ spec:
             type: object
           spec:
             properties:
+              backupVersion:
+                type: string
               blobStoreConfiguration:
                 properties:
                   accountName:

controllers/admin_client_test.go

@@ -357,6 +357,7 @@ var _ = Describe("admin_client_test", func() {
 						"blobstore://test@test-service/test-backup",
 						nil,
 						"",
+						"",
 					),
 				).To(Succeed())
 

controllers/start_restore.go

@@ -56,6 +56,7 @@ func (s startRestore) reconcile(
 			restore.BackupURL(),
 			restore.Spec.KeyRanges,
 			restore.Spec.EncryptionKeyPath,
+			restore.Spec.BackupVersion,
 		)
 		if err != nil {
 			return &requeue{curError: err}

docs/restore_spec.md

@@ -56,6 +56,7 @@ FoundationDBRestoreSpec describes the desired state of the backup for a cluster.
 | blobStoreConfiguration | This is the configuration of the target blobstore for this backup. | *BlobStoreConfiguration | false |
 | customParameters | CustomParameters defines additional parameters to pass to the backup agents. | FoundationDBCustomParameters | false |
 | encryptionKeyPath | The path to the encryption key used to encrypt the backup. | string | false |
+| backupVersion | Instead of the latest version the backup can be restored to, restore to BackupVersion. | string | false |
 
 [Back to TOC](#table-of-contents)
 

fdbclient/admin_client.go

@@ -918,6 +918,7 @@ func (client *cliAdminClient) StartRestore(
 	url string,
 	keyRanges []fdbv1beta2.FoundationDBKeyRange,
 	encryptionKeyPath string,
+	backupVersion string,
 ) error {
 	args := []string{
 		"start",
@@ -934,6 +935,10 @@ func (client *cliAdminClient) StartRestore(
 		args = append(args, "--encryption-key-file", encryptionKeyPath)
 	}
 
+	if backupVersion != "" {
+		args = append(args, "-v", backupVersion)
+	}
+
 	if keyRanges != nil {
 		keyRangeString := ""
 		for _, keyRange := range keyRanges {

fdbclient/admin_client_test.go

@@ -1047,7 +1047,7 @@ protocol fdb00b071010000`,
 
 			url := "blobstore://test@test-service/test-backup"
 
-			err := client.StartRestore(url, keyRanges, encryptionKeyPath)
+			err := client.StartRestore(url, keyRanges, encryptionKeyPath, "mock-versionstamp")
 			Expect(err).NotTo(HaveOccurred())
 
 			Expect(mockRunner.receivedArgs[0]).To(ContainElements(

pkg/fdbadminclient/admin_client.go

@@ -92,6 +92,7 @@ type AdminClient interface {
 		url string,
 		keyRanges []fdbv1beta2.FoundationDBKeyRange,
 		encyptionKeyPath string,
+		backupVersion string,
 	) error
 
 	// GetRestoreStatus gets the status of the current restore.

pkg/fdbadminclient/mock/admin_client_mock.go

@@ -969,6 +969,7 @@ func (client *AdminClient) StartRestore(
 	url string,
 	_ []fdbv1beta2.FoundationDBKeyRange,
 	_ string,
+	_ string,
 ) error {
 	adminClientMutex.Lock()
 	defer adminClientMutex.Unlock()