Share cleanup job

api/v1beta1/manila_types.go

@@ -25,7 +25,8 @@ import (
 const (
 	// DbSyncHash hash
 	DbSyncHash = "dbsync"
-
+	// SvcCleanupHash hash
+	SvcCleanupHash = "servicecleanup"
 	// DeploymentHash hash used to detect changes
 	DeploymentHash = "deployment"
 )

controllers/manila_controller.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/utils/ptr"
 
 	"github.com/go-logr/logr"
 	memcachedv1 "github.com/openstack-k8s-operators/infra-operator/apis/memcached/v1beta1"
@@ -366,7 +367,15 @@ func (r *ManilaReconciler) reconcileInit(
 	// run manila db sync
 	//
 	dbSyncHash := instance.Status.Hash[manilav1beta1.DbSyncHash]
-	jobDef := manila.DbSyncJob(instance, serviceLabels, serviceAnnotations)
+	jobDef := manila.Job(
+		instance,
+		serviceLabels,
+		serviceAnnotations,
+		nil,
+		manila.DBSyncJobName,
+		manila.DBSyncCommand,
+		0, // no need to delay dbSync
+	)
 	dbSyncjob := job.NewJob(
 		jobDef,
 		manilav1beta1.DbSyncHash,
@@ -778,11 +787,36 @@ func (r *ManilaReconciler) reconcileNormal(ctx context.Context, instance *manila
 	instance.Status.Conditions.MarkTrue(condition.CronJobReadyCondition, condition.CronJobReadyMessage)
 	// create CronJob - end
 
-	err = r.shareCleanup(ctx, instance)
+	cleanJob, hash, err := r.shareCleanup(ctx, instance)
 	if err != nil {
 		return ctrl.Result{}, err
 	}
 
+	if cleanJob {
+		jobDef := manila.Job(
+			instance,
+			serviceLabels,
+			serviceAnnotations,
+			ptr.To(manila.TTL),
+			fmt.Sprintf("%s-%s", manila.SvcCleanupJobName, hash[:manila.TruncateHash]),
+			manila.SvcCleanupCommand,
+			manila.ManilaServiceCleanupDelay,
+		)
+		shareCleanupJob := job.NewJob(
+			jobDef,
+			manilav1beta1.SvcCleanupHash,
+			false,
+			manila.ShortDuration,
+			"",
+		)
+		ctrlResult, err := shareCleanupJob.DoJob(
+			ctx,
+			helper,
+		)
+		if err != nil {
+			return ctrlResult, err
+		}
+	}
 	r.Log.Info(fmt.Sprintf("Reconciled Service '%s' successfully", instance.Name))
 	// update the overall status condition if service is ready
 	if instance.IsReady() {
@@ -1216,32 +1250,40 @@ func (r *ManilaReconciler) checkManilaShareGeneration(
 func (r *ManilaReconciler) shareCleanup(
 	ctx context.Context,
 	instance *manilav1beta1.Manila,
-) error {
+) (bool, string, error) {
+	cleanJob := false
+	var deletedShares = []string{}
 	// Generate a list of share CRs
 	shares := &manilav1beta1.ManilaShareList{}
+
 	listOpts := []client.ListOption{
 		client.InNamespace(instance.Namespace),
 	}
 	if err := r.Client.List(ctx, shares, listOpts...); err != nil {
 		r.Log.Error(err, "Unable to retrieve Manila Share CRs %v")
-		return nil
+		return cleanJob, "", nil
 	}
 	for _, share := range shares.Items {
 		// Skip shares CRs that we don't own
 		if manila.GetOwningManilaName(&share) != instance.Name {
 			continue
 		}
-
 		// Delete the manilaShare if it's no longer in the spec
 		_, exists := instance.Spec.ManilaShares[share.ShareName()]
 		if !exists && share.DeletionTimestamp.IsZero() {
 			err := r.Client.Delete(ctx, &share)
 			if err != nil && !k8s_errors.IsNotFound(err) {
 				err = fmt.Errorf("Error cleaning up %s: %w", share.Name, err)
-				return err
+				return cleanJob, "", err
 			}
 			delete(instance.Status.ManilaSharesReadyCounts, share.ShareName())
+			deletedShares = append(deletedShares, share.ShareName())
+			cleanJob = true
 		}
 	}
-	return nil
+	hash, err := manila.SharesListHash(deletedShares)
+	if err != nil {
+		return false, hash, err
+	}
+	return cleanJob, hash, nil
 }

pkg/manila/const.go

@@ -43,12 +43,13 @@ const (
 	ManilaUserID int64 = 42429
 	// ManilaGroupID -
 	ManilaGroupID int64 = 42429
-
 	// ManilaPublicPort -
 	ManilaPublicPort int32 = 8786
 	// ManilaInternalPort -
 	ManilaInternalPort int32 = 8786
-
+	// ManilaServiceCleanupDelay - Time in seconds that the ServiceCleanupJob
+	// needs to wait before executing the manila-manage command
+	ManilaServiceCleanupDelay int32 = 120
 	// ManilaExtraVolTypeUndefined can be used to label an extraMount which
 	// is not associated with a specific backend
 	ManilaExtraVolTypeUndefined storage.ExtraVolType = "Undefined"
@@ -79,8 +80,18 @@ const (
 	ShortDuration = time.Duration(5) * time.Second
 	// NormalDuration -
 	NormalDuration = time.Duration(10) * time.Second
-	//DBSyncCommand -
+	// DBSyncJobName -
+	DBSyncJobName = "db-sync"
+	// DBSyncCommand -
 	DBSyncCommand = "/usr/bin/manila-manage --config-dir /etc/manila/manila.conf.d db sync"
+	// SvcCleanupJobName -
+	SvcCleanupJobName = "service-cleanup"
+	// SvcCleanupCommand -
+	SvcCleanupCommand = "/usr/bin/manila-manage --config-dir /etc/manila/manila.conf.d service cleanup"
+	// TruncateHash -
+	TruncateHash int = 8
+	// TTL -
+	TTL int32 = 5 * 60 // 5 minutes
 )
 
 // DbsyncPropagation keeps track of the DBSync Service Propagation Type

pkg/manila/funcs.go

@@ -3,6 +3,7 @@ package manila
 import (
 	common "github.com/openstack-k8s-operators/lib-common/modules/common"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/affinity"
+	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
 
 	corev1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -55,3 +56,13 @@ func GetPodAffinity(componentName string) *corev1.Affinity {
 		corev1.LabelHostname,
 	)
 }
+
+// SharesListHash - Given a list of share names passed as an array of strings,
+// it returns an hash that is currently used to build the job name
+func SharesListHash(shareNames []string) (string, error) {
+	hash, err := util.ObjectHash(shareNames)
+	if err != nil {
+		return hash, err
+	}
+	return hash, err
+}

pkg/manila/dbsync.go → pkg/manila/job.go

@@ -1,25 +1,33 @@
 package manila
 
 import (
+	"fmt"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/env"
 	manilav1 "github.com/openstack-k8s-operators/manila-operator/api/v1beta1"
 	batchv1 "k8s.io/api/batch/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// DbSyncJob func
-func DbSyncJob(instance *manilav1.Manila, labels map[string]string, annotations map[string]string) *batchv1.Job {
+// Job func
+func Job(
+	instance *manilav1.Manila,
+	labels map[string]string,
+	annotations map[string]string,
+	ttl *int32,
+	jobName string,
+	jobCommand string,
+	delay int32,
+) *batchv1.Job {
 	var config0644AccessMode int32 = 0644
-
-	// Unlike the individual manila services, the DbSyncJob doesn't need a
-	// secret that contains all of the config snippets required by every
-	// service, The two snippet files that it does need (DefaultsConfigFileName
-	// and CustomConfigFileName) can be extracted from the top-level manila
-	// config-data secret.
-	dbSyncVolume := []corev1.Volume{
+	// Unlike the individual manila services, DbSyncJob or a Job executing a
+	// manila-manage command doesn't need a secret that contains all of the
+	// config snippets required by every service, The two snippet files that it
+	// does need (DefaultsConfigFileName and CustomConfigFileName) can be
+	// extracted from the top-level manila config-data secret.
+	manilaJobVolume := []corev1.Volume{
 		{
-			Name: "db-sync-config-data",
+			Name: "job-config-data",
 			VolumeSource: corev1.VolumeSource{
 				Secret: &corev1.SecretVolumeSource{
 					DefaultMode: &config0644AccessMode,
@@ -48,9 +56,9 @@ func DbSyncJob(instance *manilav1.Manila, labels map[string]string, annotations
 		},
 	}
 
-	dbSyncMounts := []corev1.VolumeMount{
+	manilaJobMounts := []corev1.VolumeMount{
 		{
-			Name:      "db-sync-config-data",
+			Name:      "job-config-data",
 			MountPath: "/etc/manila/manila.conf.d",
 			ReadOnly:  true,
 		},
@@ -62,12 +70,13 @@ func DbSyncJob(instance *manilav1.Manila, labels map[string]string, annotations
 		},
 	}
 
-	args := []string{"-c", DBSyncCommand}
+	delayCommand := fmt.Sprintf("sleep %d", delay)
+	args := []string{"-c", fmt.Sprintf("%s && %s", delayCommand, jobCommand)}
 
 	// add CA cert if defined
 	if instance.Spec.ManilaAPI.TLS.CaBundleSecretName != "" {
-		dbSyncVolume = append(dbSyncVolume, instance.Spec.ManilaAPI.TLS.CreateVolume())
-		dbSyncMounts = append(dbSyncMounts, instance.Spec.ManilaAPI.TLS.CreateVolumeMounts(nil)...)
+		manilaJobVolume = append(manilaJobVolume, instance.Spec.ManilaAPI.TLS.CreateVolume())
+		manilaJobMounts = append(manilaJobMounts, instance.Spec.ManilaAPI.TLS.CreateVolumeMounts(nil)...)
 	}
 
 	envVars := map[string]env.Setter{}
@@ -76,7 +85,7 @@ func DbSyncJob(instance *manilav1.Manila, labels map[string]string, annotations
 
 	job := &batchv1.Job{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      instance.Name + "-db-sync",
+			Name:      fmt.Sprintf("%s-%s", instance.Name, jobName),
 			Namespace: instance.Namespace,
 			Labels:    labels,
 		},
@@ -90,22 +99,25 @@ func DbSyncJob(instance *manilav1.Manila, labels map[string]string, annotations
 					ServiceAccountName: instance.RbacResourceName(),
 					Containers: []corev1.Container{
 						{
-							Name: instance.Name + "-db-sync",
+							Name: fmt.Sprintf("%s-%s", instance.Name, jobName),
 							Command: []string{
 								"/bin/bash",
 							},
 							Args:            args,
 							Image:           instance.Spec.ManilaAPI.ContainerImage,
 							SecurityContext: manilaDefaultSecurityContext(),
 							Env:             env.MergeEnvs([]corev1.EnvVar{}, envVars),
-							VolumeMounts:    dbSyncMounts,
+							VolumeMounts:    manilaJobMounts,
 						},
 					},
-					Volumes: dbSyncVolume,
+					Volumes: manilaJobVolume,
 				},
 			},
 		},
 	}
-
+	if ttl != nil {
+		// Setting TTL to delete the job after it has completed
+		job.Spec.TTLSecondsAfterFinished = ttl
+	}
 	return job
 }