feat: support nydusify for build and push (#128)

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

Author: chlins

cmd/build.go

@@ -55,6 +55,8 @@ func init() {
 	flags.BoolVarP(&buildConfig.OutputRemote, "output-remote", "", false, "turning on this flag will output model artifact to remote registry directly")
 	flags.BoolVarP(&buildConfig.PlainHTTP, "plain-http", "", false, "turning on this flag will use plain HTTP instead of HTTPS")
 	flags.BoolVarP(&buildConfig.Insecure, "insecure", "", false, "turning on this flag will disable TLS verification")
+	flags.BoolVar(&buildConfig.Nydusify, "nydusify", false, "[EXPERIMENTAL] nydusify the model artifact")
+	flags.MarkHidden("nydusify")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache list flags to viper: %w", err))
@@ -73,5 +75,16 @@ func runBuild(ctx context.Context, workDir string) error {
 	}
 
 	fmt.Printf("Successfully built model artifact: %s\n", buildConfig.Target)
+
+	// nydusify the model artifact if needed.
+	if buildConfig.Nydusify {
+		nydusName, err := b.Nydusify(ctx, buildConfig.Target)
+		if err != nil {
+			return fmt.Errorf("failed to nydusify %s: %w", buildConfig.Target, err)
+		}
+
+		fmt.Printf("Successfully nydusify model artifact: %s\n", nydusName)
+	}
+
 	return nil
 }

cmd/push.go

@@ -51,6 +51,8 @@ func init() {
 	flags := pushCmd.Flags()
 	flags.IntVar(&pushConfig.Concurrency, "concurrency", pushConfig.Concurrency, "specify the number of concurrent push operations")
 	flags.BoolVar(&pushConfig.PlainHTTP, "plain-http", false, "use plain HTTP instead of HTTPS")
+	flags.BoolVar(&pushConfig.Nydusify, "nydusify", false, "[EXPERIMENTAL] nydusify the model artifact")
+	flags.MarkHidden("nydusify")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache push flags to viper: %w", err))
@@ -69,5 +71,16 @@ func runPush(ctx context.Context, target string) error {
 	}
 
 	fmt.Printf("Successfully pushed model artifact: %s\n", target)
+
+	// nydusify the model artifact if needed.
+	if pushConfig.Nydusify {
+		nydusName, err := b.Nydusify(ctx, target)
+		if err != nil {
+			return fmt.Errorf("failed to nydusify %s: %w", target, err)
+		}
+
+		fmt.Printf("Successfully nydusify model artifact: %s\n", nydusName)
+	}
+
 	return nil
 }

pkg/backend/backend.go

@@ -57,6 +57,9 @@ type Backend interface {
 
 	// Tag creates a new tag that refers to the source model artifact.
 	Tag(ctx context.Context, source, target string) error
+
+	// Nydusify converts the model artifact to nydus format.
+	Nydusify(ctx context.Context, target string) (string, error)
 }
 
 // backend is the implementation of Backend.

pkg/backend/nydusify.go

@@ -0,0 +1,53 @@
+/*
+ *     Copyright 2025 The CNAI Authors
+ *
+ * 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 backend
+
+import (
+	"context"
+	"os/exec"
+)
+
+const (
+	// nydusImageTagSuffix is the suffix for the nydus image tag.
+	nydusImageTagSuffix = "_nydus_v2"
+)
+
+// Nydusify is a function that converts a given model artifact to a nydus image.
+func (b *backend) Nydusify(ctx context.Context, source string) (string, error) {
+	target := source + nydusImageTagSuffix
+	cmd := exec.CommandContext(
+		ctx,
+		"nydusify",
+		"convert",
+		"--source-backend-type",
+		"model-artifact",
+		"--compressor",
+		"lz4_block",
+		"--fs-version",
+		"5",
+		"--source",
+		source,
+		"--target",
+		target,
+	)
+
+	if err := cmd.Run(); err != nil {
+		return "", err
+	}
+
+	return target, nil
+}

pkg/config/build.go

@@ -30,6 +30,7 @@ type Build struct {
 	OutputRemote bool
 	PlainHTTP    bool
 	Insecure     bool
+	Nydusify     bool
 }
 
 func NewBuild() *Build {
@@ -40,6 +41,7 @@ func NewBuild() *Build {
 		OutputRemote: false,
 		PlainHTTP:    false,
 		Insecure:     false,
+		Nydusify:     false,
 	}
 }
 
@@ -56,5 +58,11 @@ func (b *Build) Validate() error {
 		return fmt.Errorf("model file path is required")
 	}
 
+	if b.Nydusify {
+		if !b.OutputRemote {
+			return fmt.Errorf("nydusify only works with output remote")
+		}
+	}
+
 	return nil
 }

pkg/config/push.go

@@ -26,12 +26,14 @@ const (
 type Push struct {
 	Concurrency int
 	PlainHTTP   bool
+	Nydusify    bool
 }
 
 func NewPush() *Push {
 	return &Push{
 		Concurrency: defaultPushConcurrency,
 		PlainHTTP:   false,
+		Nydusify:    false,
 	}
 }