Skip to content

Commit 4fc2d7b

Browse files
vvolandvvoland
committed
containerimage: Export option keys
Signed-off-by: Paweł Gronowski <[email protected]>
1 parent 268225c commit 4fc2d7b

5 files changed

Lines changed: 87 additions & 35 deletions

File tree

‎control/control.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import (
2020
"github.com/moby/buildkit/cmd/buildkitd/config"
2121
controlgateway "github.com/moby/buildkit/control/gateway"
2222
"github.com/moby/buildkit/exporter"
23+
"github.com/moby/buildkit/exporter/containerimage/exptypes"
2324
"github.com/moby/buildkit/exporter/util/epoch"
2425
"github.com/moby/buildkit/frontend"
2526
"github.com/moby/buildkit/frontend/attestations"
@@ -331,11 +332,11 @@ func (c *Controller) Solve(ctx context.Context, req *controlapi.SolveRequest) (*
331332

332333
// if SOURCE_DATE_EPOCH is set, enable it for the exporter
333334
if v, ok := epoch.ParseBuildArgs(req.FrontendAttrs); ok {
334-
if _, ok := req.ExporterAttrs[epoch.KeySourceDateEpoch]; !ok {
335+
if _, ok := req.ExporterAttrs[exptypes.OptKeySourceDateEpoch]; !ok {
335336
if req.ExporterAttrs == nil {
336337
req.ExporterAttrs = make(map[string]string)
337338
}
338-
req.ExporterAttrs[epoch.KeySourceDateEpoch] = v
339+
req.ExporterAttrs[exptypes.OptKeySourceDateEpoch] = v
339340
}
340341
}
341342

‎exporter/containerimage/export.go‎

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,6 @@ import (
3434
)
3535

3636
const (
37-
keyPush = "push"
38-
keyPushByDigest = "push-by-digest"
39-
keyInsecure = "registry.insecure"
40-
keyUnpack = "unpack"
41-
keyDanglingPrefix = "dangling-name-prefix"
42-
keyNameCanonical = "name-canonical"
43-
keyStore = "store"
44-
4537
// keyUnsafeInternalStoreAllowIncomplete should only be used for tests. This option allows exporting image to the image store
4638
// as well as lacking some blobs in the content store. Some integration tests for lazyref behaviour depends on this option.
4739
// Ignored when store=false.
@@ -88,7 +80,7 @@ func (e *imageExporter) Resolve(ctx context.Context, opt map[string]string) (exp
8880

8981
for k, v := range opt {
9082
switch k {
91-
case keyPush:
83+
case exptypes.OptKeyPush:
9284
if v == "" {
9385
i.push = true
9486
continue
@@ -98,7 +90,7 @@ func (e *imageExporter) Resolve(ctx context.Context, opt map[string]string) (exp
9890
return nil, errors.Wrapf(err, "non-bool value specified for %s", k)
9991
}
10092
i.push = b
101-
case keyPushByDigest:
93+
case exptypes.OptKeyPushByDigest:
10294
if v == "" {
10395
i.pushByDigest = true
10496
continue
@@ -108,7 +100,7 @@ func (e *imageExporter) Resolve(ctx context.Context, opt map[string]string) (exp
108100
return nil, errors.Wrapf(err, "non-bool value specified for %s", k)
109101
}
110102
i.pushByDigest = b
111-
case keyInsecure:
103+
case exptypes.OptKeyInsecure:
112104
if v == "" {
113105
i.insecure = true
114106
continue
@@ -118,7 +110,7 @@ func (e *imageExporter) Resolve(ctx context.Context, opt map[string]string) (exp
118110
return nil, errors.Wrapf(err, "non-bool value specified for %s", k)
119111
}
120112
i.insecure = b
121-
case keyUnpack:
113+
case exptypes.OptKeyUnpack:
122114
if v == "" {
123115
i.unpack = true
124116
continue
@@ -128,7 +120,7 @@ func (e *imageExporter) Resolve(ctx context.Context, opt map[string]string) (exp
128120
return nil, errors.Wrapf(err, "non-bool value specified for %s", k)
129121
}
130122
i.unpack = b
131-
case keyStore:
123+
case exptypes.OptKeyStore:
132124
if v == "" {
133125
i.store = true
134126
continue
@@ -148,9 +140,9 @@ func (e *imageExporter) Resolve(ctx context.Context, opt map[string]string) (exp
148140
return nil, errors.Wrapf(err, "non-bool value specified for %s", k)
149141
}
150142
i.storeAllowIncomplete = b
151-
case keyDanglingPrefix:
143+
case exptypes.OptKeyDanglingPrefix:
152144
i.danglingPrefix = v
153-
case keyNameCanonical:
145+
case exptypes.OptKeyNameCanonical:
154146
if v == "" {
155147
i.nameCanonical = true
156148
continue

‎exporter/containerimage/exptypes/keys.go‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
package exptypes
2+
3+
// Options keys supported by the image exporter output.
4+
var (
5+
// Name of the image.
6+
// Value: string
7+
OptKeyName = "name"
8+
9+
// Push after creating image.
10+
// Value: bool <true|false>
11+
OptKeyPush = "push"
12+
13+
// Push unnamed image.
14+
// Value: bool <true|false>
15+
OptKeyPushByDigest = "push-by-digest"
16+
17+
// Allow pushing to insecure HTTP registry.
18+
// Value: bool <true|false>
19+
OptKeyInsecure = "registry.insecure"
20+
21+
// Unpack image after it's created (containerd).
22+
// Value: bool <true|false>
23+
OptKeyUnpack = "unpack"
24+
25+
// Fallback image name prefix if image name isn't provided.
26+
// If used, image will be named as <value>@<digest>
27+
// Value: string
28+
OptKeyDanglingPrefix = "dangling-name-prefix"
29+
30+
// Creates additional image name with format <name>@<digest>
31+
// Value: bool <true|false>
32+
OptKeyNameCanonical = "name-canonical"
33+
34+
// Store the resulting image along with all of the content it references.
35+
// Ignored if the worker doesn't have image store (e.g. OCI worker).
36+
// Value: bool <true|false>
37+
OptKeyStore = "store"
38+
39+
// Use OCI mediatypes instead of Docker in JSON configs.
40+
// Value: bool <true|false>
41+
OptKeyOCITypes = "oci-mediatypes"
42+
43+
// Force attestation to be attached.
44+
// Value: bool <true|false>
45+
OptKeyForceInlineAttestations = "attestation-inline"
46+
47+
// Mark layers as non-distributable if they are found to use a
48+
// non-distributable media type. When this option is not set, the exporter
49+
// will change the media type of the layer to a distributable one.
50+
// Value: bool <true|false>
51+
OptKeyPreferNondistLayers = "prefer-nondist-layers"
52+
53+
// Clamp produced timestamps. For more information see the
54+
// SOURCE_DATE_EPOCH specification.
55+
// Value: int (number of seconds since Unix epoch)
56+
OptKeySourceDateEpoch = "source-date-epoch"
57+
58+
// Compression type for newly created and cached layers.
59+
// estargz should be used with OptKeyOCITypes set to true.
60+
// Value: string <uncompressed|gzip|estargz|zstd>
61+
OptKeyLayerCompression = "compression"
62+
63+
// Force compression on all (including existing) layers.
64+
// Value: bool <true|false>
65+
OptKeyForceCompression = "force-compression"
66+
67+
// Compression level
68+
// Value: int (0-9) for gzip and estargz
69+
// Value: int (0-22) for zstd
70+
OptKeyCompressionLevel = "compression-level"
71+
)

‎exporter/containerimage/opts.go‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,13 @@ import (
66
"time"
77

88
cacheconfig "github.com/moby/buildkit/cache/config"
9+
"github.com/moby/buildkit/exporter/containerimage/exptypes"
910
"github.com/moby/buildkit/exporter/util/epoch"
1011
"github.com/moby/buildkit/util/bklog"
1112
"github.com/moby/buildkit/util/compression"
1213
"github.com/pkg/errors"
1314
)
1415

15-
const (
16-
keyImageName = "name"
17-
keyOCITypes = "oci-mediatypes"
18-
keyForceInlineAttestations = "attestation-inline"
19-
20-
// preferNondistLayersKey is an exporter option which can be used to mark a layer as non-distributable if the layer reference was
21-
// already found to use a non-distributable media type.
22-
// When this option is not set, the exporter will change the media type of the layer to a distributable one.
23-
keyPreferNondistLayers = "prefer-nondist-layers"
24-
)
25-
2616
type ImageCommitOpts struct {
2717
ImageName string
2818
RefCfg cacheconfig.RefConfig
@@ -54,13 +44,13 @@ func (c *ImageCommitOpts) Load(ctx context.Context, opt map[string]string) (map[
5444
for k, v := range opt {
5545
var err error
5646
switch k {
57-
case keyImageName:
47+
case exptypes.OptKeyName:
5848
c.ImageName = v
59-
case keyOCITypes:
49+
case exptypes.OptKeyOCITypes:
6050
err = parseBoolWithDefault(&c.OCITypes, k, v, true)
61-
case keyForceInlineAttestations:
51+
case exptypes.OptKeyForceInlineAttestations:
6252
err = parseBool(&c.ForceInlineAttestations, k, v)
63-
case keyPreferNondistLayers:
53+
case exptypes.OptKeyPreferNondistLayers:
6454
err = parseBool(&c.RefCfg.PreferNonDistributable, k, v)
6555
default:
6656
rest[k] = v

‎exporter/util/epoch/parse.go‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ import (
1111

1212
const (
1313
frontendSourceDateEpochArg = "build-arg:SOURCE_DATE_EPOCH"
14-
15-
KeySourceDateEpoch = "source-date-epoch"
1614
)
1715

1816
func ParseBuildArgs(opt map[string]string) (string, bool) {
@@ -27,7 +25,7 @@ func ParseExporterAttrs(opt map[string]string) (*time.Time, map[string]string, e
2725

2826
for k, v := range opt {
2927
switch k {
30-
case KeySourceDateEpoch:
28+
case exptypes.OptKeySourceDateEpoch:
3129
var err error
3230
tm, err = parseTime(k, v)
3331
if err != nil {

0 commit comments

Comments
 (0)