generated from kubernetes/kubernetes-template-project
/
preflight.go
197 lines (168 loc) · 7.88 KB
/
preflight.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
package preflight
import (
"context"
"fmt"
kmmv1beta1 "github.com/kubernetes-sigs/kernel-module-management/api/v1beta1"
"github.com/kubernetes-sigs/kernel-module-management/internal/api"
"github.com/kubernetes-sigs/kernel-module-management/internal/auth"
"github.com/kubernetes-sigs/kernel-module-management/internal/build"
"github.com/kubernetes-sigs/kernel-module-management/internal/module"
"github.com/kubernetes-sigs/kernel-module-management/internal/registry"
"github.com/kubernetes-sigs/kernel-module-management/internal/sign"
"github.com/kubernetes-sigs/kernel-module-management/internal/statusupdater"
"github.com/kubernetes-sigs/kernel-module-management/internal/utils"
ctrlruntime "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
)
const (
VerificationStatusReasonBuildConfigPresent = "Verification successful, all driver-containers have paired BuildConfigs in the recipe"
VerificationStatusReasonNoDaemonSet = "Verification successful, no driver-container present in the recipe"
VerificationStatusReasonUnknown = "Verification has not started yet"
VerificationStatusReasonVerified = "Verification successful (%s), this Module will not be verified again in this Preflight CR"
)
//go:generate mockgen -source=preflight.go -package=preflight -destination=mock_preflight_api.go PreflightAPI, preflightHelperAPI
type PreflightAPI interface {
PreflightUpgradeCheck(ctx context.Context, pv *kmmv1beta1.PreflightValidation, mod *kmmv1beta1.Module) (bool, string)
}
func NewPreflightAPI(
client client.Client,
buildAPI build.Manager,
signAPI sign.SignManager,
registryAPI registry.Registry,
statusUpdater statusupdater.PreflightStatusUpdater,
kernelAPI module.KernelMapper) PreflightAPI {
helper := newPreflightHelper(client, buildAPI, signAPI, registryAPI)
return &preflight{
kernelAPI: kernelAPI,
statusUpdater: statusUpdater,
helper: helper,
}
}
type preflight struct {
kernelAPI module.KernelMapper
statusUpdater statusupdater.PreflightStatusUpdater
helper preflightHelperAPI
}
func (p *preflight) PreflightUpgradeCheck(ctx context.Context, pv *kmmv1beta1.PreflightValidation, mod *kmmv1beta1.Module) (bool, string) {
log := ctrlruntime.LoggerFrom(ctx)
kernelVersion := pv.Spec.KernelVersion
mld, err := p.kernelAPI.GetModuleLoaderDataForKernel(mod, kernelVersion)
if err != nil {
return false, fmt.Sprintf("failed to process kernel mapping in the module %s for kernel version %s", mod.Name, kernelVersion)
}
err = p.statusUpdater.PreflightSetVerificationStage(ctx, pv, mld.Name, kmmv1beta1.VerificationStageImage)
if err != nil {
log.Info(utils.WarnString("failed to update the stage of Module CR in preflight to image stage"), "module", mld.Name, "error", err)
}
verified, msg := p.helper.verifyImage(ctx, mld)
if verified {
return true, msg
}
shouldBuild := module.ShouldBeBuilt(mld)
shouldSign := module.ShouldBeSigned(mld)
if shouldBuild {
err = p.statusUpdater.PreflightSetVerificationStage(ctx, pv, mld.Name, kmmv1beta1.VerificationStageBuild)
if err != nil {
log.Info(utils.WarnString("failed to update the stage of Module CR in preflight to build stage"), "module", mld.Name, "error", err)
}
verified, msg = p.helper.verifyBuild(ctx, pv, mld)
if !verified {
return false, msg
}
}
if shouldSign {
err = p.statusUpdater.PreflightSetVerificationStage(ctx, pv, mld.Name, kmmv1beta1.VerificationStageSign)
if err != nil {
log.Info(utils.WarnString("failed to update the stage of Module CR in preflight to sign stage"), "module", mld.Name, "error", err)
}
verified, msg = p.helper.verifySign(ctx, pv, mld)
if !verified {
return false, msg
}
}
return verified, msg
}
type preflightHelperAPI interface {
verifyImage(ctx context.Context, mld *api.ModuleLoaderData) (bool, string)
verifyBuild(ctx context.Context, pv *kmmv1beta1.PreflightValidation, mld *api.ModuleLoaderData) (bool, string)
verifySign(ctx context.Context, pv *kmmv1beta1.PreflightValidation, mld *api.ModuleLoaderData) (bool, string)
}
type preflightHelper struct {
client client.Client
registryAPI registry.Registry
buildAPI build.Manager
signAPI sign.SignManager
}
func newPreflightHelper(client client.Client, buildAPI build.Manager, signAPI sign.SignManager, registryAPI registry.Registry) preflightHelperAPI {
return &preflightHelper{
client: client,
buildAPI: buildAPI,
signAPI: signAPI,
registryAPI: registryAPI,
}
}
func (p *preflightHelper) verifyImage(ctx context.Context, mld *api.ModuleLoaderData) (bool, string) {
log := ctrlruntime.LoggerFrom(ctx)
image := mld.ContainerImage
moduleFileName := mld.Modprobe.ModuleName + ".ko"
baseDir := mld.Modprobe.DirName
kernelVersion := mld.KernelVersion
registryAuthGetter := auth.NewRegistryAuthGetterFrom(p.client, mld)
digests, repoConfig, err := p.registryAPI.GetLayersDigests(ctx, image, mld.RegistryTLS, registryAuthGetter)
if err != nil {
log.Info("image layers inaccessible, image probably does not exists", "module name", mld.Name, "image", image)
return false, fmt.Sprintf("image %s inaccessible or does not exists", image)
}
for i := len(digests) - 1; i >= 0; i-- {
layer, err := p.registryAPI.GetLayerByDigest(digests[i], repoConfig)
if err != nil {
log.Info("layer from image inaccessible", "layer", digests[i], "repo", repoConfig, "image", image)
return false, fmt.Sprintf("image %s, layer %s is inaccessible", image, digests[i])
}
// check kernel module file present in the directory of the kernel lib modules
if p.registryAPI.VerifyModuleExists(layer, baseDir, kernelVersion, moduleFileName) {
return true, fmt.Sprintf(VerificationStatusReasonVerified, "image accessible and verified")
}
log.V(1).Info("module is not present in the current layer", "image", image, "module file name", moduleFileName, "kernel", kernelVersion, "dir", baseDir)
}
log.Info("driver for kernel is not present in the image", "baseDir", baseDir, "kernel", kernelVersion, "moduleFileName", moduleFileName, "image", image)
return false, fmt.Sprintf("image %s does not contain kernel module for kernel %s on any layer", image, kernelVersion)
}
func (p *preflightHelper) verifyBuild(ctx context.Context, pv *kmmv1beta1.PreflightValidation, mld *api.ModuleLoaderData) (bool, string) {
log := ctrlruntime.LoggerFrom(ctx)
// at this stage we know that eiher mapping Build or Container build are defined
buildStatus, err := p.buildAPI.Sync(ctx, mld, pv.Spec.PushBuiltImage, pv)
if err != nil {
return false, fmt.Sprintf("Failed to verify build for module %s, kernel version %s, error %s", mld.Name, pv.Spec.KernelVersion, err)
}
if buildStatus == utils.StatusCompleted {
msg := "build compiles"
if pv.Spec.PushBuiltImage {
msg += " and image pushed"
}
log.Info("build for module during preflight has been build successfully", "module", mld.Name)
return true, fmt.Sprintf(VerificationStatusReasonVerified, msg)
}
return false, "Waiting for build verification"
}
func (p *preflightHelper) verifySign(ctx context.Context, pv *kmmv1beta1.PreflightValidation, mld *api.ModuleLoaderData) (bool, string) {
log := ctrlruntime.LoggerFrom(ctx)
previousImage := ""
if module.ShouldBeBuilt(mld) {
previousImage = module.IntermediateImageName(mld.Name, mld.Namespace, mld.ContainerImage)
}
// at this stage we know that eiher mapping Sign or Container sign are defined
signStatus, err := p.signAPI.Sync(ctx, mld, previousImage, pv.Spec.PushBuiltImage, pv)
if err != nil {
return false, fmt.Sprintf("Failed to verify signing for module %s, kernel version %s, error %s", mld.Name, pv.Spec.KernelVersion, err)
}
if signStatus == utils.StatusCompleted {
msg := "sign completes"
if pv.Spec.PushBuiltImage {
msg += " and image pushed"
}
log.Info("build for module during preflight has been build successfully", "module", mld.Name)
return true, fmt.Sprintf(VerificationStatusReasonVerified, msg)
}
return false, "Waiting for sign verification"
}