Add `fsbackup` and `fsrestore` to work directly from filesystem with restic #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

dermodmaster merged 11 commits into master from task/add-fsbackup-and-fsrestore

Sep 25, 2025

README.md

-Original file line number
+Diff line change
@@ Expand Up @@
        - [CLI](#cli)
        - [Docker](#docker)
        - [Configuration](#configuration)
-          - [Sources](#sources)
+         - [Sources](#sources)
+             - [FsBackup](#fsbackup)
              - [Tar](#tar)
              - [MySQLDump](#mysqldump)
              - [MongoDump](#mongodump)
@@ Expand All @@
           - [Sensitive data: Environment variables](#sensitive-data-environment-variables)
           - [Gzip support for binaries without native gzip support](#gzip-support-for-binaries-without-native-gzip-support)
           - [Restoring from backup](#restoring-from-backup)
+             - [FsRestore](#fsrestore)
              - [TarRestore](#tarrestore)
              - [MongoRestore](#mongorestore)
              - [MySQLRestore](#mysqlrestore)
@@ Expand Down Expand Up / @@ -65,6 +67,8 @@ Usage: @@
     Available Commands:
       help           Help about any command
+      fsbackup       Backs up directories directly. Use it with the --restic flag.
+      fsrestore      Restores directories directly. Use it with the --restic flag.
       mongodump      Creates a mongodump of your desired server
       mongorestore   Restores a server from a mongodump
       mysqldump      Creates a mysqldump of your desired server
@@ Expand Down Expand Up @@
     #### Sources
+    ##### FsBackup
+    ```yaml
+    fsbackup:
+      options:
+        path: /srv/data
+      hostName: autoGeneratedIfEmpty
+    ```
+    Running: `brudi fsbackup -c ${HOME}/.brudi.yml --restic`
+    The `fsbackup` command validates that the configured directory exists and then hands it over to `restic backup` without creating intermediate archives.
     ##### Tar
     ```yaml
@@ Expand Down Expand Up / @@ -343,6 +360,24 @@ mysqlrestore: @@
     #### Restoring from backup
+    ##### FsRestore
+    ```yaml
+    fsrestore:
+      options:
+        path: /srv/data
+      hostName: autoGeneratedIfEmpty
+    restic:
+      restore:
+        flags:
+          target: /restore-target
+        id: "latest"
+    ```
+    Running: `brudi fsrestore -c ${HOME}/.brudi.yml --restic`
+    `fsrestore` triggers `restic restore` for the stored directory path without any additional processing. The configured `target` controls where the restored files are written.
     ##### TarRestore
     ```yaml
@@ Expand Down Expand Up @@
     ### Source backup methods
+    - [x] `fsbackup`
     - [x] `mysqldump`
     - [x] `mongodump`
     - [x] `tar`
@@ Expand All @@
     ### Restore backup methods
+    - [x] `fsrestore`
     - [x] `mysqlrestore`
     - [x] `mongorestore`
     - [x] `tarrestore`
@@ Expand Down @@

cmd/fsbackup.go

-Original file line number
+Diff line change
@@ -0,0 +1,30 @@
+    package cmd
+    import (
+    	"context"
+    	"github.com/mittwald/brudi/pkg/source"
+    	"github.com/mittwald/brudi/pkg/source/fsbackup"
+    	"github.com/spf13/cobra"
+    )
+    var (
+    	fsbackupCmd = &cobra.Command{
+    		Use:   "fsbackup",
+    		Short: "Backs up directories directly with restic",
+    		Long:  "Backs up configured directories using restic without creating intermediate archives.",
+    		Run: func(cmd *cobra.Command, args []string) {
+    			ctx, cancel := context.WithCancel(context.Background())
+    			defer cancel()
+    			if err := source.DoBackupForKind(ctx, fsbackup.Kind, cleanup, useRestic, useResticForget, useResticPrune); err != nil {
+    				panic(err)
+    			}
+    		},
+    	}
+    )
+    func init() {
+    	rootCmd.AddCommand(fsbackupCmd)
+    }

cmd/fsrestore.go

-Original file line number
+Diff line change
@@ -0,0 +1,30 @@
+    package cmd
+    import (
+    	"context"
+    	"github.com/mittwald/brudi/pkg/source"
+    	"github.com/mittwald/brudi/pkg/source/fsrestore"
+    	"github.com/spf13/cobra"
+    )
+    var (
+    	fsrestoreCmd = &cobra.Command{
+    		Use:   "fsrestore",
+    		Short: "Restores directories directly from restic",
+    		Long:  "Restores directories from restic snapshots without additional processing.",
+    		Run: func(cmd *cobra.Command, args []string) {
+    			ctx, cancel := context.WithCancel(context.Background())
+    			defer cancel()
+    			if err := source.DoRestoreForKind(ctx, fsrestore.Kind, cleanup, useRestic); err != nil {
+    				panic(err)
+    			}
+    		},
+    	}
+    )
+    func init() {
+    	rootCmd.AddCommand(fsrestoreCmd)
+    }

pkg/source/backup.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,7 @@ import ( @@
     	log "github.com/sirupsen/logrus"
+    	"github.com/mittwald/brudi/pkg/source/fsbackup"
     	"github.com/mittwald/brudi/pkg/source/mongodump"
     	"github.com/mittwald/brudi/pkg/source/mysqldump"
     	"github.com/mittwald/brudi/pkg/source/redisdump"
@@ Expand All / @@ -29,6 +30,8 @@ func getGenericBackendForKind(kind string) (Generic, error) { @@
     		return redisdump.NewConfigBasedBackend()
     	case tar.Kind:
     		return tar.NewConfigBasedBackend()
+    	case fsbackup.Kind:
+    		return fsbackup.NewConfigBasedBackend()
     	default:
     		return nil, fmt.Errorf("unsupported kind '%s'", kind)
     	}
@@ Expand Down @@

pkg/source/fsbackup/backend_config_based.go

-Original file line number
+Diff line change
@@ -0,0 +1,56 @@
+    package fsbackup
+    import (
+    	"context"
+    	"fmt"
+    	"os"
+    	"github.com/pkg/errors"
+    )
+    type Options struct {
+    	Path string `validate:"min=1"`
+    }
+    type ConfigBasedBackend struct {
+    	cfg *Config
+    }
+    func NewConfigBasedBackend() (*ConfigBasedBackend, error) {
+    	config := &Config{
+    		Options: &Options{},
+    	}
+    	if err := config.InitFromViper(); err != nil {
+    		return nil, err
+    	}
+    	return &ConfigBasedBackend{cfg: config}, nil
+    }
+    func (b *ConfigBasedBackend) CreateBackup(_ context.Context) error {
+    	path := b.cfg.Options.Path
+    	info, err := os.Stat(path)
+    	if err != nil {
+    		return errors.WithStack(err)
+    	}
+    	if !info.IsDir() {
+    		return errors.WithStack(fmt.Errorf("configured path %s is not a directory", path))
+    	}
+    	return nil
+    }
+    func (b *ConfigBasedBackend) GetBackupPath() string {
+    	return b.cfg.Options.Path
+    }
+    func (b *ConfigBasedBackend) GetHostname() string {
+    	return b.cfg.HostName
+    }
+    func (b *ConfigBasedBackend) CleanUp() error {
+    	return nil
+    }

pkg/source/fsrestore/backend_config_based.go

-Original file line number
+Diff line change
@@ -0,0 +1,39 @@
+    package fsrestore
+    import "context"
+    type Options struct {
+    	Path string `validate:"min=1"`
+    }
+    type ConfigBasedBackend struct {
+    	cfg *Config
+    }
+    func NewConfigBasedBackend() (*ConfigBasedBackend, error) {
+    	config := &Config{
+    		Options: &Options{},
+    	}
+    	if err := config.InitFromViper(); err != nil {
+    		return nil, err
+    	}
+    	return &ConfigBasedBackend{cfg: config}, nil
+    }
+    func (b *ConfigBasedBackend) RestoreBackup(context.Context) error {
+    	return nil
+    }
+    func (b *ConfigBasedBackend) GetBackupPath() string {
+    	return b.cfg.Options.Path
+    }
+    func (b *ConfigBasedBackend) GetHostname() string {
+    	return b.cfg.HostName
+    }
+    func (b *ConfigBasedBackend) CleanUp() error {
+    	return nil
+    }

pkg/source/fsrestore/config.go

-Original file line number
+Diff line change
@@ -0,0 +1,35 @@
+    package fsrestore
+    import (
+    	"os"
+    	"github.com/pkg/errors"
+    	"github.com/mittwald/brudi/pkg/config"
+    )
+    const (
+    	// Kind identifies the fsrestore backend in configuration.
+    	Kind = "fsrestore"
+    )
+    type Config struct {
+    	Options  *Options
+    	HostName string `validate:"min=1"`
+    }
+    func (c *Config) InitFromViper() error {
+    	err := config.InitializeStructFromViper(Kind, c)
+    	if err != nil {
+    		return errors.WithStack(err)
+    	}
+    	if c.HostName == "" {
+    		c.HostName, err = os.Hostname()
+    		if err != nil {
+    			return errors.WithStack(err)
+    		}
+    	}
+    	return config.Validate(c)
+    }

pkg/source/restore.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ import ( @@
     	log "github.com/sirupsen/logrus"
     	"github.com/mittwald/brudi/pkg/restic"
+    	"github.com/mittwald/brudi/pkg/source/fsrestore"
     	"github.com/mittwald/brudi/pkg/source/mongorestore"
     	"github.com/mittwald/brudi/pkg/source/mysqlrestore"
     	"github.com/mittwald/brudi/pkg/source/pgrestore"
@@ Expand All @@
     		return tarrestore.NewConfigBasedBackend()
     	case psql.Kind:
     		return psql.NewConfigBasedBackend()
+    	case fsrestore.Kind:
+    		return fsrestore.NewConfigBasedBackend()
     	default:
     		return nil, fmt.Errorf("unsupported kind '%s'", kind)
     	}
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `fsbackup` and `fsrestore` to work directly from filesystem with restic #40

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Add fsbackup and fsrestore to work directly from filesystem with restic #40

Uh oh!

Add fsbackup and fsrestore to work directly from filesystem with restic #40

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Add `fsbackup` and `fsrestore` to work directly from filesystem with restic #40

Add `fsbackup` and `fsrestore` to work directly from filesystem with restic #40