-
Notifications
You must be signed in to change notification settings - Fork 757
/
commit.go
384 lines (350 loc) · 15.7 KB
/
commit.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
package main
import (
"encoding/json"
"errors"
"fmt"
"os"
"strings"
"time"
"github.com/containers/buildah"
"github.com/containers/buildah/define"
"github.com/containers/buildah/pkg/cli"
"github.com/containers/buildah/pkg/parse"
"github.com/containers/buildah/util"
"github.com/containers/common/pkg/auth"
"github.com/containers/common/pkg/completion"
"github.com/containers/image/v5/manifest"
"github.com/containers/image/v5/pkg/shortnames"
storageTransport "github.com/containers/image/v5/storage"
"github.com/containers/image/v5/transports/alltransports"
"github.com/containers/image/v5/types"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
)
type commitInputOptions struct {
authfile string
omitHistory bool
blobCache string
certDir string
changes []string
configFile string
creds string
cwOptions string
disableCompression bool
format string
iidfile string
manifest string
omitTimestamp bool
timestamp int64
quiet bool
referenceTime string
rm bool
pull string
pullAlways bool
pullNever bool
sbomImgOutput string
sbomImgPurlOutput string
sbomMergeStrategy string
sbomOutput string
sbomPreset string
sbomPurlOutput string
sbomScannerCommand []string
sbomScannerImage string
signaturePolicy string
signBy string
squash bool
tlsVerify bool
identityLabel bool
encryptionKeys []string
encryptLayers []int
unsetenvs []string
addFile []string
}
func init() {
var (
opts commitInputOptions
commitDescription = "\n Writes a new image using the container's read-write layer and, if it is based\n on an image, the layers of that image."
)
commitCommand := &cobra.Command{
Use: "commit",
Short: "Create an image from a working container",
Long: commitDescription,
RunE: func(cmd *cobra.Command, args []string) error {
return commitCmd(cmd, args, opts)
},
Example: `buildah commit containerID
buildah commit containerID newImageName
buildah commit containerID docker://localhost:5000/imageId`,
}
commitCommand.SetUsageTemplate(UsageTemplate())
commitListFlagSet(commitCommand, &opts)
rootCmd.AddCommand(commitCommand)
}
func commitListFlagSet(cmd *cobra.Command, opts *commitInputOptions) {
flags := cmd.Flags()
flags.SetInterspersed(false)
flags.StringArrayVar(&opts.addFile, "add-file", nil, "add contents of a file to the image at a specified path (`source:destination`)")
flags.StringVar(&opts.authfile, "authfile", auth.GetDefaultAuthFile(), "path of the authentication file. Use REGISTRY_AUTH_FILE environment variable to override")
_ = cmd.RegisterFlagCompletionFunc("authfile", completion.AutocompleteDefault)
flags.StringVar(&opts.blobCache, "blob-cache", "", "assume image blobs in the specified directory will be available for pushing")
if err := flags.MarkHidden("blob-cache"); err != nil {
panic(fmt.Sprintf("error marking blob-cache as hidden: %v", err))
}
flags.StringSliceVar(&opts.encryptionKeys, "encryption-key", nil, "key with the encryption protocol to use needed to encrypt the image (e.g. jwe:/path/to/key.pem)")
_ = cmd.RegisterFlagCompletionFunc("encryption-key", completion.AutocompleteDefault)
flags.IntSliceVar(&opts.encryptLayers, "encrypt-layer", nil, "layers to encrypt, 0-indexed layer indices with support for negative indexing (e.g. 0 is the first layer, -1 is the last layer). If not defined, will encrypt all layers if encryption-key flag is specified")
_ = cmd.RegisterFlagCompletionFunc("encryption-key", completion.AutocompleteNone)
flags.StringArrayVarP(&opts.changes, "change", "c", nil, "apply containerfile `instruction`s to the committed image")
flags.StringVar(&opts.certDir, "cert-dir", "", "use certificates at the specified path to access the registry")
_ = cmd.RegisterFlagCompletionFunc("cert-dir", completion.AutocompleteDefault)
flags.StringVar(&opts.configFile, "config", "", "apply configuration JSON `file` to the committed image")
_ = cmd.RegisterFlagCompletionFunc("config", completion.AutocompleteDefault)
flags.StringVar(&opts.creds, "creds", "", "use `[username[:password]]` for accessing the registry")
_ = cmd.RegisterFlagCompletionFunc("creds", completion.AutocompleteNone)
flags.StringVar(&opts.cwOptions, "cw", "", "confidential workload `options`")
flags.BoolVarP(&opts.disableCompression, "disable-compression", "D", true, "don't compress layers")
flags.StringVarP(&opts.format, "format", "f", defaultFormat(), "`format` of the image manifest and metadata")
_ = cmd.RegisterFlagCompletionFunc("format", completion.AutocompleteNone)
flags.StringVar(&opts.manifest, "manifest", "", "adds created image to the specified manifest list. Creates manifest list if it does not exist")
_ = cmd.RegisterFlagCompletionFunc("manifest", completion.AutocompleteNone)
flags.StringVar(&opts.iidfile, "iidfile", "", "write the image ID to the file")
_ = cmd.RegisterFlagCompletionFunc("iidfile", completion.AutocompleteDefault)
flags.BoolVar(&opts.omitTimestamp, "omit-timestamp", false, "set created timestamp to epoch 0 to allow for deterministic builds")
flags.Int64Var(&opts.timestamp, "timestamp", 0, "set created timestamp to epoch seconds to allow for deterministic builds, defaults to current time")
_ = cmd.RegisterFlagCompletionFunc("timestamp", completion.AutocompleteNone)
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "don't output progress information when writing images")
flags.StringVar(&opts.referenceTime, "reference-time", "", "set the timestamp on the image to match the named `file`")
_ = cmd.RegisterFlagCompletionFunc("reference-time", completion.AutocompleteNone)
flags.StringVar(&opts.pull, "pull", "true", "pull SBOM scanner images from the registry if newer or not present in store, if false, only pull SBOM scanner images if not present, if always, pull SBOM scanner images even if the named images are present in store, if never, only use images present in store if available")
flags.Lookup("pull").NoOptDefVal = "true" //allow `--pull ` to be set to `true` as expected.
flags.BoolVar(&opts.pullAlways, "pull-always", false, "pull the image even if the named image is present in store")
if err := flags.MarkHidden("pull-always"); err != nil {
panic(fmt.Sprintf("error marking the pull-always flag as hidden: %v", err))
}
flags.BoolVar(&opts.pullNever, "pull-never", false, "do not pull the image, use the image present in store if available")
if err := flags.MarkHidden("pull-never"); err != nil {
panic(fmt.Sprintf("error marking the pull-never flag as hidden: %v", err))
}
flags.StringVar(&opts.sbomPreset, "sbom", "", "scan working container using `preset` configuration")
_ = cmd.RegisterFlagCompletionFunc("sbom", completion.AutocompleteNone)
flags.StringVar(&opts.sbomScannerImage, "sbom-scanner-image", "", "scan working container using scanner command from `image`")
_ = cmd.RegisterFlagCompletionFunc("sbom-scanner-image", completion.AutocompleteNone)
flags.StringArrayVar(&opts.sbomScannerCommand, "sbom-scanner-command", nil, "scan working container using `command` in scanner image")
_ = cmd.RegisterFlagCompletionFunc("sbom-scanner-command", completion.AutocompleteNone)
flags.StringVar(&opts.sbomMergeStrategy, "sbom-merge-strategy", "", "merge scan results using `strategy`")
_ = cmd.RegisterFlagCompletionFunc("sbom-merge-strategy", completion.AutocompleteNone)
flags.StringVar(&opts.sbomOutput, "sbom-output", "", "save scan results to `file`")
_ = cmd.RegisterFlagCompletionFunc("sbom-output", completion.AutocompleteDefault)
flags.StringVar(&opts.sbomImgOutput, "sbom-image-output", "", "add scan results to image as `path`")
_ = cmd.RegisterFlagCompletionFunc("sbom-image-output", completion.AutocompleteNone)
flags.StringVar(&opts.sbomPurlOutput, "sbom-purl-output", "", "save scan results to `file``")
_ = cmd.RegisterFlagCompletionFunc("sbom-purl-output", completion.AutocompleteDefault)
flags.StringVar(&opts.sbomImgPurlOutput, "sbom-image-purl-output", "", "add scan results to image as `path`")
_ = cmd.RegisterFlagCompletionFunc("sbom-image-purl-output", completion.AutocompleteNone)
flags.StringVar(&opts.signBy, "sign-by", "", "sign the image using a GPG key with the specified `FINGERPRINT`")
_ = cmd.RegisterFlagCompletionFunc("sign-by", completion.AutocompleteNone)
if err := flags.MarkHidden("omit-timestamp"); err != nil {
panic(fmt.Sprintf("error marking omit-timestamp as hidden: %v", err))
}
if err := flags.MarkHidden("reference-time"); err != nil {
panic(fmt.Sprintf("error marking reference-time as hidden: %v", err))
}
flags.BoolVar(&opts.omitHistory, "omit-history", false, "omit build history information from the built image (default false)")
flags.BoolVar(&opts.identityLabel, "identity-label", true, "add default builder label (default true)")
flags.BoolVar(&opts.rm, "rm", false, "remove the container and its content after committing it to an image. Default leaves the container and its content in place.")
flags.StringVar(&opts.signaturePolicy, "signature-policy", "", "`pathname` of signature policy file (not usually used)")
_ = cmd.RegisterFlagCompletionFunc("signature-policy", completion.AutocompleteDefault)
if err := flags.MarkHidden("signature-policy"); err != nil {
panic(fmt.Sprintf("error marking signature-policy as hidden: %v", err))
}
flags.BoolVar(&opts.squash, "squash", false, "produce an image with only one layer")
flags.BoolVar(&opts.tlsVerify, "tls-verify", true, "require HTTPS and verify certificates when accessing the registry. TLS verification cannot be used when talking to an insecure registry.")
flags.StringSliceVar(&opts.unsetenvs, "unsetenv", nil, "unset env from final image")
_ = cmd.RegisterFlagCompletionFunc("unsetenv", completion.AutocompleteNone)
}
func commitCmd(c *cobra.Command, args []string, iopts commitInputOptions) error {
var dest types.ImageReference
if len(args) == 0 {
return errors.New("container ID must be specified")
}
if err := cli.VerifyFlagsArgsOrder(args); err != nil {
return err
}
if err := auth.CheckAuthFile(iopts.authfile); err != nil {
return err
}
name := args[0]
args = Tail(args)
if len(args) > 1 {
return errors.New("too many arguments specified")
}
image := ""
if len(args) > 0 {
image = args[0]
}
compress := define.Gzip
if iopts.disableCompression {
compress = define.Uncompressed
}
format, err := cli.GetFormat(iopts.format)
if err != nil {
return err
}
store, err := getStore(c)
if err != nil {
return err
}
ctx := getContext()
builder, err := openBuilder(ctx, store, name)
if err != nil {
return fmt.Errorf("reading build container %q: %w", name, err)
}
systemContext, err := parse.SystemContextFromOptions(c)
if err != nil {
return fmt.Errorf("building system context: %w", err)
}
// If the user specified an image, we may need to massage it a bit if
// no transport is specified.
if image != "" {
if dest, err = alltransports.ParseImageName(image); err != nil {
candidates, err2 := shortnames.ResolveLocally(systemContext, image)
if err2 != nil {
return err2
}
if len(candidates) == 0 {
return fmt.Errorf("parsing target image name %q", image)
}
dest2, err2 := storageTransport.Transport.ParseStoreReference(store, candidates[0].String())
if err2 != nil {
return fmt.Errorf("parsing target image name %q: %w", image, err)
}
dest = dest2
}
}
// Add builder identity information.
if iopts.identityLabel {
builder.SetLabel(buildah.BuilderIdentityAnnotation, define.Version)
}
encConfig, encLayers, err := cli.EncryptConfig(iopts.encryptionKeys, iopts.encryptLayers)
if err != nil {
return fmt.Errorf("unable to obtain encryption config: %w", err)
}
var overrideConfig *manifest.Schema2Config
if c.Flag("config").Changed {
configBytes, err := os.ReadFile(iopts.configFile)
if err != nil {
return fmt.Errorf("reading configuration blob from file: %w", err)
}
overrideConfig = &manifest.Schema2Config{}
if err := json.Unmarshal(configBytes, &overrideConfig); err != nil {
return fmt.Errorf("parsing configuration blob from %q: %w", iopts.configFile, err)
}
}
var addFiles map[string]string
if len(iopts.addFile) > 0 {
addFiles = make(map[string]string)
for _, spec := range iopts.addFile {
specSlice := strings.SplitN(spec, ":", 2)
if len(specSlice) == 1 {
specSlice = []string{specSlice[0], specSlice[0]}
}
if len(specSlice) != 2 {
return fmt.Errorf("parsing add-file argument %q: expected 1 or 2 parts, got %d", spec, len(strings.SplitN(spec, ":", 2)))
}
st, err := os.Stat(specSlice[0])
if err != nil {
return fmt.Errorf("parsing add-file argument %q: source %q: %w", spec, specSlice[0], err)
}
if st.IsDir() {
return fmt.Errorf("parsing add-file argument %q: source %q is not a regular file", spec, specSlice[0])
}
addFiles[specSlice[1]] = specSlice[0]
}
}
options := buildah.CommitOptions{
PreferredManifestType: format,
Manifest: iopts.manifest,
Compression: compress,
SignaturePolicyPath: iopts.signaturePolicy,
SystemContext: systemContext,
IIDFile: iopts.iidfile,
Squash: iopts.squash,
BlobDirectory: iopts.blobCache,
OmitHistory: iopts.omitHistory,
SignBy: iopts.signBy,
OciEncryptConfig: encConfig,
OciEncryptLayers: encLayers,
UnsetEnvs: iopts.unsetenvs,
OverrideChanges: iopts.changes,
OverrideConfig: overrideConfig,
ExtraImageContent: addFiles,
}
exclusiveFlags := 0
if c.Flag("reference-time").Changed {
exclusiveFlags++
referenceFile := iopts.referenceTime
finfo, err := os.Stat(referenceFile)
if err != nil {
return fmt.Errorf("reading timestamp of file %q: %w", referenceFile, err)
}
timestamp := finfo.ModTime().UTC()
options.HistoryTimestamp = ×tamp
}
if c.Flag("timestamp").Changed {
exclusiveFlags++
timestamp := time.Unix(iopts.timestamp, 0).UTC()
options.HistoryTimestamp = ×tamp
}
if iopts.omitTimestamp {
exclusiveFlags++
timestamp := time.Unix(0, 0).UTC()
options.HistoryTimestamp = ×tamp
}
if iopts.cwOptions != "" {
confidentialWorkloadOptions, err := parse.GetConfidentialWorkloadOptions(iopts.cwOptions)
if err != nil {
return fmt.Errorf("parsing --cw arguments: %w", err)
}
options.ConfidentialWorkloadOptions = confidentialWorkloadOptions
}
pullPolicy, err := parse.PullPolicyFromOptions(c)
if err != nil {
return err
}
if c.Flag("sbom").Changed || c.Flag("sbom-scanner-command").Changed || c.Flag("sbom-scanner-image").Changed || c.Flag("sbom-image-output").Changed || c.Flag("sbom-merge-strategy").Changed || c.Flag("sbom-output").Changed || c.Flag("sbom-image-output").Changed || c.Flag("sbom-purl-output").Changed || c.Flag("sbom-image-purl-output").Changed {
var sbomOptions []define.SBOMScanOptions
sbomOption, err := parse.SBOMScanOptions(c)
if err != nil {
return err
}
sbomOption.PullPolicy = pullPolicy
sbomOptions = append(sbomOptions, *sbomOption)
options.SBOMScanOptions = sbomOptions
}
if exclusiveFlags > 1 {
return errors.New("can not use more then one timestamp option at at time")
}
if !iopts.quiet {
options.ReportWriter = os.Stderr
}
id, ref, _, err := builder.Commit(ctx, dest, options)
if err != nil {
return util.GetFailureCause(err, fmt.Errorf("committing container %q to %q: %w", builder.Container, image, err))
}
if ref != nil && id != "" {
logrus.Debugf("wrote image %s with ID %s", ref, id)
} else if ref != nil {
logrus.Debugf("wrote image %s", ref)
} else if id != "" {
logrus.Debugf("wrote image with ID %s", id)
} else {
logrus.Debugf("wrote image")
}
if options.IIDFile == "" && id != "" {
fmt.Printf("%s\n", id)
}
if iopts.rm {
return builder.Delete()
}
return nil
}