Add image squash command by weapons97 · Pull Request #3756 · containerd/nerdctl

weapons97 · 2024-12-12T08:03:26Z

This pr adds the squash image command.

The related issue is #3252.

AkihiroSuda · 2024-12-13T04:26:30Z

cmd/nerdctl/image/image_squash.go

+	cmd.Flags().StringP("message", "m", "", "Commit message")
+}
+
+func NewSquashCommand() *cobra.Command {


Needs docs and tests

ok，I will add it later.

added, please check it out

https://github.com/containerd/nerdctl/blob/main/docs/command-reference.md needs to be updated

updated, please check it out

AkihiroSuda · 2024-12-13T04:26:49Z

cmd/nerdctl/main.go

 		image.NewTagCommand(),
 		image.NewRmiCommand(),
 		image.NewHistoryCommand(),
+		image.NewSquashCommand(),


Not a fan of inflating the number of the top-level commands

AkihiroSuda · 2024-12-13T04:27:25Z

pkg/cmd/image/squash.go

+	}
+}
+
+// copied from github.com/containerd/containerd/rootfs/apply.go


Should be a permanent URL with the git tag (or the commit hash)

The commit hash has been added.

Suggest to use a full URL directly, e.g., https://github.com/containerd/containerd/blob/v2.0.1/pkg/rootfs/apply.go#L180

djdongjin · 2025-01-03T17:56:15Z

cmd/nerdctl/image/image_squash.go

+// NewSquashCommand returns a new `squash` command to compress the number of layers of the image
+func NewSquashCommand() *cobra.Command {
+	var squashCommand = &cobra.Command{
+		Use:           "squash [flags] SOURCE_IMAGE TAG_IMAGE",


nit: TAG_IMAGE -> TARGET_IMAGE

had changed

djdongjin · 2025-01-03T17:58:12Z

cmd/nerdctl/image/image_squash_test.go

+	testCase := nerdtest.Setup()
+
+	require := test.Require(
+		test.Linux,


why is this Linux only?

ok, i deleted

djdongjin · 2025-01-03T18:06:10Z

cmd/nerdctl/image/image_squash.go

+)
+
+func addSquashFlags(cmd *cobra.Command) {
+	cmd.Flags().IntP("layer-count", "c", 0, "The number of layers that can be compressed")


does this flag specify squashing the last N (N=layer-count) layers? If so I suggest renaming it to last-n-layer.

Or rename it to from-layer, meaning squashing all layers starting from from-layer (and --from-layer=0 means squash all layers)

Thank you, I have changed it to last-n-layer.

djdongjin · 2025-01-03T18:06:24Z

cmd/nerdctl/image/image_squash.go

+
+func addSquashFlags(cmd *cobra.Command) {
+	cmd.Flags().IntP("layer-count", "c", 0, "The number of layers that can be compressed")
+	cmd.Flags().StringP("layer-digest", "d", "", "The digest of the layer to be compressed")


why do we need this flag?

It is indeed unnecessary, so I have removed this flag.

djdongjin · 2025-01-03T18:07:43Z

cmd/nerdctl/image/image_squash.go

+	cmd.Flags().StringP("author", "a", "", `Author (e.g., "nerdctl contributor <[email protected]>")`)
+	cmd.Flags().StringP("message", "m", "", "Commit message")


nit: maybe use something like author="nerdctl" and message="generated by nerdctl squash" as default values.

thanks， changed

djdongjin · 2025-01-03T18:09:53Z

docs/command-reference.md


+### :nerd_face: nerdctl image squash
+
+Squash an image layers.


suggest to add some details, e.g., Squash all layers starting from from-layer into a single layer.

thanks， changed

djdongjin · 2025-01-03T18:11:49Z

pkg/cmd/image/squash.go

+	}
+}
+
+// copied from github.com/containerd/containerd/rootfs/apply.go


Suggest to use a full URL directly, e.g., https://github.com/containerd/containerd/blob/v2.0.1/pkg/rootfs/apply.go#L180

djdongjin · 2025-01-15T03:24:39Z

cmd/nerdctl/image/image_squash.go

+	layerN, err := cmd.Flags().GetInt("last-n-layer")
+	if err != nil {
+		return options, err
+	}


can we add a check to make sure layerN > 0?

OK, I have modified it.

djdongjin · 2025-01-15T03:30:18Z

pkg/cmd/image/squash.go

+	if matchCount < 1 {
+		return fmt.Errorf("%s: not found", option.SourceImageRef)
+	}


what's the behavior if matchCount > 1?

I'm not sure. Maybe just return an error.

djdongjin · 2025-01-15T03:32:29Z

pkg/cmd/image/squash.go

+		return err
+	}
+	remainingLayerCount := len(img.manifest.Layers) - len(sLayers)
+	// Don't gc me and clean the dirty data after 1 hour!


why 1 hour? after squash we should just remove the temp data and keep the final new data forever?

I'm not sure if this "leases" part is necessary. This code is copy from the "commit" command （pkg/imgutil/commit/commit.go）. Could you help me take a look?

djdongjin · 2025-01-15T03:36:17Z

pkg/cmd/image/squash.go

+	}
+
+	clientImage := containerd.NewImage(sr.client, containerImage)
+	manifest, _, err := imgutil.ReadManifest(ctx, clientImage)


what if we pass in an image index instead of manifest? seems index is not supported? can we add a check to return an error if the image is not a manifest.

sure, please check it out

AkihiroSuda · 2025-02-20T01:53:09Z

@weapons97 Could you check the comments from djdongjin?

lingdie · 2025-04-15T09:57:06Z

Is there any new progress? I might be able to provide assistance, as the code in this PR is derived from one of my repositories https://github.com/lingdie/squash/blob/main/pkg/squash/runtime.go, provided that this PR allows me to make modifications and the nerdctl open source community permits it.

AkihiroSuda · 2025-04-21T06:41:17Z

@lingdie Thanks, would you be interested in opening a new PR?

Alternatively @weapons97 may invite @lingdie to allow pushing to https://github.com/weapons97/nerdctl/tree/main (if @weapons97 would like to do so)

weapons97 · 2025-05-20T01:38:47Z

Is there any new progress? I might be able to provide assistance, as the code in this PR is derived from one of my repositories https://github.com/lingdie/squash/blob/main/pkg/squash/runtime.go, provided that this PR allows me to make modifications and the nerdctl open source community permits it.

Sorry for the late reply. I've added you as a collaborator to the project, so you should have permission to push to the main branch.

Signed-off-by: weapons97 <[email protected]>

weapons97 force-pushed the main branch 4 times, most recently from b7756fe to 9599d0a Compare December 13, 2024 01:14

AkihiroSuda reviewed Dec 13, 2024

View reviewed changes

weapons97 force-pushed the main branch from 9599d0a to 313960f Compare December 13, 2024 05:42

weapons97 force-pushed the main branch 11 times, most recently from df967a2 to b6077c1 Compare January 2, 2025 01:17

weapons97 force-pushed the main branch from b6077c1 to eaabf57 Compare January 3, 2025 02:51

djdongjin reviewed Jan 3, 2025

View reviewed changes

weapons97 force-pushed the main branch from eaabf57 to 70fc46c Compare January 15, 2025 01:03

AkihiroSuda requested a review from djdongjin January 15, 2025 01:40

djdongjin reviewed Jan 15, 2025

View reviewed changes

weapons97 force-pushed the main branch from 70fc46c to 71fb80c Compare May 20, 2025 01:43

weapons97 force-pushed the main branch 8 times, most recently from a68839b to 8f4449e Compare May 26, 2025 03:18

Add image squash command

ddfc80f

Signed-off-by: weapons97 <[email protected]>

weapons97 force-pushed the main branch from 8f4449e to ddfc80f Compare May 26, 2025 03:20

		cmd.Flags().StringP("author", "a", "", `Author (e.g., "nerdctl contributor <[email protected]>")`)
		cmd.Flags().StringP("message", "m", "", "Commit message")

Conversation

weapons97 commented Dec 12, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AkihiroSuda commented Feb 20, 2025

Uh oh!

lingdie commented Apr 15, 2025

Uh oh!

AkihiroSuda commented Apr 21, 2025

Uh oh!

weapons97 commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

weapons97 commented May 20, 2025 •

edited

Loading