[nerdctl build] Set default output type=image #3604
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,18 +61,22 @@ func (p platformParser) DefaultSpec() platforms.Platform { | |
| } | ||
|
|
||
| func Build(ctx context.Context, client *containerd.Client, options types.BuilderBuildOptions) error { | ||
| buildCtlArgs, err := generateBuildctlArgs(ctx, client, options) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if buildCtlArgs.Cleanup != nil { | ||
| defer buildCtlArgs.Cleanup() | ||
| } | ||
|
|
||
| buildctlBinary := buildCtlArgs.BuildctlBinary | ||
| buildctlArgs := buildCtlArgs.BuildctlArgs | ||
|
|
||
| log.L.Debugf("running %s %v", buildctlBinary, buildctlArgs) | ||
| buildctlCmd := exec.Command(buildctlBinary, buildctlArgs...) | ||
| buildctlCmd.Env = os.Environ() | ||
|
|
||
| needsLoading := buildCtlArgs.NeedsLoading | ||
| var buildctlStdout io.Reader | ||
| if needsLoading { | ||
| buildctlStdout, err = buildctlCmd.StdoutPipe() | ||
|
|
@@ -95,6 +99,8 @@ func Build(ctx context.Context, client *containerd.Client, options types.Builder | |
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Load the image into the containerd image store | ||
| if err = loadImage(ctx, buildctlStdout, options.GOptions.Namespace, options.GOptions.Address, options.GOptions.Snapshotter, options.Stdout, platMC, options.Quiet); err != nil { | ||
| return err | ||
| } | ||
|
|
@@ -105,7 +111,7 @@ func Build(ctx context.Context, client *containerd.Client, options types.Builder | |
| } | ||
|
|
||
| if options.IidFile != "" { | ||
| id, err := getDigestFromMetaFile(buildCtlArgs.MetaFile) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
@@ -114,6 +120,7 @@ func Build(ctx context.Context, client *containerd.Client, options types.Builder | |
| } | ||
| } | ||
|
|
||
| tags := buildCtlArgs.Tags | ||
| if len(tags) > 1 { | ||
| log.L.Debug("Found more than 1 tag") | ||
| imageService := client.ImageService() | ||
|
|
@@ -160,11 +167,15 @@ func loadImage(ctx context.Context, in io.Reader, namespace, address, snapshotte | |
| client.Close() | ||
| }() | ||
| r := &readCounter{Reader: in} | ||
| imgs, err := client.Import(ctx, r, | ||
| containerd.WithDigestRef(archive.DigestTranslator(snapshotter)), | ||
| containerd.WithSkipDigestRef(func(name string) bool { return name != "" }), | ||
| containerd.WithImportPlatform(platMC), | ||
| ) | ||
| if err != nil { | ||
| if r.N == 0 { | ||
| // Avoid confusing "unrecognized image format" | ||
| return fmt.Errorf("no image was built: %w", err) | ||
|
There was a problem hiding this comment. Make the error more descriptive by adding the actual error |
||
| } | ||
| if errors.Is(err, images.ErrEmptyWalk) { | ||
| err = fmt.Errorf("%w (Hint: set `--platform=PLATFORM` or `--all-platforms`)", err) | ||
|
|
@@ -192,69 +203,82 @@ func loadImage(ctx context.Context, in io.Reader, namespace, address, snapshotte | |
| return nil | ||
| } | ||
|
|
||
| type BuildctlArgsResult struct { | ||
| BuildctlArgs []string | ||
| BuildctlBinary string | ||
| Cleanup func() | ||
| DestFile string | ||
| MetaFile string | ||
| NeedsLoading bool // Specifies whether the image needs to be loaded into the containerd image store | ||
| Tags []string | ||
| } | ||
|
|
||
| func generateBuildctlArgs(ctx context.Context, client *containerd.Client, options types.BuilderBuildOptions) (result BuildctlArgsResult, err error) { | ||
| buildctlBinary, err := buildkitutil.BuildctlBinary() | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| result.BuildctlBinary = buildctlBinary | ||
|
|
||
| output := options.Output | ||
| if output == "" { | ||
| info, err := client.Server(ctx) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| sharable, err := isImageSharable(options.BuildKitHost, options.GOptions.Namespace, info.UUID, options.GOptions.Snapshotter, options.Platform) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| if sharable { | ||
| output = "type=image,unpack=true" // ensure the target stage is unlazied (needed for any snapshotters) | ||
| } else { | ||
| // https://github.com/moby/buildkit?tab=readme-ov-file#output | ||
| // type=image is the native type for containerd | ||
| output = "type=image" | ||
|
There was a problem hiding this comment. Default to cc @profnandaa |
||
| if len(options.Platform) > 1 { | ||
| // For avoiding `error: failed to solve: docker exporter does not currently support exporting manifest lists` | ||
| // TODO: consider using type=oci for single-options.Platform build too | ||
| output = "type=oci" | ||
| } | ||
| } | ||
| } else { | ||
| if !strings.Contains(output, "type=") { | ||
| // should accept --output <DIR> as an alias of --output | ||
| // type=local,dest=<DIR> | ||
| output = fmt.Sprintf("type=local,dest=%s", output) | ||
| } | ||
| } | ||
|
|
||
| if strings.Contains(output, "type=docker") || strings.Contains(output, "type=oci") { | ||
| if !strings.Contains(output, "dest=") { | ||
| result.NeedsLoading = true | ||
| } | ||
| } | ||
|
|
||
| var tags []string | ||
| if tags = strutil.DedupeStrSlice(options.Tag); len(tags) > 0 { | ||
| ref := tags[0] | ||
| parsedReference, err := referenceutil.Parse(ref) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| output += ",name=" + parsedReference.String() | ||
|
|
||
| // pick the first tag and add it to output | ||
| for idx, tag := range tags { | ||
| parsedReference, err = referenceutil.Parse(tag) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| tags[idx] = parsedReference.String() | ||
| } | ||
| } else if len(tags) == 0 { | ||
| output = output + ",dangling-name-prefix=<none>" | ||
| } | ||
| result.Tags = tags | ||
|
|
||
| buildctlArgs := buildkitutil.BuildctlBaseArgs(options.BuildKitHost) | ||
| buildctlArgs = append(buildctlArgs, []string{ | ||
| "build", | ||
| "--progress=" + options.Progress, | ||
|
|
@@ -271,9 +295,9 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
| var err error | ||
| dir, err = buildkitutil.WriteTempDockerfile(options.Stdin) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| result.Cleanup = func() { | ||
| os.RemoveAll(dir) | ||
| } | ||
| } else { | ||
|
|
@@ -286,12 +310,12 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
| } | ||
| dir, file, err = buildkitutil.BuildKitFile(dir, file) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
|
|
||
| buildCtx, err := parseContextNames(options.ExtendedBuildContext) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
|
|
||
| for k, v := range buildCtx { | ||
|
|
@@ -306,7 +330,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
| if isOCILayout := strings.HasPrefix(v, "oci-layout://"); isOCILayout { | ||
| args, err := parseBuildContextFromOCILayout(k, v) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
|
|
||
| buildctlArgs = append(buildctlArgs, args...) | ||
|
|
@@ -315,7 +339,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
|
|
||
| path, err := filepath.Abs(v) | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| buildctlArgs = append(buildctlArgs, fmt.Sprintf("--local=%s=%s", k, path)) | ||
| buildctlArgs = append(buildctlArgs, fmt.Sprintf("--opt=context:%s=local:%s", k, k)) | ||
|
|
@@ -362,7 +386,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
| } | ||
| } | ||
| } else { | ||
| return result, fmt.Errorf("invalid build arg %q", ba) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -405,7 +429,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
| optAttestType := strings.TrimPrefix(optAttestType, "type=") | ||
| buildctlArgs = append(buildctlArgs, fmt.Sprintf("--opt=attest:%s=%s", optAttestType, optAttestAttrs)) | ||
| } else { | ||
| return result, fmt.Errorf("attestation type not specified") | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -434,11 +458,11 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
| if options.IidFile != "" { | ||
| file, err := os.CreateTemp("", "buildkit-meta-*") | ||
| if err != nil { | ||
| return result, err | ||
| } | ||
| defer file.Close() | ||
| result.MetaFile = file.Name() | ||
| buildctlArgs = append(buildctlArgs, "--metadata-file="+result.MetaFile) | ||
| } | ||
|
|
||
| if options.NetworkMode != "" { | ||
|
|
@@ -453,7 +477,9 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option | |
| } | ||
| } | ||
|
|
||
| result.BuildctlArgs = buildctlArgs | ||
|
|
||
| return result, nil | ||
| } | ||
|
|
||
| func getDigestFromMetaFile(path string) (string, error) { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@apostasie I've removed this test for now. I may be missing something. What is this testing?