Skip to content

Commit 660e184

Browse files
committed
add velero restore implementation
Signed-off-by: Andrey Kolkov <[email protected]>
1 parent 08e154d commit 660e184

4 files changed

Lines changed: 210 additions & 71 deletions

File tree

‎api/backups/strategy/v1alpha1/velero_types.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ type VeleroSpec struct {
5555
// VeleroTemplate describes the data a backup.velero.io should have when
5656
// templated from a Velero backup strategy.
5757
type VeleroTemplate struct {
58-
Spec velerov1.BackupSpec `json:"spec"`
58+
Spec velerov1.BackupSpec `json:"spec"`
59+
RestoreSpec velerov1.RestoreSpec `json:"restoreSpec"`
5960
}
6061

6162
type VeleroStatus struct {

‎internal/backupcontroller/backupjob_controller.go‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import (
66

77
apierrors "k8s.io/apimachinery/pkg/api/errors"
88
"k8s.io/apimachinery/pkg/api/meta"
9+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
910
"k8s.io/apimachinery/pkg/runtime"
1011
"k8s.io/apimachinery/pkg/types"
1112
"k8s.io/client-go/dynamic"
@@ -91,3 +92,27 @@ func (r *BackupJobReconciler) SetupWithManager(mgr ctrl.Manager) error {
9192
For(&backupsv1alpha1.BackupJob{}).
9293
Complete(r)
9394
}
95+
96+
func (r *BackupJobReconciler) markBackupJobFailed(ctx context.Context, backupJob *backupsv1alpha1.BackupJob, message string) (ctrl.Result, error) {
97+
logger := getLogger(ctx)
98+
now := metav1.Now()
99+
backupJob.Status.CompletedAt = &now
100+
backupJob.Status.Phase = backupsv1alpha1.BackupJobPhaseFailed
101+
backupJob.Status.Message = message
102+
103+
// Add condition
104+
backupJob.Status.Conditions = append(backupJob.Status.Conditions, metav1.Condition{
105+
Type: "Ready",
106+
Status: metav1.ConditionFalse,
107+
Reason: "BackupFailed",
108+
Message: message,
109+
LastTransitionTime: now,
110+
})
111+
112+
if err := r.Status().Update(ctx, backupJob); err != nil {
113+
logger.Error(err, "failed to update BackupJob status to Failed")
114+
return ctrl.Result{}, err
115+
}
116+
logger.Debug("BackupJob failed", "message", message)
117+
return ctrl.Result{}, nil
118+
}

‎internal/backupcontroller/restorejob_controller.go‎

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ import (
44
"context"
55
"fmt"
66
"net/http"
7-
"time"
87

8+
corev1 "k8s.io/api/core/v1"
99
apierrors "k8s.io/apimachinery/pkg/api/errors"
1010
"k8s.io/apimachinery/pkg/api/meta"
11+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1112
"k8s.io/apimachinery/pkg/runtime"
1213
"k8s.io/apimachinery/pkg/types"
1314
"k8s.io/client-go/dynamic"
@@ -22,10 +23,6 @@ import (
2223
backupsv1alpha1 "github.com/cozystack/cozystack/api/backups/v1alpha1"
2324
)
2425

25-
const (
26-
defaultRestoreRequeueAfter = 5 * time.Second
27-
)
28-
2926
// RestoreJobReconciler reconciles RestoreJob objects.
3027
// It routes RestoreJobs to strategy-specific handlers based on the strategy
3128
// referenced in the Backup that the RestoreJob is restoring from.
@@ -118,3 +115,38 @@ func (r *RestoreJobReconciler) SetupWithManager(mgr ctrl.Manager) error {
118115
For(&backupsv1alpha1.RestoreJob{}).
119116
Complete(r)
120117
}
118+
119+
// getTargetApplicationRef determines the effective target application reference.
120+
// According to DESIGN.md, if spec.targetApplicationRef is omitted, drivers SHOULD
121+
// restore into backup.spec.applicationRef.
122+
func (r *RestoreJobReconciler) getTargetApplicationRef(restoreJob *backupsv1alpha1.RestoreJob, backup *backupsv1alpha1.Backup) corev1.TypedLocalObjectReference {
123+
if restoreJob.Spec.TargetApplicationRef != nil {
124+
return *restoreJob.Spec.TargetApplicationRef
125+
}
126+
return backup.Spec.ApplicationRef
127+
}
128+
129+
// markRestoreJobFailed updates the RestoreJob status to Failed with the given message.
130+
func (r *RestoreJobReconciler) markRestoreJobFailed(ctx context.Context, restoreJob *backupsv1alpha1.RestoreJob, message string) (ctrl.Result, error) {
131+
logger := getLogger(ctx)
132+
now := metav1.Now()
133+
restoreJob.Status.CompletedAt = &now
134+
restoreJob.Status.Phase = backupsv1alpha1.RestoreJobPhaseFailed
135+
restoreJob.Status.Message = message
136+
137+
// Add condition
138+
restoreJob.Status.Conditions = append(restoreJob.Status.Conditions, metav1.Condition{
139+
Type: "Ready",
140+
Status: metav1.ConditionFalse,
141+
Reason: "RestoreFailed",
142+
Message: message,
143+
LastTransitionTime: now,
144+
})
145+
146+
if err := r.Status().Update(ctx, restoreJob); err != nil {
147+
logger.Error(err, "failed to update RestoreJob status to Failed")
148+
return ctrl.Result{}, err
149+
}
150+
logger.Debug("RestoreJob failed", "message", message)
151+
return ctrl.Result{}, nil
152+
}

‎internal/backupcontroller/velerostrategy_controller.go‎

Lines changed: 146 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,14 @@ type bucketInfo struct {
6363
}
6464

6565
const (
66-
defaultRequeueAfter = 5 * time.Second
67-
defaultActiveJobPollingInterval = defaultRequeueAfter
66+
defaultRequeueAfter = 5 * time.Second
67+
defaultActiveJobPollingInterval = defaultRequeueAfter
68+
defaultRestoreRequeueAfter = 5 * time.Second
69+
defaultActiveRestorePollingInterval = defaultRestoreRequeueAfter
6870
// Velero requires API objects and secrets to be in the cozy-velero namespace
69-
veleroNamespace = "cozy-velero"
70-
virtualMachinePrefix = "virtual-machine-"
71+
veleroNamespace = "cozy-velero"
72+
veleroBackupNameMetadataKey = "velero.io/backup-name"
73+
veleroBackupNamespaceMetadataKey = "velero.io/backup-namespace"
7174
)
7275

7376
func storageS3SecretName(namespace, backupJobName string) string {
@@ -120,7 +123,6 @@ func (r *BackupJobReconciler) reconcileVelero(ctx context.Context, j *backupsv1a
120123

121124
// Step 3: Execute backup logic
122125
// Check if we already created a Velero Backup
123-
// Use human-readable timestamp: YYYY-MM-DD-HH-MM-SS
124126
if j.Status.StartedAt == nil {
125127
logger.Error(nil, "StartedAt is nil after status update, this should not happen")
126128
return ctrl.Result{RequeueAfter: defaultRequeueAfter}, nil
@@ -488,30 +490,6 @@ func (r *BackupJobReconciler) createVolumeSnapshotLocation(ctx context.Context,
488490
return nil
489491
}
490492

491-
func (r *BackupJobReconciler) markBackupJobFailed(ctx context.Context, backupJob *backupsv1alpha1.BackupJob, message string) (ctrl.Result, error) {
492-
logger := getLogger(ctx)
493-
now := metav1.Now()
494-
backupJob.Status.CompletedAt = &now
495-
backupJob.Status.Phase = backupsv1alpha1.BackupJobPhaseFailed
496-
backupJob.Status.Message = message
497-
498-
// Add condition
499-
backupJob.Status.Conditions = append(backupJob.Status.Conditions, metav1.Condition{
500-
Type: "Ready",
501-
Status: metav1.ConditionFalse,
502-
Reason: "BackupFailed",
503-
Message: message,
504-
LastTransitionTime: now,
505-
})
506-
507-
if err := r.Status().Update(ctx, backupJob); err != nil {
508-
logger.Error(err, "failed to update BackupJob status to Failed")
509-
return ctrl.Result{}, err
510-
}
511-
logger.Debug("BackupJob failed", "message", message)
512-
return ctrl.Result{}, nil
513-
}
514-
515493
func (r *BackupJobReconciler) createVeleroBackup(ctx context.Context, backupJob *backupsv1alpha1.BackupJob, strategy *strategyv1alpha1.Velero) error {
516494
logger := getLogger(ctx)
517495
logger.Debug("createVeleroBackup called", "strategy", strategy.Name)
@@ -579,8 +557,8 @@ func (r *BackupJobReconciler) createBackupResource(ctx context.Context, backupJo
579557

580558
// Extract driver metadata (e.g., Velero backup name)
581559
driverMetadata := map[string]string{
582-
"velero.io/backup-name": veleroBackup.Name,
583-
"velero.io/backup-namespace": veleroBackup.Namespace,
560+
veleroBackupNameMetadataKey: veleroBackup.Name,
561+
veleroBackupNamespaceMetadataKey: veleroBackup.Namespace,
584562
}
585563

586564
backup := &backupsv1alpha1.Backup{
@@ -644,47 +622,150 @@ func (r *RestoreJobReconciler) reconcileVeleroRestore(ctx context.Context, resto
644622
return ctrl.Result{RequeueAfter: defaultRestoreRequeueAfter}, nil
645623
}
646624

647-
// TODO: Implement Velero strategy restore logic
648625
// Step 2: Resolve inputs - Read Strategy, Storage, target Application
649-
// Step 3: Execute restore logic (create Velero Restore)
650-
// Step 4: On success - set completedAt, phase = Succeeded
651-
// Step 5: On failure - set completedAt, phase = Failed, message and conditions
626+
logger.Debug("fetching Velero strategy", "strategyName", backup.Spec.StrategyRef.Name)
627+
veleroStrategy := &strategyv1alpha1.Velero{}
628+
if err := r.Get(ctx, client.ObjectKey{Name: backup.Spec.StrategyRef.Name}, veleroStrategy); err != nil {
629+
if errors.IsNotFound(err) {
630+
logger.Error(err, "Velero strategy not found", "strategyName", backup.Spec.StrategyRef.Name)
631+
return r.markRestoreJobFailed(ctx, restoreJob, fmt.Sprintf("Velero strategy not found: %s", backup.Spec.StrategyRef.Name))
632+
}
633+
logger.Error(err, "failed to get Velero strategy")
634+
return ctrl.Result{}, err
635+
}
636+
logger.Debug("fetched Velero strategy", "strategyName", veleroStrategy.Name)
652637

653-
logger.Debug("Velero strategy restore not yet implemented", "restorejob", restoreJob.Name)
654-
return ctrl.Result{}, nil
655-
}
638+
// Get Velero backup name from Backup's driverMetadata
639+
veleroBackupName, ok := backup.Spec.DriverMetadata[veleroBackupNameMetadataKey]
640+
if !ok {
641+
return r.markRestoreJobFailed(ctx, restoreJob, fmt.Sprintf("Backup missing Velero backup name in driverMetadata (key: %s)", veleroBackupNameMetadataKey))
642+
}
643+
644+
// Step 3: Execute restore logic
645+
// Check if we already created a Velero Restore
646+
logger.Debug("checking for existing Velero Restore", "namespace", veleroNamespace)
647+
veleroRestoreList := &velerov1.RestoreList{}
648+
opts := []client.ListOption{
649+
client.InNamespace(veleroNamespace),
650+
client.MatchingLabels{
651+
backupsv1alpha1.OwningJobNameLabel: restoreJob.Name,
652+
backupsv1alpha1.OwningJobNamespaceLabel: restoreJob.Namespace,
653+
},
654+
}
655+
656+
if err := r.List(ctx, veleroRestoreList, opts...); err != nil {
657+
logger.Error(err, "failed to get Velero Restore")
658+
return ctrl.Result{}, err
659+
}
660+
661+
if len(veleroRestoreList.Items) == 0 {
662+
// Create Velero Restore
663+
logger.Debug("Velero Restore not found, creating new one")
664+
if err := r.createVeleroRestore(ctx, restoreJob, backup, veleroStrategy, veleroBackupName); err != nil {
665+
logger.Error(err, "failed to create Velero Restore")
666+
return r.markRestoreJobFailed(ctx, restoreJob, fmt.Sprintf("failed to create Velero Restore: %v", err))
667+
}
668+
logger.Debug("created Velero Restore, requeuing")
669+
// Requeue to check status
670+
return ctrl.Result{RequeueAfter: defaultRestoreRequeueAfter}, nil
671+
}
672+
673+
if len(veleroRestoreList.Items) > 1 {
674+
logger.Error(fmt.Errorf("too many Velero restores for RestoreJob"), "found more than one Velero Restore referencing a single RestoreJob as owner")
675+
return r.markRestoreJobFailed(ctx, restoreJob, "found multiple Velero Restores for this RestoreJob")
676+
}
677+
678+
veleroRestore := veleroRestoreList.Items[0].DeepCopy()
679+
logger.Debug("found existing Velero Restore", "phase", veleroRestore.Status.Phase)
680+
681+
// Check Velero Restore status
682+
phase := string(veleroRestore.Status.Phase)
683+
if phase == "" {
684+
// Still in progress, requeue
685+
return ctrl.Result{RequeueAfter: defaultActiveRestorePollingInterval}, nil
686+
}
687+
688+
// Step 4: On success
689+
if phase == "Completed" {
690+
now := metav1.Now()
691+
restoreJob.Status.CompletedAt = &now
692+
restoreJob.Status.Phase = backupsv1alpha1.RestoreJobPhaseSucceeded
693+
if err := r.Status().Update(ctx, restoreJob); err != nil {
694+
logger.Error(err, "failed to update RestoreJob status")
695+
return ctrl.Result{}, err
696+
}
697+
logger.Debug("RestoreJob succeeded")
698+
return ctrl.Result{}, nil
699+
}
656700

657-
// getTargetApplicationRef determines the effective target application reference.
658-
// According to DESIGN.md, if spec.targetApplicationRef is omitted, drivers SHOULD
659-
// restore into backup.spec.applicationRef.
660-
func (r *RestoreJobReconciler) getTargetApplicationRef(restoreJob *backupsv1alpha1.RestoreJob, backup *backupsv1alpha1.Backup) corev1.TypedLocalObjectReference {
661-
if restoreJob.Spec.TargetApplicationRef != nil {
662-
return *restoreJob.Spec.TargetApplicationRef
701+
// Step 5: On failure
702+
if phase == "Failed" || phase == "PartiallyFailed" {
703+
message := fmt.Sprintf("Velero Restore failed with phase: %s", phase)
704+
if veleroRestore.Status.FailureReason != "" {
705+
message = fmt.Sprintf("%s: %s", message, veleroRestore.Status.FailureReason)
706+
}
707+
return r.markRestoreJobFailed(ctx, restoreJob, message)
663708
}
664-
return backup.Spec.ApplicationRef
709+
710+
// Still in progress (InProgress, New, etc.)
711+
return ctrl.Result{RequeueAfter: defaultRestoreRequeueAfter}, nil
665712
}
666713

667-
// markRestoreJobFailed updates the RestoreJob status to Failed with the given message.
668-
func (r *RestoreJobReconciler) markRestoreJobFailed(ctx context.Context, restoreJob *backupsv1alpha1.RestoreJob, message string) (ctrl.Result, error) {
714+
// createVeleroRestore creates a Velero Restore resource.
715+
func (r *RestoreJobReconciler) createVeleroRestore(ctx context.Context, restoreJob *backupsv1alpha1.RestoreJob, backup *backupsv1alpha1.Backup, strategy *strategyv1alpha1.Velero, veleroBackupName string) error {
669716
logger := getLogger(ctx)
670-
now := metav1.Now()
671-
restoreJob.Status.CompletedAt = &now
672-
restoreJob.Status.Phase = backupsv1alpha1.RestoreJobPhaseFailed
673-
restoreJob.Status.Message = message
674-
675-
// Add condition
676-
restoreJob.Status.Conditions = append(restoreJob.Status.Conditions, metav1.Condition{
677-
Type: "Ready",
678-
Status: metav1.ConditionFalse,
679-
Reason: "RestoreFailed",
680-
Message: message,
681-
LastTransitionTime: now,
682-
})
717+
logger.Debug("createVeleroRestore called", "strategy", strategy.Name, "veleroBackupName", veleroBackupName)
683718

684-
if err := r.Status().Update(ctx, restoreJob); err != nil {
685-
logger.Error(err, "failed to update RestoreJob status to Failed")
686-
return ctrl.Result{}, err
719+
// Determine target application reference
720+
targetAppRef := r.getTargetApplicationRef(restoreJob, backup)
721+
722+
// Get the target application object for templating
723+
mapping, err := r.RESTMapping(schema.GroupKind{Group: *targetAppRef.APIGroup, Kind: targetAppRef.Kind})
724+
if err != nil {
725+
return fmt.Errorf("failed to get REST mapping for target application: %w", err)
726+
}
727+
ns := restoreJob.Namespace
728+
if mapping.Scope.Name() != meta.RESTScopeNameNamespace {
729+
ns = ""
730+
}
731+
app, err := r.Resource(mapping.Resource).Namespace(ns).Get(ctx, targetAppRef.Name, metav1.GetOptions{})
732+
if err != nil {
733+
return fmt.Errorf("failed to get target application: %w", err)
734+
}
735+
736+
// Template the restore spec from the strategy
737+
veleroRestoreSpec, err := template.Template(&strategy.Spec.Template.RestoreSpec, app.Object)
738+
if err != nil {
739+
return fmt.Errorf("failed to template Velero Restore spec: %w", err)
687740
}
688-
logger.Debug("RestoreJob failed", "message", message)
689-
return ctrl.Result{}, nil
741+
742+
// Set the backupName in the spec (required by Velero)
743+
veleroRestoreSpec.BackupName = veleroBackupName
744+
745+
veleroRestore := &velerov1.Restore{
746+
ObjectMeta: metav1.ObjectMeta{
747+
GenerateName: fmt.Sprintf("%s.%s-", restoreJob.Namespace, restoreJob.Name),
748+
Namespace: veleroNamespace,
749+
Labels: map[string]string{
750+
backupsv1alpha1.OwningJobNameLabel: restoreJob.Name,
751+
backupsv1alpha1.OwningJobNamespaceLabel: restoreJob.Namespace,
752+
},
753+
},
754+
Spec: *veleroRestoreSpec,
755+
}
756+
name := veleroRestore.GenerateName
757+
if err := r.Create(ctx, veleroRestore); err != nil {
758+
if veleroRestore.Name != "" {
759+
name = veleroRestore.Name
760+
}
761+
logger.Error(err, "failed to create Velero Restore", "name", veleroRestore.Name)
762+
r.Recorder.Event(restoreJob, corev1.EventTypeWarning, "VeleroRestoreCreationFailed",
763+
fmt.Sprintf("Failed to create Velero Restore %s/%s: %v", veleroNamespace, name, err))
764+
return err
765+
}
766+
767+
logger.Debug("created Velero Restore", "name", veleroRestore.Name, "namespace", veleroRestore.Namespace)
768+
r.Recorder.Event(restoreJob, corev1.EventTypeNormal, "VeleroRestoreCreated",
769+
fmt.Sprintf("Created Velero Restore %s/%s", veleroNamespace, name))
770+
return nil
690771
}

0 commit comments

Comments
 (0)