Merge pull request #1333 from signal18/feature/restic-02-configuration

feat: add restic configuration wiring and mount auto-disable

Author: caffeinated92

cluster/cluster_bck.go

@@ -101,7 +101,14 @@ func (cluster *Cluster) StartResticManager() error {
 		return nil
 	}
 
-	cluster.ResticManager = backupmgr.NewResticRepo(cluster.Conf.BackupResticBinaryPath, cluster.MessageChan, config.ConstLogModRestic)
+	resticManager := backupmgr.NewResticRepo(cluster.Conf.BackupResticBinaryPath, cluster.MessageChan, config.ConstLogModRestic)
+	if err := cluster.Conf.ValidateResticPermissions(); err != nil {
+		cluster.LogModulePrintf(cluster.Conf.Verbose, config.ConstLogModGeneral, config.LvlWarn, "Invalid restic permission config: %s", err)
+	}
+	resticManager.SetPermissions(cluster.Conf.GetResticDirMode(), cluster.Conf.GetResticFileMode())
+	resticManager.SetOperationTimeout(cluster.Conf.GetResticTimeout())
+	resticManager.AutoDetectAndDisableMount()
+	cluster.ResticManager = resticManager
 	cluster.ReloadResticEnv()
 	go cluster.ResticFetchRepo()
 	return nil

config/config.go

@@ -743,6 +743,8 @@ type Config struct {
 	BackupResticPassword                      string                 `mapstructure:"backup-restic-password"  toml:"backup-restic-password" json:"-"`
 	BackupResticAws                           bool                   `mapstructure:"backup-restic-aws"  toml:"backup-restic-aws" json:"backupResticAws"`
 	BackupResticTimeout                       int                    `mapstructure:"backup-restic-timeout"  toml:"backup-restic-timeout" json:"backupResticTimeout"`
+	BackupResticDirMode                       int                    `mapstructure:"backup-restic-dir-mode" toml:"backup-restic-dir-mode" json:"backupResticDirMode"`
+	BackupResticFileMode                      int                    `mapstructure:"backup-restic-file-mode" toml:"backup-restic-file-mode" json:"backupResticFileMode"`
 	BackupResticPurgeOldestOnDiskSpace        bool                   `mapstructure:"backup-restic-purge-oldest-on-disk-space" toml:"backup-restic-purge-oldest-on-disk-space" json:"backupResticPurgeOldestOnDiskSpace"`
 	BackupResticPurgeOldestOnDiskThreshold    int                    `mapstructure:"backup-restic-purge-oldest-on-disk-threshold" toml:"backup-restic-purge-oldest-on-disk-treshold" json:"backupResticPurgeOldestOnDiskTreshold"`
 	BackupStreaming                           bool                   `mapstructure:"backup-streaming" toml:"backup-streaming" json:"backupStreaming"`
@@ -1759,7 +1761,6 @@ func (conf *Config) GenerateKey(Logger *logrus.Logger) error {
 			conf.MonitoringKeyPath = fallbackPath
 			Logger.Debugf("Path writable. Flag 'monitoring-key-path' set to: %s.", fallbackPath)
 			Logger.Debugf("Generating key on: %s", conf.MonitoringKeyPath)
-
 		}
 
 		p := crypto.Password{}
@@ -3787,6 +3788,58 @@ func (conf *Config) CheckKeepWithin() error {
 	return nil
 }
 
+func isValidResticMode(value int) bool {
+	if value == 0 {
+		return true
+	}
+	if value < 600 || value > 777 {
+		return false
+	}
+	_, err := strconv.ParseUint(strconv.Itoa(value), 8, 32)
+	return err == nil
+}
+
+func parseResticMode(value int, defaultMode os.FileMode) os.FileMode {
+	if value <= 0 {
+		return defaultMode
+	}
+	if !isValidResticMode(value) {
+		return defaultMode
+	}
+
+	parsed, err := strconv.ParseUint(strconv.Itoa(value), 8, 32)
+	if err != nil {
+		return defaultMode
+	}
+
+	return os.FileMode(parsed)
+}
+
+func (conf *Config) ValidateResticPermissions() error {
+	if !isValidResticMode(conf.BackupResticDirMode) {
+		return NewValidationError("backup-restic-dir-mode", conf.BackupResticDirMode, "expected octal value in 6xx/7xx range, like 700")
+	}
+	if !isValidResticMode(conf.BackupResticFileMode) {
+		return NewValidationError("backup-restic-file-mode", conf.BackupResticFileMode, "expected octal value in 6xx/7xx range, like 600")
+	}
+	return nil
+}
+
+func (conf *Config) GetResticDirMode() os.FileMode {
+	return parseResticMode(conf.BackupResticDirMode, 0700)
+}
+
+func (conf *Config) GetResticFileMode() os.FileMode {
+	return parseResticMode(conf.BackupResticFileMode, 0600)
+}
+
+func (conf *Config) GetResticTimeout() time.Duration {
+	if conf.BackupResticTimeout <= 0 {
+		return 2 * time.Hour
+	}
+	return time.Duration(conf.BackupResticTimeout) * time.Second
+}
+
 type MeasurementConfig struct {
 	Min      int
 	Max      int

config/config_v2.go

@@ -23,10 +23,10 @@ type ConfigV2 struct {
 	WithEmbed   string `mapstructure:"-" toml:"-" json:"withEmbed"`
 
 	// Domain-Specific Configurations
-	Monitoring  MonitoringConfig  `mapstructure:",squash" toml:",inline" json:"monitoring"`
-	Database    DatabaseConfig    `mapstructure:",squash" toml:",inline" json:"database"`
-	Replication ReplicationConfig `mapstructure:",squash" toml:",inline" json:"replication"`
-	Failover    FailoverConfig    `mapstructure:",squash" toml:",inline" json:"failover"`
+	Monitoring   MonitoringConfig   `mapstructure:",squash" toml:",inline" json:"monitoring"`
+	Database     DatabaseConfig     `mapstructure:",squash" toml:",inline" json:"database"`
+	Replication  ReplicationConfig  `mapstructure:",squash" toml:",inline" json:"replication"`
+	Failover     FailoverConfig     `mapstructure:",squash" toml:",inline" json:"failover"`
 	// TODO: Add remaining domain configs:
 	// Switchover   SwitchoverConfig   `mapstructure:",squash" toml:",inline" json:"switchover"`
 	// Backup       BackupConfig       `mapstructure:",squash" toml:",inline" json:"backup"`

config/restic_permissions_test.go

@@ -0,0 +1,54 @@
+package config
+
+import (
+	"os"
+	"testing"
+)
+
+func TestParseResticMode(t *testing.T) {
+	defaultMode := os.FileMode(0700)
+
+	if got := parseResticMode(700, defaultMode); got != 0700 {
+		t.Fatalf("expected 700 to parse as 0700, got %#o", got)
+	}
+	if got := parseResticMode(600, defaultMode); got != 0600 {
+		t.Fatalf("expected 600 to parse as 0600, got %#o", got)
+	}
+	if got := parseResticMode(755, defaultMode); got != 0755 {
+		t.Fatalf("expected 755 to parse as 0755, got %#o", got)
+	}
+	if got := parseResticMode(400, defaultMode); got != defaultMode {
+		t.Fatalf("expected 400 to fallback to default, got %#o", got)
+	}
+	if got := parseResticMode(888, defaultMode); got != defaultMode {
+		t.Fatalf("expected 888 to fallback to default, got %#o", got)
+	}
+}
+
+func TestValidateResticPermissions(t *testing.T) {
+	conf := &Config{}
+
+	conf.BackupResticDirMode = 700
+	conf.BackupResticFileMode = 600
+	if err := conf.ValidateResticPermissions(); err != nil {
+		t.Fatalf("expected valid permissions, got error: %v", err)
+	}
+
+	conf.BackupResticDirMode = 400
+	conf.BackupResticFileMode = 600
+	if err := conf.ValidateResticPermissions(); err == nil {
+		t.Fatalf("expected error for invalid dir mode 400")
+	}
+
+	conf.BackupResticDirMode = 700
+	conf.BackupResticFileMode = 888
+	if err := conf.ValidateResticPermissions(); err == nil {
+		t.Fatalf("expected error for invalid file mode 888")
+	}
+
+	conf.BackupResticDirMode = 0
+	conf.BackupResticFileMode = 0
+	if err := conf.ValidateResticPermissions(); err != nil {
+		t.Fatalf("expected zero values to be valid, got error: %v", err)
+	}
+}

doc/implementation/config/RESTIC_PERMISSION_VALIDATION.md

@@ -0,0 +1,49 @@
+# Restic Permission Validation
+
+## Summary
+
+Restic permission modes accept only octal digit values in the 6xx or 7xx range
+(e.g., 600, 700, 750, 755). This keeps configuration consistent with OpenSVC's
+permission inputs (string values like "700"/"600").
+
+## Entry Points
+
+- config/config.go
+  - parseResticMode() converts octal digit values to os.FileMode.
+  - ValidateResticPermissions() enforces allowed ranges and returns
+    configuration validation errors.
+- server/api_cluster.go
+  - API updates for backup-restic-dir-mode and backup-restic-file-mode
+    validate inputs and return errors if invalid.
+- cluster/cluster_bck.go
+  - StartResticManager() calls ValidateResticPermissions() and logs a warning
+    on invalid inputs.
+
+## Rules
+
+- Valid values: 600-777 (octal digits only)
+- Zero value: 0 means "use defaults" (0700 for dirs, 0600 for files)
+- Invalid values (examples): 400, 888, -1, 0o700 (parsed to 448 and rejected)
+
+## Behavior
+
+- API updates with invalid values return errors and do not apply changes.
+- Invalid values from config files are rejected by validation; defaults are
+  used when values are zero or invalid.
+
+## Rationale
+
+- Aligns with OpenSVC permission formatting (string octal digits).
+- Avoids ambiguous interpretation of decimal values.
+- Ensures stronger defaults for security (owner-only permissions).
+
+## Examples
+
+Valid:
+- backup-restic-dir-mode = 700
+- backup-restic-file-mode = 600
+
+Invalid:
+- backup-restic-dir-mode = 400
+- backup-restic-file-mode = 888
+

etc/config.toml

@@ -177,6 +177,9 @@ include = "/etc/replication-manager/cluster.d"
 # backup-mydumper-path = "/usr/bin/mydumper"
 # backup-myloader-path = "/usr/bin/myloader"
 # backup-restic-binary-path = "/usr/bin/restic"
+# backup-restic-timeout = 7200
+# backup-restic-dir-mode = 700
+# backup-restic-file-mode = 600
 # haproxy-binary-path =  "/usr/sbin/haproxy"
 # maxscale-binary-path =  "/usr/sbin/maxscale"
 

etc/local/features/backup-s3/config.toml

@@ -64,6 +64,9 @@ backup-restic-aws =  true
 backup-restic-aws-access-secret = "xxxx"
 backup-restic-password = "xxxx"
 backup-restic-binary-path = "/usr/local/bin/restic"
+backup-restic-timeout = 7200
+backup-restic-dir-mode = 700
+backup-restic-file-mode = 600
 
 monitoring-scheduler = true
 scheduler-db-servers-logical-backup  = true

etc/local/features/backup/config.toml

@@ -71,6 +71,9 @@ backup-physical-type = "mariabackup"
 backup-restic-aws-access-secret = "xxxx"
 backup-restic-password = "xxxx"
 backup-restic-binary-path = "/usr/local/bin/restic"
+backup-restic-timeout = 7200
+backup-restic-dir-mode = 700
+backup-restic-file-mode = 600
 
 monitoring-scheduler = true
 scheduler-db-servers-logical-backup  = true

server/api_cluster.go

@@ -2803,6 +2803,43 @@ func (repman *ReplicationManager) setClusterSetting(mycluster *cluster.Cluster,
 	case "backup-restic-purge-oldest-on-disk-threshold":
 		val, _ := strconv.Atoi(value)
 		mycluster.Conf.BackupResticPurgeOldestOnDiskThreshold = val
+	case "backup-restic-timeout":
+		val, err := strconv.Atoi(value)
+		if err != nil {
+			return fmt.Errorf("invalid value for backup-restic-timeout: %q", value)
+		}
+		mycluster.Conf.BackupResticTimeout = val
+		if mycluster.ResticManager != nil {
+			mycluster.ResticManager.SetOperationTimeout(mycluster.Conf.GetResticTimeout())
+		}
+	case "backup-restic-dir-mode":
+		val, err := strconv.Atoi(value)
+		if err != nil {
+			return fmt.Errorf("invalid value for backup-restic-dir-mode: %q", value)
+		}
+		oldValue := mycluster.Conf.BackupResticDirMode
+		mycluster.Conf.BackupResticDirMode = val
+		if err := mycluster.Conf.ValidateResticPermissions(); err != nil {
+			mycluster.Conf.BackupResticDirMode = oldValue
+			return err
+		}
+		if mycluster.ResticManager != nil {
+			mycluster.ResticManager.SetPermissions(mycluster.Conf.GetResticDirMode(), mycluster.Conf.GetResticFileMode())
+		}
+	case "backup-restic-file-mode":
+		val, err := strconv.Atoi(value)
+		if err != nil {
+			return fmt.Errorf("invalid value for backup-restic-file-mode: %q", value)
+		}
+		oldValue := mycluster.Conf.BackupResticFileMode
+		mycluster.Conf.BackupResticFileMode = val
+		if err := mycluster.Conf.ValidateResticPermissions(); err != nil {
+			mycluster.Conf.BackupResticFileMode = oldValue
+			return err
+		}
+		if mycluster.ResticManager != nil {
+			mycluster.ResticManager.SetPermissions(mycluster.Conf.GetResticDirMode(), mycluster.Conf.GetResticFileMode())
+		}
 	case "backup-logical-type":
 		mycluster.SetBackupLogicalType(value)
 	case "backup-physical-type":

server/server.go

@@ -796,6 +796,9 @@ func (repman *ReplicationManager) AddFlags(flags *pflag.FlagSet, conf *config.Co
 	flags.StringVar(&conf.BackupResticRepository, "backup-restic-repository", "s3:https://s3.signal18.io/backups", "Restic backend repository")
 	flags.StringVar(&conf.BackupResticPassword, "backup-restic-password", "secret", "Restic backend password")
 	flags.BoolVar(&conf.BackupResticAws, "backup-restic-aws", false, "Restic will archive to s3 or to datadir/backups/archive")
+	flags.IntVar(&conf.BackupResticTimeout, "backup-restic-timeout", 7200, "Restic operation timeout in seconds")
+	flags.IntVar(&conf.BackupResticDirMode, "backup-restic-dir-mode", 700, "Restic directory permissions (octal, e.g. 700)")
+	flags.IntVar(&conf.BackupResticFileMode, "backup-restic-file-mode", 600, "Restic file permissions (octal, e.g. 600)")
 	flags.BoolVar(&conf.BackupResticPurgeOldestOnDiskSpace, "backup-restic-purge-oldest-on-disk-space", true, "Restic will purge oldest backup when disk space is critically low")
 	flags.IntVar(&conf.BackupResticPurgeOldestOnDiskThreshold, "backup-restic-purge-oldest-on-disk-threshold", 0, "Restic will purge oldest backup when disk space used is above this percentage. 0 means use backup-disk-threshold-crit value")
 	flags.BoolVar(&conf.BackupStreaming, "backup-streaming", false, "Backup streaming to cloud ")