File: main_add.go

package info (click to toggle)
incus 6.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 23,864 kB
  • sloc: sh: 16,015; ansic: 3,121; python: 456; makefile: 321; ruby: 51; sql: 50; lisp: 6
file content (447 lines) | stat: -rw-r--r-- 10,181 bytes parent folder | download | duplicates (3)
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
package main

import (
	"archive/tar"
	"context"
	"crypto/sha256"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"io/fs"
	"os"
	"strings"
	"time"

	"github.com/spf13/cobra"
	"gopkg.in/yaml.v2"

	cli "github.com/lxc/incus/v6/internal/cmd"
	internalUtil "github.com/lxc/incus/v6/internal/util"
	"github.com/lxc/incus/v6/shared/api"
	"github.com/lxc/incus/v6/shared/archive"
	"github.com/lxc/incus/v6/shared/osarch"
	"github.com/lxc/incus/v6/shared/simplestreams"
)

type cmdAdd struct {
	global *cmdGlobal

	flagAliases        []string
	flagNoDefaultAlias bool
}

// Command generates the command definition.
func (c *cmdAdd) Command() *cobra.Command {
	cmd := &cobra.Command{}
	cmd.Use = "add <metadata tarball> [<data file>]"
	cmd.Short = "Add an image"
	cmd.Long = cli.FormatSection("Description",
		`Add an image to the server

This command parses the metadata tarball to retrieve the following fields from its metadata.yaml:
 - architecture
 - creation_date
 - properties["description"]
 - properties["os"]
 - properties["release"]
 - properties["variant"]
 - properties["architecture"]

It then check computes the hash for the new image, confirm it's not
already on the image server and finally adds it to the index.

Unless "--no-default-alias" is specified, it generates a default "{os}/{release}/{variant}" alias.

If one argument is specified, it is assumed to be a unified image,
with both the metadata and rootfs in a single tarball.

Otherwise, it is a split image (separate files for metadata and rootfs/disk).
`)
	cmd.RunE = c.Run

	cmd.Flags().StringArrayVar(&c.flagAliases, "alias", nil, "Add alias")
	cmd.Flags().BoolVar(&c.flagNoDefaultAlias, "no-default-alias", false, "Do not add the default alias")

	return cmd
}

// dataItem - holds information about the image data file.
// used if different from the metadata file.
type dataItem struct {
	Path           string
	FileType       string
	Size           int64
	Sha256         string
	Extension      string
	combinedSha256 string
}

// parseImage parses the metadata and data, filling the dataItem struct.
func (c *cmdAdd) parseImage(metaFile *os.File, dataFile *os.File) (*dataItem, error) {
	item := dataItem{
		Path: dataFile.Name(),
	}

	// Read the header.
	_, extension, _, err := archive.DetectCompressionFile(dataFile)
	if err != nil {
		return nil, err
	}

	item.Extension = extension

	if item.Extension == ".squashfs" {
		item.FileType = "squashfs"
	} else if item.Extension == ".qcow2" {
		item.FileType = "disk-kvm.img"
	} else {
		return nil, fmt.Errorf("Unsupported data type %q", item.Extension)
	}

	// Get the size.
	dataStat, err := dataFile.Stat()
	if err != nil {
		return nil, err
	}

	item.Size = dataStat.Size()

	// Get the sha256.
	_, err = dataFile.Seek(0, 0)
	if err != nil {
		return nil, err
	}

	hash256 := sha256.New()
	_, err = io.Copy(hash256, dataFile)
	if err != nil {
		return nil, err
	}

	item.Sha256 = fmt.Sprintf("%x", hash256.Sum(nil))

	// Get the combined sha256.
	_, err = metaFile.Seek(0, 0)
	if err != nil {
		return nil, err
	}

	_, err = dataFile.Seek(0, 0)
	if err != nil {
		return nil, err
	}

	hash256 = sha256.New()
	_, err = io.Copy(hash256, metaFile)
	if err != nil {
		return nil, err
	}

	_, err = io.Copy(hash256, dataFile)
	if err != nil {
		return nil, err
	}

	item.combinedSha256 = fmt.Sprintf("%x", hash256.Sum(nil))

	return &item, nil
}

// Run runs the actual command logic.
func (c *cmdAdd) Run(cmd *cobra.Command, args []string) error {
	// Quick checks.
	exit, err := c.global.CheckArgs(cmd, args, 1, 2)
	if exit {
		return err
	}

	isUnifiedTarball := (len(args) == 1)

	// Open the metadata.
	metaFile, err := os.Open(args[0])
	if err != nil {
		return err
	}

	defer metaFile.Close()

	// Read the header.
	_, _, unpacker, err := archive.DetectCompressionFile(metaFile)
	if err != nil {
		return err
	}

	// Get the size.
	metaStat, err := metaFile.Stat()
	if err != nil {
		return err
	}

	metaSize := metaStat.Size()

	// Get the sha256.
	_, err = metaFile.Seek(0, 0)
	if err != nil {
		return err
	}

	hash256 := sha256.New()
	_, err = io.Copy(hash256, metaFile)
	if err != nil {
		return err
	}

	metaSha256 := fmt.Sprintf("%x", hash256.Sum(nil))

	// Set the metadata paths.
	metaPath := args[0]

	// Go through the tarball.
	_, err = metaFile.Seek(0, 0)
	if err != nil {
		return err
	}

	metaTar, metaTarCancel, err := archive.CompressedTarReader(context.Background(), metaFile, unpacker, "")
	if err != nil {
		return err
	}

	defer metaTarCancel()

	var hdr *tar.Header
	for {
		hdr, err = metaTar.Next()
		if err != nil {
			if err == io.EOF {
				break
			}

			return err
		}

		if hdr.Name == "metadata.yaml" {
			break
		}
	}

	if hdr == nil || hdr.Name != "metadata.yaml" {
		return fmt.Errorf("Couldn't find metadata.yaml in metadata tarball")
	}

	// Parse the metadata.
	metadata := api.ImageMetadata{}

	body, err := io.ReadAll(metaTar)
	if err != nil {
		return err
	}

	err = yaml.Unmarshal(body, &metadata)
	if err != nil {
		return err
	}

	// Validate the metadata.
	_, err = osarch.ArchitectureId(metadata.Architecture)
	if err != nil {
		return fmt.Errorf("Invalid architecture in metadata.yaml: %w", err)
	}

	if metadata.CreationDate == 0 {
		return fmt.Errorf("Missing creation date in metadata.yaml")
	}

	for _, prop := range []string{"os", "release", "variant", "architecture", "description"} {
		_, ok := metadata.Properties[prop]
		if !ok {
			return fmt.Errorf("Missing property %q in metadata.yaml", prop)
		}
	}

	var data *dataItem
	if !isUnifiedTarball {
		// Open the data.
		dataFile, err := os.Open(args[1])
		if err != nil {
			return err
		}

		defer dataFile.Close()

		// Parse the content.
		data, err = c.parseImage(metaFile, dataFile)
		if err != nil {
			return err
		}
	}

	// Create the paths if missing.
	err = os.MkdirAll("images", 0o755)
	if err != nil && !os.IsExist(err) {
		return err
	}

	err = os.MkdirAll("streams/v1", 0o755)
	if err != nil && !os.IsExist(err) {
		return err
	}

	// Load the images file.
	products := simplestreams.Products{}

	body, err = os.ReadFile("streams/v1/images.json")
	if err != nil {
		if !errors.Is(err, fs.ErrNotExist) {
			return err
		}

		// Create a blank images file.
		products = simplestreams.Products{
			ContentID: "images",
			DataType:  "image-downloads",
			Format:    "products:1.0",
			Products:  map[string]simplestreams.Product{},
		}
	} else {
		// Parse the existing images file.
		err = json.Unmarshal(body, &products)
		if err != nil {
			return err
		}
	}

	// Check if the product already exists.
	productName := fmt.Sprintf("%s:%s:%s:%s", metadata.Properties["os"], metadata.Properties["release"], metadata.Properties["variant"], metadata.Properties["architecture"])
	product, ok := products.Products[productName]
	if !ok {
		var aliases []string
		if !c.flagNoDefaultAlias {
			// Generate a default alias
			aliases = append(aliases, fmt.Sprintf("%s/%s/%s",
				metadata.Properties["os"],
				metadata.Properties["release"],
				metadata.Properties["variant"]))
		}

		aliases = append(aliases, c.flagAliases...)

		// Create a new product.
		product = simplestreams.Product{
			Aliases:         strings.Join(aliases, ","),
			Architecture:    metadata.Properties["architecture"],
			OperatingSystem: metadata.Properties["os"],
			Release:         metadata.Properties["release"],
			ReleaseTitle:    metadata.Properties["release"],
			Variant:         metadata.Properties["variant"],
			Versions:        map[string]simplestreams.ProductVersion{},
		}
	}

	var fileType, fileKey, metaTargetPath string

	if !isUnifiedTarball {
		fileKey = "incus.tar.xz"
		fileType = "incus.tar.xz"
		metaTargetPath = fmt.Sprintf("images/%s.incus.tar.xz", metaSha256)
	} else {
		fileKey = "incus_combined.tar.gz"
		fileType = "incus_combined.tar.gz"
		metaTargetPath = fmt.Sprintf("images/%s.incus_combined.tar.gz", metaSha256)
	}

	// Check if a version already exists.
	versionName := time.Unix(metadata.CreationDate, 0).Format("200601021504")
	version, ok := product.Versions[versionName]
	if !ok {
		// Create a new version.
		version = simplestreams.ProductVersion{
			Items: map[string]simplestreams.ProductVersionItem{
				fileKey: {
					FileType:   fileType,
					HashSha256: metaSha256,
					Size:       metaSize,
					Path:       metaTargetPath,
				},
			},
		}
	} else {
		// Check that we're dealing with the same metadata.
		_, ok := version.Items[fileKey]
		if !ok {
			// No fileKey found, add it.
			version.Items[fileKey] = simplestreams.ProductVersionItem{
				FileType:   fileType,
				HashSha256: metaSha256,
				Size:       metaSize,
				Path:       metaTargetPath,
			}
		}
	}

	// Copy the metadata file if missing.
	err = internalUtil.FileCopy(metaPath, metaTargetPath)
	if err != nil && !os.IsExist(err) {
		return err
	}

	if !isUnifiedTarball {
		// Check that the data file isn't already in.
		_, ok = version.Items[data.FileType]
		if ok {
			return fmt.Errorf("Already have a %q file for this image", data.FileType)
		}

		dataTargetPath := fmt.Sprintf("images/%s%s", metaSha256, data.Extension)

		// Add the file entry.
		version.Items[data.FileType] = simplestreams.ProductVersionItem{
			FileType:   data.FileType,
			HashSha256: data.Sha256,
			Size:       data.Size,
			Path:       dataTargetPath,
		}

		// Add the combined hash.
		metaItem := version.Items["incus.tar.xz"]
		if data.FileType == "squashfs" {
			metaItem.CombinedSha256SquashFs = data.combinedSha256
		} else if data.FileType == "disk-kvm.img" {
			metaItem.CombinedSha256DiskKvmImg = data.combinedSha256
		}

		version.Items["incus.tar.xz"] = metaItem

		// Copy the data file if missing.
		err = internalUtil.FileCopy(data.Path, dataTargetPath)
		if err != nil && !os.IsExist(err) {
			return err
		}
	}

	// Update the version.
	product.Versions[versionName] = version

	// Update the product.
	products.Products[productName] = product

	// Write back the images file.
	body, err = json.Marshal(&products)
	if err != nil {
		return err
	}

	err = os.WriteFile("streams/v1/images.json", body, 0o644)
	if err != nil {
		return err
	}

	// Re-generate the index.
	err = writeIndex(&products)
	if err != nil {
		return err
	}

	return nil
}