-
Notifications
You must be signed in to change notification settings - Fork 420
/
eventlistener.go
398 lines (351 loc) · 16 KB
/
eventlistener.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
395
396
397
398
/*
Copyright 2019 The Tekton Authors
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 eventlistener
import (
"context"
"encoding/json"
"fmt"
"strings"
"sync"
"github.com/tektoncd/triggers/pkg/apis/config"
"github.com/tektoncd/triggers/pkg/apis/triggers/contexts"
"github.com/tektoncd/triggers/pkg/apis/triggers/v1beta1"
triggersclientset "github.com/tektoncd/triggers/pkg/client/clientset/versioned"
eventlistenerreconciler "github.com/tektoncd/triggers/pkg/client/injection/reconciler/triggers/v1beta1/eventlistener"
dynamicduck "github.com/tektoncd/triggers/pkg/dynamic"
"github.com/tektoncd/triggers/pkg/reconciler/eventlistener/resources"
"github.com/tektoncd/triggers/pkg/reconciler/metrics"
"golang.org/x/xerrors"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/kubernetes"
appsv1lister "k8s.io/client-go/listers/apps/v1"
corev1lister "k8s.io/client-go/listers/core/v1"
reconcilersource "knative.dev/eventing/pkg/reconciler/source"
"knative.dev/pkg/apis"
"knative.dev/pkg/kmeta"
"knative.dev/pkg/logging"
pkgreconciler "knative.dev/pkg/reconciler"
)
const (
// ControllerName defines the name for EventListener Controller
ControllerName = "EventListener"
// eventListenerServicePortName defines service port name for EventListener Service
eventListenerServicePortName = "http-listener"
// eventListenerServiceTLSPortName defines service TLS port name for EventListener Service
eventListenerServiceTLSPortName = "https-listener"
// eventListenerMetricsPortName defines the metrics port name by the EventListener Container
eventListenerMetricsPortName = "http-metrics"
// eventListenerContainerPort defines service port for EventListener Service
eventListenerContainerPort = 8080
// eventListenerMetricsPort defines metrics port for EventListener Service
eventListenerMetricsPort = 9000
// GeneratedResourcePrefix is the name prefix for resources generated in the
// EventListener reconciler
GeneratedResourcePrefix = "el"
)
// Reconciler implements controller.Reconciler for Configuration resources.
type Reconciler struct {
DynamicClientSet dynamic.Interface
// KubeClientSet allows us to talk to the k8s for core APIs
KubeClientSet kubernetes.Interface
// TriggersClientSet allows us to configure triggers objects
TriggersClientSet triggersclientset.Interface
// listers index properties about resources
deploymentLister appsv1lister.DeploymentLister
serviceLister corev1lister.ServiceLister
// config accessor for observability/logging/tracing
configAcc reconcilersource.ConfigAccessor
// config is the configuration options that the Reconciler accepts.
config resources.Config
podspecableTracker dynamicduck.ListableTracker
onlyOnce sync.Once
// Metrics Recorder config
Metrics *metrics.Recorder
}
var (
// Check that our Reconciler implements eventlistenerreconciler.Interface
_ eventlistenerreconciler.Interface = (*Reconciler)(nil)
)
// ReconcileKind compares the actual state with the desired, and attempts to
// converge the two.
func (r *Reconciler) ReconcileKind(ctx context.Context, el *v1beta1.EventListener) pkgreconciler.Event {
// Initial reconciliation
el.Status.InitializeConditions()
el.Status.Configuration.GeneratedResourceName = fmt.Sprintf("%s-%s", GeneratedResourcePrefix, el.Name)
// We may be reading a version of the object that was stored at an older version
// and may not have had all of the assumed default specified.
el.SetDefaults(contexts.WithUpgradeViaDefaulting(ctx))
cfg := config.FromContextOrDefaults(ctx)
if el.Spec.Resources.CustomResource != nil {
return r.reconcileCustomObject(ctx, el, cfg)
}
deploymentReconcileError := r.reconcileDeployment(ctx, el, cfg)
serviceReconcileError := r.reconcileService(ctx, el)
if el.Spec.Resources.CustomResource == nil {
el.Status.SetReadyCondition()
}
if len(el.Finalizers) > 0 {
// TODO(dibyom): Remove this in a future release once we are sure no one is using pre v0.16 resources
r.removeFinalizer(ctx, el)
}
return wrapError(serviceReconcileError, deploymentReconcileError)
}
func (r *Reconciler) reconcileService(ctx context.Context, el *v1beta1.EventListener) error {
service := resources.MakeService(ctx, el, r.config)
existingService, err := r.serviceLister.Services(el.Namespace).Get(el.Status.Configuration.GeneratedResourceName)
switch {
case err == nil:
el.Status.SetExistsCondition(v1beta1.ServiceExists, nil)
el.Status.SetAddress(resources.ListenerHostname(el, r.config))
// Copy over output spec fields.
service.Spec.ClusterIP = existingService.Spec.ClusterIP
// Copy any assigned NodePorts
if service.Spec.Type == corev1.ServiceTypeNodePort &&
existingService.Spec.Type == corev1.ServiceTypeNodePort {
for i := range service.Spec.Ports {
if i >= len(existingService.Spec.Ports) {
break
}
service.Spec.Ports[i].NodePort = existingService.Spec.Ports[i].NodePort
}
}
// Preserve user-added annotations.
if len(existingService.Annotations) > 0 {
service.Annotations = kmeta.UnionMaps(service.Annotations, existingService.Annotations)
}
if !equality.Semantic.DeepEqual(existingService.Spec, service.Spec) ||
!equality.Semantic.DeepEqual(existingService.Labels, service.Labels) ||
!equality.Semantic.DeepEqual(existingService.Annotations, service.Annotations) {
existingService = existingService.DeepCopy() // Don't modify the lister cache
existingService.Labels = service.Labels
existingService.Annotations = service.Annotations
existingService.Spec = service.Spec
if updated, err := r.KubeClientSet.CoreV1().Services(el.Namespace).Update(ctx, existingService, metav1.UpdateOptions{}); err != nil {
logging.FromContext(ctx).Errorf("Error updating EventListener Service: %s", err)
return err
} else if existingService.ResourceVersion != updated.ResourceVersion {
logging.FromContext(ctx).Infof("Updated EventListener Service %s in Namespace %s", existingService.Namespace, el.Namespace)
}
}
case errors.IsNotFound(err):
// Create the EventListener Service
_, err = r.KubeClientSet.CoreV1().Services(el.Namespace).Create(ctx, service, metav1.CreateOptions{})
el.Status.SetExistsCondition(v1beta1.ServiceExists, err)
if err != nil {
logging.FromContext(ctx).Errorf("Error creating EventListener Service: %s", err)
return err
}
el.Status.SetAddress(resources.ListenerHostname(el, r.config))
logging.FromContext(ctx).Infof("Created EventListener Service %s in Namespace %s", service.Name, el.Namespace)
default:
logging.FromContext(ctx).Error(err)
return err
}
return nil
}
func (r *Reconciler) reconcileDeployment(ctx context.Context, el *v1beta1.EventListener, cfg *config.Config) error {
deployment, err := resources.MakeDeployment(ctx, el, r.configAcc, r.config, cfg)
if err != nil {
logging.FromContext(ctx).Error(err)
return err
}
existingDeployment, err := r.deploymentLister.Deployments(el.Namespace).Get(el.Status.Configuration.GeneratedResourceName)
switch {
case err == nil:
// TODO(mattmoor): Should this delete stuff for the CustomObject? That path deletes Deployments,
// so it seems asymmetrical for this path to not.
el.Status.SetDeploymentConditions(existingDeployment.Status.Conditions)
el.Status.SetExistsCondition(v1beta1.DeploymentExists, nil)
// If the scale of the deployment is unspecified, then persist the current
// scale of what is deployed. This allows users to use HPA to automatically
// (or manually themselves) scale the underlying deployment.
if deployment.Spec.Replicas == nil {
deployment.Spec.Replicas = existingDeployment.Spec.Replicas
}
// Preserve user-added annotations.
if len(existingDeployment.Annotations) > 0 {
deployment.Annotations = kmeta.UnionMaps(deployment.Annotations, existingDeployment.Annotations)
}
if !equality.Semantic.DeepEqual(existingDeployment.Spec, deployment.Spec) ||
!equality.Semantic.DeepEqual(existingDeployment.Labels, deployment.Labels) ||
!equality.Semantic.DeepEqual(existingDeployment.Annotations, deployment.Annotations) {
existingDeployment = existingDeployment.DeepCopy() // Don't modify the lister cache
existingDeployment.Labels = deployment.Labels
existingDeployment.Annotations = deployment.Annotations
existingDeployment.Spec = deployment.Spec
// If the spec/labels/annotations of what we want and got are different, then
// issue an Update. They may differ due to things like defaulting, so the
// Update may not change anything, so only log if the ResourceVersion changes.
if updated, err := r.KubeClientSet.AppsV1().Deployments(el.Namespace).Update(ctx, existingDeployment, metav1.UpdateOptions{}); err != nil {
logging.FromContext(ctx).Errorf("Error updating EventListener Deployment: %s", err)
return err
} else if existingDeployment.ResourceVersion != updated.ResourceVersion {
logging.FromContext(ctx).Infof("Updated EventListener Deployment %s in Namespace %s", existingDeployment.Name, el.Namespace)
}
}
case errors.IsNotFound(err):
// Create the EventListener Deployment
deployment, err = r.KubeClientSet.AppsV1().Deployments(el.Namespace).Create(ctx, deployment, metav1.CreateOptions{})
el.Status.SetExistsCondition(v1beta1.DeploymentExists, err)
if err != nil {
logging.FromContext(ctx).Errorf("Error creating EventListener Deployment: %s", err)
return err
}
el.Status.SetDeploymentConditions(deployment.Status.Conditions)
logging.FromContext(ctx).Infof("Created EventListener Deployment %s in Namespace %s", deployment.Name, el.Namespace)
default:
logging.FromContext(ctx).Error(err)
return err
}
return nil
}
func (r *Reconciler) reconcileCustomObject(ctx context.Context, el *v1beta1.EventListener, cfg *config.Config) error {
data, err := resources.MakeCustomObject(ctx, el, r.configAcc, r.config, cfg)
if err != nil {
logging.FromContext(ctx).Errorf("unable to construct custom object", err)
return err
}
gvr, _ := meta.UnsafeGuessKindToResource(data.GetObjectKind().GroupVersionKind())
// TODO(mattmoor): Consider replacing this with duck.InformerFactory, it actually has a bug where
// the podspecableTracker can only service a single GVR, despite multiple EventListener objects
// being able to specify unique resource types (yikes).
var watchError error
r.onlyOnce.Do(func() {
watchError = r.podspecableTracker.WatchOnDynamicObject(ctx, gvr)
})
if watchError != nil {
logging.FromContext(ctx).Errorf("failed to watch on created custom object", watchError)
return watchError
}
// TODO(mattmoor): We should look into using duck.InformerFactory to have this be a lister fetch.
existingCustomObject, err := r.DynamicClientSet.Resource(gvr).Namespace(data.GetNamespace()).Get(ctx, data.GetName(), metav1.GetOptions{})
switch {
case err == nil:
// Clean up any Deployments that may have existed for this listener.
if _, err := r.deploymentLister.Deployments(el.Namespace).Get(el.Status.Configuration.GeneratedResourceName); err == nil {
if err := r.KubeClientSet.AppsV1().Deployments(el.Namespace).Delete(ctx, el.Status.Configuration.GeneratedResourceName,
metav1.DeleteOptions{}); err != nil && !errors.IsNotFound(err) {
return err
}
if err = r.KubeClientSet.CoreV1().Services(el.Namespace).Delete(ctx, el.Status.Configuration.GeneratedResourceName,
metav1.DeleteOptions{}); err != nil && !errors.IsNotFound(err) {
return err
}
}
var updated bool
// Preserve any externally added annotations
data.SetAnnotations(kmeta.UnionMaps(data.GetAnnotations(), existingCustomObject.GetAnnotations()))
if !equality.Semantic.DeepEqual(data.GetLabels(), existingCustomObject.GetLabels()) ||
!equality.Semantic.DeepEqual(data.GetAnnotations(), existingCustomObject.GetAnnotations()) {
// Don't modify informer copy
existingCustomObject = existingCustomObject.DeepCopy()
existingCustomObject.SetLabels(data.GetLabels())
existingCustomObject.SetAnnotations(data.GetAnnotations())
updated = true
}
if !equality.Semantic.DeepEqual(data.Object["spec"], existingCustomObject.Object["spec"]) {
diffExist, existingObject, err := resources.UpdateCustomObject(data, existingCustomObject)
if err != nil {
return err
}
// To avoid un necessary marshalling when there is no updates.
if diffExist {
existingMarshaledData, err := json.Marshal(existingObject)
if err != nil {
logging.FromContext(ctx).Errorf("failed to marshal custom object: %v", err)
return err
}
existingCustomObject = new(unstructured.Unstructured)
if err := existingCustomObject.UnmarshalJSON(existingMarshaledData); err != nil {
logging.FromContext(ctx).Errorf("failed to unmarshal to unstructured object: %v", err)
return err
}
updated = diffExist
}
}
if updated {
updatedData, err := r.DynamicClientSet.Resource(gvr).Namespace(data.GetNamespace()).Update(ctx, existingCustomObject, metav1.UpdateOptions{})
if err != nil {
logging.FromContext(ctx).Errorf("error updating to eventListener custom object: %v", err)
return err
} else if data.GetResourceVersion() != updatedData.GetResourceVersion() {
logging.FromContext(ctx).Infof("Updated EventListener Custom Object %s in Namespace %s", data.GetName(), el.Namespace)
}
}
// TODO(mattmoor): Consider replacing this stuff with the "addressable resolver"
// from knative.dev/pkg, which is purpose built for this kind of thing.
customConditions, url, err := dynamicduck.GetConditions(existingCustomObject)
if customConditions == nil {
// No status in the created object, it is weird but let's not fail
logging.FromContext(ctx).Warn("empty status for the created custom object")
return nil
}
if err != nil {
return err
}
for _, cond := range customConditions {
if cond.Type == apis.ConditionReady {
if cond.Status != corev1.ConditionTrue {
logging.FromContext(ctx).Warnf("custom object is not yet ready because %s", cond.Message)
return fmt.Errorf("custom object is not yet ready because %s", cond.Message)
}
}
}
el.Status.SetConditionsForDynamicObjects(customConditions)
if url != nil {
el.Status.SetAddress(strings.Split(fmt.Sprintf("%v", url), "//")[1])
}
case errors.IsNotFound(err):
createDynamicObject, err := r.DynamicClientSet.Resource(gvr).Namespace(data.GetNamespace()).Create(ctx, data, metav1.CreateOptions{})
if err != nil {
logging.FromContext(ctx).Errorf("Error creating EventListener Dynamic object: ", err)
return err
}
logging.FromContext(ctx).Infof("Created EventListener Deployment %s in Namespace %s", createDynamicObject.GetName(), el.Namespace)
default:
logging.FromContext(ctx).Error(err)
return err
}
return nil
}
func (r *Reconciler) removeFinalizer(ctx context.Context, el *v1beta1.EventListener) {
// We used to need Finalizers in older versions of Triggers.
// They are not necessary anymore so let's remove them from any old EventListener objects
for i, f := range el.Finalizers {
if f == "eventlisteners.triggers.tekton.dev" {
el.Finalizers = append(el.Finalizers[:i], el.Finalizers[i+1:]...)
_, err := r.TriggersClientSet.TriggersV1beta1().EventListeners(el.Namespace).Update(ctx, el, metav1.UpdateOptions{})
if err != nil {
logging.FromContext(ctx).Errorf("failed to update EventListener to remove finalizer: %v", err)
}
break
}
}
}
// wrapError wraps errors together. If one of the errors is nil, the other is
// returned.
func wrapError(err1, err2 error) error {
if err1 == nil {
return err2
}
if err2 == nil {
return err1
}
return xerrors.Errorf("%s : %s", err1.Error(), err2.Error())
}