/
build_sign_reconciler.go
313 lines (260 loc) · 10.8 KB
/
build_sign_reconciler.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
/*
Copyright 2022.
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"
"strings"
buildv1 "github.com/openshift/api/build/v1"
kmmv1beta1 "github.com/rh-ecosystem-edge/kernel-module-management/api/v1beta1"
"github.com/rh-ecosystem-edge/kernel-module-management/internal/api"
"github.com/rh-ecosystem-edge/kernel-module-management/internal/build"
"github.com/rh-ecosystem-edge/kernel-module-management/internal/filter"
"github.com/rh-ecosystem-edge/kernel-module-management/internal/module"
"github.com/rh-ecosystem-edge/kernel-module-management/internal/sign"
"github.com/rh-ecosystem-edge/kernel-module-management/internal/utils"
ocpbuildutils "github.com/rh-ecosystem-edge/kernel-module-management/internal/utils/ocpbuild"
v1 "k8s.io/api/core/v1"
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/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
const BuildSignReconcilerName = "BuildSignReconciler"
// ModuleReconciler reconciles a Module object
type BuildSignReconciler struct {
filter *filter.Filter
reconHelperAPI buildSignReconcilerHelperAPI
}
func NewBuildSignReconciler(
client client.Client,
buildAPI build.Manager,
signAPI sign.SignManager,
kernelAPI module.KernelMapper,
filter *filter.Filter,
) *BuildSignReconciler {
reconHelperAPI := newBuildSignReconcilerHelper(client, buildAPI, signAPI, kernelAPI)
return &BuildSignReconciler{
reconHelperAPI: reconHelperAPI,
filter: filter,
}
}
//+kubebuilder:rbac:groups=kmm.sigs.x-k8s.io,resources=modules,verbs=get;list;watch;update;patch
//+kubebuilder:rbac:groups=kmm.sigs.x-k8s.io,resources=modules/status,verbs=get;update;patch
//+kubebuilder:rbac:groups="core",resources=nodes,verbs=get;list;watch
//+kubebuilder:rbac:groups="core",resources=secrets,verbs=get;list;watch
//+kubebuilder:rbac:groups="core",resources=configmaps,verbs=get;list;delete;watch
//+kubebuilder:rbac:groups="build.openshift.io",resources=builds,verbs=get;list;create;delete;watch;patch
// Reconcile lists all nodes and looks for kernels that match its mappings.
// For each mapping that matches at least one node in the cluster, it creates a DaemonSet running the container image
// on the nodes with a compatible kernel.
func (r *BuildSignReconciler) Reconcile(ctx context.Context, mod *kmmv1beta1.Module) (ctrl.Result, error) {
res := ctrl.Result{}
logger := log.FromContext(ctx)
targetedNodes, err := r.reconHelperAPI.getNodesListBySelector(ctx, mod)
if err != nil {
return res, fmt.Errorf("could get targeted nodes for module %s: %w", mod.Name, err)
}
mldMappings, err := r.reconHelperAPI.getRelevantKernelMappings(ctx, mod, targetedNodes)
if err != nil {
return res, fmt.Errorf("could get kernel mappings for module %s: %w", mod.Name, err)
}
for kernelVersion, mld := range mldMappings {
completedSuccessfully, err := r.reconHelperAPI.handleBuild(ctx, mld)
if err != nil {
return res, fmt.Errorf("failed to handle build for kernel version %s: %v", kernelVersion, err)
}
mldLogger := logger.WithValues(
"kernel version", kernelVersion,
"mld", mld,
)
if !completedSuccessfully {
mldLogger.Info("Build has not finished successfully yet:skipping handling signing for now")
continue
}
completedSuccessfully, err = r.reconHelperAPI.handleSigning(ctx, mld)
if err != nil {
return res, fmt.Errorf("failed to handle signing for kernel version %s: %v", kernelVersion, err)
}
if !completedSuccessfully {
mldLogger.Info("Signing has not finished successfully yet")
}
}
logger.Info("run garbage collector for build/sign pods")
err = r.reconHelperAPI.garbageCollect(ctx, mod, mldMappings)
if err != nil {
return res, fmt.Errorf("failed to run garbage collection: %v", err)
}
logger.Info("Reconcile loop finished successfully")
return res, nil
}
//go:generate mockgen -source=build_sign_reconciler.go -package=controllers -destination=mock_build_sign_reconciler.go buildSignReconcilerHelperAPI
type buildSignReconcilerHelperAPI interface {
getNodesListBySelector(ctx context.Context, mod *kmmv1beta1.Module) ([]v1.Node, error)
getRelevantKernelMappings(ctx context.Context, mod *kmmv1beta1.Module, targetedNodes []v1.Node) (map[string]*api.ModuleLoaderData, error)
handleBuild(ctx context.Context, mld *api.ModuleLoaderData) (bool, error)
handleSigning(ctx context.Context, mld *api.ModuleLoaderData) (bool, error)
garbageCollect(ctx context.Context, mod *kmmv1beta1.Module, mldMappings map[string]*api.ModuleLoaderData) error
}
type buildSignReconcilerHelper struct {
client client.Client
buildAPI build.Manager
signAPI sign.SignManager
kernelAPI module.KernelMapper
}
func newBuildSignReconcilerHelper(client client.Client,
buildAPI build.Manager,
signAPI sign.SignManager,
kernelAPI module.KernelMapper) buildSignReconcilerHelperAPI {
return &buildSignReconcilerHelper{
client: client,
buildAPI: buildAPI,
signAPI: signAPI,
kernelAPI: kernelAPI,
}
}
func (bsrh *buildSignReconcilerHelper) getRelevantKernelMappings(ctx context.Context,
mod *kmmv1beta1.Module,
targetedNodes []v1.Node) (map[string]*api.ModuleLoaderData, error) {
mldMappings := make(map[string]*api.ModuleLoaderData)
logger := log.FromContext(ctx)
for _, node := range targetedNodes {
kernelVersion := strings.TrimSuffix(node.Status.NodeInfo.KernelVersion, "+")
nodeLogger := logger.WithValues(
"node", node.Name,
"kernel version", kernelVersion,
)
if mld, ok := mldMappings[kernelVersion]; ok {
nodeLogger.V(1).Info("Using cached mld mapping", "mld", mld)
continue
}
mld, err := bsrh.kernelAPI.GetModuleLoaderDataForKernel(mod, kernelVersion)
if err != nil {
nodeLogger.Error(err, "failed to get and process kernel mapping")
continue
}
nodeLogger.V(1).Info("Found a valid mapping",
"image", mld.ContainerImage,
"build", mld.Build != nil,
)
mldMappings[kernelVersion] = mld
}
return mldMappings, nil
}
func (bsrh *buildSignReconcilerHelper) getNodesListBySelector(ctx context.Context, mod *kmmv1beta1.Module) ([]v1.Node, error) {
logger := log.FromContext(ctx)
logger.V(1).Info("Listing nodes", "selector", mod.Spec.Selector)
selectedNodes := v1.NodeList{}
opt := client.MatchingLabels(mod.Spec.Selector)
if err := bsrh.client.List(ctx, &selectedNodes, opt); err != nil {
logger.Error(err, "Could not list nodes")
return nil, fmt.Errorf("could not list nodes: %v", err)
}
nodes := make([]v1.Node, 0, len(selectedNodes.Items))
for _, node := range selectedNodes.Items {
if utils.IsNodeSchedulable(&node) {
nodes = append(nodes, node)
}
}
return nodes, nil
}
// handleBuild returns true if build is not needed or finished successfully
func (bsrh *buildSignReconcilerHelper) handleBuild(ctx context.Context, mld *api.ModuleLoaderData) (bool, error) {
shouldSync, err := bsrh.buildAPI.ShouldSync(ctx, mld)
if err != nil {
return false, fmt.Errorf("could not check if build synchronization is needed: %w", err)
}
if !shouldSync {
return true, nil
}
logger := log.FromContext(ctx).WithValues("kernel version", mld.KernelVersion, "image", mld.ContainerImage)
buildCtx := log.IntoContext(ctx, logger)
buildStatus, err := bsrh.buildAPI.Sync(buildCtx, mld, true, mld.Owner)
if err != nil {
return false, fmt.Errorf("could not synchronize the build: %w", err)
}
completedSuccessfully := false
switch buildStatus {
case ocpbuildutils.StatusCompleted:
completedSuccessfully = true
case ocpbuildutils.StatusFailed:
logger.Info(utils.WarnString("Build pod has failed. If the fix is not in Module CR, then delete pod after the fix in order to restart the pod"))
}
return completedSuccessfully, nil
}
// handleSigning returns true if signing is not needed or finished successfully
func (bsrh *buildSignReconcilerHelper) handleSigning(ctx context.Context, mld *api.ModuleLoaderData) (bool, error) {
shouldSync, err := bsrh.signAPI.ShouldSync(ctx, mld)
if err != nil {
return false, fmt.Errorf("cound not check if synchronization is needed: %w", err)
}
if !shouldSync {
return true, nil
}
// if we need to sign AND we've built, then we must have built the intermediate image so must figure out its name
previousImage := ""
if module.ShouldBeBuilt(mld) {
previousImage = module.IntermediateImageName(mld.Name, mld.Namespace, mld.ContainerImage)
}
logger := log.FromContext(ctx).WithValues("kernel version", mld.KernelVersion, "image", mld.ContainerImage)
signCtx := log.IntoContext(ctx, logger)
signStatus, err := bsrh.signAPI.Sync(signCtx, mld, previousImage, true, mld.Owner)
if err != nil {
return false, fmt.Errorf("could not synchronize the signing: %w", err)
}
completedSuccessfully := false
switch signStatus {
case ocpbuildutils.StatusCompleted:
completedSuccessfully = true
case ocpbuildutils.StatusFailed:
logger.Info(utils.WarnString("Sign pod has failed. If the fix is not in Module CR, then delete pod after the fix in order to restart the pod"))
}
return completedSuccessfully, nil
}
func (bsrh *buildSignReconcilerHelper) garbageCollect(ctx context.Context,
mod *kmmv1beta1.Module,
mldMappings map[string]*api.ModuleLoaderData) error {
logger := log.FromContext(ctx)
// Garbage collect for successfully finished build pods
deleted, err := bsrh.buildAPI.GarbageCollect(ctx, mod.Name, mod.Namespace, mod)
if err != nil {
return fmt.Errorf("could not garbage collect build objects: %v", err)
}
logger.Info("Garbage-collected Build objects", "names", deleted)
// Garbage collect for successfully finished sign pods
deleted, err = bsrh.signAPI.GarbageCollect(ctx, mod.Name, mod.Namespace, mod)
if err != nil {
return fmt.Errorf("could not garbage collect sign objects: %v", err)
}
logger.Info("Garbage-collected Sign objects", "names", deleted)
return nil
}
// SetupWithManager sets up the controller with the Manager.
func (r *BuildSignReconciler) SetupWithManager(mgr ctrl.Manager, kernelLabel string) error {
return ctrl.NewControllerManagedBy(mgr).
For(&kmmv1beta1.Module{}).
Owns(&buildv1.Build{}).
Watches(
&v1.Node{},
handler.EnqueueRequestsFromMapFunc(r.filter.FindModulesForNode),
builder.WithPredicates(
r.filter.ModuleReconcilerNodePredicate(kernelLabel),
),
).
Named(BuildSignReconcilerName).
Complete(
reconcile.AsReconciler[*kmmv1beta1.Module](mgr.GetClient(), r),
)
}