Add Forgejo backup (#310)

* Add backup functionality

Author: ThisIsntTheWay

apis/vshn/v1/dbaas_vshn_forgejo.go

@@ -187,11 +187,11 @@ func (v *VSHNForgejo) GetMaintenanceDayOfWeek() string {
 }
 
 // GetMaintenanceTimeOfDay returns the currently set time of day
-func (v *VSHNForgejo) GetMaintenanceTimeOfDay() TimeOfDay {
+func (v *VSHNForgejo) GetMaintenanceTimeOfDay() *TimeOfDay {
 	if v.Spec.Parameters.Maintenance.TimeOfDay != "" {
-		return v.Spec.Parameters.Maintenance.TimeOfDay
+		return &v.Spec.Parameters.Maintenance.TimeOfDay
 	}
-	return v.Status.Schedules.Maintenance.TimeOfDay
+	return &v.Status.Schedules.Maintenance.TimeOfDay
 }
 
 // SetMaintenanceDayOfWeek sets the day of week to the given value
@@ -208,7 +208,7 @@ func (v *VSHNForgejo) SetMaintenanceTimeOfDay(tod TimeOfDay) {
 func (v *VSHNForgejo) GetFullMaintenanceSchedule() VSHNDBaaSMaintenanceScheduleSpec {
 	schedule := v.Spec.Parameters.Maintenance
 	schedule.DayOfWeek = v.GetMaintenanceDayOfWeek()
-	schedule.TimeOfDay = v.GetMaintenanceTimeOfDay()
+	schedule.TimeOfDay = *v.GetMaintenanceTimeOfDay()
 	return schedule
 }
 

pkg/comp-functions/functions/common/backup/backup.go

@@ -52,6 +52,9 @@ func AddK8upBackup(ctx context.Context, svc *runtime.ServiceRuntime, comp common
 }
 
 func createObjectBucket(ctx context.Context, comp common.InfoGetter, svc *runtime.ServiceRuntime) error {
+	if comp.GetName() == "" {
+		return fmt.Errorf("could not get composite name")
+	}
 
 	ob := &appcatv1.XObjectBucket{
 		ObjectMeta: metav1.ObjectMeta{

pkg/comp-functions/functions/common/schedule.go

@@ -2,9 +2,10 @@ package common
 
 import (
 	"fmt"
-	v1 "github.com/vshn/appcat/v4/apis/vshn/v1"
 	"math/rand"
 	"time"
+
+	v1 "github.com/vshn/appcat/v4/apis/vshn/v1"
 )
 
 var (

pkg/comp-functions/functions/vshnforgejo/backup.go

@@ -0,0 +1,80 @@
+package vshnforgejo
+
+import (
+	"context"
+	_ "embed"
+	"encoding/json"
+	"fmt"
+
+	xfnproto "github.com/crossplane/function-sdk-go/proto/v1beta1"
+	xhelmv1 "github.com/vshn/appcat/v4/apis/helm/release/v1beta1"
+	vshnv1 "github.com/vshn/appcat/v4/apis/vshn/v1"
+	"github.com/vshn/appcat/v4/pkg/comp-functions/functions/common"
+	"github.com/vshn/appcat/v4/pkg/comp-functions/functions/common/backup"
+	"github.com/vshn/appcat/v4/pkg/comp-functions/runtime"
+)
+
+//go:embed script/backup.sh
+var forgejoBackupScript string
+
+func AddBackup(ctx context.Context, comp *vshnv1.VSHNForgejo, svc *runtime.ServiceRuntime) *xfnproto.Result {
+	err := svc.GetObservedComposite(comp)
+	if err != nil {
+		return runtime.NewFatalResult(fmt.Errorf("can't get composite: %w", err))
+	}
+
+	common.SetRandomSchedules(comp, comp)
+	err = backup.AddK8upBackup(ctx, svc, comp)
+	if err != nil {
+		return runtime.NewWarningResult(fmt.Sprintf("cannot add k8s backup to the desired state: %v", err))
+	}
+
+	err = backup.AddBackupScriptCM(svc, comp, forgejoBackupScript)
+	if err != nil {
+		return runtime.NewFatalResult(err)
+	}
+
+	err = updateRelease(svc, comp)
+	if err != nil {
+		return runtime.NewWarningResult(fmt.Sprintf("cannot update release with backup configuration: %s", err))
+	}
+
+	return nil
+}
+
+func updateRelease(svc *runtime.ServiceRuntime, comp *vshnv1.VSHNForgejo) error {
+	release := &xhelmv1.Release{}
+
+	err := svc.GetDesiredComposedResourceByName(release, comp.GetName())
+	if err != nil {
+		return err
+	}
+
+	values, err := common.GetReleaseValues(release)
+	if err != nil {
+		return err
+	}
+
+	err = backup.AddPVCAnnotationToValues(values, "persistence", "annotations")
+	if err != nil {
+		return fmt.Errorf("cannot add pvc annotations to values: %w", err)
+	}
+
+	err = backup.AddPodAnnotationToValues(values, "/scripts/backup.sh", ".tar", "gitea", "podAnnotations")
+	if err != nil {
+		return fmt.Errorf("cannot add pod annotations to values: %w", err)
+	}
+
+	err = backup.AddBackupCMToValues(values, []string{"extraVolumes"}, []string{"extraContainerVolumeMounts"})
+	if err != nil {
+		return fmt.Errorf("cannot add backup cm to values: %w", err)
+	}
+
+	byteValues, err := json.Marshal(values)
+	if err != nil {
+		return err
+	}
+	release.Spec.ForProvider.Values.Raw = byteValues
+
+	return svc.SetDesiredComposedResourceWithName(release, comp.GetName())
+}

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

@@ -156,9 +156,17 @@ func addForgejo(ctx context.Context, svc *runtime.ServiceRuntime, comp *vshnv1.V
 				},
 			},
 		},
-		"persistance": map[string]any{
+		"persistence": map[string]any{
 			"enabled": true,
 		},
+		"extraVolumes": []map[string]any{{
+			"name":     "backup-scratch",
+			"emptyDir": map[string]any{},
+		}},
+		"extraContainerVolumeMounts": []map[string]string{{
+			"name":      "backup-scratch",
+			"mountPath": "/tmp/backup",
+		}},
 		"postgresql": map[string]any{
 			"enabled": false,
 		},

pkg/comp-functions/functions/vshnforgejo/register.go

@@ -13,6 +13,10 @@ func init() {
 				Name:    "deploy",
 				Execute: DeployForgejo,
 			},
+			{
+				Name:    "backup",
+				Execute: AddBackup,
+			},
 		},
 	})
 }

pkg/comp-functions/functions/vshnforgejo/script/backup.sh

@@ -0,0 +1,3 @@
+#!/bin/bash -xef
+
+/usr/local/bin/forgejo dump --type tar -t /tmp/backup -V -f -