summaryrefslogtreecommitdiffstats
path: root/cmd/crane/cmd/pull.go
blob: 41c6e95cdb9c1786c89ef8174a3759791f8e6a6d (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
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
// Copyright 2018 Google LLC All Rights Reserved.
//
// 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 cmd

import (
	"fmt"

	"github.com/google/go-containerregistry/pkg/crane"
	"github.com/google/go-containerregistry/pkg/name"
	v1 "github.com/google/go-containerregistry/pkg/v1"
	"github.com/google/go-containerregistry/pkg/v1/cache"
	"github.com/google/go-containerregistry/pkg/v1/empty"
	"github.com/google/go-containerregistry/pkg/v1/layout"
	"github.com/google/go-containerregistry/pkg/v1/remote"
	"github.com/spf13/cobra"
)

// NewCmdPull creates a new cobra.Command for the pull subcommand.
func NewCmdPull(options *[]crane.Option) *cobra.Command {
	var (
		cachePath, format string
		annotateRef       bool
	)

	cmd := &cobra.Command{
		Use:   "pull IMAGE TARBALL",
		Short: "Pull remote images by reference and store their contents locally",
		Args:  cobra.MinimumNArgs(2),
		RunE: func(_ *cobra.Command, args []string) error {
			imageMap := map[string]v1.Image{}
			indexMap := map[string]v1.ImageIndex{}
			srcList, path := args[:len(args)-1], args[len(args)-1]
			o := crane.GetOptions(*options...)
			for _, src := range srcList {
				ref, err := name.ParseReference(src, o.Name...)
				if err != nil {
					return fmt.Errorf("parsing reference %q: %w", src, err)
				}

				rmt, err := remote.Get(ref, o.Remote...)
				if err != nil {
					return err
				}

				// If we're writing an index to a layout and --platform hasn't been set,
				// pull the entire index, not just a child image.
				if format == "oci" && rmt.MediaType.IsIndex() && o.Platform == nil {
					idx, err := rmt.ImageIndex()
					if err != nil {
						return err
					}
					indexMap[src] = idx
					continue
				}

				img, err := rmt.Image()
				if err != nil {
					return err
				}
				if cachePath != "" {
					img = cache.Image(img, cache.NewFilesystemCache(cachePath))
				}
				imageMap[src] = img
			}

			switch format {
			case "tarball":
				if err := crane.MultiSave(imageMap, path); err != nil {
					return fmt.Errorf("saving tarball %s: %w", path, err)
				}
			case "legacy":
				if err := crane.MultiSaveLegacy(imageMap, path); err != nil {
					return fmt.Errorf("saving legacy tarball %s: %w", path, err)
				}
			case "oci":
				// Don't use crane.MultiSaveOCI so we can control annotations.
				p, err := layout.FromPath(path)
				if err != nil {
					p, err = layout.Write(path, empty.Index)
					if err != nil {
						return err
					}
				}
				for ref, img := range imageMap {
					opts := []layout.Option{}
					if annotateRef {
						parsed, err := name.ParseReference(ref, o.Name...)
						if err != nil {
							return err
						}
						opts = append(opts, layout.WithAnnotations(map[string]string{
							"org.opencontainers.image.ref.name": parsed.Name(),
						}))
					}
					if err = p.AppendImage(img, opts...); err != nil {
						return err
					}
				}

				for ref, idx := range indexMap {
					opts := []layout.Option{}
					if annotateRef {
						parsed, err := name.ParseReference(ref, o.Name...)
						if err != nil {
							return err
						}
						opts = append(opts, layout.WithAnnotations(map[string]string{
							"org.opencontainers.image.ref.name": parsed.Name(),
						}))
					}
					if err := p.AppendIndex(idx, opts...); err != nil {
						return err
					}
				}
			default:
				return fmt.Errorf("unexpected --format: %q (valid values are: tarball, legacy, and oci)", format)
			}
			return nil
		},
	}
	cmd.Flags().StringVarP(&cachePath, "cache_path", "c", "", "Path to cache image layers")
	cmd.Flags().StringVar(&format, "format", "tarball", fmt.Sprintf("Format in which to save images (%q, %q, or %q)", "tarball", "legacy", "oci"))
	cmd.Flags().BoolVar(&annotateRef, "annotate-ref", false, "Preserves image reference used to pull as an annotation when used with --format=oci")

	return cmd
}