-
Notifications
You must be signed in to change notification settings - Fork 71
/
grow_manifest.go
325 lines (283 loc) · 8.29 KB
/
grow_manifest.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
/*
Copyright 2020 The Kubernetes Authors.
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 inventory
import (
"context"
"io/ioutil"
"path"
"path/filepath"
"github.com/sirupsen/logrus"
"golang.org/x/xerrors"
)
const (
// This is a banned tag. It is not allowed to be manipulated with this tool.
latestTag = "latest"
)
// GrowManifestOptions holds the parameters for modifying manifests.
type GrowManifestOptions struct {
// BaseDir is the directory containing the thin promoter manifests.
BaseDir string
// StagingRepo is the staging subproject repo to read from. If no filters
// are provided, all images are attempted to be promoted as-is without any
// modifications.
StagingRepo RegistryName
// FilterImage is the image (name) to filter by. Optional.
FilterImage ImageName
// FilterDigest is the image digest to filter by. Optional.
FilterDigest Digest
// FilterTag is the image tag to filter by. Optional.
FilterTag Tag
}
// Populate sets the values for GrowManifestOptions.
func (o *GrowManifestOptions) Populate(
baseDir,
stagingRepo,
filterImage,
filterDigest,
filterTag string,
) error {
baseDirAbsPath, err := filepath.Abs(baseDir)
if err != nil {
return xerrors.Errorf(
"cannot resolve %q to absolute path: %w", baseDir, err)
}
o.BaseDir = baseDirAbsPath
o.StagingRepo = RegistryName(stagingRepo)
o.FilterImage = ImageName(filterImage)
o.FilterDigest = Digest(filterDigest)
o.FilterTag = Tag(filterTag)
return nil
}
// Validate validates the options.
func (o *GrowManifestOptions) Validate() error {
if o.BaseDir == "" {
return xerrors.New("must specify --base_dir")
}
if o.StagingRepo == "" {
return xerrors.New("must specify --staging_repo")
}
if o.FilterTag == latestTag {
return xerrors.Errorf(
"--filter_tag cannot be %q (anti-pattern)", latestTag)
}
return nil
}
// GrowManifest modifies a manifest by adding images into it.
func GrowManifest(
ctx context.Context,
o *GrowManifestOptions,
) error {
var err error
var riiCombined RegInvImage
// (1) Scan the BaseDir and find the promoter manifest to modify.
manifest, err := FindManifest(o)
if err != nil {
return err
}
// (2) Scan the StagingRepo, and whittle the read results down with some
// filters (Filter* fields in GrowManifestOptions).
riiUnfiltered, err := ReadStagingRepo(o)
if err != nil {
return err
}
// (3) Apply some filters.
riiFiltered, err := ApplyFilters(o, riiUnfiltered)
if err != nil {
return err
}
// (4) Inject (2)'s output into (1)'s manifest's images to create a larger
// RegInvImage.
riiCombined = Union(manifest.ToRegInvImage(), riiFiltered)
// (5) Write back RegInvImage as Manifest ([]Image field}) back onto disk.
err = WriteImages(manifest, riiCombined)
return err
}
// WriteImages writes images as YAML out to the expected path of the given
// (thin) manifest.
func WriteImages(manifest Manifest, rii RegInvImage) error {
// Chop off trailing "promoter-manifest.yaml".
p := path.Dir(manifest.Filepath)
// Get staging repo directory name as it is laid out in the thin manifest
// dir.
stagingRepoName := path.Base(p)
// Construct path to the images.yaml.
imagesPath := path.Join(p, "..", "..",
"images", stagingRepoName, "images.yaml")
logrus.Infoln("RENDER", imagesPath)
// Write the file.
err := ioutil.WriteFile(
imagesPath, []byte(rii.ToYAML(YamlMarshalingOpts{})), 0o644)
return err
}
// FindManifest finds the manifest to modify.
func FindManifest(o *GrowManifestOptions) (Manifest, error) {
var err error
var manifests []Manifest
manifests, err = ParseThinManifestsFromDir(o.BaseDir)
if err != nil {
return Manifest{}, err
}
logrus.Infof("%d manifests parsed", len(manifests))
for _, manifest := range manifests {
if manifest.SrcRegistry.Name == o.StagingRepo {
return manifest, nil
}
}
return Manifest{},
xerrors.Errorf("could not find Manifest for %q", o.StagingRepo)
}
// ReadStagingRepo reads the StagingRepo, and applies whatever filters are
// available to the resulting RegInvImage. This RegInvImage is what we want to
// inject into the "images.yaml" of a thin manifest.
func ReadStagingRepo(
o *GrowManifestOptions,
) (RegInvImage, error) {
stagingRepoRC := RegistryContext{
Name: o.StagingRepo,
}
manifests := []Manifest{
{
Registries: []RegistryContext{
stagingRepoRC,
},
Images: []Image{},
},
}
sc, err := MakeSyncContext(
manifests,
10,
true,
false)
if err != nil {
return RegInvImage{}, err
}
sc.ReadRegistries(
[]RegistryContext{stagingRepoRC},
// Read all registries recursively, because we want to produce a
// complete snapshot.
true,
MkReadRepositoryCmdReal)
return sc.Inv[manifests[0].Registries[0].Name], nil
}
// ApplyFilters applies the filters in the options to whittle down the given
// rii.
func ApplyFilters(o *GrowManifestOptions, rii RegInvImage) (RegInvImage, error) {
// If nothing to filter, short-circuit.
if len(rii) == 0 {
return rii, nil
}
// Now perform some filtering, if any.
if len(o.FilterImage) > 0 {
rii = FilterByImage(rii, o.FilterImage)
}
if len(o.FilterTag) > 0 {
rii = FilterByTag(rii, string(o.FilterTag))
}
if len(o.FilterDigest) > 0 {
rii = FilterByDigest(rii, o.FilterDigest)
}
// Remove any other tags that should still be filtered.
excludeTags := map[Tag]bool{latestTag: true}
rii = ExcludeTags(rii, excludeTags)
if len(rii) == 0 {
return RegInvImage{}, xerrors.New(
"no images survived filtering; double-check your --filter_* flag(s) for typos",
)
}
return rii, nil
}
// FilterByImage removes all images in RegInvImage that do not match the
// filterImage.
func FilterByImage(rii RegInvImage, filterImage ImageName) RegInvImage {
filtered := make(RegInvImage)
for imageName, digestTags := range rii {
if imageName == filterImage {
filtered[imageName] = digestTags
}
}
return filtered
}
// FilterByDigest removes all images in RegInvImage that do not match the
// filterDigest.
func FilterByDigest(rii RegInvImage, filterDigest Digest) RegInvImage {
filtered := make(RegInvImage)
for imageName, digestTags := range rii {
for digest, tags := range digestTags {
if digest == filterDigest {
if filtered[imageName] == nil {
filtered[imageName] = make(DigestTags)
}
filtered[imageName][digest] = tags
}
}
}
return filtered
}
// ExcludeTags removes tags in rii that match excludedTags.
func ExcludeTags(rii RegInvImage, excludedTags map[Tag]bool) RegInvImage {
filtered := make(RegInvImage)
for imageName, digestTags := range rii {
for digest, tags := range digestTags {
for _, tag := range tags {
if _, excludeMe := excludedTags[tag]; excludeMe {
continue
}
if filtered[imageName] == nil {
filtered[imageName] = make(DigestTags)
}
filtered[imageName][digest] = append(
filtered[imageName][digest],
tag)
}
}
}
return filtered
}
// Union inject b's contents into a. However, it does so in a special way.
func Union(a, b RegInvImage) RegInvImage {
for imageName, digestTags := range b {
// If a does not have this image at all, then it's a simple
// injection.
if a[imageName] == nil {
a[imageName] = digestTags
continue
}
for digest, tags := range digestTags {
// If a has the image but not this digest, inject just this digest
// and all associated tags.
if a[imageName][digest] == nil {
a[imageName][digest] = tags
continue
}
// If c has the digest already, try to inject those tags in b that
// are not already in a.
tagSlice := TagSlice{}
for tag := range tags.Union(a[imageName][digest]) {
if tag == "latest" {
continue
}
tagSlice = append(tagSlice, tag)
}
a[imageName][digest] = tagSlice
}
}
return a
}
// ToRegInvImage converts a Manifest into a RegInvImage.
func (manifest *Manifest) ToRegInvImage() RegInvImage {
rii := make(RegInvImage)
for _, image := range manifest.Images {
rii[image.ImageName] = image.Dmap
}
return rii
}