Cleanup older configmaps with the naming format etcd-bootstrap-UID[:6] (#1014)

* cleanup older configmaps with the naming format etcd-bootstrap-UID[:6]

Author: anveshreddy18

api/core/v1alpha1/helper.go

@@ -29,6 +29,12 @@ func GetServiceAccountName(etcdObjMeta metav1.ObjectMeta) string {
 	return etcdObjMeta.Name
 }
 
+// GetOldConfigMapName returns the name of the old configmap for the Etcd.
+// TODO: @anveshreddy18: Remove this function after 3 releases, i.e in v0.31.0
+func GetOldConfigMapName(etcdObjMeta metav1.ObjectMeta) string {
+	return fmt.Sprintf("etcd-bootstrap-%s", string(etcdObjMeta.UID[:6]))
+}
+
 // GetConfigMapName returns the name of the configmap for the Etcd.
 func GetConfigMapName(etcdObjMeta metav1.ObjectMeta) string {
 	return fmt.Sprintf("%s-config", etcdObjMeta.Name)

internal/component/configmap/configmap.go

@@ -64,7 +64,24 @@ func (r _resource) GetExistingResourceNames(ctx component.OperatorContext, etcdO
 }
 
 // PreSync is a no-op for the configmap component.
-func (r _resource) PreSync(_ component.OperatorContext, _ *druidv1alpha1.Etcd) error {
+// TODO: @anveshreddy18: Remove the functionality in the below PreSync method after 3 releases i.e in v0.31.0
+// This is a temporary functionality to remove the old configmaps from the cluster that are created by the etcd-druid.
+func (r _resource) PreSync(ctx component.OperatorContext, etcd *druidv1alpha1.Etcd) error {
+	oldConfigMap := emptyConfigMap(getOldObjectKey(etcd.ObjectMeta))
+	ctx.Logger.Info("PreSync: Deleting old configmap", "name", oldConfigMap.Name)
+	if err := r.client.Delete(ctx, oldConfigMap); err != nil {
+		if errors.IsNotFound(err) {
+			ctx.Logger.Info("No old configmap found, ConfigMap PreSync is a no-op", "name", oldConfigMap.Name)
+			return nil
+		}
+		return druiderr.WrapError(
+			err,
+			ErrDeleteConfigMap,
+			component.OperationPreSync,
+			fmt.Sprintf("Failed to delete old configmap %s", oldConfigMap.Name),
+		)
+	}
+	ctx.Logger.Info("deleted", "component", "configmap", "name", oldConfigMap.Name)
 	return nil
 }
 
@@ -142,6 +159,13 @@ func getObjectKey(obj metav1.ObjectMeta) client.ObjectKey {
 	}
 }
 
+func getOldObjectKey(obj metav1.ObjectMeta) client.ObjectKey {
+	return client.ObjectKey{
+		Name:      druidv1alpha1.GetOldConfigMapName(obj),
+		Namespace: obj.Namespace,
+	}
+}
+
 func emptyConfigMap(objectKey client.ObjectKey) *corev1.ConfigMap {
 	return &corev1.ConfigMap{
 		ObjectMeta: metav1.ObjectMeta{

internal/component/types.go

@@ -17,6 +17,8 @@ import (
 // However, it can also be used where ever operation context is required to be specified.
 // Each component can in turn define their own fine-grained operation labels as well.
 const (
+	// OperationPreSync is the PreSync operation of the Operator.
+	OperationPreSync = "PreSync"
 	// OperationSync is the Sync operation of the Operator.
 	OperationSync = "Sync"
 	// OperationTriggerDelete is the TriggerDelete operation of the Operator.

internal/controller/etcd/reconcile_spec.go

@@ -169,7 +169,9 @@ func (r *Reconciler) recordEtcdSpecReconcileSuspension(etcd *druidv1alpha1.Etcd,
 }
 
 func (r *Reconciler) getOrderedOperatorsForPreSync() []component.Kind {
-	return []component.Kind{}
+	return []component.Kind{
+		component.ConfigMapKind,
+	}
 }
 
 func (r *Reconciler) getOrderedOperatorsForSync() []component.Kind {