From 8fd21319b2d7f9d081940ae72b22d831ac986eed Mon Sep 17 00:00:00 2001 From: Sjors Gielen Date: Sun, 11 Aug 2024 13:28:13 +0200 Subject: [PATCH] Rename volume class -> storage class and fix Helm chart camelCase. Fixes SKY-1587. --- chart/templates/manager.yaml | 16 ++++++++-------- chart/values.yaml | 8 ++++---- cmd/main.go | 6 +++--- config/manager/manager.yaml | 2 +- internal/controller/pvcbackup_controller.go | 8 ++++---- internal/controller/pvcbackup_controller_test.go | 2 +- internal/controller/pvcrestore_controller.go | 8 ++++---- internal/controller/util.go | 2 +- 8 files changed, 26 insertions(+), 26 deletions(-) diff --git a/chart/templates/manager.yaml b/chart/templates/manager.yaml index 38107b5..1696687 100644 --- a/chart/templates/manager.yaml +++ b/chart/templates/manager.yaml @@ -1,7 +1,7 @@ {{- $s3Host := .Values.app.s3.host | required ".Values.app.s3.host is required." -}} {{- $s3Bucket := .Values.app.s3.bucket | required ".Values.app.s3.bucket is required." -}} -{{- $s3AccessKey := .Values.app.s3.accesskey | required ".Values.app.s3.accesskey is required." -}} -{{- $s3SecretKey := .Values.app.s3.secretkey | required ".Values.app.s3.secretkey is required." -}} +{{- $s3AccessKey := .Values.app.s3.accessKey | required ".Values.app.s3.accessKey is required." -}} +{{- $s3SecretKey := .Values.app.s3.secretKey | required ".Values.app.s3.secretKey is required." -}} {{- $resticPassword := .Values.app.restic.password | required ".Values.app.restic.password is required." -}} --- apiVersion: apps/v1 @@ -94,19 +94,19 @@ spec: # volume snapshot class name is used. # - --snapshotclass # - csi-snapshot - {{- if .Values.app.snapshotclass }} + {{- if .Values.app.snapshotClass }} - --snapshotclass - - {{ .Values.app.snapshotclass }} + - {{ .Values.app.snapshotClass }} {{- end }} # The storage class name set here is used for all PVCs created by Backsnap # both while creating a back-up and while restoring one. Otherwise, the # cluster default storage class is used. - # - --volumeclass + # - --storageclass # - csi-block - {{- if .Values.app.volumeclass }} - - --volumeclass - - {{ .Values.app.volumeclass }} + {{- if .Values.app.storageClass }} + - --storageclass + - {{ .Values.app.storageClass }} {{- end }} # The location and credentials of the S3 bucket where backups will be stored. diff --git a/chart/values.yaml b/chart/values.yaml index 2b381b4..8fa5da6 100644 --- a/chart/values.yaml +++ b/chart/values.yaml @@ -43,12 +43,12 @@ app: schedule: "@daily" # Default is nothing to run backsnap in automatic mode manual: "" - snapshotclass: "" - volumeclass: "" + snapshotClass: "" + storageClass: "" s3: host: "" bucket: "" - accesskey: "" - secretkey: "" + accessKey: "" + secretKey: "" restic: password: "" diff --git a/cmd/main.go b/cmd/main.go index 69d48df..c69dae0 100644 --- a/cmd/main.go +++ b/cmd/main.go @@ -43,8 +43,8 @@ var ( maxRunningBackups = flag.Int("max-running-backups", 1, "Maximum amount of backups to run simultaneously") sleepBetweenBackups = flag.Int("sleep-between-backups", 30, "Seconds to sleep between backing up of each PVC") - snapshotClassFlag = flag.String("snapshotclass", "", "volumeSnapshotClassName") - volumeClassFlag = flag.String("volumeclass", "", "volumeClassName") + snapshotClassFlag = flag.String("snapshotclass", "", "name of the VolumeSnapshotClass to use") + storageClassFlag = flag.String("storageclass", "", "name fo the StorageClass to use") imagePullSecret = flag.String("imagepullsecret", "", "imagePullSecret to pass to backup Pod (optional)") image = flag.String("image", "sjorsgielen/backsnap-restic:latest-main", "Restic back-up image") s3Host = flag.String("s3-host", "", "S3 hostname (can be host, host:port or http://host:port/)") @@ -142,7 +142,7 @@ func main() { backupSettings := controller.BackupSettings{ SnapshotClass: *snapshotClassFlag, - VolumeClass: *volumeClassFlag, + StorageClass: *storageClassFlag, ImagePullSecret: *imagePullSecret, Image: *image, S3Host: *s3Host, diff --git a/config/manager/manager.yaml b/config/manager/manager.yaml index 93e1520..cb94358 100644 --- a/config/manager/manager.yaml +++ b/config/manager/manager.yaml @@ -75,7 +75,7 @@ spec: # The storage class name set here is used for all PVCs created by Backsnap # both while creating a back-up and while restoring one. Otherwise, the # cluster default storage class is used. - # - --volumeclass + # - -storageclass # - csi-block # The location and credentials of the S3 bucket where backups will be stored. diff --git a/internal/controller/pvcbackup_controller.go b/internal/controller/pvcbackup_controller.go index 0a8017b..39fb577 100644 --- a/internal/controller/pvcbackup_controller.go +++ b/internal/controller/pvcbackup_controller.go @@ -267,9 +267,9 @@ func (r *PVCBackupReconciler) Reconcile(ctx context.Context, req ctrl.Request) ( return ctrl.Result{}, err } - var volumeClass *string - if r.BackupSettings.VolumeClass != "" { - volumeClass = &r.BackupSettings.VolumeClass + var storageClass *string + if r.BackupSettings.StorageClass != "" { + storageClass = &r.BackupSettings.StorageClass } snapshotPvc = corev1.PersistentVolumeClaim{ ObjectMeta: metav1.ObjectMeta{ @@ -280,7 +280,7 @@ func (r *PVCBackupReconciler) Reconcile(ctx context.Context, req ctrl.Request) ( }, }, Spec: corev1.PersistentVolumeClaimSpec{ - StorageClassName: volumeClass, + StorageClassName: storageClass, DataSource: &corev1.TypedLocalObjectReference{ APIGroup: lo.ToPtr("snapshot.storage.k8s.io"), Kind: "VolumeSnapshot", diff --git a/internal/controller/pvcbackup_controller_test.go b/internal/controller/pvcbackup_controller_test.go index 6087f3d..cf0b7b3 100644 --- a/internal/controller/pvcbackup_controller_test.go +++ b/internal/controller/pvcbackup_controller_test.go @@ -149,7 +149,7 @@ var _ = Describe("PVCBackup and PVCRestore controller", func() { backupSettings := BackupSettings{ SnapshotClass: snapshotClassName, - VolumeClass: storageClassName, + StorageClass: storageClassName, // default restic image ImagePullSecret: "", Image: "sjorsgielen/backsnap-restic:latest-main", diff --git a/internal/controller/pvcrestore_controller.go b/internal/controller/pvcrestore_controller.go index e31d5a4..ffa2f57 100644 --- a/internal/controller/pvcrestore_controller.go +++ b/internal/controller/pvcrestore_controller.go @@ -89,9 +89,9 @@ func (r *PVCRestoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) return ctrl.Result{}, err } - var volumeClass *string - if r.BackupSettings.VolumeClass != "" { - volumeClass = &r.BackupSettings.VolumeClass + var storageClass *string + if r.BackupSettings.StorageClass != "" { + storageClass = &r.BackupSettings.StorageClass } pvc = corev1.PersistentVolumeClaim{ ObjectMeta: metav1.ObjectMeta{ @@ -102,7 +102,7 @@ func (r *PVCRestoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) }, }, Spec: corev1.PersistentVolumeClaimSpec{ - StorageClassName: volumeClass, + StorageClassName: storageClass, AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadWriteOnce}, Resources: corev1.VolumeResourceRequirements{ Requests: map[corev1.ResourceName]resource.Quantity{ diff --git a/internal/controller/util.go b/internal/controller/util.go index 54195fc..9cce350 100644 --- a/internal/controller/util.go +++ b/internal/controller/util.go @@ -17,7 +17,7 @@ type Clock interface { type BackupSettings struct { SnapshotClass string - VolumeClass string + StorageClass string ImagePullSecret string Image string // S3 hostname (can be host, host:port or http://host:port/)