Support filesystem backup as well as blob store backup #1
+262
−29
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| /* | ||
| * foundationdbbrestore_types_test.go | ||
| * | ||
| * This source file is part of the FoundationDB open source project | ||
| * | ||
| * Copyright 2020-2021 Apple Inc. and the FoundationDB project authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package v1beta1 | ||
| @@ -126,6 +126,39 @@ var _ = Describe("[api] FoundationDBRestore", func() { | ||
| }, | ||
| }, | ||
| "blobstore://account@account/mybackup?bucket=fdb-backups&secure_connection=0"), | ||
| Entry("A restore with a fs config and a backup name", | ||
| FoundationDBRestore{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "mybackup", | ||
| }, | ||
| Spec: FoundationDBRestoreSpec{ | ||
| FSConfiguration: &FSConfiguration{ | ||
| URL: "/some/path", | ||
| BackupName: "backup", | ||
| }, | ||
| }, | ||
| }, | ||
| "/some/path/backup"), | ||
| Entry("A restore with a fs config and no specific name", | ||
| FoundationDBRestore{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "mybackup", | ||
| }, | ||
| Spec: FoundationDBRestoreSpec{ | ||
| FSConfiguration: &FSConfiguration{ | ||
| URL: "/some/path", | ||
| }, | ||
| }, | ||
| }, | ||
| "/some/path/mybackup"), | ||
| Entry("A restore with just a metadata name will return an empty name", | ||
| FoundationDBRestore{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "mybackup", | ||
| }, | ||
| Spec: FoundationDBRestoreSpec{}, | ||
| }, | ||
| ""), | ||
| ) | ||
| }) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -95,6 +95,8 @@ type FoundationDBBackupSpec struct { | ||||||
|
|
||||||
| // This is the configuration of the target blobstore for this backup. | ||||||
| BlobStoreConfiguration *BlobStoreConfiguration `json:"blobStoreConfiguration,omitempty"` | ||||||
| // This is the configuration of the target filesystem for this backup. | ||||||
| FSConfiguration *FSConfiguration `json:"fsConfiguration,omitempty"` | ||||||
|
|
||||||
| // MainContainer defines customization for the foundationdb container. | ||||||
| MainContainer ContainerOverrides `json:"mainContainer,omitempty"` | ||||||
| @@ -211,6 +213,19 @@ type BlobStoreConfiguration struct { | ||||||
| URLParameters []URLParameter `json:"urlParameters,omitempty"` | ||||||
| } | ||||||
|
|
||||||
| // FSConfiguration describes the blob store configuration. | ||||||
| type FSConfiguration struct { | ||||||
| // The name for the backup. | ||||||
| // If empty defaults to .metadata.name. | ||||||
| // +kubebuilder:validation:MaxLength=1024 | ||||||
| BackupName string `json:"backupName,omitempty"` | ||||||
|
|
||||||
| // The url to use with the backup destination. | ||||||
| // +kubebuilder:validation:MaxLength=255 | ||||||
| // +kubebuilder:validation:Required | ||||||
| URL string `json:"url"` | ||||||
| } | ||||||
|
|
||||||
| // ShouldRun determines whether a backup should be running. | ||||||
| func (backup *FoundationDBBackup) ShouldRun() bool { | ||||||
| return backup.Spec.BackupState == "" || backup.Spec.BackupState == BackupStateRunning || backup.Spec.BackupState == BackupStatePaused | ||||||
| @@ -224,7 +239,7 @@ func (backup *FoundationDBBackup) ShouldBePaused() bool { | ||||||
| // Bucket gets the bucket this backup will use. | ||||||
| // This will fill in a default value if the bucket in the spec is empty. | ||||||
| func (backup *FoundationDBBackup) Bucket() string { | ||||||
| if backup.Spec.BlobStoreConfiguration == nil || backup.Spec.BlobStoreConfiguration.Bucket == "" { | ||||||
| return "fdb-backups" | ||||||
| } | ||||||
|
|
||||||
| @@ -234,16 +249,27 @@ func (backup *FoundationDBBackup) Bucket() string { | ||||||
| // BackupName gets the name of the backup in the destination. | ||||||
| // This will fill in a default value if the backup name in the spec is empty. | ||||||
| func (backup *FoundationDBBackup) BackupName() string { | ||||||
| if backup.Spec.BlobStoreConfiguration != nil && backup.Spec.BlobStoreConfiguration.BackupName != "" { | ||||||
| return backup.Spec.BlobStoreConfiguration.BackupName | ||||||
| } | ||||||
|
|
||||||
| if backup.Spec.FSConfiguration != nil && backup.Spec.FSConfiguration.BackupName != "" { | ||||||
| return backup.Spec.FSConfiguration.BackupName | ||||||
| } | ||||||
|
|
||||||
| return backup.ObjectMeta.Name | ||||||
| } | ||||||
|
|
||||||
| // BackupURL gets the destination url of the backup. | ||||||
| func (backup *FoundationDBBackup) BackupURL() string { | ||||||
| if backup.Spec.BlobStoreConfiguration != nil { | ||||||
| return backup.Spec.BlobStoreConfiguration.getURL(backup.BackupName(), backup.Bucket()) | ||||||
| } | ||||||
| // mpatou: should we use file:// ? | ||||||
| if backup.Spec.FSConfiguration != nil { | ||||||
| return fmt.Sprintf("%s/%s", backup.Spec.FSConfiguration.URL, backup.BackupName()) | ||||||
|
There was a problem hiding this comment. if this is a filesystem path, you should use
Suggested change
|
||||||
| } | ||||||
| return "" | ||||||
| } | ||||||
|
|
||||||
| // SnapshotPeriodSeconds gets the period between snapshots for a backup. | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -17,6 +17,7 @@ limitations under the License. | ||
| package v1beta2 | ||
|
|
||
| import ( | ||
| "fmt" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| @@ -55,6 +56,8 @@ type FoundationDBRestoreSpec struct { | ||
|
|
||
| // This is the configuration of the target blobstore for this backup. | ||
| BlobStoreConfiguration *BlobStoreConfiguration `json:"blobStoreConfiguration,omitempty"` | ||
| // This is the configuration of the target filesystem for this backup. | ||
| FSConfiguration *FSConfiguration `json:"fsConfiguration,omitempty"` | ||
|
|
||
| // CustomParameters defines additional parameters to pass to the backup | ||
| // agents. | ||
| @@ -85,16 +88,32 @@ type FoundationDBKeyRange struct { | ||
| // BackupName gets the name of the backup for the source backup. | ||
| // This will fill in a default value if the backup name in the spec is empty. | ||
| func (restore *FoundationDBRestore) BackupName() string { | ||
| if (restore.Spec.BlobStoreConfiguration == nil || restore.Spec.BlobStoreConfiguration.BackupName == "") && (restore.Spec.FSConfiguration == nil || restore.Spec.FSConfiguration.BackupName == "") { | ||
| return restore.ObjectMeta.Name | ||
| } | ||
|
|
||
| if restore.Spec.BlobStoreConfiguration != nil && restore.Spec.BlobStoreConfiguration.BackupName != "" { | ||
| return restore.Spec.BlobStoreConfiguration.BackupName | ||
| } | ||
|
|
||
| if restore.Spec.FSConfiguration != nil && restore.Spec.FSConfiguration.BackupName != "" { | ||
| return restore.Spec.FSConfiguration.BackupName | ||
| } | ||
|
|
||
| return "" | ||
| } | ||
|
|
||
| // BackupURL gets the destination url of the backup. | ||
| func (restore *FoundationDBRestore) BackupURL() string { | ||
| if restore.Spec.BlobStoreConfiguration != nil { | ||
| return restore.Spec.BlobStoreConfiguration.getURL(restore.BackupName(), restore.Spec.BlobStoreConfiguration.BucketName()) | ||
| } | ||
|
|
||
| if restore.Spec.FSConfiguration != nil { | ||
| return fmt.Sprintf("%s/%s", restore.Spec.FSConfiguration.URL, restore.BackupName()) | ||
|
|
||
| } | ||
|
|
||
| return "" | ||
| } | ||
|
|
||
| func init() { | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -116,6 +116,39 @@ var _ = Describe("[api] FoundationDBRestore", func() { | ||
| }, | ||
| }, | ||
| "blobstore://account@account:80/mybackup?bucket=fdb-backups&secure_connection=0"), | ||
| Entry("A restore with a fs config and a backup name", | ||
| FoundationDBRestore{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "mybackup", | ||
| }, | ||
| Spec: FoundationDBRestoreSpec{ | ||
| FSConfiguration: &FSConfiguration{ | ||
| URL: "/some/path", | ||
| BackupName: "backup", | ||
| }, | ||
| }, | ||
| }, | ||
| "/some/path/backup"), | ||
| Entry("A restore with a fs config and no specific name", | ||
| FoundationDBRestore{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "mybackup", | ||
| }, | ||
| Spec: FoundationDBRestoreSpec{ | ||
| FSConfiguration: &FSConfiguration{ | ||
| URL: "/some/path", | ||
| }, | ||
| }, | ||
| }, | ||
| "/some/path/mybackup"), | ||
| Entry("A restore with just a metadata name will return an empty name", | ||
| FoundationDBRestore{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "mybackup", | ||
| }, | ||
| Spec: FoundationDBRestoreSpec{}, | ||
| }, | ||
| ""), | ||
| ) | ||
| }) | ||
| }) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if this is a filesystem path, you should use
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation of
fdbindicates that you can usefile://I don't think it would work ?