-
Notifications
You must be signed in to change notification settings - Fork 345
/
image.go
268 lines (222 loc) · 7.39 KB
/
image.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
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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 builder
import (
"os"
"path"
"path/filepath"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/selection"
ctrl "sigs.k8s.io/controller-runtime/pkg/client"
v1 "github.com/apache/camel-k/v2/pkg/apis/camel/v1"
"github.com/apache/camel-k/v2/pkg/util"
"github.com/apache/camel-k/v2/pkg/util/defaults"
)
const (
// ContextDir is the directory used to package the container.
ContextDir = "context"
// DeploymentDir is the directory used in the runtime application to deploy the artifacts.
DeploymentDir = "/deployments"
// DependenciesDir is the directory used to store required dependencies.
DependenciesDir = "dependencies"
)
func init() {
registerSteps(Image)
}
type imageSteps struct {
IncrementalImageContext Step
NativeImageContext Step
StandardImageContext Step
ExecutableDockerfile Step
JvmDockerfile Step
}
// Image used to export the steps available on an Image building process.
var Image = imageSteps{
IncrementalImageContext: NewStep(ApplicationPackagePhase, incrementalImageContext),
NativeImageContext: NewStep(ApplicationPackagePhase, nativeImageContext),
StandardImageContext: NewStep(ApplicationPackagePhase, standardImageContext),
ExecutableDockerfile: NewStep(ApplicationPackagePhase+1, executableDockerfile),
JvmDockerfile: NewStep(ApplicationPackagePhase+1, jvmDockerfile),
}
type artifactsSelector func(ctx *builderContext) error
func nativeImageContext(ctx *builderContext) error {
return imageContext(ctx, func(ctx *builderContext) error {
runner := "camel-k-integration-" + defaults.Version + "-runner"
ctx.Artifacts = []v1.Artifact{
{
ID: runner,
Location: QuarkusRuntimeSupport(ctx.Catalog.GetCamelQuarkusVersion()).TargetDirectory(ctx.Path, runner),
Target: runner,
},
}
ctx.SelectedArtifacts = ctx.Artifacts
return nil
})
}
func executableDockerfile(ctx *builderContext) error {
// #nosec G202
dockerfile := []byte(`
FROM ` + ctx.BaseImage + `
WORKDIR ` + DeploymentDir + `
COPY --chown=nonroot:root . ` + DeploymentDir + `
USER nonroot
`)
err := os.WriteFile(filepath.Join(ctx.Path, ContextDir, "Dockerfile"), dockerfile, 0o400)
if err != nil {
return err
}
return nil
}
func standardImageContext(ctx *builderContext) error {
return imageContext(ctx, func(ctx *builderContext) error {
ctx.SelectedArtifacts = ctx.Artifacts
return nil
})
}
func jvmDockerfile(ctx *builderContext) error {
// #nosec G202
dockerfile := []byte(`
FROM ` + ctx.BaseImage + `
ADD . ` + DeploymentDir + `
USER 1000
`)
err := os.WriteFile(filepath.Join(ctx.Path, ContextDir, "Dockerfile"), dockerfile, 0o400)
if err != nil {
return err
}
return nil
}
func incrementalImageContext(ctx *builderContext) error {
images, err := listPublishedImages(ctx)
if err != nil {
return err
}
return imageContext(ctx, func(ctx *builderContext) error {
ctx.SelectedArtifacts = ctx.Artifacts
bestImage, commonLibs := findBestImage(images, ctx.Artifacts)
if bestImage.Image != "" {
ctx.BaseImage = bestImage.Image
ctx.SelectedArtifacts = make([]v1.Artifact, 0)
for _, entry := range ctx.Artifacts {
if _, isCommon := commonLibs[entry.ID]; !isCommon {
ctx.SelectedArtifacts = append(ctx.SelectedArtifacts, entry)
}
}
}
return nil
})
}
func imageContext(ctx *builderContext, selector artifactsSelector) error {
err := selector(ctx)
if err != nil {
return err
}
contextDir := filepath.Join(ctx.Path, ContextDir)
err = os.MkdirAll(contextDir, 0o700)
if err != nil {
return err
}
for _, entry := range ctx.SelectedArtifacts {
_, err := util.CopyFile(entry.Location, filepath.Join(contextDir, entry.Target))
if err != nil {
return err
}
}
for _, entry := range ctx.Resources {
filePath, fileName := path.Split(entry.Target)
fullPath := filepath.Join(contextDir, filePath, fileName)
if err := util.WriteFileWithContent(fullPath, entry.Content); err != nil {
return err
}
}
return nil
}
func listPublishedImages(context *builderContext) ([]v1.IntegrationKitStatus, error) {
excludeNativeImages, err := labels.NewRequirement(v1.IntegrationKitLayoutLabel, selection.NotEquals, []string{
v1.IntegrationKitLayoutNativeSources,
})
if err != nil {
return nil, err
}
options := []ctrl.ListOption{
ctrl.InNamespace(context.Namespace),
ctrl.MatchingLabels{
v1.IntegrationKitTypeLabel: v1.IntegrationKitTypePlatform,
"camel.apache.org/runtime.version": context.Catalog.Runtime.Version,
"camel.apache.org/runtime.provider": string(context.Catalog.Runtime.Provider),
},
ctrl.MatchingLabelsSelector{
Selector: labels.NewSelector().Add(*excludeNativeImages),
},
}
list := v1.NewIntegrationKitList()
err = context.Client.List(context.C, &list, options...)
if err != nil {
return nil, err
}
images := make([]v1.IntegrationKitStatus, 0)
for _, kit := range list.Items {
// Discard non ready kits
if kit.Status.Phase != v1.IntegrationKitPhaseReady {
continue
}
// Discard kits with a different root hierarchy
// context.BaseImage should still contain the root base image at this stage
if kit.Status.RootImage != context.BaseImage {
continue
}
images = append(images, kit.Status)
}
return images, nil
}
func findBestImage(images []v1.IntegrationKitStatus, artifacts []v1.Artifact) (v1.IntegrationKitStatus, map[string]bool) {
var bestImage v1.IntegrationKitStatus
if len(images) == 0 {
return bestImage, nil
}
requiredLibs := make(map[string]string, len(artifacts))
for _, entry := range artifacts {
requiredLibs[entry.ID] = entry.Checksum
}
bestImageCommonLibs := make(map[string]bool)
bestImageSurplusLibs := 0
for _, image := range images {
common := make(map[string]bool)
for _, artifact := range image.Artifacts {
// If the Artifact's checksum is not defined we can't reliably determine if for some
// reason the artifact has been changed but not the ID (as example for snapshots or
// other generated jar) thus we do not take this artifact into account.
if artifact.Checksum == "" {
continue
}
if requiredLibs[artifact.ID] == artifact.Checksum {
common[artifact.ID] = true
}
}
numCommonLibs := len(common)
surplus := len(image.Artifacts) - numCommonLibs
if numCommonLibs != len(image.Artifacts) && surplus >= numCommonLibs/3 {
// Heuristic approach: if there are too many unrelated libraries then this image is
// not suitable to be used as base image
continue
}
if numCommonLibs > len(bestImageCommonLibs) || (numCommonLibs == len(bestImageCommonLibs) && surplus < bestImageSurplusLibs) {
bestImage = image
bestImageCommonLibs = common
bestImageSurplusLibs = surplus
}
}
return bestImage, bestImageCommonLibs
}