Skip to content

CloudStorage: Only delete and remove finalizer if there exists an annotation. #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 9, 2022
Merged

CloudStorage: Only delete and remove finalizer if there exists an annotation. #574

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6959bf
remove finalizers when delete is successful
kaovilai Feb 17, 2022
01335c7
Delete bucket if annotation exist, add finalizer only if not deleting…
kaovilai Feb 21, 2022
6105831
implemented removeKey outside Reconcile func
kaovilai Feb 21, 2022
369297f
uses strconv.ParseBool
kaovilai Mar 8, 2022
b402ffa
Event name update addressing https://github.com/openshift/oadp-operat…
kaovilai Mar 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 49 additions & 20 deletions controllers/bucket_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package controllers
import (
"context"
"fmt"
"strconv"
"time"

"github.com/go-logr/logr"
Expand All @@ -20,7 +21,8 @@ import (
)

const (
oadpFinalizerBucket = "oadp.openshift.io/bucket-protection"
oadpFinalizerBucket = "oadp.openshift.io/bucket-protection"
oadpCloudStorageDeleteAnnotation = "oadp.openshift.io/cloudstorage-delete"
)

// VeleroReconciler reconciles a Velero object
Expand Down Expand Up @@ -60,8 +62,8 @@ func (b BucketReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl
return result, nil
}

// Add finalizer if none exists.
if !containFinalizer(bucket.Finalizers, oadpFinalizerBucket) {
// Add finalizer if none exists and object is not being deleted.
if bucket.DeletionTimestamp == nil && !containFinalizer(bucket.Finalizers, oadpFinalizerBucket) {
bucket.Finalizers = append(bucket.Finalizers, oadpFinalizerBucket)
err := b.Client.Update(ctx, &bucket, &client.UpdateOptions{})
if err != nil {
Expand All @@ -75,10 +77,42 @@ func (b BucketReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl
if err != nil {
return result, err
}

annotation, annotationExists := bucket.Annotations[oadpCloudStorageDeleteAnnotation]
shouldDelete := false
if annotationExists {
shouldDelete, err = strconv.ParseBool(annotation)
if err != nil {
// delete annotation should have values of "1", "t", "T", "true", "TRUE", "True" or "0", "f", "F", "false", "FALSE", "False"
b.EventRecorder.Event(&bucket, corev1.EventTypeWarning, "UnableToParseAnnotation", fmt.Sprintf("unable to parse annotation: %v, use \"1\", \"t\", \"T\", \"true\", \"TRUE\", \"True\" or \"0\", \"f\", \"F\", \"false\", \"FALSE\", \"False\"", err))
return ctrl.Result{Requeue: true}, nil
}
if shouldDelete && bucket.DeletionTimestamp != nil {
deleted, err := clnt.Delete()
if err != nil {
log.Error(err, "unable to delete bucket")
b.EventRecorder.Event(&bucket, corev1.EventTypeWarning, "unable to delete bucket", fmt.Sprintf("unable to delete bucket: %v", bucket.Spec.Name))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the event needs to look different

return ctrl.Result{RequeueAfter: 30 * time.Second}, nil
}
if !deleted {
log.Info("unable to delete bucket for unknown reason")
b.EventRecorder.Event(&bucket, corev1.EventTypeWarning, "unable to delete bucket", fmt.Sprintf("unable to delete bucket: %v", bucket.Spec.Name))
return ctrl.Result{RequeueAfter: 30 * time.Second}, nil
}
log.Info("bucket deleted")
b.EventRecorder.Event(&bucket, corev1.EventTypeNormal, "BucketDeleted", fmt.Sprintf("bucket %v deleted", bucket.Spec.Name))

//Removing oadpFinalizerBucket from bucket.Finalizers
bucket.Finalizers = removeKey(bucket.Finalizers, oadpFinalizerBucket)
err = b.Client.Update(ctx, &bucket, &client.UpdateOptions{})
if err != nil {
b.EventRecorder.Event(&bucket, corev1.EventTypeWarning, "UnableToRemoveFinalizer", fmt.Sprintf("unable to remove finalizer: %v", err))
}
return ctrl.Result{Requeue: true}, nil
}
}
var ok bool
if ok, err = clnt.Exists(); !ok {
// Handle Deletion.
if ok, err = clnt.Exists(); !ok && err == nil {
// Handle Creation if not exist.
created, err := clnt.Create()
if !created {
log.Info("unable to create object bucket")
Expand All @@ -98,20 +132,6 @@ func (b BucketReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl
b.EventRecorder.Event(&bucket, corev1.EventTypeWarning, "BucketNotFound", fmt.Sprintf("unable to find bucket: %v", err))
return ctrl.Result{RequeueAfter: 1 * time.Minute}, nil
}
if bucket.DeletionTimestamp != nil {
deleted, err := clnt.Delete()
if err != nil {
log.Error(err, "unable to delete bucket")
b.EventRecorder.Event(&bucket, corev1.EventTypeWarning, "unable to delete bucket", fmt.Sprintf("unable to delete bucket: %v", bucket.Spec.Name))
return ctrl.Result{RequeueAfter: 30 * time.Second}, nil
}
if !deleted {
log.Info("unable to delete bucket for unknown reason")
b.EventRecorder.Event(&bucket, corev1.EventTypeWarning, "unable to delete bucket", fmt.Sprintf("unable to delete bucket: %v", bucket.Spec.Name))
return ctrl.Result{RequeueAfter: 30 * time.Second}, nil
}
return ctrl.Result{Requeue: true}, nil
}

// Update status with updated value
bucket.Status.LastSynced = &v1.Time{Time: time.Now()}
Expand Down Expand Up @@ -159,3 +179,12 @@ func containFinalizer(finalizers []string, f string) bool {
}
return false
}

func removeKey(slice []string, s string) []string {
for i, v := range slice {
if v == s {
return append(slice[:i], slice[i+1:]...)
}
}
return slice
}
7 changes: 3 additions & 4 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ module github.com/openshift/oadp-operator
go 1.16

require (
github.com/Azure-Samples/azure-sdk-for-go-samples v0.0.0-20210506191746-b49c4162aa1d
github.com/Azure/azure-sdk-for-go/sdk/azcore v0.20.0 // indirect
github.com/Azure/azure-sdk-for-go/sdk/storage/azblob v0.2.0
github.com/Azure/azure-storage-blob-go v0.0.0-20181023070848-cf01652132cc
github.com/aws/aws-sdk-go v1.28.2
github.com/go-logr/logr v0.4.0
github.com/google/uuid v1.1.2
Expand All @@ -18,6 +14,9 @@ require (
github.com/operator-framework/operator-lib v0.9.0
github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.51.2
github.com/vmware-tanzu/velero v1.7.0 // TODO: Update this to a pinned version
golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d // indirect
golang.org/x/text v0.3.7 // indirect
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
k8s.io/api v0.22.2
k8s.io/apiextensions-apiserver v0.22.2
k8s.io/apimachinery v0.22.2
Expand Down
Loading