-
Notifications
You must be signed in to change notification settings - Fork 0
/
operator.go
242 lines (213 loc) · 7.7 KB
/
operator.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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
package cron
import (
"fmt"
"sort"
"time"
"github.com/robfig/cron"
log "github.com/sirupsen/logrus"
v12 "k8s.io/api/core/v1"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
"github.com/argoproj/argo/pkg/client/clientset/versioned"
typed "github.com/argoproj/argo/pkg/client/clientset/versioned/typed/workflow/v1alpha1"
"github.com/argoproj/argo/workflow/common"
"github.com/argoproj/argo/workflow/util"
)
type cronWfOperationCtx struct {
// CronWorkflow is the CronWorkflow to be run
name string
cronWf *v1alpha1.CronWorkflow
wfClientset versioned.Interface
wfClient typed.WorkflowInterface
cronWfIf typed.CronWorkflowInterface
}
func newCronWfOperationCtx(cronWorkflow *v1alpha1.CronWorkflow, wfClientset versioned.Interface) (*cronWfOperationCtx, error) {
return &cronWfOperationCtx{
name: cronWorkflow.ObjectMeta.Name,
cronWf: cronWorkflow,
wfClientset: wfClientset,
wfClient: wfClientset.ArgoprojV1alpha1().Workflows(cronWorkflow.Namespace),
cronWfIf: wfClientset.ArgoprojV1alpha1().CronWorkflows(cronWorkflow.Namespace),
}, nil
}
func (woc *cronWfOperationCtx) Run() {
log.Infof("Running %s", woc.name)
proceed, err := woc.enforceRuntimePolicy()
if err != nil {
log.Errorf("Concurrency policy error: %s", err)
return
} else if !proceed {
return
}
wf, err := common.ConvertToWorkflow(woc.cronWf)
if err != nil {
log.Errorf("Unable to create Workflow for CronWorkflow %s", woc.name)
return
}
runWf, err := util.SubmitWorkflow(woc.wfClient, woc.wfClientset, woc.cronWf.Namespace, wf, &util.SubmitOpts{})
if err != nil {
log.Errorf("Failed to run CronWorkflow: %v", err)
return
}
woc.cronWf.Status.Active = append(woc.cronWf.Status.Active, getWorkflowObjectReference(wf, runWf))
woc.cronWf.Status.LastScheduledTime = &v1.Time{Time: time.Now().UTC()}
err = woc.persistUpdate()
if err != nil {
log.Error(err)
}
}
func getWorkflowObjectReference(wf *v1alpha1.Workflow, runWf *v1alpha1.Workflow) v12.ObjectReference {
// This is a bit of a hack. Ideally we'd use ref.GetReference, but for some reason the `runWf` object is coming back
// without `Kind` and `APIVersion` set (even though it it set on `wf`). To fix this, we hard code those values.
return v12.ObjectReference{
Kind: wf.Kind,
APIVersion: wf.APIVersion,
Name: runWf.GetName(),
Namespace: runWf.GetNamespace(),
UID: runWf.GetUID(),
ResourceVersion: runWf.GetResourceVersion(),
}
}
func (woc *cronWfOperationCtx) persistUpdate() error {
_, err := woc.cronWfIf.Update(woc.cronWf)
if err != nil {
return fmt.Errorf("failed to update CronWorkflow: %s", err)
}
return nil
}
func (woc *cronWfOperationCtx) enforceRuntimePolicy() (bool, error) {
if woc.cronWf.Spec.Suspend {
log.Infof("%s is suspended, skipping execution", woc.name)
return false, nil
}
if woc.cronWf.Spec.ConcurrencyPolicy != "" {
switch woc.cronWf.Spec.ConcurrencyPolicy {
case v1alpha1.AllowConcurrent, "":
// Do nothing
case v1alpha1.ForbidConcurrent:
if len(woc.cronWf.Status.Active) > 0 {
log.Infof("%s has 'ConcurrencyPolicy: Forbid' and has an active Workflow so it was not run", woc.name)
return false, nil
}
case v1alpha1.ReplaceConcurrent:
if len(woc.cronWf.Status.Active) > 0 {
log.Infof("%s has 'ConcurrencyPolicy: Replace' and has active Workflows", woc.name)
err := woc.terminateOutstandingWorkflows()
if err != nil {
return false, err
}
}
default:
return false, fmt.Errorf("invalid ConcurrencyPolicy: %s", woc.cronWf.Spec.ConcurrencyPolicy)
}
}
return true, nil
}
func (woc *cronWfOperationCtx) terminateOutstandingWorkflows() error {
for _, wfObjectRef := range woc.cronWf.Status.Active {
log.Infof("stopping '%s'", wfObjectRef.Name)
err := util.TerminateWorkflow(woc.wfClient, wfObjectRef.Name)
if err != nil {
return fmt.Errorf("error stopping workflow %s: %e", wfObjectRef.Name, err)
}
}
return nil
}
func (woc *cronWfOperationCtx) runOutstandingWorkflows() error {
// If this CronWorkflow has been run before, check if we have missed any scheduled executions
if woc.cronWf.Status.LastScheduledTime != nil {
now := time.Now()
var missedExecutionTime time.Time
cronSchedule, err := cron.ParseStandard(woc.cronWf.Spec.Schedule)
if err != nil {
return err
}
nextScheduledRunTime := cronSchedule.Next(woc.cronWf.Status.LastScheduledTime.Time)
// Workflow should have ran
for nextScheduledRunTime.Before(now) {
missedExecutionTime = nextScheduledRunTime
nextScheduledRunTime = cronSchedule.Next(missedExecutionTime)
}
// We missed the latest execution time
if !missedExecutionTime.IsZero() {
// If StartingDeadlineSeconds is not set, or we are still within the deadline window, run the Workflow
if woc.cronWf.Spec.StartingDeadlineSeconds == nil || now.Before(missedExecutionTime.Add(time.Duration(*woc.cronWf.Spec.StartingDeadlineSeconds)*time.Second)) {
log.Infof("%s missed an execution at %s and is within StartingDeadline", woc.cronWf.Name, missedExecutionTime.Format("Mon Jan _2 15:04:05 2006"))
woc.Run()
}
}
}
return nil
}
func (woc *cronWfOperationCtx) removeActiveWf(wf *v1alpha1.Workflow) {
if wf == nil || wf.ObjectMeta.UID == "" {
return
}
for i, objectRef := range woc.cronWf.Status.Active {
if objectRef.UID == wf.ObjectMeta.UID {
woc.cronWf.Status.Active = append(woc.cronWf.Status.Active[:i], woc.cronWf.Status.Active[i+1:]...)
err := woc.persistUpdate()
if err != nil {
log.Errorf("Unable to update CronWorkflow '%s': %s", woc.cronWf.Name, err)
}
}
}
}
func (woc *cronWfOperationCtx) enforceHistoryLimit() {
log.Infof("Enforcing history limit for '%s'", woc.cronWf.Name)
listOptions := &v1.ListOptions{}
wfInformerListOptionsFunc(listOptions)
wfList, err := woc.wfClient.List(*listOptions)
if err != nil {
log.Errorf("Unable to enforce history limit for CronWorkflow '%s': %s", woc.cronWf.Name, err)
return
}
var successfulWorkflows []v1alpha1.Workflow
var failedWorkflows []v1alpha1.Workflow
for _, wf := range wfList.Items {
if wf.Labels[common.LabelCronWorkflow] != woc.cronWf.Name {
continue
}
if wf.Status.Completed() {
if wf.Status.Successful() {
successfulWorkflows = append(successfulWorkflows, wf)
} else {
failedWorkflows = append(failedWorkflows, wf)
}
}
}
workflowsToKeep := int32(3)
if woc.cronWf.Spec.SuccessfulJobsHistoryLimit != nil && *woc.cronWf.Spec.SuccessfulJobsHistoryLimit >= 0 {
workflowsToKeep = *woc.cronWf.Spec.SuccessfulJobsHistoryLimit
}
err = woc.deleteOldestWorkflows(successfulWorkflows, int(workflowsToKeep))
if err != nil {
log.Errorf("Unable to delete Successful Workflows of CronWorkflow '%s': %s", woc.cronWf.Name, err)
return
}
workflowsToKeep = int32(1)
if woc.cronWf.Spec.FailedJobsHistoryLimit != nil && *woc.cronWf.Spec.FailedJobsHistoryLimit >= 0 {
workflowsToKeep = *woc.cronWf.Spec.FailedJobsHistoryLimit
}
err = woc.deleteOldestWorkflows(failedWorkflows, int(workflowsToKeep))
if err != nil {
log.Errorf("Unable to delete Failed Workflows of CronWorkflow '%s': %s", woc.cronWf.Name, err)
return
}
}
func (woc *cronWfOperationCtx) deleteOldestWorkflows(jobList []v1alpha1.Workflow, workflowsToKeep int) error {
if workflowsToKeep >= len(jobList) {
return nil
}
sort.SliceStable(jobList, func(i, j int) bool {
return jobList[i].Status.FinishedAt.Time.After(jobList[j].Status.FinishedAt.Time)
})
for _, wf := range jobList[workflowsToKeep:] {
err := woc.wfClient.Delete(wf.Name, &v1.DeleteOptions{})
if err != nil {
return fmt.Errorf("error deleting workflow '%s': %e", wf.Name, err)
}
log.Infof("Deleted Workflow '%s' due to CronWorkflow '%s' history limit", wf.Name, woc.cronWf.Name)
}
return nil
}