/
driver_starter.go
449 lines (391 loc) · 15.1 KB
/
driver_starter.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
package csidriveroperator
import (
"bytes"
"context"
"fmt"
"time"
storagev1 "k8s.io/api/storage/v1"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
configv1 "github.com/openshift/api/config/v1"
operatorapi "github.com/openshift/api/operator/v1"
openshiftv1 "github.com/openshift/client-go/config/listers/config/v1"
"github.com/openshift/cluster-storage-operator/assets"
"github.com/openshift/cluster-storage-operator/pkg/csoclients"
"github.com/openshift/cluster-storage-operator/pkg/operator/csidriveroperator/csioperatorclient"
"github.com/openshift/library-go/pkg/controller/factory"
"github.com/openshift/library-go/pkg/controller/manager"
"github.com/openshift/library-go/pkg/operator/configobserver/featuregates"
"github.com/openshift/library-go/pkg/operator/events"
"github.com/openshift/library-go/pkg/operator/resource/resourceapply"
"github.com/openshift/library-go/pkg/operator/staticresourcecontroller"
"github.com/openshift/library-go/pkg/operator/status"
"github.com/openshift/library-go/pkg/operator/v1helpers"
"k8s.io/apimachinery/pkg/api/errors"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
"k8s.io/apimachinery/pkg/util/sets"
storagelister "k8s.io/client-go/listers/storage/v1"
"k8s.io/client-go/restmapper"
"k8s.io/klog/v2"
)
const (
infraConfigName = "cluster"
featureGateConfigName = "cluster"
annOpenShiftManaged = "csi.openshift.io/managed"
)
var (
relatedObjects []configv1.ObjectReference
)
type driverInterface interface {
initController([]csioperatorclient.CSIOperatorConfig, driverInterface) factory.Controller
addExtraControllersToManager(manager.ControllerManager, csioperatorclient.CSIOperatorConfig)
sync(ctx context.Context, syncCtx factory.SyncContext) error
}
type driverStarterCommon struct {
commonClients *csoclients.Clients
resyncInterval time.Duration
infraLister openshiftv1.InfrastructureLister
featureGates featuregates.FeatureGate
csiDriverLister storagelister.CSIDriverLister
restMapper *restmapper.DeferredDiscoveryRESTMapper
versionGetter status.VersionGetter
targetVersion string
eventRecorder events.Recorder
controllers []csiDriverControllerManager
controllerStarted bool // true if at least one controller has started
}
type standAloneDriverStarter struct {
driverStarterCommon
}
type hypershiftDriverStarter struct {
driverStarterCommon
mgmtClient *csoclients.Clients
mgmtEventRecorder events.Recorder
controllerNamespace string
}
type RelatedObjectGetter interface {
RelatedObjects() ([]configv1.ObjectReference, error)
}
type csiDriverControllerManager struct {
operatorConfig csioperatorclient.CSIOperatorConfig
// ControllerManager that installs the CSI driver operator and all its
// objects.
mgr manager.ControllerManager
running bool
ctrlRelatedObjects RelatedObjectGetter
}
func initCommonStarterParams(
client *csoclients.Clients,
featureGates featuregates.FeatureGate,
resyncInterval time.Duration,
versionGetter status.VersionGetter,
targetVersion string,
eventRecorder events.Recorder) driverStarterCommon {
c := driverStarterCommon{
commonClients: client,
versionGetter: versionGetter,
targetVersion: targetVersion,
resyncInterval: resyncInterval,
featureGates: featureGates,
eventRecorder: eventRecorder.WithComponentSuffix("CSIDriverStarter"),
controllerStarted: false,
}
return c
}
func (dsrc *driverStarterCommon) createInformers() {
dsrc.infraLister = dsrc.commonClients.ConfigInformers.Config().V1().Infrastructures().Lister()
dsrc.csiDriverLister = dsrc.commonClients.KubeInformers.InformersFor("").Storage().V1().CSIDrivers().Lister()
dsrc.restMapper = dsrc.commonClients.RestMapper
}
func (dsrc *driverStarterCommon) initController(
driverConfigs []csioperatorclient.CSIOperatorConfig, vStarter driverInterface) factory.Controller {
dsrc.createInformers()
relatedObjects = []configv1.ObjectReference{}
// Populating all CSI driver operator ControllerManagers here simplifies
// the startup a lot
// - All necessary informers are populated.
// - CSO then just Run()s
// All ControllerManagers are not running at this point! They will be
// started in sync() when their platform is detected.
dsrc.controllers = []csiDriverControllerManager{}
for _, cfg := range driverConfigs {
mgr, ctrlRelatedObjects := dsrc.createCSIControllerManager(cfg)
vStarter.addExtraControllersToManager(mgr, cfg)
dsrc.controllers = append(dsrc.controllers, csiDriverControllerManager{
operatorConfig: cfg,
mgr: mgr,
running: false,
ctrlRelatedObjects: ctrlRelatedObjects,
})
}
return factory.New().WithSync(dsrc.sync).WithSyncDegradedOnError(dsrc.commonClients.OperatorClient).WithInformers(
dsrc.commonClients.OperatorClient.Informer(),
dsrc.commonClients.ConfigInformers.Config().V1().Infrastructures().Informer(),
dsrc.commonClients.ConfigInformers.Config().V1().FeatureGates().Informer(),
dsrc.commonClients.KubeInformers.InformersFor("").Storage().V1().CSIDrivers().Informer(),
).ToController("CSIDriverStarter", dsrc.eventRecorder)
}
func (dsrc *driverStarterCommon) createCSIControllerManager(cfg csioperatorclient.CSIOperatorConfig) (manager.ControllerManager, RelatedObjectGetter) {
manager := manager.NewControllerManager()
clients := dsrc.commonClients
staticResourceClients := resourceapply.NewKubeClientHolder(clients.KubeClient).WithDynamicClient(clients.DynamicClient)
src := staticresourcecontroller.NewStaticResourceController(
cfg.ConditionPrefix+"CSIDriverOperatorStaticController",
assets.ReadFile, cfg.StaticAssets, staticResourceClients, dsrc.commonClients.OperatorClient, dsrc.eventRecorder).
AddKubeInformers(clients.KubeInformers).
AddRESTMapper(clients.RestMapper).
AddCategoryExpander(clients.CategoryExpander)
manager = manager.WithController(src, 1)
ctrlRelatedObjects := src
crController := NewCSIDriverOperatorCRController(
cfg.ConditionPrefix,
clients,
cfg,
dsrc.eventRecorder,
dsrc.resyncInterval,
)
manager = manager.WithController(crController, 1)
return manager, ctrlRelatedObjects
}
func (dsrc *driverStarterCommon) isOperatorInstalled(name string) (bool, error) {
_, err := dsrc.commonClients.OperatorInformers.Operator().V1().ClusterCSIDrivers().Lister().Get(name)
if err != nil {
if errors.IsNotFound(err) {
return false, nil
}
return false, err
}
return true, nil
}
func (dsrc *driverStarterCommon) setUpgradeableTrue(ctx context.Context) error {
conditionPrefix := "StorageOperator"
upgradeableCnt := operatorapi.OperatorCondition{
Type: conditionPrefix + operatorapi.OperatorStatusTypeUpgradeable,
Status: operatorapi.ConditionTrue,
}
_, _, err := v1helpers.UpdateStatus(ctx, dsrc.commonClients.OperatorClient,
v1helpers.UpdateConditionFn(upgradeableCnt),
)
return err
}
func (dsrc *driverStarterCommon) sync(ctx context.Context, syncCtx factory.SyncContext) error {
klog.V(4).Infof("CSIDriverStarterController.Sync started")
defer klog.V(4).Infof("CSIDriverStarterController.Sync finished")
opSpec, _, _, err := dsrc.commonClients.OperatorClient.GetOperatorState()
if err != nil {
return err
}
if opSpec.ManagementState != operatorapi.Managed {
return nil
}
infrastructure, err := dsrc.infraLister.Get(infraConfigName)
if err != nil {
return err
}
// Start controller managers for this platform
for i := range dsrc.controllers {
ctrl := &dsrc.controllers[i]
csiDriver, err := dsrc.csiDriverLister.Get(ctrl.operatorConfig.CSIDriverName)
if errors.IsNotFound(err) {
err = nil
csiDriver = nil
}
if err != nil {
return err
}
if !ctrl.running {
isInstalled, err := dsrc.isOperatorInstalled(ctrl.operatorConfig.CSIDriverName)
if err != nil {
return err
}
shouldRun, err := shouldRunController(ctrl.operatorConfig, infrastructure, dsrc.featureGates, csiDriver, isInstalled)
if err != nil {
return err
}
if !shouldRun {
continue
}
// add static assets
objs, err := ctrl.ctrlRelatedObjects.RelatedObjects()
if err != nil {
if isNoMatchError(err) {
// RESTMapper NoResourceMatch / NoKindMatch errors are cached. Reset the cache to get fresh results on the next sync.
dsrc.restMapper.Reset()
}
return err
}
relatedObjects = append(relatedObjects, objs...)
relatedObjects = append(relatedObjects, configv1.ObjectReference{
Group: operatorapi.GroupName,
Resource: "clustercsidrivers",
Name: ctrl.operatorConfig.CSIDriverName,
})
klog.V(2).Infof("Starting ControllerManager for %s", ctrl.operatorConfig.ConditionPrefix)
go ctrl.mgr.Start(ctx)
ctrl.running = true
dsrc.controllerStarted = true
}
}
// If no controller has started, then CSIDriverOperatorCRController
// will not run and we have to set Upgradeable=true right now.
if !dsrc.controllerStarted {
err := dsrc.setUpgradeableTrue(ctx)
if err != nil {
return err
}
}
return nil
}
func NewStandaloneDriverStarter(
clients *csoclients.Clients,
featureGates featuregates.FeatureGate,
resyncInterval time.Duration,
versionGetter status.VersionGetter,
targetVersion string,
eventRecorder events.Recorder,
driverConfigs []csioperatorclient.CSIOperatorConfig) (factory.Controller, *standAloneDriverStarter) {
c := &standAloneDriverStarter{
initCommonStarterParams(clients, featureGates, resyncInterval, versionGetter, targetVersion, eventRecorder),
}
return c.initController(driverConfigs, c), c
}
func (s *standAloneDriverStarter) addExtraControllersToManager(manager manager.ControllerManager, cfg csioperatorclient.CSIOperatorConfig) {
manager = manager.WithController(NewCSIDriverOperatorDeploymentController(
s.commonClients,
cfg,
s.versionGetter,
s.targetVersion,
s.eventRecorder,
s.resyncInterval,
), 1)
olmRemovalCtrl := NewOLMOperatorRemovalController(cfg, s.commonClients, s.eventRecorder, s.resyncInterval)
if olmRemovalCtrl != nil {
manager = manager.WithController(olmRemovalCtrl, 1)
}
if cfg.ServiceMonitorAsset != "" {
manager = manager.WithController(staticresourcecontroller.NewStaticResourceController(
cfg.ConditionPrefix+"CSIDriverOperatorServiceMonitorController",
assets.ReadFile,
[]string{cfg.ServiceMonitorAsset},
(&resourceapply.ClientHolder{}).WithDynamicClient(s.commonClients.DynamicClient),
s.commonClients.OperatorClient,
s.eventRecorder,
).WithIgnoreNotFoundOnCreate(), 1)
}
for i := range cfg.ExtraControllers {
manager = manager.WithController(cfg.ExtraControllers[i], 1)
}
}
func NewHypershiftDriverStarter(
clients *csoclients.Clients,
mgmtClients *csoclients.Clients,
fg featuregates.FeatureGate,
controlNamespace string,
resyncInterval time.Duration,
versionGetter status.VersionGetter,
targetVersion string,
eventRecorder events.Recorder,
mgmtEventRecorder events.Recorder,
driverConfigs []csioperatorclient.CSIOperatorConfig) (factory.Controller, *hypershiftDriverStarter) {
c := &hypershiftDriverStarter{
initCommonStarterParams(clients, fg, resyncInterval, versionGetter, targetVersion, eventRecorder),
mgmtClients,
mgmtEventRecorder,
controlNamespace,
}
return c.initController(driverConfigs, c), c
}
func (h *hypershiftDriverStarter) addExtraControllersToManager(manager manager.ControllerManager, cfg csioperatorclient.CSIOperatorConfig) {
mgmtStaticResourceClient := resourceapply.NewKubeClientHolder(h.mgmtClient.KubeClient).WithDynamicClient(h.mgmtClient.DynamicClient)
namespacedAssetFunc := namespaceReplacer(assets.ReadFile, "${CONTROLPLANE_NAMESPACE}", h.controllerNamespace)
mgmtStaticResourceController := staticresourcecontroller.NewStaticResourceController(
cfg.ConditionPrefix+"CSIDriverOperatorMgmtStaticController",
namespacedAssetFunc, cfg.MgmtStaticAssets, mgmtStaticResourceClient, h.commonClients.OperatorClient, h.eventRecorder).
AddKubeInformers(h.mgmtClient.KubeInformers).
AddRESTMapper(h.mgmtClient.RestMapper).
AddCategoryExpander(h.mgmtClient.CategoryExpander)
manager = manager.WithController(mgmtStaticResourceController, 1)
manager.WithController(NewHyperShiftControllerDeployment(
h.mgmtClient,
h.commonClients,
h.controllerNamespace,
cfg,
h.versionGetter,
h.targetVersion,
h.eventRecorder,
h.resyncInterval,
), 1)
}
func namespaceReplacer(assetFunc resourceapply.AssetFunc, placeholder, namespace string) resourceapply.AssetFunc {
return func(name string) ([]byte, error) {
asset, err := assetFunc(name)
if err != nil {
return asset, err
}
asset = bytes.ReplaceAll(asset, []byte(placeholder), []byte(namespace))
return asset, nil
}
}
// shouldRunController returns true, if given CSI driver controller should run.
func shouldRunController(cfg csioperatorclient.CSIOperatorConfig, infrastructure *configv1.Infrastructure, fg featuregates.FeatureGate, csiDriver *storagev1.CSIDriver, isInstalled bool) (bool, error) {
// Check the correct platform first, it will filter out most CSI driver operators
var platform configv1.PlatformType
if infrastructure.Status.PlatformStatus != nil {
platform = infrastructure.Status.PlatformStatus.Type
}
if cfg.Platform != csioperatorclient.AllPlatforms && cfg.Platform != platform {
klog.V(5).Infof("Not starting %s: wrong platform %s", cfg.CSIDriverName, platform)
return false, nil
}
if cfg.StatusFilter != nil && !cfg.StatusFilter(&infrastructure.Status, isInstalled) {
klog.V(5).Infof("Not starting %s: StatusFilter returned false", cfg.CSIDriverName)
return false, nil
}
if cfg.RequireFeatureGate == "" {
// This is GA / always enabled operator, always run
klog.V(5).Infof("Starting %s: it's GA", cfg.CSIDriverName)
return true, nil
}
knownFeatures := sets.New[configv1.FeatureGateName](fg.KnownFeatures()...)
if !knownFeatures.Has(cfg.RequireFeatureGate) || !fg.Enabled(cfg.RequireFeatureGate) {
klog.V(4).Infof("Not starting %s: feature %s is not enabled", cfg.CSIDriverName, cfg.RequireFeatureGate)
return false, nil
}
if isUnsupportedCSIDriverRunning(cfg, csiDriver) {
// Some other version of the CSI driver is running, degrade the whole cluster
return false, fmt.Errorf("detected CSI driver %s that is not provided by OpenShift - please remove it before enabling the OpenShift one", cfg.CSIDriverName)
}
// Tech preview operator and tech preview is enabled
klog.V(5).Infof("Starting %s: feature %s is enabled", cfg.CSIDriverName, cfg.RequireFeatureGate)
return true, nil
}
func RelatedObjectFunc() func() (isset bool, objs []configv1.ObjectReference) {
return func() (isset bool, objs []configv1.ObjectReference) {
if len(relatedObjects) == 0 {
return false, relatedObjects
}
return true, relatedObjects
}
}
func isUnsupportedCSIDriverRunning(cfg csioperatorclient.CSIOperatorConfig, csiDriver *storagev1.CSIDriver) bool {
if csiDriver == nil {
return false
}
if metav1.HasAnnotation(csiDriver.ObjectMeta, annOpenShiftManaged) {
return false
}
return true
}
func isNoMatchError(err error) bool {
// ctrlRelatedObjects.RelatedObjects() may return aggregated errors, process that
if agg, ok := err.(utilerrors.Aggregate); ok {
errs := agg.Errors()
for _, err := range errs {
if meta.IsNoMatchError(err) {
return true
}
}
return false
}
return meta.IsNoMatchError(err)
}