-
Notifications
You must be signed in to change notification settings - Fork 90
/
target_accessor.go
324 lines (263 loc) · 9.99 KB
/
target_accessor.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
/*
Copyright 2022 The Katalyst 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 target
import (
"context"
"fmt"
"time"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/labels"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/dynamic/dynamicinformer"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog/v2"
"github.com/kubewharf/katalyst-core/pkg/util/native"
)
const (
targetWorkerCount = 1
)
// KatalystCustomConfigTargetAccessor is to handle creation/update/delete event of target unstructured obj,
// and it can trigger obj re-sync by calling Enqueue function
type KatalystCustomConfigTargetAccessor interface {
// Start to reconcile obj of kcc target type
Start()
// Stop reconcile obj of kcc target type
Stop()
// Enqueue obj of kcc target type to the work queue
Enqueue(name string, obj *unstructured.Unstructured)
// List all obj (with DeepCopy) of kcc target type according selector
List(selector labels.Selector) ([]*unstructured.Unstructured, error)
// Get obj (with DeepCopy) of kcc target type by namespace and name
Get(namespace, name string) (*unstructured.Unstructured, error)
}
type DummyKatalystCustomConfigTargetAccessor struct{}
func (d DummyKatalystCustomConfigTargetAccessor) Start() {}
func (d DummyKatalystCustomConfigTargetAccessor) Stop() {}
func (d DummyKatalystCustomConfigTargetAccessor) Enqueue(_ *unstructured.Unstructured) {}
func (d DummyKatalystCustomConfigTargetAccessor) List(_ labels.Selector) ([]*unstructured.Unstructured, error) {
return nil, nil
}
func (d DummyKatalystCustomConfigTargetAccessor) Get(_, _ string) (*unstructured.Unstructured, error) {
return nil, nil
}
// KatalystCustomConfigTargetHandlerFunc func to process the obj in the work queue
type KatalystCustomConfigTargetHandlerFunc func(gvr metav1.GroupVersionResource, target *unstructured.Unstructured) error
// targetHandlerFuncWithSyncQueue is used to store the handler and
// syncing queue for each kcc-target
type targetHandlerFuncWithSyncQueue struct {
targetHandlerFunc KatalystCustomConfigTargetHandlerFunc
syncQueue workqueue.RateLimitingInterface
}
type RealKatalystCustomConfigTargetAccessor struct {
stopCh chan struct{}
ctx context.Context
gvr metav1.GroupVersionResource
// targetLister can list/get target resource from the targetInformer's store
targetLister cache.GenericLister
targetInformer cache.SharedIndexInformer
// targetHandlerFuncWithSyncQueueMap is used to store the handler and syncing
// queue for each kcc-target
targetHandlerFuncWithSyncQueueMap map[string]targetHandlerFuncWithSyncQueue
}
// NewRealKatalystCustomConfigTargetAccessor returns a new KatalystCustomConfigTargetAccessor
// which is used to handle creation/update/delete event of target unstructured obj, and it can
// trigger obj re-sync by calling Enqueue function of the returned accessor.
func NewRealKatalystCustomConfigTargetAccessor(
gvr metav1.GroupVersionResource,
client dynamic.Interface,
handlerInfos map[string]KatalystCustomConfigTargetHandlerFunc,
) (*RealKatalystCustomConfigTargetAccessor, error) {
dynamicInformer := dynamicinformer.NewFilteredDynamicInformer(client,
native.ToSchemaGVR(gvr.Group, gvr.Version, gvr.Resource),
metav1.NamespaceAll,
time.Hour*24,
cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc},
nil)
k := &RealKatalystCustomConfigTargetAccessor{
stopCh: make(chan struct{}),
gvr: gvr,
targetLister: dynamicInformer.Lister(),
targetInformer: dynamicInformer.Informer(),
targetHandlerFuncWithSyncQueueMap: make(map[string]targetHandlerFuncWithSyncQueue),
}
k.targetInformer.AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: k.addTargetEventHandle,
UpdateFunc: k.updateTargetEventHandle,
DeleteFunc: k.deleteTargetEventHandle,
})
for name, info := range handlerInfos {
k.targetHandlerFuncWithSyncQueueMap[name] = targetHandlerFuncWithSyncQueue{
targetHandlerFunc: info,
syncQueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(),
name+"-"+gvr.Resource),
}
}
return k, nil
}
func (k *RealKatalystCustomConfigTargetAccessor) Start() {
// run target informer
go k.targetInformer.Run(k.stopCh)
for _, info := range k.targetHandlerFuncWithSyncQueueMap {
for i := 0; i < targetWorkerCount; i++ {
go wait.Until(k.generateWorker(info), time.Second, k.stopCh)
}
}
klog.Infof("target accessor of %s has been started", k.gvr.String())
}
func (k *RealKatalystCustomConfigTargetAccessor) Stop() {
klog.Infof("target accessor of %s is stopping", k.gvr.String())
for _, info := range k.targetHandlerFuncWithSyncQueueMap {
info.syncQueue.ShutDown()
}
close(k.stopCh)
}
// Enqueue will add the obj to the work queue of the target handler, if name is empty,
// it will add the obj to all the work queue of the target handler
func (k *RealKatalystCustomConfigTargetAccessor) Enqueue(name string, obj *unstructured.Unstructured) {
if len(name) == 0 {
k.enqueueTarget(obj)
return
}
if obj == nil {
klog.Warning("trying to enqueue a nil kcc target")
return
}
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err != nil {
utilruntime.HandleError(fmt.Errorf("couldn't get key for object %#v: %v", obj, err))
return
}
info, ok := k.targetHandlerFuncWithSyncQueueMap[name]
if ok {
info.syncQueue.Add(key)
} else {
klog.Warningf("target handler %s not found", name)
}
}
func (k *RealKatalystCustomConfigTargetAccessor) Get(namespace, name string) (*unstructured.Unstructured, error) {
if !k.targetInformer.HasSynced() {
return nil, fmt.Errorf("target targetInformer for %s not synced", k.gvr)
}
if namespace == "" {
obj, err := k.targetLister.Get(name)
if err != nil {
return nil, err
}
return obj.(*unstructured.Unstructured), nil
}
obj, err := k.targetLister.ByNamespace(namespace).Get(name)
if err != nil {
return nil, err
}
return obj.(*unstructured.Unstructured).DeepCopy(), nil
}
func (k *RealKatalystCustomConfigTargetAccessor) List(selector labels.Selector) ([]*unstructured.Unstructured, error) {
if !k.targetInformer.HasSynced() {
return nil, fmt.Errorf("target targetInformer for %s not synced", k.gvr)
}
list, err := k.targetLister.List(selector)
if err != nil {
return nil, err
}
ret := make([]*unstructured.Unstructured, 0, len(list))
for _, o := range list {
ret = append(ret, o.(*unstructured.Unstructured).DeepCopy())
}
return ret, nil
}
func (k *RealKatalystCustomConfigTargetAccessor) addTargetEventHandle(obj interface{}) {
t, ok := obj.(*unstructured.Unstructured)
if !ok {
klog.Errorf("cannot convert obj to *unstructured.Unstructured: %v", obj)
return
}
klog.V(4).Infof("notice addition of %s, %s", k.gvr, native.GenerateUniqObjectNameKey(t))
k.enqueueTarget(t)
}
func (k *RealKatalystCustomConfigTargetAccessor) updateTargetEventHandle(_, new interface{}) {
t, ok := new.(*unstructured.Unstructured)
if !ok {
klog.Errorf("cannot convert obj to *unstructured.Unstructured: %v", new)
return
}
klog.V(4).Infof("notice update of %s, %s", k.gvr, native.GenerateUniqObjectNameKey(t))
k.enqueueTarget(t)
}
func (k *RealKatalystCustomConfigTargetAccessor) deleteTargetEventHandle(obj interface{}) {
t, ok := obj.(*unstructured.Unstructured)
if !ok {
klog.Errorf("cannot convert obj to *unstructured.Unstructured: %v", obj)
return
}
klog.V(4).Infof("notice delete of %s, %s", k.gvr, native.GenerateUniqObjectNameKey(t))
k.enqueueTarget(t)
}
func (k *RealKatalystCustomConfigTargetAccessor) enqueueTarget(obj *unstructured.Unstructured) {
if obj == nil {
klog.Warning("trying to enqueue a nil kcc target")
return
}
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err != nil {
utilruntime.HandleError(fmt.Errorf("couldn't get key for object %#v: %v", obj, err))
return
}
for _, info := range k.targetHandlerFuncWithSyncQueueMap {
info.syncQueue.Add(key)
}
}
func (k *RealKatalystCustomConfigTargetAccessor) generateWorker(queue targetHandlerFuncWithSyncQueue) func() {
return func() {
for k.processNextKatalystCustomConfigTargetItem(queue.syncQueue, queue.targetHandlerFunc) {
}
}
}
func (k *RealKatalystCustomConfigTargetAccessor) processNextKatalystCustomConfigTargetItem(queue workqueue.RateLimitingInterface, handler KatalystCustomConfigTargetHandlerFunc) bool {
key, quit := queue.Get()
if quit {
return false
}
defer queue.Done(key)
err := k.syncHandler(key.(string), handler)
if err == nil {
queue.Forget(key)
return true
}
klog.Errorf("sync kcc target %q failed with %v", key, err)
queue.AddRateLimited(key)
return true
}
func (k *RealKatalystCustomConfigTargetAccessor) syncHandler(key string, handlerFunc KatalystCustomConfigTargetHandlerFunc) error {
if !k.targetInformer.HasSynced() {
return fmt.Errorf("target targetInformer for %s not synced", k.gvr)
}
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
klog.Errorf("failed to split namespace and name from key %s", key)
return err
}
target, err := k.Get(namespace, name)
if apierrors.IsNotFound(err) {
klog.Warningf("%s resource %s is not found", k.gvr.String(), key)
return nil
} else if err != nil {
klog.Errorf("%s resource %s get error: %v", k.gvr.String(), key, err)
return err
}
return handlerFunc(k.gvr, target)
}