/
controller.go
456 lines (413 loc) · 16.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
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
package agentdeploy
import (
"context"
"fmt"
"strings"
"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/runtime"
errorsutil "k8s.io/apimachinery/pkg/util/errors"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog/v2"
addonapiv1alpha1 "open-cluster-management.io/api/addon/v1alpha1"
addonv1alpha1client "open-cluster-management.io/api/client/addon/clientset/versioned"
addoninformerv1alpha1 "open-cluster-management.io/api/client/addon/informers/externalversions/addon/v1alpha1"
addonlisterv1alpha1 "open-cluster-management.io/api/client/addon/listers/addon/v1alpha1"
clusterinformers "open-cluster-management.io/api/client/cluster/informers/externalversions/cluster/v1"
clusterlister "open-cluster-management.io/api/client/cluster/listers/cluster/v1"
workv1client "open-cluster-management.io/api/client/work/clientset/versioned"
workinformers "open-cluster-management.io/api/client/work/informers/externalversions/work/v1"
clusterv1 "open-cluster-management.io/api/cluster/v1"
workapiv1 "open-cluster-management.io/api/work/v1"
workapplier "open-cluster-management.io/sdk-go/pkg/apis/work/v1/applier"
workbuilder "open-cluster-management.io/sdk-go/pkg/apis/work/v1/builder"
"open-cluster-management.io/sdk-go/pkg/patcher"
"open-cluster-management.io/addon-framework/pkg/addonmanager/constants"
"open-cluster-management.io/addon-framework/pkg/agent"
"open-cluster-management.io/addon-framework/pkg/basecontroller/factory"
"open-cluster-management.io/addon-framework/pkg/index"
)
const (
controllerName = "addon-deploy-controller"
)
// addonDeployController deploy addon agent resources on the managed cluster.
type addonDeployController struct {
workApplier *workapplier.WorkApplier
workBuilder *workbuilder.WorkBuilder
addonClient addonv1alpha1client.Interface
managedClusterLister clusterlister.ManagedClusterLister
managedClusterAddonLister addonlisterv1alpha1.ManagedClusterAddOnLister
managedClusterAddonIndexer cache.Indexer
workIndexer cache.Indexer
agentAddons map[string]agent.AgentAddon
queue workqueue.RateLimitingInterface
}
func NewAddonDeployController(
workClient workv1client.Interface,
addonClient addonv1alpha1client.Interface,
clusterInformers clusterinformers.ManagedClusterInformer,
addonInformers addoninformerv1alpha1.ManagedClusterAddOnInformer,
workInformers workinformers.ManifestWorkInformer,
agentAddons map[string]agent.AgentAddon,
) factory.Controller {
syncCtx := factory.NewSyncContext(controllerName)
c := &addonDeployController{
queue: syncCtx.Queue(),
workApplier: workapplier.NewWorkApplierWithTypedClient(workClient, workInformers.Lister()),
// the default manifest limit in a work is 500k
// TODO: make the limit configurable
workBuilder: workbuilder.NewWorkBuilder().WithManifestsLimit(500 * 1024),
addonClient: addonClient,
managedClusterLister: clusterInformers.Lister(),
managedClusterAddonLister: addonInformers.Lister(),
managedClusterAddonIndexer: addonInformers.Informer().GetIndexer(),
workIndexer: workInformers.Informer().GetIndexer(),
agentAddons: agentAddons,
}
f := factory.New().WithSyncContext(syncCtx).
WithFilteredEventsInformersQueueKeysFunc(
func(obj runtime.Object) []string {
key, _ := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
return []string{key}
},
func(obj interface{}) bool {
accessor, _ := meta.Accessor(obj)
if _, ok := c.agentAddons[accessor.GetName()]; !ok {
return false
}
return true
},
addonInformers.Informer()).
WithFilteredEventsInformersQueueKeysFunc(
func(obj runtime.Object) []string {
accessor, _ := meta.Accessor(obj)
// in hosted mode, need get the addon namespace from the AddonNamespaceLabel, because
// the namespaces of manifestWork and addon may be different.
// in default mode, the addon and manifestWork are in the cluster namespace.
if addonNamespace, ok := accessor.GetLabels()[addonapiv1alpha1.AddonNamespaceLabelKey]; ok {
return []string{fmt.Sprintf("%s/%s", addonNamespace, accessor.GetLabels()[addonapiv1alpha1.AddonLabelKey])}
}
return []string{fmt.Sprintf("%s/%s", accessor.GetNamespace(), accessor.GetLabels()[addonapiv1alpha1.AddonLabelKey])}
},
func(obj interface{}) bool {
accessor, _ := meta.Accessor(obj)
if accessor.GetLabels() == nil {
return false
}
// only watch the addon deploy/hook manifestWorks here.
addonName, ok := accessor.GetLabels()[addonapiv1alpha1.AddonLabelKey]
if !ok {
return false
}
if _, ok := c.agentAddons[addonName]; !ok {
return false
}
if strings.HasPrefix(accessor.GetName(), constants.DeployWorkNamePrefix(addonName)) ||
strings.HasPrefix(accessor.GetName(), constants.PreDeleteHookWorkName(addonName)) {
return true
}
return false
},
workInformers.Informer(),
).
WithSync(c.sync)
if c.watchManagedCluster(clusterInformers) {
f.WithBareInformers(clusterInformers.Informer())
}
return f.ToController(controllerName)
}
func (c addonDeployController) watchManagedCluster(clusterInformers clusterinformers.ManagedClusterInformer) bool {
var filters []func(old, new *clusterv1.ManagedCluster) bool
for _, addon := range c.agentAddons {
if addon.GetAgentAddonOptions().AgentDeployTriggerClusterFilter != nil {
filters = append(filters, addon.GetAgentAddonOptions().AgentDeployTriggerClusterFilter)
}
}
if len(filters) == 0 {
return false
}
_, err := clusterInformers.Informer().AddEventHandler(
cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {},
UpdateFunc: func(oldObj, newObj interface{}) {
oldCluster, ook := oldObj.(*clusterv1.ManagedCluster)
newCluster, nok := newObj.(*clusterv1.ManagedCluster)
if !ook || !nok {
return
}
// enqueue the addon if one of cluster filters is matched.
for _, filter := range filters {
if filter(oldCluster, newCluster) {
c.enqueueAddOnsByCluster()(newObj)
break
}
}
},
DeleteFunc: func(obj interface{}) {},
},
)
if err != nil {
utilruntime.HandleError(err)
}
return true
}
func (c *addonDeployController) enqueueAddOnsByCluster() func(obj interface{}) {
return func(obj interface{}) {
accessor, _ := meta.Accessor(obj)
addons, err := c.managedClusterAddonIndexer.ByIndex(index.ManagedClusterAddonByNamespace, accessor.GetName())
if err != nil {
utilruntime.HandleError(fmt.Errorf("failed to get addons by cluster %s , err: %v", accessor.GetName(), err))
return
}
var addonNames []string
for _, addon := range addons {
if addon == nil {
continue
}
key, _ := cache.MetaNamespaceKeyFunc(addon)
c.queue.Add(key)
addonNames = append(addonNames, key)
}
klog.V(5).Infof("Enqueue addons by cluster %s, addons: %v", accessor.GetName(), addonNames)
}
}
type addonDeploySyncer interface {
sync(ctx context.Context, syncCtx factory.SyncContext,
cluster *clusterv1.ManagedCluster,
addon *addonapiv1alpha1.ManagedClusterAddOn) (*addonapiv1alpha1.ManagedClusterAddOn, error)
}
func (c *addonDeployController) getWorksByAddonFn(index string) func(addonName, addonNamespace string) ([]*workapiv1.ManifestWork, error) {
return func(addonName, addonNamespace string) ([]*workapiv1.ManifestWork, error) {
items, err := c.workIndexer.ByIndex(index, fmt.Sprintf("%s/%s", addonNamespace, addonName))
if err != nil {
return nil, err
}
ret := make([]*workapiv1.ManifestWork, 0, len(items))
for _, item := range items {
ret = append(ret, item.(*workapiv1.ManifestWork))
}
return ret, nil
}
}
func (c *addonDeployController) sync(ctx context.Context, syncCtx factory.SyncContext, key string) error {
klog.V(4).Infof("%s sync addon key %s", controllerName, key)
clusterName, addonName, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
// ignore addon whose key is not in format: namespace/name
return nil
}
agentAddon, ok := c.agentAddons[addonName]
if !ok {
return nil
}
addon, err := c.managedClusterAddonLister.ManagedClusterAddOns(clusterName).Get(addonName)
if errors.IsNotFound(err) {
// need to find a way to clean up cache by addon
return nil
}
if err != nil {
return err
}
// to deploy agents if there is RegistrationApplied condition.
if meta.FindStatusCondition(addon.Status.Conditions, addonapiv1alpha1.ManagedClusterAddOnRegistrationApplied) == nil {
return nil
}
cluster, err := c.managedClusterLister.Get(clusterName)
if errors.IsNotFound(err) {
// the managedCluster is nil in this case,and sync cannot handle nil managedCluster.
// TODO: consider to force delete the addon and its deploy manifestWorks.
return nil
}
if err != nil {
return err
}
syncers := []addonDeploySyncer{
&defaultSyncer{
buildWorks: c.buildDeployManifestWorks,
applyWork: c.applyWork,
getWorkByAddon: c.getWorksByAddonFn(index.ManifestWorkByAddon),
deleteWork: c.workApplier.Delete,
agentAddon: agentAddon,
},
&hostedSyncer{
buildWorks: c.buildDeployManifestWorks,
applyWork: c.applyWork,
deleteWork: c.workApplier.Delete,
getCluster: c.managedClusterLister.Get,
getWorkByAddon: c.getWorksByAddonFn(index.ManifestWorkByHostedAddon),
agentAddon: agentAddon},
&defaultHookSyncer{
buildWorks: c.buildHookManifestWork,
applyWork: c.applyWork,
agentAddon: agentAddon},
&hostedHookSyncer{
buildWorks: c.buildHookManifestWork,
applyWork: c.applyWork,
deleteWork: c.workApplier.Delete,
getCluster: c.managedClusterLister.Get,
getWorkByAddon: c.getWorksByAddonFn(index.ManifestWorkHookByHostedAddon),
agentAddon: agentAddon},
&healthCheckSyncer{
getWorkByAddon: c.getWorksByAddonFn(index.ManifestWorkByAddon),
agentAddon: agentAddon,
},
}
oldAddon := addon
addon = addon.DeepCopy()
var errs []error
for _, s := range syncers {
var err error
addon, err = s.sync(ctx, syncCtx, cluster, addon)
if err != nil {
errs = append(errs, err)
}
}
if err = c.updateAddon(ctx, addon, oldAddon); err != nil {
return err
}
return errorsutil.NewAggregate(errs)
}
// updateAddon updates finalizers and conditions of addon.
// to avoid conflict updateAddon updates finalizers firstly if finalizers has change.
func (c *addonDeployController) updateAddon(ctx context.Context, new, old *addonapiv1alpha1.ManagedClusterAddOn) error {
if !equality.Semantic.DeepEqual(new.GetFinalizers(), old.GetFinalizers()) {
_, err := c.addonClient.AddonV1alpha1().ManagedClusterAddOns(new.Namespace).Update(ctx, new, metav1.UpdateOptions{})
return err
}
addonPatcher := patcher.NewPatcher[
*addonapiv1alpha1.ManagedClusterAddOn,
addonapiv1alpha1.ManagedClusterAddOnSpec,
addonapiv1alpha1.ManagedClusterAddOnStatus](c.addonClient.AddonV1alpha1().ManagedClusterAddOns(new.Namespace))
_, err := addonPatcher.PatchStatus(ctx, new, new.Status, old.Status)
return err
}
func (c *addonDeployController) applyWork(ctx context.Context, appliedType string,
work *workapiv1.ManifestWork, addon *addonapiv1alpha1.ManagedClusterAddOn) (*workapiv1.ManifestWork, error) {
work, err := c.workApplier.Apply(ctx, work)
if err != nil {
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: appliedType,
Status: metav1.ConditionFalse,
Reason: addonapiv1alpha1.AddonManifestAppliedReasonWorkApplyFailed,
Message: fmt.Sprintf("failed to apply manifestWork: %v", err),
})
return work, err
}
// Update addon status based on work's status
WorkAppliedCond := meta.FindStatusCondition(work.Status.Conditions, workapiv1.WorkApplied)
switch {
case WorkAppliedCond == nil:
return work, nil
case WorkAppliedCond.Status == metav1.ConditionTrue:
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: appliedType,
Status: metav1.ConditionTrue,
Reason: addonapiv1alpha1.AddonManifestAppliedReasonManifestsApplied,
Message: "manifests of addon are applied successfully",
})
default:
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: appliedType,
Status: metav1.ConditionFalse,
Reason: addonapiv1alpha1.AddonManifestAppliedReasonManifestsApplyFailed,
Message: "failed to apply the manifests of addon",
})
}
return work, nil
}
func (c *addonDeployController) buildDeployManifestWorks(installMode, workNamespace string,
cluster *clusterv1.ManagedCluster, existingWorks []*workapiv1.ManifestWork,
addon *addonapiv1alpha1.ManagedClusterAddOn) (appliedWorks, deleteWorks []*workapiv1.ManifestWork, err error) {
var appliedType string
var addonWorkBuilder *addonWorksBuilder
agentAddon := c.agentAddons[addon.Name]
if agentAddon == nil {
return nil, nil, fmt.Errorf("failed to get agentAddon")
}
switch installMode {
case constants.InstallModeHosted:
appliedType = addonapiv1alpha1.ManagedClusterAddOnHostingManifestApplied
addonWorkBuilder = newHostingAddonWorksBuilder(agentAddon.GetAgentAddonOptions().HostedModeEnabled, c.workBuilder)
case constants.InstallModeDefault:
appliedType = addonapiv1alpha1.ManagedClusterAddOnManifestApplied
addonWorkBuilder = newAddonWorksBuilder(agentAddon.GetAgentAddonOptions().HostedModeEnabled, c.workBuilder)
default:
return nil, nil, fmt.Errorf("invalid install mode %v", installMode)
}
objects, err := agentAddon.Manifests(cluster, addon)
if err != nil {
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: appliedType,
Status: metav1.ConditionFalse,
Reason: addonapiv1alpha1.AddonManifestAppliedReasonWorkApplyFailed,
Message: fmt.Sprintf("failed to get manifest from agent interface: %v", err),
})
return nil, nil, err
}
if len(objects) == 0 {
return nil, nil, nil
}
manifestOptions := getManifestConfigOption(agentAddon, cluster, addon)
existingWorksCopy := []workapiv1.ManifestWork{}
for _, work := range existingWorks {
existingWorksCopy = append(existingWorksCopy, *work)
}
appliedWorks, deleteWorks, err = addonWorkBuilder.BuildDeployWorks(workNamespace, addon, existingWorksCopy, objects, manifestOptions)
if err != nil {
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: appliedType,
Status: metav1.ConditionFalse,
Reason: addonapiv1alpha1.AddonManifestAppliedReasonWorkApplyFailed,
Message: fmt.Sprintf("failed to build manifestwork: %v", err),
})
return nil, nil, err
}
return appliedWorks, deleteWorks, nil
}
func (c *addonDeployController) buildHookManifestWork(installMode, workNamespace string,
cluster *clusterv1.ManagedCluster, addon *addonapiv1alpha1.ManagedClusterAddOn) (*workapiv1.ManifestWork, error) {
var appliedType string
var addonWorkBuilder *addonWorksBuilder
agentAddon := c.agentAddons[addon.Name]
if agentAddon == nil {
return nil, fmt.Errorf("failed to get agentAddon")
}
switch installMode {
case constants.InstallModeHosted:
appliedType = addonapiv1alpha1.ManagedClusterAddOnHostingManifestApplied
addonWorkBuilder = newHostingAddonWorksBuilder(agentAddon.GetAgentAddonOptions().HostedModeEnabled, c.workBuilder)
case constants.InstallModeDefault:
appliedType = addonapiv1alpha1.ManagedClusterAddOnManifestApplied
addonWorkBuilder = newAddonWorksBuilder(agentAddon.GetAgentAddonOptions().HostedModeEnabled, c.workBuilder)
default:
return nil, fmt.Errorf("invalid install mode %v", installMode)
}
objects, err := agentAddon.Manifests(cluster, addon)
if err != nil {
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: appliedType,
Status: metav1.ConditionFalse,
Reason: addonapiv1alpha1.AddonManifestAppliedReasonWorkApplyFailed,
Message: fmt.Sprintf("failed to get manifest from agent interface: %v", err),
})
return nil, err
}
if len(objects) == 0 {
return nil, nil
}
hookWork, err := addonWorkBuilder.BuildHookWork(workNamespace, addon, objects)
if err != nil {
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: appliedType,
Status: metav1.ConditionFalse,
Reason: addonapiv1alpha1.AddonManifestAppliedReasonWorkApplyFailed,
Message: fmt.Sprintf("failed to build manifestwork: %v", err),
})
return nil, err
}
return hookWork, nil
}