/
controller.go
347 lines (293 loc) · 10.3 KB
/
controller.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
package external
import (
"context"
"fmt"
"time"
customapis "github.com/notrainy/operator-learning/pkg/apis/stable/v1beta1"
"github.com/notrainy/operator-learning/pkg/consts"
customClient "github.com/notrainy/operator-learning/pkg/generated/clientset/versioned"
customscheme "github.com/notrainy/operator-learning/pkg/generated/clientset/versioned/scheme"
customInformers "github.com/notrainy/operator-learning/pkg/generated/informers/externalversions/stable/v1beta1"
customlisters "github.com/notrainy/operator-learning/pkg/generated/listers/stable/v1beta1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
appsinformers "k8s.io/client-go/informers/apps/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/scheme"
typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
appslisters "k8s.io/client-go/listers/apps/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog/v2"
)
const (
controllerAgentName = "redis-controller"
rateLimitQueueName = "custom-queue"
)
// Controller 自定义实现的Controller
type Controller struct {
// k8sClientSet is a standard kubernetes clientset
k8sClientSet kubernetes.Interface
// customClientSet is a custom clientset
customClientSet customClient.Interface
deploymentLister appslisters.DeploymentLister
// a function to determine if an informer has synced
deploymentSynced cache.InformerSynced
customResourceLister customlisters.RedisLister
customResourceSynced cache.InformerSynced
// 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
}
// NewController 自定义的创建controller的函数
func NewController(
ctx context.Context,
k8sClientSet kubernetes.Interface,
customClientSet customClient.Interface,
k8sInformer appsinformers.DeploymentInformer,
informer customInformers.RedisInformer) *Controller {
logger := klog.FromContext(ctx)
utilruntime.Must(customscheme.AddToScheme(scheme.Scheme))
logger.V(4).Info("event broadcaster created...")
eventBroadcaster := record.NewBroadcaster()
eventBroadcaster.StartStructuredLogging(0)
eventBroadcaster.StartRecordingToSink(&typedcorev1.EventSinkImpl{Interface: k8sClientSet.CoreV1().Events("")})
recorder := eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: controllerAgentName})
controller := &Controller{
k8sClientSet: k8sClientSet,
customClientSet: customClientSet,
deploymentLister: k8sInformer.Lister(),
deploymentSynced: k8sInformer.Informer().HasSynced,
customResourceLister: informer.Lister(),
customResourceSynced: informer.Informer().HasSynced,
workqueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), rateLimitQueueName),
recorder: recorder,
}
logger.Info("setting handlers...")
// set up handlers when custom resource changes
informer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
controller.enqueueCRD(obj)
},
UpdateFunc: func(_, newObj interface{}) {
controller.enqueueCRD(newObj)
},
})
// Set up an event handler for when Deployment resources change. This
// handler will lookup the owner of the given Deployment, and if it is
// owned by a Foo resource then the handler will enqueue that Foo resource for
// processing. This way, we don't need to implement custom logic for
// handling Deployment resources.
k8sInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: controller.handleObject,
UpdateFunc: func(oldObj, newObj interface{}) {
newDepl := newObj.(*appsv1.Deployment)
oldDepl := oldObj.(*appsv1.Deployment)
if newDepl.ResourceVersion == oldDepl.ResourceVersion {
return
}
controller.handleObject(newObj)
},
DeleteFunc: controller.handleObject,
})
logger.Info("handlers setted")
return controller
}
// Run controller执行
func (c *Controller) Run(ctx context.Context, workers int) error {
defer utilruntime.HandleCrash()
defer c.workqueue.ShutDown()
logger := klog.FromContext(ctx)
if ok := cache.WaitForCacheSync(ctx.Done(), c.deploymentSynced, c.customResourceSynced); !ok {
return fmt.Errorf("failed to wait for cache to sync")
}
logger.Info("starting workers")
for i := 0; i < workers; i++ {
go wait.UntilWithContext(ctx, c.runWorker, time.Second)
}
logger.Info("started workers")
<-ctx.Done()
logger.Info("shutdown workers")
return nil
}
func (c *Controller) runWorker(ctx context.Context) {
for c.processNextWorkItem(ctx) {
}
}
// enqueueCRD takes a CRD resource and converts it into a namespace/name
// string which is then put onto the work queue. This method should *not* be
// passed resources of any type other than CRD.
func (c *Controller) enqueueCRD(obj interface{}) {
var (
key string
err error
)
if key, err = cache.MetaNamespaceKeyFunc(obj); err != nil {
utilruntime.HandleError(err)
return
}
c.workqueue.Add(key)
}
// processNextWorkItem will read a single work item off the workqueue and
// attempt to process it, by calling the syncHandler.
func (c *Controller) processNextWorkItem(ctx context.Context) bool {
obj, quit := c.workqueue.Get()
if quit {
return false
}
logger := klog.FromContext(ctx)
err := func(object interface{}) error {
defer c.workqueue.Done(object)
var (
key string
ok bool
)
if key, ok = object.(string); !ok {
c.workqueue.Forget(object)
utilruntime.HandleError(fmt.Errorf("expected string in workqueue but got %v", object))
return nil
}
if err := c.syncHandler(ctx, key); err != nil {
c.workqueue.AddRateLimited(key)
return fmt.Errorf("error syncing '%s': %s, requeuing", key, err.Error())
}
c.workqueue.Forget(object)
logger.Info("Successfully synced", "resourceName", key)
return nil
}(obj)
if err != nil {
utilruntime.HandleError(err)
return true
}
return true
}
// handleObject will take any resource implementing metav1.Object and attempt
// to find the CRD resource that 'owns' it. It does this by looking at the
// objects metadata.ownerReferences field for an appropriate OwnerReference.
// It then enqueues that CRD resource to be processed. If the object does not
// have an appropriate OwnerReference, it will simply be skipped.
func (c *Controller) handleObject(obj interface{}) {
var (
object metav1.Object
ok bool
)
logger := klog.FromContext(context.Background())
if object, ok = obj.(metav1.Object); !ok {
// if is deleted object, recover it
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
logger.V(4).Info("object is neither the metav1.object nor the deleted object")
utilruntime.HandleError(fmt.Errorf("error decoding object, invalid type"))
return
}
object, ok = tombstone.Obj.(metav1.Object)
if !ok {
utilruntime.HandleError(fmt.Errorf("error decoding object tombstone, invalid type"))
return
}
logger.V(4).Info("recovered the deleted object")
}
logger.V(4).Info("processing the object", "object", klog.KObj(object))
if ownerRef := metav1.GetControllerOf(object); ownerRef != nil {
if ownerRef.Kind != consts.CRDKind {
return
}
crd, err := c.customResourceLister.Redises(object.GetNamespace()).Get(ownerRef.Name)
if err != nil {
logger.V(4).Info("ignored the object", "object", klog.KObj(object))
return
}
c.enqueueCRD(crd)
}
}
// syncHandler 处理
func (c *Controller) syncHandler(ctx context.Context, key string) error {
// get namesapce and name from key
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
utilruntime.HandleError(fmt.Errorf("invalid resource key %s", key))
return nil
}
// get the CRD resource by namespace/name
crd, err := c.customResourceLister.Redises(namespace).Get(name)
if err != nil {
if k8serrors.IsNotFound(err) {
utilruntime.HandleError(fmt.Errorf("resource %s in work queue no longer exists", key))
return nil
}
return err
}
// get deployment name of the crd
deploymentName := crd.Spec.DeploymentName
if deploymentName == "" {
utilruntime.HandleError(fmt.Errorf("%s deployment name must be specified", key))
return nil
}
// create/update the deployment for the CRD
deployment, err := c.deploymentLister.Deployments(crd.Namespace).Get(deploymentName)
if k8serrors.IsNotFound(err) {
deployment, err = c.k8sClientSet.AppsV1().Deployments(crd.Namespace).Create(context.TODO(), newDeployment(crd), metav1.CreateOptions{})
if err != nil {
utilruntime.HandleError(fmt.Errorf("create deployment %s %s failed", crd.Namespace, deploymentName))
}
}
if err != nil {
return err
}
if !metav1.IsControlledBy(deployment, crd) {
return fmt.Errorf("deployment %s not controlled by the resource %s", deployment.Name, crd.Name)
}
if crd.Spec.Replicas != nil && *crd.Spec.Replicas != *deployment.Spec.Replicas {
deployment, err = c.k8sClientSet.AppsV1().Deployments(crd.Namespace).Update(context.TODO(), newDeployment(crd), metav1.UpdateOptions{})
if err != nil {
return err
}
}
c.recorder.Event(crd, corev1.EventTypeNormal, "Synced", "crd synced successfully")
return nil
}
func newDeployment(r *customapis.Redis) *appsv1.Deployment {
labels := map[string]string{
"app": "redis",
}
deploy := &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: r.Spec.DeploymentName,
Namespace: r.Namespace,
OwnerReferences: []metav1.OwnerReference{
*metav1.NewControllerRef(r, customapis.SchemeGroupVersion.WithKind(consts.CRDKind)),
},
},
Spec: appsv1.DeploymentSpec{
Replicas: r.Spec.Replicas,
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: labels,
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Image: r.Spec.Image,
Name: "test",
},
},
},
},
},
}
return deploy
}