/
definition.go
717 lines (597 loc) · 21 KB
/
definition.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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
package shared
import (
"errors"
"fmt"
"reflect"
"slices"
"strconv"
"strings"
"time"
"github.com/canonical/lxd/shared/osarch"
)
// ImageTarget represents the image target.
type ImageTarget int
const (
// ImageTargetAll is used for all targets.
ImageTargetAll ImageTarget = 1
// ImageTargetContainer is used for container targets.
ImageTargetContainer ImageTarget = 1 << 1
// ImageTargetVM is used for VM targets.
ImageTargetVM ImageTarget = 1 << 2
// ImageTargetUndefined is used when no type has been specified.
ImageTargetUndefined ImageTarget = 1 << 3
)
// DefinitionFilterType represents the filter type.
type DefinitionFilterType string
const (
// DefinitionFilterTypeVM is used for VMs.
DefinitionFilterTypeVM DefinitionFilterType = "vm"
// DefinitionFilterTypeContainer is used for containers.
DefinitionFilterTypeContainer DefinitionFilterType = "container"
)
// UnmarshalYAML validates the filter type.
func (d *DefinitionFilterType) UnmarshalYAML(unmarshal func(interface{}) error) error {
var filterType string
err := unmarshal(&filterType)
if err != nil {
return err
}
if DefinitionFilterType(filterType) != DefinitionFilterTypeContainer && DefinitionFilterType(filterType) != DefinitionFilterTypeVM {
return fmt.Errorf("Invalid filter type %q", filterType)
}
*d = DefinitionFilterType(filterType)
return nil
}
// Filter represents a filter.
type Filter interface {
GetReleases() []string
GetArchitectures() []string
GetVariants() []string
GetTypes() []DefinitionFilterType
}
// A DefinitionFilter defines filters for various actions.
type DefinitionFilter struct {
Releases []string `yaml:"releases,omitempty"`
Architectures []string `yaml:"architectures,omitempty"`
Variants []string `yaml:"variants,omitempty"`
Types []DefinitionFilterType `yaml:"types,omitempty"`
}
// GetReleases returns a list of releases.
func (d *DefinitionFilter) GetReleases() []string {
return d.Releases
}
// GetArchitectures returns a list of architectures.
func (d *DefinitionFilter) GetArchitectures() []string {
return d.Architectures
}
// GetVariants returns a list of variants.
func (d *DefinitionFilter) GetVariants() []string {
return d.Variants
}
// GetTypes returns a list of types.
func (d *DefinitionFilter) GetTypes() []DefinitionFilterType {
return d.Types
}
// A DefinitionPackagesSet is a set of packages which are to be installed
// or removed.
type DefinitionPackagesSet struct {
DefinitionFilter `yaml:",inline"`
Packages []string `yaml:"packages"`
Action string `yaml:"action"`
Early bool `yaml:"early,omitempty"`
Flags []string `yaml:"flags,omitempty"`
}
// A DefinitionPackagesRepository contains data of a specific repository.
type DefinitionPackagesRepository struct {
DefinitionFilter `yaml:",inline"`
Name string `yaml:"name"` // Name of the repository
URL string `yaml:"url"` // URL (may differ based on manager)
Type string `yaml:"type,omitempty"` // For distros that have more than one repository manager
Key string `yaml:"key,omitempty"` // GPG armored keyring
}
// CustomManagerCmd represents a command for a custom manager.
type CustomManagerCmd struct {
Command string `yaml:"cmd"`
Flags []string `yaml:"flags,omitempty"`
}
// DefinitionPackagesCustomManager represents a custom package manager.
type DefinitionPackagesCustomManager struct {
Clean CustomManagerCmd `yaml:"clean"`
Install CustomManagerCmd `yaml:"install"`
Remove CustomManagerCmd `yaml:"remove"`
Refresh CustomManagerCmd `yaml:"refresh"`
Update CustomManagerCmd `yaml:"update"`
Flags []string `yaml:"flags,omitempty"`
}
// A DefinitionPackages represents a package handler.
type DefinitionPackages struct {
Manager string `yaml:"manager,omitempty"`
CustomManager *DefinitionPackagesCustomManager `yaml:"custom_manager,omitempty"`
Update bool `yaml:"update,omitempty"`
Cleanup bool `yaml:"cleanup,omitempty"`
Sets []DefinitionPackagesSet `yaml:"sets,omitempty"`
Repositories []DefinitionPackagesRepository `yaml:"repositories,omitempty"`
}
// A DefinitionImage represents the image.
type DefinitionImage struct {
Description string `yaml:"description"`
Distribution string `yaml:"distribution"`
Release string `yaml:"release,omitempty"`
Architecture string `yaml:"architecture,omitempty"`
Expiry string `yaml:"expiry,omitempty"`
Variant string `yaml:"variant,omitempty"`
Name string `yaml:"name,omitempty"`
Serial string `yaml:"serial,omitempty"`
// Internal fields (YAML input ignored)
ArchitectureMapped string `yaml:"architecture_mapped,omitempty"`
ArchitectureKernel string `yaml:"architecture_kernel,omitempty"`
ArchitecturePersonality string `yaml:"architecture_personality,omitempty"`
}
// A DefinitionSource specifies the download type and location.
type DefinitionSource struct {
Downloader string `yaml:"downloader"`
URL string `yaml:"url,omitempty"`
Keys []string `yaml:"keys,omitempty"`
Keyserver string `yaml:"keyserver,omitempty"`
Variant string `yaml:"variant,omitempty"`
Suite string `yaml:"suite,omitempty"`
SameAs string `yaml:"same_as,omitempty"`
SkipVerification bool `yaml:"skip_verification,omitempty"`
Components []string `yaml:"components,omitempty"`
}
// A DefinitionTargetLXCConfig represents the config part of the metadata.
type DefinitionTargetLXCConfig struct {
DefinitionFilter `yaml:",inline"`
Type string `yaml:"type"`
Before uint `yaml:"before,omitempty"`
After uint `yaml:"after,omitempty"`
Content string `yaml:"content"`
}
// A DefinitionTargetLXC represents LXC specific files as part of the metadata.
type DefinitionTargetLXC struct {
CreateMessage string `yaml:"create_message,omitempty"`
Config []DefinitionTargetLXCConfig `yaml:"config,omitempty"`
}
// DefinitionTargetLXDVM represents LXD VM specific options.
type DefinitionTargetLXDVM struct {
Size uint64 `yaml:"size,omitempty"`
Filesystem string `yaml:"filesystem,omitempty"`
}
// DefinitionTargetLXD represents LXD specific options.
type DefinitionTargetLXD struct {
VM DefinitionTargetLXDVM `yaml:"vm,omitempty"`
}
// A DefinitionTarget specifies target dependent files.
type DefinitionTarget struct {
LXC DefinitionTargetLXC `yaml:"lxc,omitempty"`
LXD DefinitionTargetLXD `yaml:"lxd,omitempty"`
Type DefinitionFilterType // This field is internal only and used only for simplicity.
}
// A DefinitionFile represents a file which is to be created inside to chroot.
type DefinitionFile struct {
DefinitionFilter `yaml:",inline"`
Generator string `yaml:"generator"`
Path string `yaml:"path,omitempty"`
Content string `yaml:"content,omitempty"`
Name string `yaml:"name,omitempty"`
Template DefinitionFileTemplate `yaml:"template,omitempty"`
Templated bool `yaml:"templated,omitempty"`
Mode string `yaml:"mode,omitempty"`
GID string `yaml:"gid,omitempty"`
UID string `yaml:"uid,omitempty"`
Pongo bool `yaml:"pongo,omitempty"`
Source string `yaml:"source,omitempty"`
}
// A DefinitionFileTemplate represents the settings used by generators.
type DefinitionFileTemplate struct {
Properties map[string]string `yaml:"properties,omitempty"`
When []string `yaml:"when,omitempty"`
}
// A DefinitionAction specifies a custom action (script) which is to be run after
// a certain action.
type DefinitionAction struct {
DefinitionFilter `yaml:",inline"`
Trigger string `yaml:"trigger"`
Action string `yaml:"action"`
Pongo bool `yaml:"pongo,omitempty"`
}
// DefinitionMappings defines custom mappings.
type DefinitionMappings struct {
Architectures map[string]string `yaml:"architectures,omitempty"`
ArchitectureMap string `yaml:"architecture_map,omitempty"`
}
// DefinitionEnvVars defines custom environment variables.
type DefinitionEnvVars struct {
DefinitionFilter `yaml:",inline"`
Key string `yaml:"key"`
Value string `yaml:"value"`
}
// DefinitionEnv represents the config part of the environment section.
type DefinitionEnv struct {
ClearDefaults bool `yaml:"clear_defaults,omitempty"`
EnvVariables []DefinitionEnvVars `yaml:"variables,omitempty"`
}
// DefinitionSimplestreamRequirements contains a map of image requirements
// and filters to selectively apply the requirements.
type DefinitionSimplestreamRequirements struct {
DefinitionFilter `yaml:",inline"`
// Map of the image requirements.
Requirements map[string]string `yaml:"requirements,omitempty"`
}
// DefinitionSimplestream contains additional information about the image.
// It is parsed by the simplestream-maintainer when building a product
// catalog.
type DefinitionSimplestream struct {
// Pretty distro name.
DistroName string `yaml:"distro_name,omitempty"`
// Map of release aliases. Key represents the release name and value
// is a comma delimited string of additional release aliases.
ReleaseAliases map[string]string `yaml:"release_aliases,omitempty"`
// List of the image requirements.
Requirements []DefinitionSimplestreamRequirements `yaml:"requirements,omitempty"`
}
// A Definition a definition.
type Definition struct {
Image DefinitionImage `yaml:"image"`
Source DefinitionSource `yaml:"source"`
Targets DefinitionTarget `yaml:"targets,omitempty"`
Files []DefinitionFile `yaml:"files,omitempty"`
Packages DefinitionPackages `yaml:"packages,omitempty"`
Actions []DefinitionAction `yaml:"actions,omitempty"`
Mappings DefinitionMappings `yaml:"mappings,omitempty"`
Environment DefinitionEnv `yaml:"environment,omitempty"`
Simplestream DefinitionSimplestream `yaml:"simplestream,omitempty"`
}
// SetValue writes the provided value to a field represented by the yaml tag 'key'.
func (d *Definition) SetValue(key string, value string) error {
// Walk through the definition and find the field with the given key
field, err := getFieldByTag(reflect.ValueOf(d).Elem(), reflect.TypeOf(d).Elem(), key)
if err != nil {
return fmt.Errorf("Failed to get field by tag: %w", err)
}
// Fail if the field cannot be set
if !field.CanSet() {
return fmt.Errorf("Cannot set value for %s", key)
}
switch field.Kind() {
case reflect.Bool:
v, err := strconv.ParseBool(value)
if err != nil {
return fmt.Errorf("Failed to parse bool %q: %w", value, err)
}
field.SetBool(v)
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
v, err := strconv.ParseInt(value, 10, 64)
if err != nil {
return fmt.Errorf("Failed to parse int %q: %w", value, err)
}
field.SetInt(v)
case reflect.String:
field.SetString(value)
case reflect.Uint, reflect.Uintptr, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
v, err := strconv.ParseUint(value, 10, 64)
if err != nil {
return fmt.Errorf("Failed to parse uint %q: %w", value, err)
}
field.SetUint(v)
default:
return fmt.Errorf("Unsupported type '%s'", field.Kind())
}
return nil
}
// SetDefaults sets some default values.
func (d *Definition) SetDefaults() {
// default to local arch
if d.Image.Architecture == "" {
localArch, _ := osarch.ArchitectureGetLocal()
d.Image.Architecture = localArch
}
// set default expiry of 30 days
if d.Image.Expiry == "" {
d.Image.Expiry = "30d"
}
// Set default serial number
if d.Image.Serial == "" {
d.Image.Serial = time.Now().UTC().Format("20060102_1504")
}
// Set default variant
if d.Image.Variant == "" {
d.Image.Variant = "default"
}
// Set default keyserver
if d.Source.Keyserver == "" {
d.Source.Keyserver = "hkps.pool.sks-keyservers.net"
}
// Set default name and description templates
if d.Image.Name == "" {
d.Image.Name = "{{ image.distribution }}-{{ image.release }}-{{ image.architecture_mapped }}-{{ image.variant }}-{{ image.serial }}"
}
if d.Image.Description == "" {
d.Image.Description = "{{ image.distribution|capfirst }} {{ image.release }} {{ image.architecture_mapped }}{% if image.variant != \"default\" %} ({{ image.variant }}){% endif %} ({{ image.serial }})"
}
// Set default target type. This will only be overridden if building VMs for LXD.
d.Targets.Type = DefinitionFilterTypeContainer
}
// Validate validates the Definition.
func (d *Definition) Validate() error {
if strings.TrimSpace(d.Image.Distribution) == "" {
return errors.New("image.distribution may not be empty")
}
validDownloaders := []string{
"almalinux-http",
"alpinelinux-http",
"alt-http",
"apertis-http",
"archlinux-http",
"busybox",
"centos-http",
"springdalelinux-http",
"debootstrap",
"rpmbootstrap",
"fedora-http",
"gentoo-http",
"ubuntu-http",
"sabayon-http",
"docker-http",
"oraclelinux-http",
"openeuler-http",
"opensuse-http",
"openwrt-http",
"plamolinux-http",
"voidlinux-http",
"funtoo-http",
"rootfs-http",
"rockylinux-http",
"vyos-http",
"slackware-http",
"nixos-http",
}
if !slices.Contains(validDownloaders, strings.TrimSpace(d.Source.Downloader)) {
return fmt.Errorf("source.downloader must be one of %v", validDownloaders)
}
if d.Packages.Manager != "" {
validManagers := []string{
"apk",
"apt",
"dnf",
"egoportage",
"opkg",
"pacman",
"portage",
"yum",
"equo",
"xbps",
"zypper",
"anise",
"slackpkg",
}
if !slices.Contains(validManagers, strings.TrimSpace(d.Packages.Manager)) {
return fmt.Errorf("packages.manager must be one of %v", validManagers)
}
if d.Packages.CustomManager != nil {
return errors.New("cannot have both packages.manager and packages.custom_manager set")
}
} else {
if d.Packages.CustomManager == nil {
return errors.New("packages.manager or packages.custom_manager needs to be set")
}
if d.Packages.CustomManager.Clean.Command == "" {
return errors.New("packages.custom_manager requires a clean command")
}
if d.Packages.CustomManager.Install.Command == "" {
return errors.New("packages.custom_manager requires an install command")
}
if d.Packages.CustomManager.Remove.Command == "" {
return errors.New("packages.custom_manager requires a remove command")
}
if d.Packages.CustomManager.Refresh.Command == "" {
return errors.New("packages.custom_manager requires a refresh command")
}
if d.Packages.CustomManager.Update.Command == "" {
return errors.New("packages.custom_manager requires an update command")
}
}
validGenerators := []string{
"dump",
"copy",
"template",
"hostname",
"hosts",
"remove",
"cloud-init",
"lxd-agent",
"fstab",
}
for _, file := range d.Files {
if !slices.Contains(validGenerators, strings.TrimSpace(file.Generator)) {
return fmt.Errorf("files.*.generator must be one of %v", validGenerators)
}
}
validMappings := []string{
"almalinux",
"alpinelinux",
"altlinux",
"archlinux",
"centos",
"debian",
"gentoo",
"plamolinux",
"voidlinux",
"funtoo",
"slackware",
}
architectureMap := strings.TrimSpace(d.Mappings.ArchitectureMap)
if architectureMap != "" {
if !slices.Contains(validMappings, architectureMap) {
return fmt.Errorf("mappings.architecture_map must be one of %v", validMappings)
}
}
validTriggers := []string{
"post-files",
"post-packages",
"post-unpack",
"post-update",
}
for _, action := range d.Actions {
if !slices.Contains(validTriggers, action.Trigger) {
return fmt.Errorf("actions.*.trigger must be one of %v", validTriggers)
}
}
validPackageActions := []string{
"install",
"remove",
}
for _, set := range d.Packages.Sets {
if !slices.Contains(validPackageActions, set.Action) {
return fmt.Errorf("packages.*.set.*.action must be one of %v", validPackageActions)
}
}
// Mapped architecture (distro name)
archMapped, err := d.getMappedArchitecture()
if err != nil {
return fmt.Errorf("Failed to get mapped architecture: %w", err)
}
d.Image.ArchitectureMapped = archMapped
// Kernel architecture and personality
archID, err := osarch.ArchitectureId(d.Image.Architecture)
if err != nil {
return fmt.Errorf("Failed to get architecture ID: %w", err)
}
archName, err := osarch.ArchitectureName(archID)
if err != nil {
return fmt.Errorf("Failed to get architecture name: %w", err)
}
d.Image.ArchitectureKernel = archName
archPersonality, err := osarch.ArchitecturePersonality(archID)
if err != nil {
return fmt.Errorf("Failed to get architecture personality: %w", err)
}
d.Image.ArchitecturePersonality = archPersonality
return nil
}
// GetRunnableActions returns a list of actions depending on the trigger
// and releases.
func (d *Definition) GetRunnableActions(trigger string, imageTarget ImageTarget) []DefinitionAction {
out := []DefinitionAction{}
for _, action := range d.Actions {
if action.Trigger != trigger {
continue
}
if !ApplyFilter(&action, d.Image.Release, d.Image.ArchitectureMapped, d.Image.Variant, d.Targets.Type, imageTarget) {
continue
}
out = append(out, action)
}
return out
}
// GetEarlyPackages returns a list of packages which are to be installed or removed earlier than the actual package handling
// Also removes them from the package set so they aren't attempted to be re-installed again as normal packages.
func (d *Definition) GetEarlyPackages(action string) []string {
var early []string
normal := []DefinitionPackagesSet{}
for _, set := range d.Packages.Sets {
if set.Early && set.Action == action && ApplyFilter(&set, d.Image.Release, d.Image.ArchitectureMapped, d.Image.Variant, d.Targets.Type, 0) {
early = append(early, set.Packages...)
} else {
normal = append(normal, set)
}
}
d.Packages.Sets = normal
return early
}
func (d *Definition) getMappedArchitecture() (string, error) {
var arch string
if d.Mappings.ArchitectureMap != "" {
// Translate the architecture using the requested map
var err error
arch, err = GetArch(d.Mappings.ArchitectureMap, d.Image.Architecture)
if err != nil {
return "", fmt.Errorf("Failed to translate the architecture name: %w", err)
}
} else if len(d.Mappings.Architectures) > 0 {
// Translate the architecture using a user specified mapping
var ok bool
arch, ok = d.Mappings.Architectures[d.Image.Architecture]
if !ok {
// If no mapping exists, it means it doesn't need translating
arch = d.Image.Architecture
}
} else {
// No map or mappings provided, just go with it as it is
arch = d.Image.Architecture
}
return arch, nil
}
func getFieldByTag(v reflect.Value, t reflect.Type, tag string) (reflect.Value, error) {
parts := strings.SplitN(tag, ".", 2)
if t.Kind() == reflect.Slice {
// Get index, e.g. '0' from tag 'foo.0'
value, err := strconv.Atoi(parts[0])
if err != nil {
return reflect.Value{}, err
}
if t.Elem().Kind() == reflect.Struct {
// Make sure we are in range, otherwise return error
if value < 0 || value >= v.Len() {
return reflect.Value{}, errors.New("Index out of range")
}
return getFieldByTag(v.Index(value), t.Elem(), parts[1])
}
// Primitive type
return v.Index(value), nil
}
if t.Kind() == reflect.Struct {
// Find struct field with correct tag
for i := 0; i < t.NumField(); i++ {
value := t.Field(i).Tag.Get("yaml")
if value != "" && strings.Split(value, ",")[0] == parts[0] {
if len(parts) == 1 {
return v.Field(i), nil
}
return getFieldByTag(v.Field(i), t.Field(i).Type, parts[1])
}
}
}
// Return its value if it's a primitive type
return v, nil
}
// ApplyFilter returns true if the filter matches.
func ApplyFilter(filter Filter, release string, architecture string, variant string, targetType DefinitionFilterType, acceptedImageTargets ImageTarget) bool {
if len(filter.GetReleases()) > 0 && !slices.Contains(filter.GetReleases(), release) {
return false
}
if len(filter.GetArchitectures()) > 0 && !slices.Contains(filter.GetArchitectures(), architecture) {
return false
}
if len(filter.GetVariants()) > 0 && !slices.Contains(filter.GetVariants(), variant) {
return false
}
types := filter.GetTypes()
if (acceptedImageTargets == 0 || acceptedImageTargets&ImageTargetUndefined > 0) && len(types) == 0 {
return true
}
hasTargetType := func(targetType DefinitionFilterType) bool {
for _, t := range types {
if t == targetType {
return true
}
}
return false
}
if acceptedImageTargets&ImageTargetAll > 0 {
if len(types) == 2 && hasTargetType(targetType) {
return true
}
}
if acceptedImageTargets&ImageTargetContainer > 0 {
if targetType == DefinitionFilterTypeContainer && hasTargetType(targetType) {
return true
}
}
if acceptedImageTargets&ImageTargetVM > 0 {
if targetType == DefinitionFilterTypeVM && hasTargetType(targetType) {
return true
}
}
return false
}