git squash

Author: guozhi.li

CHANGELOG.md

@@ -6,6 +6,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 ### Added
+ * `MysqlDatabase` `MysqlUser` Add delete policy
 ### Changed
 ### Removed
 ### Fixed

examples/example-database.yaml

@@ -2,6 +2,8 @@ apiVersion: mysql.presslabs.org/v1alpha1
 kind: MysqlDatabase
 metadata:
   name: my-database
+#  annotations:
+#    mysql-operator.presslabs.org/resourceDeletionPolicy: retain # When the MysqlDatabase is deleted, the MySQL DB will be preserved
 spec:
   database: db-name-in-mysql
   clusterRef:

examples/example-user.yaml

@@ -10,6 +10,8 @@ apiVersion: mysql.presslabs.org/v1alpha1
 kind: MysqlUser
 metadata:
   name: my-user
+#  annotations:
+#    mysql-operator.presslabs.org/resourceDeletionPolicy: retain # When the MysqlUser is deleted, the MySQL user will be preserved
 spec:
   user: user-name-in-mysql
   clusterRef:

pkg/apis/mysql/v1alpha1/common_types.go

@@ -0,0 +1,21 @@
+package v1alpha1
+
+import "sigs.k8s.io/controller-runtime/pkg/client"
+
+// MysqlResourceDeletionPolicy delete policy defined
+type MysqlResourceDeletionPolicy string
+
+const (
+	// MysqlResourceDeletionPolicyAnnotationKey delete policy key defined
+	MysqlResourceDeletionPolicyAnnotationKey = "mysql-operator.presslabs.org/resourceDeletionPolicy"
+	// MysqlResourceDeletionPolicyDelete delete policy delete
+	MysqlResourceDeletionPolicyDelete = MysqlResourceDeletionPolicy("delete")
+	// MysqlResourceDeletionPolicyRetain delete policy retain
+	MysqlResourceDeletionPolicyRetain = MysqlResourceDeletionPolicy("retain")
+)
+
+// DeletionPolicyRetain parse obj is need to retain
+func DeletionPolicyRetain(obj client.Object) bool {
+	annotations := obj.GetAnnotations()
+	return annotations != nil && MysqlResourceDeletionPolicy(annotations[MysqlResourceDeletionPolicyAnnotationKey]) == MysqlResourceDeletionPolicyRetain
+}

pkg/controller/mysqldatabase/db_controller.go

@@ -101,7 +101,6 @@ func (r *ReconcileMySQLDatabase) Reconcile(ctx context.Context, request reconcil
 
 		// remove finalizer
 		utilmeta.RemoveFinalizer(&db.ObjectMeta, mysqlPreventDeletionFinalizer)
-
 		// update resource to remove finalizer, no status
 		return reconcile.Result{}, r.Update(ctx, db.Unwrap())
 	}
@@ -124,6 +123,10 @@ func (r *ReconcileMySQLDatabase) Reconcile(ctx context.Context, request reconcil
 }
 
 func (r *ReconcileMySQLDatabase) deleteDatabase(ctx context.Context, db *mysqldatabase.Database) error {
+	// if it's retain,do nothing.
+	if mysqlv1alpha1.DeletionPolicyRetain(db) {
+		return nil
+	}
 	log.Info("deleting MySQL database", "name", db.Name, "database", db.Spec.Database)
 	sql, closeConn, err := r.SQLRunnerFactory(mysql.NewConfigFromClusterKey(r.Client, db.GetClusterKey()))
 	if apierrors.IsNotFound(err) {

pkg/controller/mysqldatabase/db_controller_test.go

@@ -157,7 +157,6 @@ var _ = Describe("MySQL database controller", func() {
 				Expect(c.Get(context.TODO(), dbObjKey(db), db.Unwrap())).To(Succeed())
 				Expect(db.Finalizers).To(ContainElement(mysqlPreventDeletionFinalizer))
 			})
-
 			It("should drop the database when deleted ", func() {
 				fakeQR.AddExpectedCalls(
 					func(query string, args ...interface{}) error {
@@ -203,6 +202,35 @@ var _ = Describe("MySQL database controller", func() {
 					return c.Get(context.TODO(), dbObjKey(db), db.Unwrap())
 				}).ShouldNot(Succeed())
 			})
+			It("should delete resource and database should retain", func() {
+				fakeQR.AddExpectedCalls(
+					func(query string, args ...interface{}) error {
+						defer GinkgoRecover()
+
+						PanicWith("Shouldn't call this!")
+						return nil
+					},
+				)
+
+				if db.ObjectMeta.Annotations == nil {
+					db.ObjectMeta.Annotations = map[string]string{}
+				}
+				db.ObjectMeta.Annotations[mysqlv1alpha1.MysqlResourceDeletionPolicyAnnotationKey] = string(mysqlv1alpha1.MysqlResourceDeletionPolicyRetain)
+
+				// delete the resource
+				Expect(c.Delete(context.TODO(), db.Unwrap())).To(Succeed())
+
+				// expect the reconcile event to delete db and remove finalizer
+				Eventually(requests).Should(Receive(Equal(expectedRequest)))
+
+				// the database should be gone
+				Expect(c.Get(context.TODO(), dbObjKey(db), db.Unwrap())).ShouldNot(Succeed())
+
+				// last event but already deleted
+				Eventually(requests).Should(Receive(Equal(expectedRequest)))
+
+				delete(db.ObjectMeta.Annotations, mysqlv1alpha1.MysqlResourceDeletionPolicyAnnotationKey)
+			})
 		})
 	})
 

pkg/controller/mysqluser/mysqluser_controller.go

@@ -114,11 +114,13 @@ func (r *ReconcileMySQLUser) Reconcile(ctx context.Context, request reconcile.Re
 func (r *ReconcileMySQLUser) removeUser(ctx context.Context, user *mysqluser.MySQLUser) error {
 	// The resource has been deleted
 	if meta.HasFinalizer(&user.ObjectMeta, userFinalizer) {
-		// Drop the user if the finalizer is still present
-		if err := r.dropUserFromDB(ctx, user); err != nil {
-			return err
+		// if it's retain,don't drop user.
+		if !mysqlv1alpha1.DeletionPolicyRetain(user) {
+			// Drop the user if the finalizer is still present
+			if err := r.dropUserFromDB(ctx, user); err != nil {
+				return err
+			}
 		}
-
 		meta.RemoveFinalizer(&user.ObjectMeta, userFinalizer)
 
 		// update resource so it will remove the finalizer

pkg/controller/mysqluser/mysqluser_controller_test.go

@@ -503,7 +503,6 @@ var _ = Describe("MySQL user controller", func() {
 				// We need to make sure that the controller does not create infinite loops
 				Consistently(requests).ShouldNot(Receive(Equal(expectedRequest)))
 			})
-
 			It("removes the user finalizer, and the resource is deleted", func() {
 				fakeSQL.AllowExtraCalls()
 
@@ -520,6 +519,33 @@ var _ = Describe("MySQL user controller", func() {
 				err := c.Get(context.TODO(), userKey, user.Unwrap())
 				Expect(apierrors.IsNotFound(err)).To(BeTrue())
 			})
+			It("removes the user finalizer, and the resource is deleted,database user retain", func() {
+				fakeSQL.AddExpectedCalls(func(query string, args ...interface{}) error {
+					defer GinkgoRecover()
+
+					PanicWith("Shouldn't call this!")
+					return nil
+				})
+
+				if user.ObjectMeta.Annotations == nil {
+					user.ObjectMeta.Annotations = map[string]string{}
+				}
+				user.ObjectMeta.Annotations[mysqlv1alpha1.MysqlResourceDeletionPolicyAnnotationKey] = string(mysqlv1alpha1.MysqlResourceDeletionPolicyRetain)
+
+				Expect(c.Delete(context.TODO(), user.Unwrap())).To(Succeed())
+				// Wait for initial reconciliation
+				Eventually(requests, timeout).Should(Receive(Equal(expectedRequest)))
+
+				// Wait for second reconciliation triggered by finalizer removal
+				Eventually(requests, timeout).Should(Receive(Equal(expectedRequest)))
+
+				// We need to make sure that the controller does not create infinite loops
+				Consistently(requests).ShouldNot(Receive(Equal(expectedRequest)))
+
+				err := c.Get(context.TODO(), userKey, user.Unwrap())
+				Expect(apierrors.IsNotFound(err)).To(BeTrue())
+				delete(user.ObjectMeta.Annotations, mysqlv1alpha1.MysqlResourceDeletionPolicyAnnotationKey)
+			})
 		})
 		Context("and the user cannot be deleted in mysql", func() {
 			deletionResult := errors.New("couldn't delete user")