-
Notifications
You must be signed in to change notification settings - Fork 39
Expand file tree
/
Copy pathprofile_controller.go
More file actions
423 lines (352 loc) · 15.7 KB
/
profile_controller.go
File metadata and controls
423 lines (352 loc) · 15.7 KB
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
1
8000
78
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
/*
Copyright 2023. projectsveltos.io. All rights reserved.
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 controllers
import (
"context"
"fmt"
"sync"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
"
8000
;k8s.io/apimachinery/pkg/types"
clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"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"
"github.com/go-logr/logr"
"github.com/pkg/errors"
configv1beta1 "github.com/projectsveltos/addon-controller/api/v1beta1"
"github.com/projectsveltos/addon-controller/controllers/dependencymanager"
"github.com/projectsveltos/addon-controller/pkg/scope"
libsveltosv1beta1 "github.com/projectsveltos/libsveltos/api/v1beta1"
logs "github.com/projectsveltos/libsveltos/lib/logsettings"
predicates "github.com/projectsveltos/libsveltos/lib/predicates"
libsveltosset "github.com/projectsveltos/libsveltos/lib/set"
)
// ProfileReconciler reconciles a Profile object
type ProfileReconciler struct {
client.Client
Scheme *runtime.Scheme
ConcurrentReconciles int
Logger logr.Logger
// use a Mutex to update Map as MaxConcurrentReconciles is higher than one
Mux sync.Mutex
// key: Set; value: set of Profiles currently referencing the Set
SetMap map[corev1.ObjectReference]*libsveltosset.Set
// key: Sveltos/Cluster; value: set of all Profiles matching the Cluster
ClusterMap map[corev1.ObjectReference]*libsveltosset.Set
// key: Profile; value Profile Selector
Profiles map[corev1.ObjectReference]libsveltosv1beta1.Selector
// For each cluster contains current labels
// This is needed in following scenario:
// - Profile is created
// - Cluster is created with labels matching Profile
// - When first control plane machine in such cluster becomes available
// we need Cluster labels to know which Profile to reconcile
ClusterLabels map[corev1.ObjectReference]map[string]string
// Reason for the two maps:
// Profile, via ClusterSelector, matches Sveltos/CAPI Clusters based on Cluster labels.
// When a Sveltos/Cluster labels change, one or more Profile needs to be reconciled.
// In order to achieve so, Profile reconciler watches for Sveltos/CAPI Clusters. When a Sveltos/Cluster
// label changes, find all the Profiles currently referencing it and reconcile those.
// Problem is no I/O should be present inside a MapFunc (given a Sveltos/Cluster, return all the Profiles matching it).
// In the MapFunc, if the list Profiles operation failed, we would be unable to retry or re-enqueue the rigth set of
// Profiles.
// Instead the approach taken is following:
// - when a Profile is reconciled, update the Profiles and the ClusterMap;
// - in the MapFunc, given the Sveltos/Cluster that changed:
// * use Profiles to find all Profiles matching the Cluster and reconcile those;
// - in order to reconcile Profiles previously matching the Cluster and not anymore, use ClusterMap.
//
// The ProfileMap is used to update ClusterMap. Consider following scenarios to understand the need:
// 1. Profile A references Clusters 1 and 2. When reconciled, ClusterMap will have 1 => A and 2 => A;
// and ProfileMap A => 1,2
// 2. Cluster 2 label changes and now Profile matches Cluster 1 only. We ned to remove the entry 2 => A in ClusterMap. But
// when we reconcile Profile we have its current version we don't have its previous version. So we know Profile A
// now matches Sveltos/Cluster 1, but we don't know it used to match Sveltos/Cluster 2.
// So we use ProfileMap (at this point value stored here corresponds to reconciliation #1. We know currently
// Profile matches Sveltos/Cluster 1 only and looking at ProfileMap we know it used to reference
// Svetos/CAPI Cluster 1 and 2.
// So we can remove 2 => A from ClusterMap. Only after this update, we update ProfileMap (so new value will be A => 1)
ctrl controller.Controller
}
//+kubebuilder:rbac:groups=config.projectsveltos.io,resources=profiles,verbs=get;list;watch;update;patch
//+kubebuilder:rbac:groups=config.projectsveltos.io,resources=profiles/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=config.projectsveltos.io,resources=profiles/finalizers,verbs=update;patch
//+kubebuilder:rbac:groups=config.projectsveltos.io,resources=clustersummaries,verbs=get;list;update;create;delete
//+kubebuilder:rbac:groups=config.projectsveltos.io,resources=clusterreports,verbs=get;list;update;create;watch;delete
//+kubebuilder:rbac:groups=config.projectsveltos.io,resources=clusterconfigurations,verbs=get;list;update;create;watch;delete
//+kubebuilder:rbac:groups=cluster.x-k8s.io,resources=clusters,verbs=get;watch;list
//+kubebuilder:rbac:groups=cluster.x-k8s.io,resources=clusters/status,verbs=get;watch;list
//+kubebuilder:rbac:groups=cluster.x-k8s.io,resources=machines,verbs=get;watch;list
//+kubebuilder:rbac:groups=cluster.x-k8s.io,resources=machines/status,verbs=get;watch;list
//+kubebuilder:rbac:groups=lib.projectsveltos.io,resources=sveltosclusters,verbs=get;watch;list
//+kubebuilder:rbac:groups=lib.projectsveltos.io,resources=sveltosclusters/status,verbs=get;watch;list
func (r *ProfileReconciler) Reconcile(ctx context.Context, req ctrl.Request) (_ ctrl.Result, reterr error) {
logger := ctrl.LoggerFrom(ctx)
logger.V(logs.LogDebug).Info("Reconciling")
// Fecth the Profile instance
profile := &configv1beta1.Profile{}
if err := r.Get(ctx, req.NamespacedName, profile); err != nil {
if apierrors.IsNotFound(err) {
return reconcile.Result{}, nil
}
logger.Error(err, "Failed to fetch Profile")
return reconcile.Result{}, fmt.Errorf("failed to fetch Profile %s: %w", req.NamespacedName, err)
}
// limit all references to be in the namespace
r.limitReferencesToNamespace(profile)
profileScope, err := scope.NewProfileScope(scope.ProfileScopeParams{
Client: r.Client,
Logger: logger,
Profile: profile,
ControllerName: "profile",
})
if err != nil {
logger.Error(err, "Failed to create profileScope")
return reconcile.Result{}, fmt.Errorf("unable to create profile scope for %s: %w", req.NamespacedName, err)
}
if isProfilePaused(profileScope) {
logger.V(logs.LogInfo).Info("profile is paused. Skip reconciliation")
profileScope.GetStatus().ReconciliationSuspended = true
suspensionReason := "Profile is paused"
profileScope.GetStatus().SuspensionReason = &suspensionReason
return reconcile.Result{}, nil
}
profileScope.GetStatus().ReconciliationSuspended = false
profileScope.GetStatus().SuspensionReason = nil
// Always close the scope when exiting this function so we can persist any Profile
// changes.
defer func() {
if err := profileScope.Close(ctx); err != nil {
reterr = err
}
}()
// Handle deleted profile
if !profile.DeletionTimestamp.IsZero() {
return r.reconcileDelete(ctx, profileScope), nil
}
// Handle non-deleted profile
return r.reconcileNormal(ctx, profileScope), nil
}
func (r *ProfileReconciler) reconcileDelete(
ctx context.Context,
profileScope *scope.ProfileScope) reconcile.Result {
logger := profileScope.Logger
logger.V(logs.LogDebug).Info("Reconciling Profile delete")
if err := reconcileDeleteCommon(ctx, r.Client, profileScope,
configv1beta1.ProfileFinalizer, logger); err != nil {
return reconcile.Result{Requeue: true, RequeueAfter: deleteRequeueAfter}
}
r.cleanMaps(profileScope)
logger.V(logs.LogDebug).Info("Reconcile delete success")
return reconcile.Result{}
}
func (r *ProfileReconciler) reconcileNormal(
ctx context.Context,
profileScope *scope.ProfileScope) reconcile.Result {
logger := profileScope.Logger
logger.V(logs.LogDebug).Info("Reconciling Profile")
if !controllerutil.ContainsFinalizer(profileScope.Profile, configv1beta1.ProfileFinalizer) {
if err := addFinalizer(ctx, profileScope, configv1beta1.ProfileFinalizer); err != nil {
return reconcile.Result{Requeue: true, RequeueAfter: normalRequeueAfter}
}
}
depManager, err := dependencymanager.GetManagerInstance()
if err != nil {
return reconcile.Result{Requeue: true, RequeueAfter: normalRequeueAfter}
}
// Limit the search of matching cluster to the Profile namespace
matchingCluster, err := getMatchingClusters(ctx, r.Client, profileScope.Profile.GetNamespace(),
profileScope.GetSelector(), profileScope.GetSpec().ClusterRefs, logger)
if err != nil {
return reconcile.Result{Requeue: true, RequeueAfter: normalRequeueAfter}
}
// Get all clusters from referenced Sets
clusterSetClusters, err := r.getClustersFromSets(ctx, profileScope.Namespace(), profileScope.GetSpec().SetRefs, logger)
if err != nil {
return reconcile.Result{Requeue: true, RequeueAfter: normalRequeueAfter}
}
matchingCluster = append(matchingCluster, clusterSetClusters...)
// Get all clusters where deployment is required based on dependent ClusterProfile instances
profileRef := getKeyFromObject(r.Scheme, profileScope.Profile)
depClusters := depManager.GetClusterDeployments(profileRef)
matchingCluster = append(matchingCluster, depClusters...)
profileScope.SetMatchingClusterRefs(removeDuplicates(matchingCluster))
r.updateMaps(profileScope)
if err := reconcileNormalCommon(ctx, r.Client, profileScope, logger); err != nil {
return reconcile.Result{Requeue: true, RequeueAfter: normalRequeueAfter}
}
logger.V(logs.LogDebug).Info("Reconcile success")
return reconcile.Result{}
}
// SetupWithManager sets up the controller with the Manager.
func (r *ProfileReconciler) SetupWithManager(mgr ctrl.Manager) error {
c, err := ctrl.NewControllerManagedBy(mgr).
For(&configv1beta1.Profile{}, builder.WithPredicates(
predicate.Or(
predicate.GenerationChangedPredicate{},
predicate.LabelChangedPredicate{},
predicate.AnnotationChangedPredicate{},
DependenciesHashChangedPredicate{},
),
)).
WithOptions(controller.Options{
MaxConcurrentReconciles: r.ConcurrentReconciles,
}).
Watches(&libsveltosv1beta1.Set{},
handler.EnqueueRequestsFromMapFunc(r.requeueProfileForSet),
builder.WithPredicates(
SetPredicates(mgr.GetLogger().WithValues("predicate", "setpredicate")),
),
).
Watches(&libsveltosv1beta1.SveltosCluster{},
handler.EnqueueRequestsFromMapFunc(r.requeueProfileForSveltosCluster),
builder.WithPredicates(
predicates.SveltosClusterPredicates(mgr.GetLogger().WithValues("predicate", "sveltosclusterpredicate")),
),
).
Build(r)
if err != nil {
return errors.Wrap(err, "error creating controller")
}
// At this point we don't know yet whether CAPI is present in the cluster.
// Later on, in main, we detect that and if CAPI is present WatchForCAPI will be invoked.
r.ctrl = c
return nil
}
func (r *ProfileReconciler) WatchForCAPI(mgr ctrl.Manager, c controller.Controller) error {
sourceCluster := source.Kind[*clusterv1.Cluster](
mgr.GetCache(),
&clusterv1.Cluster{},
handler.TypedEnqueueRequestsFromMapFunc(r.requeueProfileForCluster),
predicates.ClusterPredicate{Logger: mgr.GetLogger().WithValues("predicate", "clusterpredicate")},
)
// When cluster-api cluster changes, according to ClusterPredicates,
// one or more ClusterProfiles need to be reconciled.
if err := c.Watch(sourceCluster); err != nil {
return err
}
return nil
}
func (r *ProfileReconciler) limitReferencesToNamespace(profile *configv1beta1.Profile) {
for i := range profile.Spec.ClusterRefs {
profile.Spec.ClusterRefs[i].Namespace = profile.Namespace
}
for i := range profile.Spec.PolicyRefs {
profile.Spec.PolicyRefs[i].Namespace = profile.Namespace
}
for i := range profile.Spec.KustomizationRefs {
profile.Spec.KustomizationRefs[i].Namespace = profile.Namespace
r.limitKustomizationRefsToNamespace(profile, &profile.Spec.KustomizationRefs[i])
}
for i := range profile.Spec.HelmCharts {
hc := &profile.Spec.HelmCharts[i]
if hc.RegistryCredentialsConfig != nil {
if hc.RegistryCredentialsConfig.CredentialsSecretRef != nil {
hc.RegistryCredentialsConfig.CredentialsSecretRef.Namespace = profile.Namespace
}
if hc.RegistryCredentialsConfig.CASecretRef != nil {
hc.RegistryCredentialsConfig.CASecretRef.Namespace = profile.Namespace
}
}
}
}
// limitKustomizationRefsToNamespace reset Namespace of all ConfigMap/Secret
// instances referenced by kustomizationRef.
func (r *ProfileReconciler) limitKustomizationRefsToNamespace(profile *configv1beta1.Profile,
kustomizationRef *configv1beta1.KustomizationRef) {
for i := range kustomizationRef.ValuesFrom {
kustomizationRef.ValuesFrom[i].Namespace = profile.Namespace
}
}
func (r *ProfileReconciler) cleanMaps(profileScope *scope.ProfileScope) {
r.Mux.Lock()
defer r.Mux.Unlock()
profileInfo := getKeyFromObject(r.Scheme, profileScope.Profile)
delete(r.Profiles, *profileInfo)
// ClusterMap contains for each cluster, set of Profiles matching
// that cluster. Remove Profile from this map
for i := range r.ClusterMap {
profileSet := r.ClusterMap[i]
profileSet.Erase(profileInfo)
}
// SetMap contains for each set, list of Profiles referencing
// such Set. Remove ClusterProfile from this map
for i := range r.SetMap {
profileSet := r.SetMap[i]
profileSet.Erase(profileInfo)
}
}
func (r *ProfileReconciler) updateMaps(profileScope *scope.ProfileScope) {
r.Mux.Lock()
defer r.Mux.Unlock()
profileInfo := getKeyFromObject(r.Scheme, profileScope.Profile)
for k, l := range r.ClusterMap {
l.Erase(profileInfo)
if l.Len() == 0 {
delete(r.ClusterMap, k)
}
}
// For each currently matching Cluster, add Profile as consumer
for i := range profileScope.GetStatus().MatchingClusterRefs {
cluster := profileScope.GetStatus().MatchingClusterRefs[i]
clusterInfo := &corev1.ObjectReference{Namespace: cluster.Namespace, Name: cluster.Name,
Kind: cluster.Kind, APIVersion: cluster.APIVersion}
getConsumersForEntry(r.ClusterMap, clusterInfo).Insert(profileInfo)
}
for k, l := range r.SetMap {
l.Erase(profileInfo)
if l.Len() == 0 {
delete(r.SetMap, k)
}
}
// For each referenced Set, add Profile as consumer
for i := range profileScope.GetSpec().SetRefs {
set := profileScope.GetSpec().SetRefs[i]
setInfo := &corev1.ObjectReference{Namespace: profileScope.Namespace(), Name: set,
Kind: libsveltosv1beta1.SetKind, APIVersion: libsveltosv1beta1.GroupVersion.String()}
getConsumersForEntry(r.SetMap, setInfo).Insert(profileInfo)
}
r.Profiles[*profileInfo] = profileScope.GetSpec().ClusterSelector
}
func (r *ProfileReconciler) GetController() controller.Controller {
return r.ctrl
}
func (r *ProfileReconciler) getClustersFromSets(ctx context.Context, namespace string, setRefs []string,
logger logr.Logger) ([]corev1.ObjectReference, error) {
clusters := make([]corev1.ObjectReference, 0)
for i := range setRefs {
set := &libsveltosv1beta1.Set{}
if err := r.Get(ctx,
types.NamespacedName{Namespace: namespace, Name: setRefs[i]},
set); err != nil {
if apierrors.IsNotFound(err) {
continue
}
logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to get set %s/%s",
namespace, setRefs[i]))
return nil, err
}
if set.Status.SelectedClusterRefs != nil {
clusters = append(clusters, set.Status.SelectedClusterRefs...)
}
}
return clusters, nil
}