-
Notifications
You must be signed in to change notification settings - Fork 718
/
trigger.go
394 lines (345 loc) · 13.6 KB
/
trigger.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
/*
Copyright 2018 BlackRock, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package sensors
import (
"encoding/json"
"fmt"
"github.com/Knetic/govaluate"
"github.com/argoproj/argo-events/common"
sn "github.com/argoproj/argo-events/controllers/sensor"
apicommon "github.com/argoproj/argo-events/pkg/apis/common"
"github.com/argoproj/argo-events/pkg/apis/sensor"
"github.com/argoproj/argo-events/pkg/apis/sensor/v1alpha1"
"github.com/argoproj/argo-events/store"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/dynamic"
)
// canProcessTriggers evaluates whether triggers can be processed and executed
func (sec *sensorExecutionCtx) canProcessTriggers() (bool, error) {
if sec.sensor.Spec.ErrorOnFailedRound && sec.sensor.Status.TriggerCycleStatus == v1alpha1.TriggerCycleFailure {
return false, fmt.Errorf("last trigger cycle was a failure and sensor policy is set to ErrorOnFailedRound, so won't process the triggers")
}
if sec.sensor.Spec.DependencyGroups != nil {
groups := make(map[string]interface{}, len(sec.sensor.Spec.DependencyGroups))
group:
for _, group := range sec.sensor.Spec.DependencyGroups {
for _, dependency := range group.Dependencies {
if nodeStatus := sn.GetNodeByName(sec.sensor, dependency); nodeStatus.Phase != v1alpha1.NodePhaseComplete {
groups[group.Name] = false
continue group
}
}
sn.MarkNodePhase(sec.sensor, group.Name, v1alpha1.NodeTypeDependencyGroup, v1alpha1.NodePhaseComplete, nil, sec.log, "dependency group is complete")
groups[group.Name] = true
}
expression, err := govaluate.NewEvaluableExpression(sec.sensor.Spec.Circuit)
if err != nil {
return false, fmt.Errorf("failed to create circuit expression. err: %+v", err)
}
result, err := expression.Evaluate(groups)
if err != nil {
return false, fmt.Errorf("failed to evaluate circuit expression. err: %+v", err)
}
return result == true, err
}
if sec.sensor.AreAllNodesSuccess(v1alpha1.NodeTypeEventDependency) {
return true, nil
}
return false, nil
}
// canExecuteTrigger determines whether a trigger is executable based on condition set on trigger
func (sec *sensorExecutionCtx) canExecuteTrigger(trigger v1alpha1.Trigger) bool {
if trigger.Template.When == nil {
return true
}
if trigger.Template.When.Any != nil {
for _, group := range trigger.Template.When.Any {
if status := sn.GetNodeByName(sec.sensor, group); status.Type == v1alpha1.NodeTypeDependencyGroup && status.Phase == v1alpha1.NodePhaseComplete {
return true
}
return false
}
}
if trigger.Template.When.All != nil {
for _, group := range trigger.Template.When.All {
if status := sn.GetNodeByName(sec.sensor, group); status.Type == v1alpha1.NodeTypeDependencyGroup && status.Phase != v1alpha1.NodePhaseComplete {
return false
}
return true
}
}
return true
}
// processTriggers checks if all event dependencies are complete and then starts executing triggers
func (sec *sensorExecutionCtx) processTriggers() {
// to trigger the sensor action/s we need to check if all event dependencies are completed and sensor is active
sec.log.Info("all event dependencies are marked completed, processing triggers")
// labels for K8s event
labels := map[string]string{
common.LabelSensorName: sec.sensor.Name,
common.LabelOperation: "process_triggers",
}
successTriggerCycle := true
for _, trigger := range sec.sensor.Spec.Triggers {
log := sec.log.WithField(common.LabelTriggerName, trigger.Template.Name)
// check if a trigger condition is set
if canExecute := sec.canExecuteTrigger(trigger); !canExecute {
log.Info("trigger can't be executed because trigger condition failed")
continue
}
if err := sec.executeTrigger(trigger); err != nil {
log.WithError(err).Error("trigger failed to execute")
// mark trigger status as error
sn.MarkNodePhase(sec.sensor, trigger.Template.Name, v1alpha1.NodeTypeTrigger, v1alpha1.NodePhaseError, nil, sec.log, fmt.Sprintf("failed to execute trigger.Template. err: %+v", err))
successTriggerCycle = false
// escalate using K8s event
labels[common.LabelEventType] = string(common.EscalationEventType)
if err := common.GenerateK8sEvent(sec.kubeClient, fmt.Sprintf("failed to execute trigger %s", trigger.Template.Name), common.EscalationEventType,
"trigger failure", sec.sensor.Name, sec.sensor.Namespace, sec.controllerInstanceID, sensor.Kind, labels); err != nil {
log.WithError(err).Error("failed to create K8s event to escalate trigger failure")
}
continue
}
// mark trigger as complete.
sn.MarkNodePhase(sec.sensor, trigger.Template.Name, v1alpha1.NodeTypeTrigger, v1alpha1.NodePhaseComplete, nil, sec.log, "successfully executed trigger")
labels[common.LabelEventType] = string(common.OperationSuccessEventType)
if err := common.GenerateK8sEvent(sec.kubeClient, fmt.Sprintf("trigger %s executed successfully", trigger.Template.Name), common.OperationSuccessEventType,
"trigger executed", sec.sensor.Name, sec.sensor.Namespace, sec.controllerInstanceID, sensor.Kind, labels); err != nil {
log.WithError(err).Error("failed to create K8s event to log trigger execution")
}
}
// increment completion counter
sec.sensor.Status.TriggerCycleCount = sec.sensor.Status.TriggerCycleCount + 1
// set completion time
sec.sensor.Status.LastCycleTime = metav1.Now()
if successTriggerCycle {
sec.sensor.Status.TriggerCycleStatus = v1alpha1.TriggerCycleSuccess
} else {
sec.sensor.Status.TriggerCycleStatus = v1alpha1.TriggerCycleFailure
}
// create K8s event to mark the trigger round completion
labels[common.LabelEventType] = string(common.OperationSuccessEventType)
if err := common.GenerateK8sEvent(sec.kubeClient, fmt.Sprintf("completion count:%d", sec.sensor.Status.TriggerCycleCount), common.OperationSuccessEventType,
"triggers execution round completion", sec.sensor.Name, sec.sensor.Namespace, sec.controllerInstanceID, sensor.Kind, labels); err != nil {
sec.log.WithError(err).Error("failed to create K8s event to log trigger execution round completion")
}
// Mark all dependency nodes as active
for _, dependency := range sec.sensor.Spec.Dependencies {
sn.MarkNodePhase(sec.sensor, dependency.Name, v1alpha1.NodeTypeEventDependency, v1alpha1.NodePhaseActive, nil, sec.log, "dependency is re-activated")
}
// Mark all dependency groups as active
for _, group := range sec.sensor.Spec.DependencyGroups {
sn.MarkNodePhase(sec.sensor, group.Name, v1alpha1.NodeTypeDependencyGroup, v1alpha1.NodePhaseActive, nil, sec.log, "dependency group is re-activated")
}
}
// applyParamsTrigger applies parameters to trigger
func (sec *sensorExecutionCtx) applyParamsTrigger(trigger *v1alpha1.Trigger) error {
if trigger.TemplateParameters != nil && len(trigger.TemplateParameters) > 0 {
templateBytes, err := json.Marshal(trigger.Template)
if err != nil {
return err
}
tObj, err := applyParams(templateBytes, trigger.TemplateParameters, sec.extractEvents(trigger.TemplateParameters))
if err != nil {
return err
}
template := &v1alpha1.TriggerTemplate{}
if err = json.Unmarshal(tObj, template); err != nil {
return err
}
trigger.Template = template
}
return nil
}
// applyParamsResource applies parameters to resource within trigger
func (sec *sensorExecutionCtx) applyParamsResource(parameters []v1alpha1.TriggerParameter, obj *unstructured.Unstructured) error {
if parameters != nil && len(parameters) > 0 {
jObj, err := obj.MarshalJSON()
if err != nil {
return fmt.Errorf("failed to marshal json. err: %+v", err)
}
events := sec.extractEvents(parameters)
jUpdatedObj, err := applyParams(jObj, parameters, events)
if err != nil {
return fmt.Errorf("failed to apply params. err: %+v", err)
}
err = obj.UnmarshalJSON(jUpdatedObj)
if err != nil {
return fmt.Errorf("failed to un-marshal json. err: %+v", err)
}
}
return nil
}
// executeTrigger executes the trigger
func (sec *sensorExecutionCtx) executeTrigger(trigger v1alpha1.Trigger) error {
if trigger.Template != nil {
if err := sec.applyParamsTrigger(&trigger); err != nil {
return err
}
creds, err := store.GetCredentials(sec.kubeClient, sec.sensor.Namespace, trigger.Template.Source)
if err != nil {
return err
}
reader, err := store.GetArtifactReader(trigger.Template.Source, creds, sec.kubeClient)
if err != nil {
return err
}
uObj, err := store.FetchArtifact(reader, trigger.Template.GroupVersionKind)
if err != nil {
return err
}
if err = sec.createResourceObject(&trigger, uObj); err != nil {
return err
}
}
return nil
}
// applyTriggerPolicy applies backoff and evaluates success/failure for a trigger
func (sec *sensorExecutionCtx) applyTriggerPolicy(trigger *v1alpha1.Trigger, resourceInterface dynamic.ResourceInterface, name, namespace string) error {
err := wait.ExponentialBackoff(wait.Backoff{
Duration: trigger.Policy.Backoff.Duration,
Steps: trigger.Policy.Backoff.Steps,
Factor: trigger.Policy.Backoff.Factor,
Jitter: trigger.Policy.Backoff.Jitter,
}, func() (bool, error) {
obj, err := resourceInterface.Get(name, metav1.GetOptions{})
if err != nil {
sec.log.WithError(err).WithField("resource-name", obj.GetName()).Error("failed to get triggered resource")
return false, nil
}
labels := obj.GetLabels()
if labels == nil {
sec.log.Warn("triggered object does not have labels, won't apply the trigger policy")
return false, nil
}
sec.log.WithField("labels", labels).Debug("object labels")
// check if success labels match with labels on object
if trigger.Policy.State.Success != nil {
success := true
for successKey, successValue := range trigger.Policy.State.Success {
if value, ok := labels[successKey]; ok {
if successValue != value {
success = false
break
}
continue
}
success = false
}
if success {
return true, nil
}
}
// check if failure labels match with labels on object
if trigger.Policy.State.Failure != nil {
failure := true
for failureKey, failureValue := range trigger.Policy.State.Failure {
if value, ok := labels[failureKey]; ok {
if failureValue != value {
failure = false
break
}
continue
}
failure = false
}
if failure {
return false, fmt.Errorf("trigger is in failed state")
}
}
return false, nil
})
return err
}
// createResourceObject creates K8s object for trigger
func (sec *sensorExecutionCtx) createResourceObject(trigger *v1alpha1.Trigger, obj *unstructured.Unstructured) error {
namespace := obj.GetNamespace()
// Defaults to sensor's namespace
if namespace == "" {
namespace = sec.sensor.Namespace
}
obj.SetNamespace(namespace)
// passing parameters to the resource object requires 4 steps
// 1. marshaling the obj to JSON
// 2. extract the appropriate eventDependency events based on the resource params
// 3. apply the params to the JSON object
// 4. unmarshal the obj from the updated JSON
if err := sec.applyParamsResource(trigger.ResourceParameters, obj); err != nil {
return err
}
gvk := obj.GroupVersionKind()
client, err := sec.clientPool.ClientForGroupVersionKind(gvk)
if err != nil {
return fmt.Errorf("failed to get client for given group version and kind. err: %+v", err)
}
apiResource, err := common.ServerResourceForGroupVersionKind(sec.discoveryClient, gvk)
if err != nil {
return fmt.Errorf("failed to get server resource for given group version and kind. err: %+v", err)
}
sec.log.WithFields(
map[string]interface{}{
"api": apiResource.Name,
"group-version": gvk.Version,
}).Info("created api resource")
reIf := client.Resource(apiResource, namespace)
liveObj, err := reIf.Create(obj)
if err != nil {
return fmt.Errorf("failed to create resource object. err: %+v", err)
}
sec.log.WithFields(
map[string]interface{}{
"kind": liveObj.GetKind(),
"name": liveObj.GetName(),
}).Info("created object")
// apply trigger policy if set
if trigger.Policy != nil {
sec.log.Info("applying trigger policy...")
if err := sec.applyTriggerPolicy(trigger, reIf, liveObj.GetName(), namespace); err != nil {
if err == wait.ErrWaitTimeout {
if trigger.Policy.ErrorOnBackoffTimeout {
return fmt.Errorf("failed to determine status of the triggered resource. setting trigger state as failed")
}
return nil
}
return err
}
}
return nil
}
// helper method to extract the events from the event dependencies nodes associated with the resource params
// returns a map of the events keyed by the event dependency name
func (sec *sensorExecutionCtx) extractEvents(params []v1alpha1.TriggerParameter) map[string]apicommon.Event {
events := make(map[string]apicommon.Event)
for _, param := range params {
if param.Src != nil {
log := sec.log.WithFields(
map[string]interface{}{
"param-src": param.Src.Event,
"param-dest": param.Dest,
})
node := sn.GetNodeByName(sec.sensor, param.Src.Event)
if node == nil {
log.Warn("event dependency node does not exist, cannot apply parameter")
continue
}
if node.Event == nil {
log.Warn("event in event dependency does not exist, cannot apply parameter")
continue
}
events[param.Src.Event] = *node.Event
}
}
return events
}