refactor: remove flags & fixes (#2574)

Author: FabianKramm

cmd/vcluster/cmd/restore.go

@@ -10,20 +10,33 @@ import (
 	"io"
 	"os"
 	"path/filepath"
+	"strings"
 
 	vclusterconfig "github.com/loft-sh/vcluster/config"
 	"github.com/loft-sh/vcluster/pkg/config"
 	"github.com/loft-sh/vcluster/pkg/constants"
 	"github.com/loft-sh/vcluster/pkg/etcd"
+	"github.com/loft-sh/vcluster/pkg/mappings/store"
+	"github.com/loft-sh/vcluster/pkg/scheme"
 	"github.com/loft-sh/vcluster/pkg/snapshot"
 	"github.com/spf13/cobra"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/serializer"
+	"k8s.io/apimachinery/pkg/runtime/serializer/protobuf"
 	"k8s.io/klog/v2"
 )
 
 type RestoreOptions struct {
 	Snapshot snapshot.Options
+
+	NewVCluster bool
 }
 
+var (
+	podGVK = corev1.SchemeGroupVersion.WithKind("Pod")
+)
+
 func NewRestoreCommand() *cobra.Command {
 	options := &RestoreOptions{}
 	envOptions, err := parseOptionsFromEnv()
@@ -42,12 +55,15 @@ func NewRestoreCommand() *cobra.Command {
 		},
 	}
 
-	// add storage flags
-	snapshot.AddFlags(cmd.Flags(), &options.Snapshot)
+	cmd.Flags().BoolVar(&options.NewVCluster, "new-vcluster", false, "Restore a new vCluster from snapshot instead of restoring into an existing vCluster")
 	return cmd
 }
 
 func (o *RestoreOptions) Run(ctx context.Context) error {
+	// create decoder and encoder
+	decoder := serializer.NewCodecFactory(scheme.Scheme).UniversalDeserializer()
+	encoder := protobuf.NewSerializer(scheme.Scheme, scheme.Scheme)
+
 	// parse vCluster config
 	vConfig, err := config.ParseConfig(constants.DefaultVClusterConfigLocation, os.Getenv("VCLUSTER_NAME"), nil)
 	if err != nil {
@@ -67,7 +83,7 @@ func (o *RestoreOptions) Run(ctx context.Context) error {
 	}
 
 	// create store
-	objectStore, err := createStore(ctx, &o.Snapshot)
+	objectStore, err := snapshot.CreateStore(ctx, &o.Snapshot)
 	if err != nil {
 		return fmt.Errorf("failed to create store: %w", err)
 	}
@@ -103,6 +119,26 @@ func (o *RestoreOptions) Run(ctx context.Context) error {
 			break
 		}
 
+		// transform value if we are restoring to a new vCluster
+		if o.NewVCluster {
+			// skip mappings
+			splitKey := strings.Split(string(key), "/")
+			if strings.HasPrefix(string(key), store.MappingsPrefix) {
+				continue
+			} else if len(splitKey) == 5 && splitKey[2] == "configmaps" && splitKey[4] == "kube-root-ca.crt" {
+				// we will get separate certificates, so we need to skip these
+				continue
+			}
+
+			// transform pods
+			if strings.HasPrefix(string(key), "/registry/pods/") {
+				value, err = transformPod(value, decoder, encoder)
+				if err != nil {
+					return fmt.Errorf("transform value: %w", err)
+				}
+			}
+		}
+
 		// write the value to etcd
 		klog.V(1).Infof("Restore key %s", string(key))
 		err = etcdClient.Put(ctx, string(key), value)
@@ -122,6 +158,30 @@ func (o *RestoreOptions) Run(ctx context.Context) error {
 	return nil
 }
 
+func transformPod(value []byte, decoder runtime.Decoder, encoder runtime.Encoder) ([]byte, error) {
+	// decode value
+	obj := &corev1.Pod{}
+	_, _, err := decoder.Decode(value, &podGVK, obj)
+	if err != nil {
+		return nil, fmt.Errorf("decode value: %w", err)
+	} else if obj.DeletionTimestamp != nil {
+		return value, nil
+	}
+
+	// make sure to delete nodename & status or otherwise vCluster will delete the pod on start
+	obj.Spec.NodeName = ""
+	obj.Status = corev1.PodStatus{}
+
+	// encode value
+	buf := &bytes.Buffer{}
+	err = encoder.Encode(obj, buf)
+	if err != nil {
+		return nil, fmt.Errorf("encode value: %w", err)
+	}
+
+	return buf.Bytes(), nil
+}
+
 func newRestoreEtcdClient(ctx context.Context, vConfig *config.VirtualClusterConfig) (etcd.Client, error) {
 	// delete existing storage:
 	// * embedded etcd: just delete the files locally

cmd/vcluster/cmd/snapshot.go

@@ -20,22 +20,13 @@ import (
 	"github.com/loft-sh/vcluster/pkg/pro"
 	"github.com/loft-sh/vcluster/pkg/setup"
 	"github.com/loft-sh/vcluster/pkg/snapshot"
-	"github.com/loft-sh/vcluster/pkg/snapshot/file"
-	"github.com/loft-sh/vcluster/pkg/snapshot/oci"
-	"github.com/loft-sh/vcluster/pkg/snapshot/s3"
 	"github.com/loft-sh/vcluster/pkg/util/servicecidr"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 	"google.golang.org/grpc/grpclog"
 	"k8s.io/klog/v2"
 )
 
-type Storage interface {
-	Target() string
-	PutObject(ctx context.Context, body io.Reader) error
-	GetObject(ctx context.Context) (io.ReadCloser, error)
-}
-
 type SnapshotOptions struct {
 	Snapshot snapshot.Options
 }
@@ -58,8 +49,6 @@ func NewSnapshotCommand() *cobra.Command {
 		},
 	}
 
-	// add storage flags
-	snapshot.AddFlags(cmd.Flags(), &options.Snapshot)
 	return cmd
 }
 
@@ -83,7 +72,7 @@ func (o *SnapshotOptions) Run(ctx context.Context) error {
 	}
 
 	// create store
-	objectStore, err := createStore(ctx, &o.Snapshot)
+	objectStore, err := snapshot.CreateStore(ctx, &o.Snapshot)
 	if err != nil {
 		return fmt.Errorf("failed to create store: %w", err)
 	}
@@ -99,7 +88,7 @@ func (o *SnapshotOptions) Run(ctx context.Context) error {
 	return nil
 }
 
-func (o *SnapshotOptions) writeSnapshot(ctx context.Context, etcdClient etcd.Client, objectStore Storage) error {
+func (o *SnapshotOptions) writeSnapshot(ctx context.Context, etcdClient etcd.Client, objectStore snapshot.Storage) error {
 	// now stream objects from etcd to object store
 	errChan := make(chan error)
 	reader, writer, err := os.Pipe()
@@ -123,6 +112,19 @@ func (o *SnapshotOptions) writeSnapshot(ctx context.Context, etcdClient etcd.Cli
 	tarWriter := tar.NewWriter(gzipWriter)
 	defer tarWriter.Close()
 
+	// write the vCluster config as first thing
+	if o.Snapshot.Release != nil {
+		releaseBytes, err := json.Marshal(o.Snapshot.Release)
+		if err != nil {
+			return fmt.Errorf("failed to marshal vCluster release: %w", err)
+		}
+
+		err = writeKeyValue(tarWriter, []byte(snapshot.SnapshotReleaseKey), releaseBytes)
+		if err != nil {
+			return fmt.Errorf("failed to snapshot vCluster release: %w", err)
+		}
+	}
+
 	// now write the snapshot
 	backedUpKeys := 0
 	for {
@@ -359,24 +361,6 @@ func generateCertificates(ctx context.Context, vConfig *config.VirtualClusterCon
 	return certificatesDir, nil
 }
 
-func createStore(ctx context.Context, options *snapshot.Options) (Storage, error) {
-	if options.Type == "s3" {
-		objectStore := s3.NewStore(klog.FromContext(ctx))
-		err := objectStore.Init(&options.S3)
-		if err != nil {
-			return nil, fmt.Errorf("failed to init s3 object store: %w", err)
-		}
-
-		return objectStore, nil
-	} else if options.Type == "file" {
-		return file.NewStore(&options.File), nil
-	} else if options.Type == "oci" {
-		return oci.NewStore(&options.OCI), nil
-	}
-
-	return nil, fmt.Errorf("unknown storage: %s", options.Type)
-}
-
 func writeKeyValue(tarWriter *tar.Writer, key, value []byte) error {
 	err := tarWriter.WriteHeader(&tar.Header{
 		Typeflag: tar.TypeReg,

cmd/vclusterctl/cmd/restore.go

@@ -41,19 +41,18 @@ Example:
 vcluster restore my-vcluster oci://ghcr.io/my-user/my-repo:my-tag
 # Restore from s3 bucket
 vcluster restore my-vcluster s3://my-bucket/my-bucket-key
-# Restore from vCluster pvc
-vcluster restore my-vcluster file:///data/my-local-snapshot.tar.gz
+# Restore from vCluster container filesystem
+vcluster restore my-vcluster container:///data/my-local-snapshot.tar.gz
 #######################################################
 	`,
 		Args:              nameValidator,
 		ValidArgsFunction: completion.NewValidVClusterNameFunc(globalFlags),
 		RunE: func(cobraCmd *cobra.Command, args []string) error {
-			return cli.Restore(cobraCmd.Context(), args, cmd.GlobalFlags, &cmd.Snapshot, &cmd.Pod, cmd.Log)
+			return cli.Restore(cobraCmd.Context(), args, cmd.GlobalFlags, &cmd.Snapshot, &cmd.Pod, false, cmd.Log)
 		},
 	}
 
 	// add storage flags
-	snapshot.AddFlags(cobraCmd.Flags(), &cmd.Snapshot)
 	pod.AddFlags(cobraCmd.Flags(), &cmd.Pod, true)
 	return cobraCmd
 }

cmd/vclusterctl/cmd/snapshot.go

@@ -41,8 +41,8 @@ Example:
 vcluster snapshot my-vcluster oci://ghcr.io/my-user/my-repo:my-tag
 # Snapshot to s3 bucket
 vcluster snapshot my-vcluster s3://my-bucket/my-bucket-key
-# Snapshot to vCluster pvc
-vcluster snapshot my-vcluster file:///data/my-local-snapshot.tar.gz
+# Snapshot to vCluster container filesystem
+vcluster snapshot my-vcluster container:///data/my-local-snapshot.tar.gz
 #######################################################
 	`,
 		Args:              nameValidator,
@@ -53,7 +53,6 @@ vcluster snapshot my-vcluster file:///data/my-local-snapshot.tar.gz
 	}
 
 	// add storage flags
-	snapshot.AddFlags(cobraCmd.Flags(), &cmd.Snapshot)
 	pod.AddFlags(cobraCmd.Flags(), &cmd.Pod, false)
 	return cobraCmd
 }