-
Notifications
You must be signed in to change notification settings - Fork 62
/
scheduler.go
199 lines (168 loc) · 5.85 KB
/
scheduler.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
package scheduler
import (
"errors"
"fmt"
"sync"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/robfig/cron/v3"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/rand"
"k8s.io/utils/strings"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/metrics"
k8upv1alpha1 "github.com/vshn/k8up/api/v1alpha1"
"github.com/vshn/k8up/operator/job"
)
type (
// JobList contains a slice of jobs and job.Config to actually apply the
// the newJobs objects.
JobList struct {
Jobs []Job
Config job.Config
}
// Job contains all necessary information to create a schedule.
Job struct {
JobType k8upv1alpha1.JobType
Schedule k8upv1alpha1.ScheduleDefinition
Object k8upv1alpha1.ObjectCreator
}
// Scheduler handles all the schedules.
Scheduler struct {
cron *cron.Cron
registeredSchedules map[string][]scheduleRef
mutex sync.Mutex
}
scheduleRef struct {
EntryID cron.EntryID
JobType k8upv1alpha1.JobType
Schedule k8upv1alpha1.ScheduleDefinition
Command func()
}
)
var (
scheduler *Scheduler
scheduleGauge = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "k8up_schedules_gauge",
Help: "How many schedules this k8up manages",
}, []string{
"namespace",
})
)
func init() {
// Register custom metrics with the global prometheus registry
metrics.Registry.MustRegister(scheduleGauge)
}
// GetScheduler returns the scheduler singleton instance.
func GetScheduler() *Scheduler {
if scheduler == nil {
scheduler = newScheduler()
scheduler.cron.Start()
}
return scheduler
}
func newScheduler() *Scheduler {
return &Scheduler{
cron: cron.New(),
registeredSchedules: make(map[string][]scheduleRef),
mutex: sync.Mutex{},
}
}
// SyncSchedules will add the given schedule to the running cron.
func (s *Scheduler) SyncSchedules(jobs JobList) error {
namespacedName := types.NamespacedName{
Name: jobs.Config.Obj.GetMetaObject().GetName(),
Namespace: jobs.Config.Obj.GetMetaObject().GetNamespace(),
}
s.RemoveSchedules(namespacedName)
return s.addSchedules(jobs, namespacedName)
}
// addSchedules registers all the jobs in the job list in the internal cron scheduler by invoking addSchedule.
func (s *Scheduler) addSchedules(jobs JobList, namespacedName types.NamespacedName) error {
config := jobs.Config
s.mutex.Lock()
defer s.mutex.Unlock()
for _, schedulableJob := range jobs.Jobs {
config.Log.Info("registering schedule for", "type", schedulableJob.JobType, "cron", schedulableJob.Schedule)
err := s.addSchedule(schedulableJob, namespacedName, s.getScheduleCallback(config, namespacedName, schedulableJob))
if err != nil {
return err
}
}
s.incRegisteredSchedulesGauge(namespacedName.Namespace)
return nil
}
func (s *Scheduler) getScheduleCallback(config job.Config, namespacedName types.NamespacedName, schedulableJob Job) func() {
return func() {
config.Log.Info("running schedule for", "job", schedulableJob.JobType)
s.createObject(schedulableJob.JobType, namespacedName.Namespace, schedulableJob.Object, config)
}
}
// HasSchedule returns true if there is a schedule that matches the given criteria, otherwise false.
func (s *Scheduler) HasSchedule(namespacedName types.NamespacedName, schedule k8upv1alpha1.ScheduleDefinition, jobType k8upv1alpha1.JobType) bool {
for ns, refs := range s.registeredSchedules {
if ns == namespacedName.String() {
for _, ref := range refs {
if ref.Schedule == schedule && ref.JobType == jobType {
return true
}
}
}
}
return false
}
// addSchedule adds the given newJobs to the cron scheduler
func (s *Scheduler) addSchedule(jb Job, namespacedName types.NamespacedName, cmd func()) error {
id, err := s.cron.AddFunc(jb.Schedule.String(), cmd)
if err != nil {
return err
}
schedules := s.registeredSchedules[namespacedName.String()]
s.registeredSchedules[namespacedName.String()] = append(schedules, scheduleRef{
EntryID: id,
JobType: jb.JobType,
Schedule: jb.Schedule,
Command: cmd,
})
return nil
}
// RemoveSchedules will remove the schedules of the given types.NamespacedName if existing.
func (s *Scheduler) RemoveSchedules(namespacedName types.NamespacedName) {
s.mutex.Lock()
defer s.mutex.Unlock()
for _, ref := range s.registeredSchedules[namespacedName.String()] {
s.cron.Remove(ref.EntryID)
}
delete(s.registeredSchedules, namespacedName.String())
s.decRegisteredSchedulesGauge(namespacedName.Namespace)
}
func (s *Scheduler) createObject(jobType k8upv1alpha1.JobType, namespace string, obj k8upv1alpha1.ObjectCreator, config job.Config) {
name := generateName(jobType, config.Obj.GetMetaObject().GetName())
rtObj := obj.CreateObject(name, namespace)
jobObject, ok := rtObj.(k8upv1alpha1.JobObject)
if !ok {
config.Log.Error(errors.New("cannot cast object"), "object is not a valid objectMeta")
return
}
err := controllerutil.SetOwnerReference(config.Obj.GetMetaObject(), jobObject.GetMetaObject(), config.Scheme)
if err != nil {
config.Log.Error(err, "cannot set owner on object", "name", jobObject.GetMetaObject().GetName())
}
err = config.Client.Create(config.CTX, rtObj.(client.Object))
if err != nil {
config.Log.Error(err, "could not trigger k8up newJobs", "name", namespace+"/"+name)
}
}
func generateName(jobType k8upv1alpha1.JobType, prefix string) string {
lenRandom := 5
remainingLength := 63 - lenRandom - len(jobType) - 2
shortPrefix := strings.ShortenString(prefix, remainingLength)
return fmt.Sprintf("%s-%s-%s", shortPrefix, jobType, rand.String(lenRandom))
}
func (s *Scheduler) incRegisteredSchedulesGauge(namespace string) {
scheduleGauge.WithLabelValues(namespace).Inc()
}
func (s *Scheduler) decRegisteredSchedulesGauge(namespace string) {
scheduleGauge.WithLabelValues(namespace).Dec()
}