/
componentsubscription_controller.go
347 lines (282 loc) · 12 KB
/
componentsubscription_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
// SPDX-FileCopyrightText: 2022 SAP SE or an SAP affiliate company and Open Component Model contributors.
//
// SPDX-License-Identifier: Apache-2.0
package controllers
import (
"context"
"encoding/base64"
"errors"
"fmt"
"time"
"github.com/Masterminds/semver/v3"
"github.com/fluxcd/pkg/apis/meta"
"github.com/fluxcd/pkg/runtime/patch"
rreconcile "github.com/fluxcd/pkg/runtime/reconcile"
ocmv1alpha1 "github.com/open-component-model/ocm-controller/api/v1alpha1"
"github.com/open-component-model/ocm-controller/pkg/status"
ocm2 "github.com/open-component-model/ocm/pkg/contexts/ocm"
"github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"
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/handler"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
"github.com/open-component-model/replication-controller/api/v1alpha1"
"github.com/open-component-model/replication-controller/pkg/ocm"
)
const requeueAfter = 10 * time.Second
// ComponentSubscriptionReconciler reconciles a ComponentSubscription object.
type ComponentSubscriptionReconciler struct {
client.Client
Scheme *runtime.Scheme
OCMClient ocm.Contract
EventRecorder record.EventRecorder
MpasEnabled bool
}
// SetupWithManager sets up the controller with the Manager.
func (r *ComponentSubscriptionReconciler) SetupWithManager(mgr ctrl.Manager) error {
const (
sourceKey = ".metadata.source.secretRef"
destinationKey = ".metadata.destination.secretRef"
)
if err := mgr.GetFieldIndexer().IndexField(context.TODO(), &v1alpha1.ComponentSubscription{}, sourceKey, func(rawObj client.Object) []string {
obj, ok := rawObj.(*v1alpha1.ComponentSubscription)
if !ok {
return []string{}
}
if obj.Spec.Source.SecretRef == nil {
return []string{}
}
ns := obj.GetNamespace()
return []string{fmt.Sprintf("%s/%s", ns, obj.Spec.Source.SecretRef.Name)}
}); err != nil {
return fmt.Errorf("failed setting index fields: %w", err)
}
if err := mgr.GetFieldIndexer().IndexField(context.TODO(), &v1alpha1.ComponentSubscription{}, destinationKey, func(rawObj client.Object) []string {
obj, ok := rawObj.(*v1alpha1.ComponentSubscription)
if !ok {
return []string{}
}
if obj.Spec.Destination == nil || obj.Spec.Destination.SecretRef == nil {
return []string{}
}
ns := obj.GetNamespace()
return []string{fmt.Sprintf("%s/%s", ns, obj.Spec.Destination.SecretRef.Name)}
}); err != nil {
return fmt.Errorf("failed setting index fields: %w", err)
}
return ctrl.NewControllerManagedBy(mgr).
For(&v1alpha1.ComponentSubscription{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})).
Watches(
&source.Kind{Type: &corev1.Secret{}},
handler.EnqueueRequestsFromMapFunc(r.findObjects(sourceKey, destinationKey))).
Complete(r)
}
// findObjects finds component versions that have a key for the secret that triggered this watch event.
func (r *ComponentSubscriptionReconciler) findObjects(sourceKey string, destinationKey string) handler.MapFunc {
return func(obj client.Object) []reconcile.Request {
sourceList := &v1alpha1.ComponentSubscriptionList{}
if err := r.List(context.Background(), sourceList, &client.ListOptions{
FieldSelector: fields.OneTermEqualSelector(sourceKey, client.ObjectKeyFromObject(obj).String()),
}); err != nil {
return []reconcile.Request{}
}
destinationList := &v1alpha1.ComponentSubscriptionList{}
if err := r.List(context.Background(), destinationList, &client.ListOptions{
FieldSelector: fields.OneTermEqualSelector(destinationKey, client.ObjectKeyFromObject(obj).String()),
}); err != nil {
return []reconcile.Request{}
}
// deduplicate the two secret lists
requestMap := make(map[reconcile.Request]struct{})
for _, item := range sourceList.Items {
requestMap[reconcile.Request{
NamespacedName: types.NamespacedName{
Name: item.GetName(),
Namespace: item.GetNamespace(),
},
}] = struct{}{}
}
for _, item := range destinationList.Items {
requestMap[reconcile.Request{
NamespacedName: types.NamespacedName{
Name: item.GetName(),
Namespace: item.GetNamespace(),
},
}] = struct{}{}
}
requests := make([]reconcile.Request, 0, len(requestMap))
for k := range requestMap {
requests = append(requests, k)
}
return requests
}
}
//+kubebuilder:rbac:groups=delivery.ocm.software,resources=componentsubscriptions,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=delivery.ocm.software,resources=componentsubscriptions/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=delivery.ocm.software,resources=componentsubscriptions/finalizers,verbs=update
//+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups="",resources=serviceaccounts,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups="",resources=events,verbs=create;patch
// 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 *ComponentSubscriptionReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
obj := &v1alpha1.ComponentSubscription{}
if err = r.Get(ctx, req.NamespacedName, obj); err != nil {
if apierrors.IsNotFound(err) {
return ctrl.Result{}, nil
}
return ctrl.Result{RequeueAfter: requeueAfter}, nil
}
if obj.DeletionTimestamp != nil {
return ctrl.Result{}, nil
}
// The replication controller doesn't need a shouldReconcile, because it should always reconcile,
// that is its purpose.
patchHelper := patch.NewSerialPatcher(obj, r.Client)
// Always attempt to patch the object and status after each reconciliation.
defer func() {
// Patching has not been set up, or the controller errored earlier.
if patchHelper == nil {
return
}
if derr := status.UpdateStatus(ctx, patchHelper, obj, r.EventRecorder, obj.GetRequeueAfter()); derr != nil {
err = errors.Join(err, derr)
}
}()
// Starts the progression by setting ReconcilingCondition.
// This will be checked in defer.
// Should only be deleted on a success.
rreconcile.ProgressiveStatus(false, obj, meta.ProgressingReason, "reconciliation in progress for resource: %s", obj.Name)
return r.reconcile(ctx, obj)
}
func (r *ComponentSubscriptionReconciler) reconcile(ctx context.Context, obj *v1alpha1.ComponentSubscription) (_ ctrl.Result, err error) {
if obj.Generation != obj.Status.ObservedGeneration {
rreconcile.ProgressiveStatus(
false,
obj,
meta.ProgressingReason,
"processing object: new generation %d -> %d",
obj.Status.ObservedGeneration,
obj.Generation,
)
}
octx, err := r.OCMClient.CreateAuthenticatedOCMContext(ctx, obj)
if err != nil {
err := fmt.Errorf("failed to authenticate OCM context: %w", err)
status.MarkAsStalled(r.EventRecorder, obj, v1alpha1.AuthenticationFailedReason, err.Error())
return ctrl.Result{}, nil
}
version, err := r.OCMClient.GetLatestSourceComponentVersion(ctx, octx, obj)
if err != nil {
err := fmt.Errorf("failed to get latest component version: %w", err)
status.MarkNotReady(r.EventRecorder, obj, v1alpha1.PullingLatestVersionFailedReason, err.Error())
// we don't want to fail but keep searching until it's there. But we do mark the subscription as failed.
return ctrl.Result{RequeueAfter: obj.GetRequeueAfter()}, nil
}
// Because of the predicate, this subscription will be reconciled again once there is an update to its status field.
if version == obj.Status.LastAppliedVersion {
status.MarkReady(r.EventRecorder, obj, "Reconciliation success")
return ctrl.Result{RequeueAfter: obj.GetRequeueAfter()}, nil
}
latestSourceComponentVersion, err := semver.NewVersion(version)
if err != nil {
err := fmt.Errorf("failed to parse source component version: %w", err)
status.MarkNotReady(r.EventRecorder, obj, v1alpha1.SemverConversionFailedReason, err.Error())
return ctrl.Result{}, err
}
lastAppliedOriginal := "0.0.0"
if obj.Status.LastAppliedVersion != "" {
lastAppliedOriginal = obj.Status.LastAppliedVersion
}
lastAppliedVersion, err := semver.NewVersion(lastAppliedOriginal)
if err != nil {
err := fmt.Errorf("failed to parse latest version: %w", err)
status.MarkNotReady(r.EventRecorder, obj, v1alpha1.SemverConversionFailedReason, err.Error())
return ctrl.Result{}, err
}
if latestSourceComponentVersion.LessThan(lastAppliedVersion) || latestSourceComponentVersion.Equal(lastAppliedVersion) {
status.MarkReady(r.EventRecorder, obj, "Reconciliation success")
return ctrl.Result{RequeueAfter: obj.GetRequeueAfter()}, nil
}
// set latest version, this will be patched in the defer statement.
obj.Status.LastAttemptedVersion = latestSourceComponentVersion.Original()
sourceComponentVersion, err := r.OCMClient.GetComponentVersion(ctx, octx, obj, latestSourceComponentVersion.Original())
if err != nil {
err := fmt.Errorf("failed to get latest component version: %w", err)
status.MarkNotReady(r.EventRecorder, obj, v1alpha1.GetComponentDescriptorFailedReason, err.Error())
return ctrl.Result{}, err
}
defer func() {
if cerr := sourceComponentVersion.Close(); cerr != nil {
err = errors.Join(err, cerr)
}
}()
if r.MpasEnabled {
if err := r.signMpasComponent(ctx, obj, sourceComponentVersion); err != nil {
status.MarkNotReady(r.EventRecorder, obj, v1alpha1.ComponentSigningFailedReason, err.Error())
return ctrl.Result{}, fmt.Errorf("failed to sign mpas component: %w", err)
}
}
if obj.Spec.Destination != nil {
rreconcile.ProgressiveStatus(false, obj, meta.ProgressingReason, "transferring component to target repository: %s", obj.Spec.Destination.URL)
if err := r.OCMClient.TransferComponent(ctx, octx, obj, sourceComponentVersion); err != nil {
err := fmt.Errorf("failed to transfer components: %w", err)
status.MarkNotReady(r.EventRecorder, obj, v1alpha1.TransferFailedReason, err.Error())
return ctrl.Result{}, err
}
obj.Status.ReplicatedRepositoryURL = obj.Spec.Destination.URL
} else {
obj.Status.ReplicatedRepositoryURL = obj.Spec.Source.URL
}
// Update the replicated version to the latest version
obj.Status.LastAppliedVersion = latestSourceComponentVersion.Original()
status.MarkReady(r.EventRecorder, obj, "Reconciliation success")
// Always requeue to constantly check for new versions.
return ctrl.Result{RequeueAfter: obj.GetRequeueAfter()}, nil
}
func (r *ComponentSubscriptionReconciler) signMpasComponent(
ctx context.Context,
obj *v1alpha1.ComponentSubscription,
sourceComponentVersion ocm2.ComponentVersionAccess,
) error {
if obj.Spec.Destination == nil {
return fmt.Errorf("destination must be set for MPAS enabled components")
}
if err := r.checkComponentIsMPASEnabled(sourceComponentVersion); err != nil {
return fmt.Errorf("failed to verify component validity: %w", err)
}
pub, err := r.OCMClient.SignDestinationComponent(ctx, sourceComponentVersion)
if err != nil {
return fmt.Errorf("failed to sign destination component: %w", err)
}
obj.Status.Signature = []ocmv1alpha1.Signature{
{
Name: v1alpha1.InternalSignatureName,
PublicKey: ocmv1alpha1.PublicKey{
Value: base64.StdEncoding.EncodeToString(pub),
},
},
}
return nil
}
func (r *ComponentSubscriptionReconciler) checkComponentIsMPASEnabled(cv ocm2.ComponentVersionAccess) error {
resources, err := cv.GetResourcesByResourceSelectors(compdesc.ResourceSelectorFunc(func(obj compdesc.ResourceSelectionContext) (bool, error) {
return obj.GetType() == v1alpha1.ProductDescriptionType, nil
}))
if err != nil {
return fmt.Errorf("failed to get resource by selector: %w", err)
}
if len(resources) == 0 {
return fmt.Errorf("failed to find product description for component")
}
return nil
}