/
controller_base.go
331 lines (283 loc) · 12 KB
/
controller_base.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
/*
Copyright 2019 The OpenEBS 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 cstorvolumeclaim
import (
"fmt"
"time"
apis "github.com/openebs/maya/pkg/apis/openebs.io/v1alpha1"
clientset "github.com/openebs/maya/pkg/client/generated/clientset/versioned"
openebsScheme "github.com/openebs/maya/pkg/client/generated/clientset/versioned/scheme"
informers "github.com/openebs/maya/pkg/client/generated/informers/externalversions"
listers "github.com/openebs/maya/pkg/client/generated/listers/openebs.io/v1alpha1"
ndmclientset "github.com/openebs/maya/pkg/client/generated/openebs.io/ndm/v1alpha1/clientset/internalclientset"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/scheme"
typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog"
)
const controllerAgentName = "cstorvolumeclaim-controller"
// CVCController is the controller implementation for CVC resources
type CVCController struct {
// kubeclientset is a standard kubernetes clientset
kubeclientset kubernetes.Interface
// clientset is a openebs custom resource package generated for custom API group.
clientset clientset.Interface
// ndmclientset is a ndm custom resource package generated for custom API group.
ndmclientset ndmclientset.Interface
cvcLister listers.CStorVolumeClaimLister
cvLister listers.CStorVolumeLister
cvrLister listers.CStorVolumeReplicaLister
cvrSynced cache.InformerSynced
cspLister listers.CStorPoolLister
// cvcSynced is used for caches sync to get populated
cvcSynced cache.InformerSynced
// Store is a generic object storage interface. Reflector knows how to watch a server
// and update a store. A generic store is provided, which allows Reflector to be used
// as a local caching system, and an LRU store, which allows Reflector to work like a
// queue of items yet to be processed.
cvcStore cache.Store
// workqueue is a rate limited work queue. This is used to queue work to be
// processed instead of performing it as soon as a change happens. This
// means we can ensure we only process a fixed amount of resources at a
// time, and makes it easy to ensure we are never processing the same item
// simultaneously in two different workers.
workqueue workqueue.RateLimitingInterface
// recorder is an event recorder for recording Event resources to the
// Kubernetes API.
recorder record.EventRecorder
}
// CVCControllerBuilder is the builder object for controller.
type CVCControllerBuilder struct {
CVCController *CVCController
}
// NewCVCControllerBuilder returns an empty instance of controller builder.
func NewCVCControllerBuilder() *CVCControllerBuilder {
return &CVCControllerBuilder{
CVCController: &CVCController{},
}
}
// withKubeClient fills kube client to controller object.
func (cb *CVCControllerBuilder) withKubeClient(ks kubernetes.Interface) *CVCControllerBuilder {
cb.CVCController.kubeclientset = ks
return cb
}
// withOpenEBSClient fills openebs client to controller object.
func (cb *CVCControllerBuilder) withOpenEBSClient(cs clientset.Interface) *CVCControllerBuilder {
cb.CVCController.clientset = cs
return cb
}
// withNDMClient fills ndm client to controller object.
func (cb *CVCControllerBuilder) withNDMClient(ndmcs ndmclientset.Interface) *CVCControllerBuilder {
cb.CVCController.ndmclientset = ndmcs
return cb
}
// withCVCLister fills cvc lister to controller object.
func (cb *CVCControllerBuilder) withCVCLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
cvcInformer := sl.Openebs().V1alpha1().CStorVolumeClaims()
cb.CVCController.cvcLister = cvcInformer.Lister()
return cb
}
// withCVLister fills cv lister to controller object.
func (cb *CVCControllerBuilder) withCVLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
cvInformer := sl.Openebs().V1alpha1().CStorVolumes()
cb.CVCController.cvLister = cvInformer.Lister()
return cb
}
// withCVRLister fills cvr lister to controller object.
func (cb *CVCControllerBuilder) withCVRLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
cvrInformer := sl.Openebs().V1alpha1().CStorVolumeReplicas()
cb.CVCController.cvrLister = cvrInformer.Lister()
return cb
}
// withCVRLister fills cvr lister to controller object.
func (cb *CVCControllerBuilder) withCVRInformerSync(sl informers.SharedInformerFactory) *CVCControllerBuilder {
cvrInformer := sl.Openebs().V1alpha1().CStorVolumeReplicas()
cb.CVCController.cvrSynced = cvrInformer.Informer().HasSynced
return cb
}
// withCSPLister fills csp lister to controller object.
func (cb *CVCControllerBuilder) withCSPLister(sl informers.SharedInformerFactory) *CVCControllerBuilder {
cspInformer := sl.Openebs().V1alpha1().CStorPools()
cb.CVCController.cspLister = cspInformer.Lister()
return cb
}
// withCVCLister returns a Store implemented simply with a map and a lock.
func (cb *CVCControllerBuilder) withCVCStore() *CVCControllerBuilder {
cb.CVCController.cvcStore = cache.NewStore(cache.DeletionHandlingMetaNamespaceKeyFunc)
return cb
}
// withCVCSynced adds object sync information in cache to controller object.
func (cb *CVCControllerBuilder) withCVCSynced(sl informers.SharedInformerFactory) *CVCControllerBuilder {
cvcInformer := sl.Openebs().V1alpha1().CStorVolumeClaims()
cb.CVCController.cvcSynced = cvcInformer.Informer().HasSynced
return cb
}
// withWorkqueue adds workqueue to controller object.
func (cb *CVCControllerBuilder) withWorkqueueRateLimiting() *CVCControllerBuilder {
cb.CVCController.workqueue = workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "CVC")
return cb
}
// withRecorder adds recorder to controller object.
func (cb *CVCControllerBuilder) withRecorder(ks kubernetes.Interface) *CVCControllerBuilder {
klog.V(4).Info("Creating event broadcaster")
eventBroadcaster := record.NewBroadcaster()
eventBroadcaster.StartLogging(klog.Infof)
eventBroadcaster.StartRecordingToSink(&typedcorev1.EventSinkImpl{Interface: ks.CoreV1().Events("")})
recorder := eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: controllerAgentName})
cb.CVCController.recorder = recorder
return cb
}
// withEventHandler adds event handlers controller object.
func (cb *CVCControllerBuilder) withEventHandler(cvcInformerFactory informers.SharedInformerFactory) *CVCControllerBuilder {
cvcInformer := cvcInformerFactory.Openebs().V1alpha1().CStorVolumeClaims()
// Set up an event handler for when CVC resources change
cvcInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: cb.CVCController.addCVC,
UpdateFunc: cb.CVCController.updateCVC,
DeleteFunc: cb.CVCController.deleteCVC,
})
return cb
}
// Build returns a controller instance.
func (cb *CVCControllerBuilder) Build() (*CVCController, error) {
err := openebsScheme.AddToScheme(scheme.Scheme)
if err != nil {
return nil, err
}
return cb.CVCController, nil
}
// addCVC is the add event handler for CstorVolumeClaim
func (c *CVCController) addCVC(obj interface{}) {
cvc, ok := obj.(*apis.CStorVolumeClaim)
if !ok {
runtime.HandleError(fmt.Errorf("Couldn't get cvc object %#v", obj))
return
}
klog.V(4).Infof("Queuing CVC %s for add event", cvc.Name)
c.enqueueCVC(cvc)
}
// updateCVC is the update event handler for CstorVolumeClaim
func (c *CVCController) updateCVC(oldObj, newObj interface{}) {
newCVC, ok := newObj.(*apis.CStorVolumeClaim)
if !ok {
runtime.HandleError(fmt.Errorf("Couldn't get cvc object %#v", newCVC))
return
}
c.enqueueCVC(newCVC)
}
// deleteCVC is the delete event handler for CstorVolumeClaim
func (c *CVCController) deleteCVC(obj interface{}) {
cvc, ok := obj.(*apis.CStorVolumeClaim)
if !ok {
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
runtime.HandleError(fmt.Errorf("Couldn't get object from tombstone %#v", obj))
return
}
cvc, ok = tombstone.Obj.(*apis.CStorVolumeClaim)
if !ok {
runtime.HandleError(fmt.Errorf("Tombstone contained object that is not a cstorvolumeclaim %#v", obj))
return
}
}
klog.V(4).Infof("Deleting cstorvolumeclaim %s", cvc.Name)
c.enqueueCVC(cvc)
}
// Run will set up the event handlers for types we are interested in, as well
// as syncing informer caches and starting workers. It will block until stopCh
// is closed, at which point it will shutdown the workqueue and wait for
// workers to finish processing their current work items.
func (c *CVCController) Run(threadiness int, stopCh <-chan struct{}) {
defer runtime.HandleCrash()
defer c.workqueue.ShutDown()
// Start the informer factories to begin populating the informer caches
klog.Info("Starting CstorVolumeClaim controller")
// Wait for the k8s caches to be synced before starting workers
klog.Info("Waiting for informer caches to sync")
if ok := cache.WaitForCacheSync(stopCh, c.cvcSynced); !ok {
klog.Errorf("failed to sync CstorVolumeClaim caches")
return
}
klog.Info("Starting CstorVolumeClaim workers")
// Launch worker to process CVC resources
// Threadiness will decide the number of workers you want to launch to process work items from queue
for i := 0; i < threadiness; i++ {
go wait.Until(c.runWorker, time.Second, stopCh)
}
klog.Info("Started CstorVolumeClaim workers")
<-stopCh
klog.Info("Shutting down CstorVolumeClaim workers")
}
// runWorker is a long-running function that will continually call the
// processNextWorkItem function in order to read and process a message on the
// workqueue.
func (c *CVCController) runWorker() {
for c.processNextWorkItem() {
}
}
// processNextWorkItem will read a single work item off the workqueue and
// attempt to process it, by calling the syncHandler.
func (c *CVCController) processNextWorkItem() bool {
obj, shutdown := c.workqueue.Get()
if shutdown {
return false
}
// We wrap this block in a func so we can defer c.workqueue.Done.
err := func(obj interface{}) error {
// We call Done here so the workqueue knows we have finished
// processing this item. We also must remember to call Forget if we
// do not want this work item being re-queued. For example, we do
// not call Forget if a transient error occurs, instead the item is
// put back on the workqueue and attempted again after a back-off
// period.
defer c.workqueue.Done(obj)
var key string
var ok bool
// We expect strings to come off the workqueue. These are of the
// form namespace/name. We do this as the delayed nature of the
// workqueue means the items in the informer cache may actually be
// more up to date that when the item was initially put onto the
// workqueue.
if key, ok = obj.(string); !ok {
// As the item in the workqueue is actually invalid, we call
// Forget here else we'd go into a loop of attempting to
// process a work item that is invalid.
c.workqueue.Forget(obj)
runtime.HandleError(fmt.Errorf("expected string in workqueue but got %#v", obj))
return nil
}
// Run the syncHandler, passing it the namespace/name string of the
// CVC resource to be synced.
if err := c.syncHandler(key); err != nil {
// Put the item back on the workqueue to handle any transient errors.
c.workqueue.AddRateLimited(key)
return fmt.Errorf("error syncing '%s': %s, requeuing", key, err.Error())
}
// Finally, if no error occurs we Forget this item so it does not
// get queued again until another change happens.
c.workqueue.Forget(obj)
klog.V(4).Infof("Successfully synced '%s'", key)
return nil
}(obj)
if err != nil {
runtime.HandleError(err)
return true
}
return true
}