-
Notifications
You must be signed in to change notification settings - Fork 112
/
datasciencecluster_controller.go
419 lines (374 loc) · 16.1 KB
/
datasciencecluster_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
/*
Copyright 2023.
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 datasciencecluster contains controller logic of CRD DataScienceCluster
package datasciencecluster
import (
"context"
"errors"
"fmt"
"reflect"
"time"
"github.com/go-logr/logr"
"github.com/hashicorp/go-multierror"
v1 "github.com/openshift/api/operator/v1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
netv1 "k8s.io/api/networking/v1"
authv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/retry"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
dsc "github.com/opendatahub-io/opendatahub-operator/v2/apis/datasciencecluster/v1"
dsci "github.com/opendatahub-io/opendatahub-operator/v2/apis/dscinitialization/v1"
"github.com/opendatahub-io/opendatahub-operator/v2/components"
"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/upgrade"
)
// DataScienceClusterReconciler reconciles a DataScienceCluster object.
type DataScienceClusterReconciler struct {
client.Client
Scheme *runtime.Scheme
Log logr.Logger
RestConfig *rest.Config
// Recorder to generate events
Recorder record.EventRecorder
DataScienceCluster *DataScienceClusterConfig
}
// DataScienceClusterConfig passing Spec of DSCI for reconcile DataScienceCluster.
type DataScienceClusterConfig struct {
DSCISpec *dsci.DSCInitializationSpec
}
const (
finalizerName = "datasciencecluster.opendatahub.io/finalizer"
)
// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
func (r *DataScienceClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
r.Log.Info("Reconciling DataScienceCluster resources", "Request.Name", req.Name)
instances := &dsc.DataScienceClusterList{}
if err := r.Client.List(ctx, instances); err != nil {
return ctrl.Result{}, err
}
if len(instances.Items) == 0 {
// Request object not found, could have been deleted after reconcile request.
// Owned objects are automatically garbage collected. For additional cleanup logic use operatorUninstall function.
// Return and don't requeue
if upgrade.HasDeleteConfigMap(r.Client) {
return reconcile.Result{}, fmt.Errorf("error while operator uninstall: %v",
upgrade.OperatorUninstall(r.Client, r.RestConfig))
}
return ctrl.Result{}, nil
}
instance := &instances.Items[0]
if len(instances.Items) > 1 {
message := fmt.Sprintf("only one instance of DataScienceCluster object is allowed. Update existing instance %s", req.Name)
err := errors.New(message)
_ = r.reportError(err, instance, message)
_, _ = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
status.SetErrorCondition(&saved.Status.Conditions, status.DuplicateDataScienceCluster, message)
saved.Status.Phase = status.PhaseError
})
return ctrl.Result{}, err
}
var err error
// Verify a valid DSCInitialization instance is created
dsciInstances := &dsci.DSCInitializationList{}
err = r.Client.List(ctx, dsciInstances)
if err != nil {
r.Log.Error(err, "Failed to retrieve DSCInitialization resource.", "DSCInitialization Request.Name", req.Name)
r.Recorder.Eventf(instance, corev1.EventTypeWarning, "DSCInitializationReconcileError", "Failed to retrieve DSCInitialization instance")
return ctrl.Result{}, err
}
// Update phase to error state if DataScienceCluster is created without valid DSCInitialization
switch len(dsciInstances.Items) {
case 0:
reason := status.ReconcileFailed
message := "Failed to get a valid DSCInitialization instance"
instance, err = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
status.SetProgressingCondition(&saved.Status.Conditions, reason, message)
saved.Status.Phase = status.PhaseError
})
if err != nil {
r.reportError(err, instance, "failed to update DataScienceCluster condition")
return ctrl.Result{}, err
} else {
return ctrl.Result{}, nil
}
case 1:
dscInitializationSpec := dsciInstances.Items[0].Spec
dscInitializationSpec.DeepCopyInto(r.DataScienceCluster.DSCISpec)
default:
message := "only one instance of DSCInitialization object is allowed"
_, _ = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
status.SetErrorCondition(&saved.Status.Conditions, status.DuplicateDSCInitialization, message)
saved.Status.Phase = status.PhaseError
})
return ctrl.Result{}, errors.New(message)
}
allComponents, err := getAllComponents(&instance.Spec.Components)
if err != nil {
return ctrl.Result{}, err
}
if instance.ObjectMeta.DeletionTimestamp.IsZero() {
if !controllerutil.ContainsFinalizer(instance, finalizerName) {
r.Log.Info("Adding finalizer for DataScienceCluster", "name", instance.Name, "finalizer", finalizerName)
controllerutil.AddFinalizer(instance, finalizerName)
if err := r.Update(ctx, instance); err != nil {
return ctrl.Result{}, err
}
}
} else {
r.Log.Info("Finalization DataScienceCluster start deleting instance", "name", instance.Name, "finalizer", finalizerName)
for _, component := range allComponents {
if err := component.Cleanup(r.Client, r.DataScienceCluster.DSCISpec); err != nil {
return ctrl.Result{}, err
}
}
if controllerutil.ContainsFinalizer(instance, finalizerName) {
controllerutil.RemoveFinalizer(instance, finalizerName)
if err := r.Update(ctx, instance); err != nil {
return ctrl.Result{}, err
}
}
if upgrade.HasDeleteConfigMap(r.Client) {
// if delete configmap exists, requeue the request to handle operator uninstall
return reconcile.Result{Requeue: true}, nil
}
return ctrl.Result{}, nil
}
// Start reconciling
if instance.Status.Conditions == nil {
reason := status.ReconcileInit
message := "Initializing DataScienceCluster resource"
instance, err = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
status.SetProgressingCondition(&saved.Status.Conditions, reason, message)
saved.Status.Phase = status.PhaseProgressing
})
if err != nil {
_ = r.reportError(err, instance, fmt.Sprintf("failed to add conditions to status of DataScienceCluster resource name %s", req.Name))
return ctrl.Result{}, err
}
}
// Ensure all omitted components show up as explicitly disabled
instance, err = r.updateComponents(ctx, instance)
if err != nil {
_ = r.reportError(err, instance, "error updating list of components in the CR")
return ctrl.Result{}, err
}
// Initialize error list, instead of returning errors after every component is deployed
var componentErrors *multierror.Error
for _, component := range allComponents {
if instance, err = r.reconcileSubComponent(ctx, instance, component); err != nil {
componentErrors = multierror.Append(componentErrors, err)
}
}
// Process errors for components
if componentErrors != nil {
r.Log.Info("DataScienceCluster Deployment Incomplete.")
instance, err = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
status.SetCompleteCondition(&saved.Status.Conditions, status.ReconcileCompletedWithComponentErrors,
fmt.Sprintf("DataScienceCluster resource reconciled with component errors: %v", componentErrors))
saved.Status.Phase = status.PhaseReady
})
if err != nil {
r.Log.Error(err, "failed to update DataScienceCluster conditions with incompleted reconciliation")
return ctrl.Result{}, err
}
r.Recorder.Eventf(instance, corev1.EventTypeNormal, "DataScienceClusterComponentFailures",
"DataScienceCluster instance %s created, but have some failures in component %v", instance.Name, componentErrors)
return ctrl.Result{RequeueAfter: time.Second * 30}, componentErrors
}
// finalize reconciliation
instance, err = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
status.SetCompleteCondition(&saved.Status.Conditions, status.ReconcileCompleted, "DataScienceCluster resource reconciled successfully")
saved.Status.Phase = status.PhaseReady
})
if err != nil {
r.Log.Error(err, "failed to update DataScienceCluster conditions after successfully completed reconciliation")
return ctrl.Result{}, err
}
r.Log.Info("DataScienceCluster Deployment Completed.")
r.Recorder.Eventf(instance, corev1.EventTypeNormal, "DataScienceClusterCreationSuccessful",
"DataScienceCluster instance %s created and deployed successfully", instance.Name)
return ctrl.Result{}, nil
}
func (r *DataScienceClusterReconciler) reconcileSubComponent(ctx context.Context, instance *dsc.DataScienceCluster,
component components.ComponentInterface,
) (*dsc.DataScienceCluster, error) {
componentName := component.GetComponentName()
enabled := component.GetManagementState() == v1.Managed
// First set conditions to reflect a component is about to be reconciled
instance, err := r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
message := "Component is disabled"
if enabled {
message = "Component is enabled"
}
status.SetComponentCondition(&saved.Status.Conditions, componentName, status.ReconcileInit, message, corev1.ConditionUnknown)
})
if err != nil {
instance = r.reportError(err, instance, "failed to update DataScienceCluster conditions before reconciling "+componentName)
// try to continue with reconciliation, as further updates can fix the status
}
// Reconcile component
err = component.ReconcileComponent(r.Client, instance, r.DataScienceCluster.DSCISpec)
if err != nil {
// reconciliation failed: log errors, raise event and update status accordingly
instance = r.reportError(err, instance, "failed to reconcile "+componentName+" on DataScienceCluster")
instance, _ = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
if enabled {
status.SetComponentCondition(&saved.Status.Conditions, componentName, status.ReconcileFailed, fmt.Sprintf("Component reconciliation failed: %v", err), corev1.ConditionFalse)
} else {
status.SetComponentCondition(&saved.Status.Conditions, componentName, status.ReconcileFailed, fmt.Sprintf("Component removal failed: %v", err), corev1.ConditionFalse)
}
})
return instance, err
} else {
// reconciliation succeeded: update status accordingly
instance, err = r.updateStatus(ctx, instance, func(saved *dsc.DataScienceCluster) {
if saved.Status.InstalledComponents == nil {
saved.Status.InstalledComponents = make(map[string]bool)
}
saved.Status.InstalledComponents[componentName] = enabled
if enabled {
status.SetComponentCondition(&saved.Status.Conditions, componentName, status.ReconcileCompleted, "Component reconciled successfully", corev1.ConditionTrue)
} else {
status.RemoveComponentCondition(&saved.Status.Conditions, componentName)
}
})
if err != nil {
instance = r.reportError(err, instance, "failed to update DataScienceCluster status after reconciling "+componentName)
return instance, err
}
}
return instance, nil
}
func (r *DataScienceClusterReconciler) reportError(err error, instance *dsc.DataScienceCluster, message string) *dsc.DataScienceCluster {
r.Log.Error(err, message, "instance.Name", instance.Name)
r.Recorder.Eventf(instance, corev1.EventTypeWarning, "DataScienceClusterReconcileError",
"%s for instance %s", message, instance.Name)
// TODO:Set error phase only for creation/deletion errors of DSC CR
// instance, err = r.updateStatus(instance, func(saved *dsc.DataScienceCluster) {
// status.SetErrorCondition(&saved.Status.Conditions, status.ReconcileFailed, fmt.Sprintf("%s : %v", message, err))
// saved.Status.Phase = status.PhaseError
// })
// if err != nil {
// r.Log.Error(err, "failed to update DataScienceCluster status after error", "instance.Name", instance.Name)
// }
return instance
}
// SetupWithManager sets up the controller with the Manager.
func (r *DataScienceClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&dsc.DataScienceCluster{}).
Owns(&corev1.Namespace{}).
Owns(&corev1.Secret{}).
Owns(&corev1.ConfigMap{}).
Owns(&netv1.NetworkPolicy{}).
Owns(&authv1.Role{}).
Owns(&authv1.RoleBinding{}).
Owns(&authv1.ClusterRole{}).
Owns(&authv1.ClusterRoleBinding{}).
Owns(&appsv1.Deployment{}).
Owns(&appsv1.ReplicaSet{}).
Owns(&corev1.Pod{}).
Watches(&source.Kind{Type: &dsci.DSCInitialization{}}, handler.EnqueueRequestsFromMapFunc(r.watchDataScienceClusterResources)).
Watches(&source.Kind{Type: &corev1.ConfigMap{}}, handler.EnqueueRequestsFromMapFunc(r.watchDataScienceClusterResources)).
// this predicates prevents meaningless reconciliations from being triggered
WithEventFilter(predicate.Or(predicate.GenerationChangedPredicate{}, predicate.LabelChangedPredicate{})).
Complete(r)
}
func (r *DataScienceClusterReconciler) updateStatus(ctx context.Context, original *dsc.DataScienceCluster, update func(saved *dsc.DataScienceCluster),
) (*dsc.DataScienceCluster, error) {
saved := &dsc.DataScienceCluster{}
err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
err := r.Client.Get(ctx, client.ObjectKeyFromObject(original), saved)
if err != nil {
return err
}
// update status here
update(saved)
// Try to update
err = r.Client.Status().Update(context.TODO(), saved)
// Return err itself here (not wrapped inside another error)
// so that RetryOnConflict can identify it correctly.
return err
})
return saved, err
}
func (r *DataScienceClusterReconciler) updateComponents(ctx context.Context, original *dsc.DataScienceCluster) (*dsc.DataScienceCluster, error) {
saved := &dsc.DataScienceCluster{}
err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
err := r.Client.Get(ctx, client.ObjectKeyFromObject(original), saved)
if err != nil {
return err
}
// Try to update
err = r.Client.Update(context.TODO(), saved)
// Return err itself here (not wrapped inside another error)
// so that RetryOnConflict can identify it correctly.
return err
})
return saved, err
}
func (r *DataScienceClusterReconciler) watchDataScienceClusterResources(a client.Object) (requests []reconcile.Request) {
instanceList := &dsc.DataScienceClusterList{}
err := r.Client.List(context.TODO(), instanceList)
if err != nil {
return nil
}
if len(instanceList.Items) == 1 {
// Trigger reconcile function when uninstall configmap is created
if a.GetObjectKind().GroupVersionKind().Kind == "ConfigMap" {
labels := a.GetLabels()
if val, ok := labels[upgrade.DeleteConfigMapLabel]; ok && val == "true" {
return []reconcile.Request{{
NamespacedName: types.NamespacedName{Name: instanceList.Items[0].Name},
}}
} else {
return nil
}
}
return []reconcile.Request{{
NamespacedName: types.NamespacedName{Name: instanceList.Items[0].Name},
}}
} else if len(instanceList.Items) == 0 {
return []reconcile.Request{{
NamespacedName: types.NamespacedName{Name: "default"},
}}
}
return nil
}
func getAllComponents(c *dsc.Components) ([]components.ComponentInterface, error) {
var allComponents []components.ComponentInterface
definedComponents := reflect.ValueOf(c).Elem()
for i := 0; i < definedComponents.NumField(); i++ {
c := definedComponents.Field(i)
if c.CanAddr() {
component, ok := c.Addr().Interface().(components.ComponentInterface)
if !ok {
return allComponents, errors.New("this is not a pointer to ComponentInterface")
}
allComponents = append(allComponents, component)
}
}
return allComponents, nil
}