-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add local snapshots management commands (#16067)
Co-authored-by: Marko <marbar3778@yahoo.com> (cherry picked from commit c1ceb3b) # Conflicts: # CHANGELOG.md # go.mod # server/types/app.go # simapp/simd/cmd/root.go # simapp/simd/cmd/root_v2.go # snapshots/store.go
- Loading branch information
1 parent
85fc4af
commit 4051927
Showing
15 changed files
with
929 additions
and
10 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| package snapshot | ||
|
|
||
| import ( | ||
| servertypes "github.com/cosmos/cosmos-sdk/server/types" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // Cmd returns the snapshots group command | ||
| func Cmd(appCreator servertypes.AppCreator) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "snapshots", | ||
| Short: "Manage local snapshots", | ||
| Long: "Manage local snapshots", | ||
| } | ||
| cmd.AddCommand( | ||
| ListSnapshotsCmd, | ||
| RestoreSnapshotCmd(appCreator), | ||
| ExportSnapshotCmd(appCreator), | ||
| DumpArchiveCmd(), | ||
| LoadArchiveCmd(), | ||
| DeleteSnapshotCmd(), | ||
| ) | ||
| return cmd | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| package snapshot | ||
|
|
||
| import ( | ||
| "strconv" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/server" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func DeleteSnapshotCmd() *cobra.Command { | ||
| return &cobra.Command{ | ||
| Use: "delete <height> <format>", | ||
| Short: "Delete a local snapshot", | ||
| Args: cobra.ExactArgs(2), | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx := server.GetServerContextFromCmd(cmd) | ||
|
|
||
| height, err := strconv.ParseUint(args[0], 10, 64) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| format, err := strconv.ParseUint(args[1], 10, 32) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| snapshotStore, err := server.GetSnapshotStore(ctx.Viper) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return snapshotStore.Delete(height, uint32(format)) | ||
| }, | ||
| } | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| package snapshot | ||
|
|
||
| import ( | ||
| "archive/tar" | ||
| "compress/gzip" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "strconv" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/server" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // DumpArchiveCmd returns a command to dump the snapshot as portable archive format | ||
| func DumpArchiveCmd() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "dump <height> <format>", | ||
| Short: "Dump the snapshot as portable archive format", | ||
| Args: cobra.ExactArgs(2), | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx := server.GetServerContextFromCmd(cmd) | ||
| snapshotStore, err := server.GetSnapshotStore(ctx.Viper) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| output, err := cmd.Flags().GetString("output") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| height, err := strconv.ParseUint(args[0], 10, 64) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| format, err := strconv.ParseUint(args[1], 10, 32) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if output == "" { | ||
| output = fmt.Sprintf("%d-%d.tar.gz", height, format) | ||
| } | ||
|
|
||
| snapshot, err := snapshotStore.Get(height, uint32(format)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| bz, err := snapshot.Marshal() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fp, err := os.Create(output) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer fp.Close() | ||
|
|
||
| // since the chunk files are already compressed, we just use fastest compression here | ||
| gzipWriter, err := gzip.NewWriterLevel(fp, gzip.BestSpeed) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| tarWriter := tar.NewWriter(gzipWriter) | ||
| if err := tarWriter.WriteHeader(&tar.Header{ | ||
| Name: SnapshotFileName, | ||
| Mode: 0o644, | ||
| Size: int64(len(bz)), | ||
| }); err != nil { | ||
| return fmt.Errorf("failed to write snapshot header to tar: %w", err) | ||
| } | ||
| if _, err := tarWriter.Write(bz); err != nil { | ||
| return fmt.Errorf("failed to write snapshot to tar: %w", err) | ||
| } | ||
|
|
||
| for i := uint32(0); i < snapshot.Chunks; i++ { | ||
| path := snapshotStore.PathChunk(height, uint32(format), i) | ||
| file, err := os.Open(path) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to open chunk file %s: %w", path, err) | ||
| } | ||
|
|
||
| st, err := file.Stat() | ||
| if err != nil { | ||
| return fmt.Errorf("failed to stat chunk file %s: %w", path, err) | ||
| } | ||
|
|
||
| if err := tarWriter.WriteHeader(&tar.Header{ | ||
| Name: strconv.FormatUint(uint64(i), 10), | ||
| Mode: 0o644, | ||
| Size: st.Size(), | ||
| }); err != nil { | ||
| return fmt.Errorf("failed to write chunk header to tar: %w", err) | ||
| } | ||
|
|
||
| if _, err := io.Copy(tarWriter, file); err != nil { | ||
| return fmt.Errorf("failed to write chunk to tar: %w", err) | ||
| } | ||
| } | ||
|
|
||
| if err := tarWriter.Close(); err != nil { | ||
| return fmt.Errorf("failed to close tar writer: %w", err) | ||
| } | ||
|
|
||
| if err := gzipWriter.Close(); err != nil { | ||
| return fmt.Errorf("failed to close gzip writer: %w", err) | ||
| } | ||
|
|
||
| return fp.Close() | ||
| }, | ||
| } | ||
|
|
||
| cmd.Flags().StringP("output", "o", "", "output file") | ||
|
|
||
| return cmd | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| package snapshot | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "cosmossdk.io/log" | ||
| "github.com/cosmos/cosmos-sdk/server" | ||
| servertypes "github.com/cosmos/cosmos-sdk/server/types" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // ExportSnapshotCmd returns a command to take a snapshot of the application state | ||
| func ExportSnapshotCmd(appCreator servertypes.AppCreator) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "export", | ||
| Short: "Export app state to snapshot store", | ||
| Args: cobra.NoArgs, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx := server.GetServerContextFromCmd(cmd) | ||
|
|
||
| height, err := cmd.Flags().GetInt64("height") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| home := ctx.Config.RootDir | ||
| db, err := openDB(home, server.GetAppDBBackend(ctx.Viper)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| logger := log.NewLogger(cmd.OutOrStdout()) | ||
| app := appCreator(logger, db, nil, ctx.Viper) | ||
|
|
||
| if height == 0 { | ||
| height = app.CommitMultiStore().LastCommitID().Version | ||
| } | ||
|
|
||
| fmt.Printf("Exporting snapshot for height %d\n", height) | ||
|
|
||
| sm := app.SnapshotManager() | ||
| snapshot, err := sm.Create(uint64(height)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fmt.Printf("Snapshot created at height %d, format %d, chunks %d\n", snapshot.Height, snapshot.Format, snapshot.Chunks) | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| cmd.Flags().Int64("height", 0, "Height to export, default to latest state height") | ||
|
|
||
| return cmd | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package snapshot | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/server" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // ListSnapshotsCmd returns the command to list local snapshots | ||
| var ListSnapshotsCmd = &cobra.Command{ | ||
| Use: "list", | ||
| Short: "List local snapshots", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx := server.GetServerContextFromCmd(cmd) | ||
| snapshotStore, err := server.GetSnapshotStore(ctx.Viper) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| snapshots, err := snapshotStore.List() | ||
| if err != nil { | ||
| return fmt.Errorf("failed to list snapshots: %w", err) | ||
| } | ||
| for _, snapshot := range snapshots { | ||
| fmt.Println("height:", snapshot.Height, "format:", snapshot.Format, "chunks:", snapshot.Chunks) | ||
| } | ||
|
|
||
| return nil | ||
| }, | ||
| } |
Oops, something went wrong.