Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Keep recovery backups and legacy settings inside the import transaction

pulse-triage[bot]a16f19c370e3
diff --git a/internal/api/configapi/config_import_metadata_test.go b/internal/api/configapi/config_import_metadata_test.go
index 6201f7047a..c72130ab32 100644
--- a/internal/api/configapi/config_import_metadata_test.go
+++ b/internal/api/configapi/config_import_metadata_test.go
@@ -28,6 +28,9 @@ func TestHandleImportConfigMetadataFailureDoesNotApplyOrSucceed(t *testing.T) {
if err := p.SaveAPITokens([]config.APITokenRecord{{ID: "keep-token", Hash: "synthetic-token-hash", OrgID: "default"}}); err != nil {
t.Fatal(err)
}
+ if err := os.WriteFile(filepath.Join(cfg.DataPath, ".env"), []byte("AUTO_UPDATE_ENABLED=true\nPOLLING_INTERVAL=77\n"), 0600); err != nil {
+ t.Fatal(err)
+ }
store := p.GetGuestMetadataStore()
if err := store.Set("keep:101", &config.GuestMetadata{Description: "Retained operator metadata"}); err != nil {
t.Fatal(err)
diff --git a/internal/config/export.go b/internal/config/export.go
index 23c453f22d..cd90fd08c5 100644
--- a/internal/config/export.go
+++ b/internal/config/export.go
@@ -262,6 +262,9 @@ func (c *ConfigPersistence) ImportConfig(encryptedData string, passphrase string
return fmt.Errorf("failed to commit import transaction: %w", err)
}
committed = true
+ c.mu.Lock()
+ c.cleanupOldBackups(c.nodesFile + ".backup-*")
+ c.mu.Unlock()
return nil
}
diff --git a/internal/config/export_metadata_transaction_test.go b/internal/config/export_metadata_transaction_test.go
index 106e1fb6ac..d917749ddd 100644
--- a/internal/config/export_metadata_transaction_test.go
+++ b/internal/config/export_metadata_transaction_test.go
@@ -2,6 +2,7 @@ package config
import (
"encoding/json"
+ "fmt"
"os"
"path/filepath"
"reflect"
@@ -32,6 +33,7 @@ func TestImportConfigMetadataFailurePreservesState(t *testing.T) {
for _, failure := range []string{"metadata_directory", "closed_store", "later_destination", "later_destination_without_metadata_file"} {
t.Run(failure, func(t *testing.T) {
cp := seedImportValidationState(t)
+ seedMetadataImportRecoveryArtifacts(t, cp)
store := cp.GetGuestMetadataStore()
metadataBefore := store.GetAll()
metadataFile := filepath.Join(cp.configDir, "guest_metadata.json")
@@ -83,6 +85,15 @@ func TestImportConfigCommitsMetadataWithConfiguration(t *testing.T) {
for _, inventory := range []string{"nil", "empty", "populated"} {
t.Run(inventory, func(t *testing.T) {
cp := seedImportValidationState(t)
+ seedMetadataImportRecoveryArtifacts(t, cp)
+ nodesBefore, err := os.ReadFile(cp.nodesFile)
+ if err != nil {
+ t.Fatal(err)
+ }
+ tokensBefore, err := os.ReadFile(cp.apiTokensFile)
+ if err != nil {
+ t.Fatal(err)
+ }
var metadata map[string]*GuestMetadata
expected := map[string]*GuestMetadata{}
if inventory == "empty" {
@@ -98,6 +109,19 @@ func TestImportConfigCommitsMetadataWithConfiguration(t *testing.T) {
if err := cp.ImportConfig(metadataImportArchive(t, metadata), "synthetic-import-validation-passphrase"); err != nil {
t.Fatal(err)
}
+ for path, want := range map[string][]byte{cp.nodesFile + ".backup": nodesBefore, cp.apiTokensFile + ".backup": tokensBefore} {
+ if got, err := os.ReadFile(path); err != nil || string(got) != string(want) {
+ t.Error("successful import did not retain its previous configuration backup")
+ }
+ }
+ backups, err := filepath.Glob(cp.nodesFile + ".backup-*")
+ if err != nil || len(backups) != 10 {
+ t.Fatal("successful import did not apply the existing ten-backup retention")
+ }
+ env, err := os.ReadFile(filepath.Join(cp.configDir, ".env"))
+ if err != nil || strings.Contains(string(env), "POLLING_INTERVAL=") || !strings.Contains(string(env), "AUTO_UPDATE_ENABLED=false") || !strings.Contains(string(env), "KEEP_SETTING=retained") {
+ t.Fatal("successful import did not commit the existing legacy settings-file update")
+ }
if !reflect.DeepEqual(cp.GetGuestMetadataStore().GetAll(), expected) {
t.Error("successful import did not publish normalized metadata")
}
@@ -128,3 +152,27 @@ func TestImportConfigCommitsMetadataWithConfiguration(t *testing.T) {
})
}
}
+
+func seedMetadataImportRecoveryArtifacts(t *testing.T, cp *ConfigPersistence) {
+ t.Helper()
+ for path, data := range map[string]string{
+ filepath.Join(cp.configDir, ".env"): "UPDATE_CHANNEL=stable\nAUTO_UPDATE_ENABLED=true\nPOLLING_INTERVAL=77\nKEEP_SETTING=retained\n",
+ cp.nodesFile + ".backup": "prior node backup",
+ cp.apiTokensFile + ".backup": "prior token backup",
+ } {
+ if err := os.WriteFile(path, []byte(data), 0600); err != nil {
+ t.Fatal(err)
+ }
+ }
+ // More than the normal retention bound makes premature pruning visible.
+ for i := 0; i < 11; i++ {
+ path := fmt.Sprintf("%s.backup-20260101-%06d", cp.nodesFile, i)
+ if err := os.WriteFile(path, []byte(fmt.Sprintf("retained backup %d", i)), 0600); err != nil {
+ t.Fatal(err)
+ }
+ stamp := time.Date(2000, 1, 1, 0, i, 0, 0, time.UTC)
+ if err := os.Chtimes(path, stamp, stamp); err != nil {
+ t.Fatal(err)
+ }
+ }
+}
diff --git a/internal/config/persistence.go b/internal/config/persistence.go
index 354698ae54..0963246f98 100644
--- a/internal/config/persistence.go
+++ b/internal/config/persistence.go
@@ -473,6 +473,16 @@ func (c *ConfigPersistence) writeConfigFileLocked(path string, data []byte, perm
return nil
}
+// writeConfigBackupLocked preserves ordinary backup writes, but makes them
+// part of an active import instead of changing recovery files before commit.
+// Caller must hold c.mu.
+func (c *ConfigPersistence) writeConfigBackupLocked(path string, data []byte, perm os.FileMode) error {
+ if c.tx != nil {
+ return c.tx.StageFile(path, data, perm)
+ }
+ return c.fs.WriteFile(path, data, perm)
+}
+
// preserveCorruptConfigFileLocked moves a config file that failed to parse or
// decrypt aside to <path>.corrupt-<timestamp>. Loaders return empty data with
// a nil error for such files, so read-modify-write savers would otherwise
@@ -782,7 +792,7 @@ func (c *ConfigPersistence) persistAPITokensLocked(tokens []APITokenRecord) erro
// Backup previous state (best effort).
if existing, err := c.fs.ReadFile(c.apiTokensFile); err == nil && len(existing) > 0 {
- if err := c.fs.WriteFile(c.apiTokensFile+".backup", existing, 0600); err != nil {
+ if err := c.writeConfigBackupLocked(c.apiTokensFile+".backup", existing, 0600); err != nil {
log.Warn().Err(err).Msg("Failed to create API token backup file")
}
}
@@ -1634,7 +1644,7 @@ func (c *ConfigPersistence) saveNodesConfig(pveInstances []PVEInstance, pbsInsta
// Create timestamped backup
timestampedBackup := fmt.Sprintf("%s.backup-%s", c.nodesFile, time.Now().Format("20060102-150405"))
if backupData, err := c.fs.ReadFile(c.nodesFile); err == nil {
- if err := c.fs.WriteFile(timestampedBackup, backupData, 0600); err != nil {
+ if err := c.writeConfigBackupLocked(timestampedBackup, backupData, 0600); err != nil {
log.Warn().Err(err).Msg("Failed to create timestamped backup of nodes config")
} else {
log.Info().Str("backup", timestampedBackup).Msg("Created timestamped backup of nodes config")
@@ -1644,13 +1654,16 @@ func (c *ConfigPersistence) saveNodesConfig(pveInstances []PVEInstance, pbsInsta
// Also maintain a "latest" backup for quick recovery
latestBackup := c.nodesFile + ".backup"
if backupData, err := c.fs.ReadFile(c.nodesFile); err == nil {
- if err := c.fs.WriteFile(latestBackup, backupData, 0600); err != nil {
+ if err := c.writeConfigBackupLocked(latestBackup, backupData, 0600); err != nil {
log.Warn().Err(err).Msg("Failed to create latest backup of nodes config")
}
}
- // Clean up old timestamped backups (keep last 10)
- c.cleanupOldBackups(c.nodesFile + ".backup-*")
+ // Imports prune only after the entire archive commits. A failed
+ // recovery must not delete an older, still usable backup.
+ if c.tx == nil {
+ c.cleanupOldBackups(c.nodesFile + ".backup-*")
+ }
}
// Encrypt if crypto manager is available
@@ -2037,6 +2050,9 @@ func (c *ConfigPersistence) saveSystemSettingsLocked(settings SystemSettings) er
// Also update the .env file if it exists
envFile := filepath.Join(c.configDir, ".env")
if err := c.updateEnvFile(envFile, settings); err != nil {
+ if c.tx != nil {
+ return fmt.Errorf("stage imported environment settings: %w", err)
+ }
log.Warn().Err(err).Msg("Failed to update .env file")
// Don't fail the operation if .env update fails
}
@@ -3877,6 +3893,9 @@ func (c *ConfigPersistence) updateEnvFile(envFile string, settings SystemSetting
perm = 0600
}
}
+ if c.tx != nil {
+ return c.writeConfigFileLocked(envFile, []byte(content), perm)
+ }
if err := c.fs.WriteFile(tempFile, []byte(content), perm); err != nil {
return fmt.Errorf("write temp env file %s: %w", tempFile, err)
}