Skip to content
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

Add jitter window #87

Merged
merged 1 commit into from
Jun 12, 2024
Merged

Add jitter window #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 19 additions & 13 deletions cmd/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,16 @@ import (
)

var (
setupLog = ctrl.Log.WithName("setup")
metricsAddr string
probeAddr string
workers int
restConfigQPS float32
restConfigBurst int
webhookPort int
concurrentReconciles int
syncPeriod time.Duration
setupLog = ctrl.Log.WithName("setup")
metricsAddr string
probeAddr string
workers int
restConfigQPS float32
restConfigBurst int
webhookPort int
concurrentReconciles int
syncPeriod time.Duration
jitterWindowInSeconds int
)

func main() {
Expand Down Expand Up @@ -105,9 +106,10 @@ func main() {
}

if err = (&controller.CleanerReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
ConcurrentReconciles: concurrentReconciles,
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
ConcurrentReconciles: concurrentReconciles,
JitterWindowInSeconds: jitterWindowInSeconds,
}).SetupWithManager(ctx, mgr, workers, ctrl.Log.WithName("worker")); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "Cleaner")
os.Exit(1)
Expand Down Expand Up @@ -139,7 +141,11 @@ func initFlags(fs *pflag.FlagSet) {

const defaultWorkers = 5
fs.IntVar(&workers, "worker-number", defaultWorkers,
"Number of worker. Workers are used to process cleaner instances in backgroun")
"Number of worker. Workers are used to process cleaner instances in background")

const defaultJitterWindow = 15
fs.IntVar(&jitterWindowInSeconds, "jitter-window", defaultJitterWindow,
"The predefined time interval around a scheduled execution time.")

const defaultReconcilers = 10
fs.IntVar(&concurrentReconciles, "concurrent-reconciles", defaultReconcilers,
Expand Down
18 changes: 11 additions & 7 deletions internal/controller/cleaner_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ import (
// CleanerReconciler reconciles a Cleaner object
type CleanerReconciler struct {
client.Client
Scheme *runtime.Scheme
ConcurrentReconciles int
Scheme *runtime.Scheme
ConcurrentReconciles int
JitterWindowInSeconds int
}

//+kubebuilder:rbac:groups=apps.projectsveltos.io,resources=cleaners,verbs=get;list;watch;patch
Expand Down Expand Up @@ -151,7 +152,7 @@ func (r *CleanerReconciler) reconcileNormal(ctx context.Context, cleanerScope *s
}

now := time.Now()
nextRun, err := schedule(ctx, cleanerScope, logger)
nextRun, err := schedule(ctx, cleanerScope, r.JitterWindowInSeconds, logger)
if err != nil {
logger.Info("failed to get next run. Err: %v", err)
msg := err.Error()
Expand Down Expand Up @@ -216,7 +217,9 @@ func (r *CleanerReconciler) removeReport(ctx context.Context,
return fmt.Errorf("report instance still present")
}

func schedule(ctx context.Context, cleanerScope *scope.CleanerScope, logger logr.Logger) (*time.Time, error) {
func schedule(ctx context.Context, cleanerScope *scope.CleanerScope, jitterWindowInSeconds int,
logger logr.Logger) (*time.Time, error) {

newLastRunTime := cleanerScope.Cleaner.Status.LastRunTime

now := time.Now()
Expand All @@ -231,7 +234,7 @@ func schedule(ctx context.Context, cleanerScope *scope.CleanerScope, logger logr
logger.Info("set NextScheduleTime")
newNextScheduleTime = &metav1.Time{Time: *nextRun}
} else {
if shouldSchedule(cleanerScope.Cleaner, logger) {
if shouldSchedule(cleanerScope.Cleaner, jitterWindowInSeconds, logger) {
logger.Info("queuing job")
executorClient := executor.GetClient()
executorClient.Process(ctx, cleanerScope.Cleaner.Name)
Expand Down Expand Up @@ -285,8 +288,9 @@ func getNextScheduleTime(cleaner *appsv1alpha1.Cleaner, now time.Time) (*time.Ti
return &next, nil
}

func shouldSchedule(cleaner *appsv1alpha1.Cleaner, logger logr.Logger) bool {
now := time.Now()
func shouldSchedule(cleaner *appsv1alpha1.Cleaner, jitterWindowInSeconds int, logger logr.Logger) bool {
// if reconciliation is happening within jitterWindowInSeconds from scheduled time still process it
now := time.Now().Add(time.Duration(jitterWindowInSeconds) * time.Second)
logger.Info(fmt.Sprintf("currently next schedule is %s", cleaner.Status.NextScheduleTime.Time))

if now.Before(cleaner.Status.NextScheduleTime.Time) {
Expand Down
6 changes: 4 additions & 2 deletions internal/controller/cleaner_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,14 @@ var _ = Describe("CleanerClient", func() {
logger, err := zap.NewDevelopment()
Expect(err).To(BeNil())

Expect(controller.ShouldSchedule(cleaner, zapr.NewLogger(logger))).To(BeTrue())
jitterWindowInSeconds := 15

Expect(controller.ShouldSchedule(cleaner, jitterWindowInSeconds, zapr.NewLogger(logger))).To(BeTrue())

after := now.Add(time.Second * 30)
cleaner.Status.NextScheduleTime = &metav1.Time{Time: after}

Expect(controller.ShouldSchedule(cleaner, zapr.NewLogger(logger))).To(BeFalse())
Expect(controller.ShouldSchedule(cleaner, jitterWindowInSeconds, zapr.NewLogger(logger))).To(BeFalse())
})

It("getNextScheduleTime returns the next time cleaner should be scheduled", func() {
Expand Down
Loading