Merge pull request #320 from vshn/nextcloud/no_downtime_backup

Allow skipping maintenance mode for nextcloud backups

Author: TheBigLee

apis/vshn/v1/vshn_nextcloud.go

@@ -55,6 +55,17 @@ type VSHNNextcloudSpec struct {
 	WriteConnectionSecretToRef LocalObjectReference `json:"writeConnectionSecretToRef,omitempty"`
 }
 
+type VSHNNextcloudBackupSpec struct {
+	K8upBackupSpec `json:",inline"`
+
+	// +kubebuilder:default=false
+
+	// SkipMaintenance defines, if setting maintenance mode should be skipped during the backup. Defaults to false
+	// Warning: If this is set to true, the maintenance mode will not be enabled during the backup. This might
+	// lead to inconsistent backups.
+	SkipMaintenance bool `json:"skipMaintenance,omitempty"`
+}
+
 // VSHNNextcloudParameters are the configurable fields of a VSHNNextcloud.
 type VSHNNextcloudParameters struct {
 	// Service contains nextcloud DBaaS specific properties
@@ -67,7 +78,7 @@ type VSHNNextcloudParameters struct {
 	Scheduling VSHNDBaaSSchedulingSpec `json:"scheduling,omitempty"`
 
 	// Backup contains settings to control how the instance should get backed up.
-	Backup K8upBackupSpec `json:"backup,omitempty"`
+	Backup VSHNNextcloudBackupSpec `json:"backup,omitempty"`
 
 	// Restore contains settings to control the restore of an instance.
 	Restore K8upRestoreSpec `json:"restore,omitempty"`

apis/vshn/v1/zz_generated.deepcopy.go

@@ -66,6 +66,8 @@ spec:
                         schedule:
                           pattern: ^(\*|([0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-9]|5[0-9])|\*\/([0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-9]|5[0-9])) (\*|([0-9]|1[0-9]|2[0-3])|\*\/([0-9]|1[0-9]|2[0-3])) (\*|([1-9]|1[0-9]|2[0-9]|3[0-1])|\*\/([1-9]|1[0-9]|2[0-9]|3[0-1])) (\*|([1-9]|1[0-2])|\*\/([1-9]|1[0-2])) (\*|([0-6])|\*\/([0-6]))$
                           type: string
+                        skipMaintenance:
+                          type: boolean
                       type: object
                       default: {}
                     instances:

crds/vshn.appcat.vshn.io_vshnnextclouds.yaml

@@ -110,6 +110,8 @@ spec:
                           (\*|([0-9]|1[0-9]|2[0-3])|\*\/([0-9]|1[0-9]|2[0-3])) (\*|([1-9]|1[0-9]|2[0-9]|3[0-1])|\*\/([1-9]|1[0-9]|2[0-9]|3[0-1]))
                           (\*|([1-9]|1[0-2])|\*\/([1-9]|1[0-2])) (\*|([0-6])|\*\/([0-6]))$
                         type: string
+                      skipMaintenance:
+                        type: boolean
                     type: object
                   instances:
                     default: 1

crds/vshn.appcat.vshn.io_xvshnnextclouds.yaml

@@ -279,6 +279,12 @@ func newValues(ctx context.Context, svc *runtime.ServiceRuntime, comp *vshnv1.VS
 			"configs": map[string]string{
 				"vshn-nextcloud.config.php": updatedNextcloudConfig,
 			},
+			"extraEnv": []map[string]any{
+				{
+					"name":  "SKIP_MAINTENANCE",
+					"value": strconv.FormatBool(comp.Spec.Parameters.Backup.SkipMaintenance),
+				},
+			},
 			"extraInitContainers": extraInitContainers,
 			"containerPort":       8080,
 			"podSecurityContext":  securityContext,

pkg/comp-functions/functions/vshnnextcloud/deploy.go

@@ -10,8 +10,11 @@ function disableMaintenance {
   sudo -u www-data /var/www/html/occ maintenance:mode --off 1>&2
 }
 
-trap disableMaintenance EXIT
+if [ "$SKIP_MAINTENANCE" = false ]; then
 
-sudo -u www-data /var/www/html/occ maintenance:mode --on 1>&2
+  trap disableMaintenance EXIT
+
+  sudo -u www-data /var/www/html/occ maintenance:mode --on 1>&2
+fi
 
 tar -cf - /var/www