summaryrefslogtreecommitdiff
path: root/vendor/github.com/containers/image/tarball/doc.go
blob: a6ced5a0ee0770307d0bfaee49d36d3f27457dbc (plain)
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
// Package tarball provides a way to generate images using one or more layer
// tarballs and an optional template configuration.
//
// An example:
//	package main
//
//	import (
//		"fmt"
//
//		cp "github.com/containers/image/copy"
//		"github.com/containers/image/tarball"
//		"github.com/containers/image/transports/alltransports"
//
//		imgspecv1 "github.com/containers/image/transports/alltransports"
//	)
//
//	func imageFromTarball() {
//		src, err := alltransports.ParseImageName("tarball:/var/cache/mock/fedora-26-x86_64/root_cache/cache.tar.gz")
//		// - or -
//		// src, err := tarball.Transport.ParseReference("/var/cache/mock/fedora-26-x86_64/root_cache/cache.tar.gz")
//		if err != nil {
//			panic(err)
//		}
//		updater, ok := src.(tarball.ConfigUpdater)
//		if !ok {
//			panic("unexpected: a tarball reference should implement tarball.ConfigUpdater")
//		}
//		config := imgspecv1.Image{
//			Config: imgspecv1.ImageConfig{
//				Cmd: []string{"/bin/bash"},
//			},
//		}
//		annotations := make(map[string]string)
//		annotations[imgspecv1.AnnotationDescription] = "test image built from a mock root cache"
//		err = updater.ConfigUpdate(config, annotations)
//		if err != nil {
//			panic(err)
//		}
//		dest, err := alltransports.ParseImageName("docker-daemon:mock:latest")
//		if err != nil {
//			panic(err)
//		}
//		err = cp.Image(nil, dest, src, nil)
//		if err != nil {
//			panic(err)
//		}
//	}
package tarball