forked from operator-framework/operator-sdk
-
Notifications
You must be signed in to change notification settings - Fork 1
/
enqueue_annotation.go
115 lines (101 loc) · 3.83 KB
/
enqueue_annotation.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
// Copyright 2019 The Operator-SDK 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 handler
import (
"strings"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/workqueue"
"sigs.k8s.io/controller-runtime/pkg/event"
crtHandler "sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
)
var log = logf.Log.WithName("event_handler")
const (
// NamespacedNameAnnotation - annotation that will be used to get the primary resource namespaced name.
NamespacedNameAnnotation = "operator-sdk/primary-resource"
// TypeAnnotation - annotation that will be used to verify that the primary resource is the primary resource to use.
TypeAnnotation = "operator-sdk/primary-resource-type"
)
// EnqueueRequestForAnnotation enqueues Requests based on the presence of an annotation that contains the
// namespaced name of the primary resource.
//
// The primary usecase for this, is to have a controller enqueue requests for the following scenarios
// 1. namespaced primary object and dependent cluster scoped resource
// 2. cluster scoped primary object.
// 3. namespaced primary object and dependent namespaced scoped but in a different namespace object.
type EnqueueRequestForAnnotation struct {
Type string
mapper meta.RESTMapper
}
var _ crtHandler.EventHandler = &EnqueueRequestForAnnotation{}
// Create implements EventHandler
func (e *EnqueueRequestForAnnotation) Create(evt event.CreateEvent, q workqueue.RateLimitingInterface) {
if ok, req := e.getAnnotationRequests(evt.Meta); ok {
q.Add(req)
}
}
// Update implements EventHandler
func (e *EnqueueRequestForAnnotation) Update(evt event.UpdateEvent, q workqueue.RateLimitingInterface) {
if ok, req := e.getAnnotationRequests(evt.MetaOld); ok {
q.Add(req)
}
if ok, req := e.getAnnotationRequests(evt.MetaNew); ok {
q.Add(req)
}
}
// Delete implements EventHandler
func (e *EnqueueRequestForAnnotation) Delete(evt event.DeleteEvent, q workqueue.RateLimitingInterface) {
if ok, req := e.getAnnotationRequests(evt.Meta); ok {
q.Add(req)
}
}
// Generic implements EventHandler
func (e *EnqueueRequestForAnnotation) Generic(evt event.GenericEvent, q workqueue.RateLimitingInterface) {
if ok, req := e.getAnnotationRequests(evt.Meta); ok {
q.Add(req)
}
}
func (e *EnqueueRequestForAnnotation) getAnnotationRequests(object metav1.Object) (bool, reconcile.Request) {
if typeString, ok := object.GetAnnotations()[TypeAnnotation]; ok && typeString == e.Type {
namespacedNameString, ok := object.GetAnnotations()[NamespacedNameAnnotation]
if !ok {
log.Info("Unable to find namespaced name annotation for resource", "resource", object)
}
if namespacedNameString == "" {
return false, reconcile.Request{}
}
nsn := parseNamespacedName(namespacedNameString)
return true, reconcile.Request{NamespacedName: nsn}
}
return false, reconcile.Request{}
}
func parseNamespacedName(namespacedNameString string) types.NamespacedName {
values := strings.Split(namespacedNameString, "/")
if len(values) == 1 {
return types.NamespacedName{
Name: values[0],
Namespace: "",
}
}
if len(values) >= 2 {
return types.NamespacedName{
Name: values[1],
Namespace: values[0],
}
}
return types.NamespacedName{}
}