/
override-controller.go
349 lines (288 loc) · 11.3 KB
/
override-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
// Copyright 2023 Flant JSC
//
// 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 release
import (
"context"
"fmt"
"os"
"path"
"path/filepath"
"syscall"
"time"
"github.com/flant/addon-operator/pkg/utils/logger"
log "github.com/sirupsen/logrus"
"golang.org/x/time/rate"
apierrors "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"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
ctrl "sigs.k8s.io/controller-runtime"
"github.com/deckhouse/deckhouse/deckhouse-controller/pkg/apis/deckhouse.io/v1alpha1"
"github.com/deckhouse/deckhouse/deckhouse-controller/pkg/client/clientset/versioned"
d8informers "github.com/deckhouse/deckhouse/deckhouse-controller/pkg/client/informers/externalversions/deckhouse.io/v1alpha1"
d8listers "github.com/deckhouse/deckhouse/deckhouse-controller/pkg/client/listers/deckhouse.io/v1alpha1"
"github.com/deckhouse/deckhouse/deckhouse-controller/pkg/controller/module-controllers/downloader"
"github.com/deckhouse/deckhouse/deckhouse-controller/pkg/controller/module-controllers/utils"
deckhouseconfig "github.com/deckhouse/deckhouse/go_lib/deckhouse-config"
)
// ModulePullOverrideController is the controller implementation for ModulePullOverride resources
type ModulePullOverrideController struct {
// kubeclientset is a standard kubernetes clientset
kubeclientset kubernetes.Interface
// d8ClientSet is a clientset for our own API group
d8ClientSet versioned.Interface
moduleSourcesLister d8listers.ModuleSourceLister
moduleSourcesSynced cache.InformerSynced
modulePullOverridesLister d8listers.ModulePullOverrideLister
modulePullOverridesSynced cache.InformerSynced
workqueue workqueue.RateLimitingInterface
logger logger.Logger
modulesValidator moduleValidator
externalModulesDir string
symlinksDir string
}
// NewModulePullOverrideController returns a new sample controller
func NewModulePullOverrideController(ks kubernetes.Interface,
d8ClientSet versioned.Interface,
moduleSourceInformer d8informers.ModuleSourceInformer,
modulePullOverridesInformer d8informers.ModulePullOverrideInformer,
modulesValidator moduleValidator,
) *ModulePullOverrideController {
ratelimiter := workqueue.NewMaxOfRateLimiter(
workqueue.NewItemExponentialFailureRateLimiter(500*time.Millisecond, 1000*time.Second),
&workqueue.BucketRateLimiter{Limiter: rate.NewLimiter(rate.Limit(50), 300)},
)
lg := log.WithField("component", "ModulePullOverrideController")
controller := &ModulePullOverrideController{
kubeclientset: ks,
d8ClientSet: d8ClientSet,
moduleSourcesLister: moduleSourceInformer.Lister(),
moduleSourcesSynced: moduleSourceInformer.Informer().HasSynced,
modulePullOverridesLister: modulePullOverridesInformer.Lister(),
modulePullOverridesSynced: modulePullOverridesInformer.Informer().HasSynced,
workqueue: workqueue.NewRateLimitingQueue(ratelimiter),
logger: lg,
modulesValidator: modulesValidator,
externalModulesDir: os.Getenv("EXTERNAL_MODULES_DIR"),
symlinksDir: filepath.Join(os.Getenv("EXTERNAL_MODULES_DIR"), "modules"),
}
_, err := modulePullOverridesInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: controller.enqueueModuleOverride,
UpdateFunc: func(old, new interface{}) {
newM := new.(*v1alpha1.ModulePullOverride)
oldM := old.(*v1alpha1.ModulePullOverride)
if newM.Spec == oldM.Spec {
if _, ok := newM.Labels["renew"]; ok {
controller.enqueueModuleOverride(newM)
}
return
}
controller.enqueueModuleOverride(newM)
},
})
if err != nil {
log.Fatalf("add event handler failed: %s", err)
}
return controller
}
func (c *ModulePullOverrideController) Run(ctx context.Context, workers int) {
if c.externalModulesDir == "" {
c.logger.Info("env: 'EXTERNAL_MODULES_DIR' is empty, we are not going to work with source modules")
return
}
defer utilruntime.HandleCrash()
defer c.workqueue.ShutDown()
// Check if controller's dependencies have been initialized
_ = wait.PollUntilContextCancel(ctx, utils.SyncedPollPeriod, false,
func(context.Context) (bool, error) {
// TODO: add modulemanager initialization check c.modulesValidator.AreModulesInited() (required for reloading modules without restarting deckhouse)
return deckhouseconfig.IsServiceInited(), nil
})
// Start the informer factories to begin populating the informer caches
c.logger.Info("Starting controller")
// Wait for the caches to be synced before starting workers
c.logger.Debug("Waiting for caches to sync")
if ok := cache.WaitForCacheSync(ctx.Done(), c.moduleSourcesSynced, c.modulePullOverridesSynced); !ok {
c.logger.Fatal("failed to wait for caches to sync")
}
c.logger.Infof("Starting workers count: %d", workers)
for i := 0; i < workers; i++ {
go wait.UntilWithContext(ctx, c.runWorker, time.Second)
}
<-ctx.Done()
c.logger.Info("Shutting down workers")
}
func (c *ModulePullOverrideController) enqueueModuleOverride(obj interface{}) {
var key string
var err error
if key, err = cache.MetaNamespaceKeyFunc(obj); err != nil {
utilruntime.HandleError(err)
return
}
c.logger.Debugf("enqueue ModuleOverride: %s", key)
c.workqueue.Add(key)
}
func (c *ModulePullOverrideController) runWorker(ctx context.Context) {
for c.processNextModuleOverride(ctx) {
}
}
func (c *ModulePullOverrideController) processNextModuleOverride(ctx context.Context) bool {
obj, shutdown := c.workqueue.Get()
if shutdown {
return false
}
err := func(obj interface{}) error {
defer c.workqueue.Done(obj)
var key string
var ok bool
if key, ok = obj.(string); !ok {
c.workqueue.Forget(obj)
c.logger.Errorf("expected string in workqueue but got %#v", obj)
return nil
}
// run reconcile loop
result, err := c.OverrideReconcile(ctx, key)
switch {
case result.RequeueAfter != 0:
c.workqueue.AddAfter(key, result.RequeueAfter)
case result.Requeue:
// Put the item back on the workqueue to handle any transient errors.
c.workqueue.AddRateLimited(key)
default:
c.workqueue.Forget(key)
}
return err
}(obj)
if err != nil {
c.logger.Errorf("ModulePullOverride reconcile error: %s", err.Error())
return true
}
return true
}
func (c *ModulePullOverrideController) OverrideReconcile(ctx context.Context, key string) (ctrl.Result, error) {
mo, err := c.modulePullOverridesLister.Get(key)
if err != nil {
// The ModulePullOverride resource may no longer exist, in which case we stop
// processing.
if apierrors.IsNotFound(err) {
return ctrl.Result{}, nil
}
return ctrl.Result{Requeue: true}, err
}
return c.moduleOverrideReconcile(ctx, mo)
}
func (c *ModulePullOverrideController) moduleOverrideReconcile(ctx context.Context, moRO *v1alpha1.ModulePullOverride) (ctrl.Result, error) {
// NEVER modify objects from the store. It's a read-only, local cache.
// You can use DeepCopy() to make a deep copy of original object and modify this copy
mo := moRO.DeepCopy()
// add labels if empty
// source and release controllers are looking for this labels
if _, ok := mo.Labels["module"]; !ok {
if len(mo.Labels) > 0 {
mo.Labels["module"] = mo.Name
mo.Labels["source"] = mo.Spec.Source
} else {
mo.SetLabels(map[string]string{"module": mo.Name, "source": mo.Spec.Source})
}
_, err := c.d8ClientSet.DeckhouseV1alpha1().ModulePullOverrides().Update(ctx, mo, metav1.UpdateOptions{})
return ctrl.Result{RequeueAfter: 500 * time.Millisecond}, err
}
ms, err := c.moduleSourcesLister.Get(mo.Spec.Source)
if err != nil {
if apierrors.IsNotFound(err) {
mo.Status.Message = fmt.Sprintf("ModuleSource %q not found", mo.Spec.Source)
if e := c.updateModulePullOverrideStatus(ctx, mo); e != nil {
return ctrl.Result{Requeue: true}, e
}
return ctrl.Result{RequeueAfter: 1 * time.Minute}, nil
}
return ctrl.Result{Requeue: true}, err
}
md := downloader.NewModuleDownloader(c.externalModulesDir, ms, utils.GenerateRegistryOptions(ms))
newChecksum, moduleDef, err := md.DownloadDevImageTag(mo.Name, mo.Spec.ImageTag, mo.Status.ImageDigest)
if err != nil {
mo.Status.Message = err.Error()
if e := c.updateModulePullOverrideStatus(ctx, mo); e != nil {
return ctrl.Result{Requeue: true}, e
}
return ctrl.Result{RequeueAfter: mo.Spec.ScanInterval.Duration}, nil
}
if newChecksum == "" {
// module is up-to-date
if mo.Status.Message != "" {
// drop error message, if exists
mo.Status.Message = ""
if e := c.updateModulePullOverrideStatus(ctx, mo); e != nil {
return ctrl.Result{Requeue: true}, e
}
}
return ctrl.Result{RequeueAfter: mo.Spec.ScanInterval.Duration}, nil
}
// what if it is nil?
if moduleDef != nil {
err = validateModule(c.modulesValidator, *moduleDef)
if err != nil {
mo.Status.Message = fmt.Sprintf("validation failed: %s", err)
if e := c.updateModulePullOverrideStatus(ctx, mo); e != nil {
return ctrl.Result{Requeue: true}, e
}
return ctrl.Result{RequeueAfter: mo.Spec.ScanInterval.Duration}, nil
}
}
symlinkPath := filepath.Join(c.symlinksDir, fmt.Sprintf("%d-%s", moduleDef.Weight, mo.Name))
err = c.enableModule(mo.Name, symlinkPath)
if err != nil {
mo.Status.Message = err.Error()
if e := c.updateModulePullOverrideStatus(ctx, mo); e != nil {
return ctrl.Result{Requeue: true}, e
}
return ctrl.Result{Requeue: true}, err
}
// disable target module hooks so as not to invoke them before restart
if c.modulesValidator.GetModule(mo.Name) != nil {
c.modulesValidator.DisableModuleHooks(mo.Name)
}
defer func() {
c.logger.Infof("Restarting Deckhouse because %q ModulePullOverride image was updated", mo.Name)
err := syscall.Kill(1, syscall.SIGUSR2)
if err != nil {
c.logger.Fatalf("Send SIGUSR2 signal failed: %s", err)
}
}()
mo.Status.Message = ""
mo.Status.ImageDigest = newChecksum
if e := c.updateModulePullOverrideStatus(ctx, mo); e != nil {
return ctrl.Result{Requeue: true}, e
}
if _, ok := mo.Labels["renew"]; ok {
delete(mo.Labels, "renew")
_, _ = c.d8ClientSet.DeckhouseV1alpha1().ModulePullOverrides().Update(ctx, mo, metav1.UpdateOptions{})
}
return ctrl.Result{RequeueAfter: mo.Spec.ScanInterval.Duration}, nil
}
func (c *ModulePullOverrideController) enableModule(moduleName, symlinkPath string) error {
currentModuleSymlink, err := findExistingModuleSymlink(c.symlinksDir, moduleName)
if err != nil {
currentModuleSymlink = "900-" + moduleName // fallback
}
return enableModule(c.externalModulesDir, currentModuleSymlink, symlinkPath, path.Join("../", moduleName, "dev"))
}
func (c *ModulePullOverrideController) updateModulePullOverrideStatus(ctx context.Context, mo *v1alpha1.ModulePullOverride) error {
mo.Status.UpdatedAt = metav1.Now()
_, err := c.d8ClientSet.DeckhouseV1alpha1().ModulePullOverrides().UpdateStatus(ctx, mo, metav1.UpdateOptions{})
return err
}