4ed938cce4
The recovery unit on the customer's drive now carries the PORTABLE secret class, so Tier-1/Tier-2 restore no longer depends on the whole-guest tier. A customer needs the drive and nothing else. Part 0's rulings overturned the brief's recommendation, on evidence: - the data_key flag is untrustworthy (4+ encryption keys the catalog itself labels as such are unflagged) -> R-127 - a DB password is not resettable in practice: POSTGRES_PASSWORD is ignored once PGDATA is non-empty, so a regenerated value leaves the app unable to authenticate against its own restored rows while the dump replay still reports success (proven on a throwaway postgres:16-alpine) Ruling (operator): type:secret travels, type:password never does, minus the nonPortableSecrets code register. Plaintext -- withholding the internet- reachable class is what licenses that, and the two are coupled. Precedence: the UNIT WINS over the guest -- the unit's secrets were captured in the same run as the dumps beside them, so they match the data being restored. The fail-closed data-key gate is unchanged. Secret values are never logged; the manifest records NAMES only.
296 lines
10 KiB
Go
296 lines
10 KiB
Go
package appbackup
|
|
|
|
import (
|
|
"bufio"
|
|
"context"
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
|
|
"gopkg.in/yaml.v3"
|
|
)
|
|
|
|
// StackDataProvider provides stack data to the backup packages without circular imports.
|
|
type StackDataProvider interface {
|
|
GetStackComposePath(name string) (composePath string, ok bool)
|
|
ListDeployedStacks() []StackSummary
|
|
GetStackHDDMounts(name string) []string
|
|
GetStackHDDPath(name string) string // raw HDD_PATH from app.yaml (empty if no HDD)
|
|
// GetImportRoot returns the CANONICAL drop-zone root (R-75): <system namespace root>/userdata/import.
|
|
// It is app-INDEPENDENT and lives on the SYSTEM drive, so ${IMPORT_PATH} binds cannot be resolved
|
|
// from GetStackHDDPath. Empty when unresolvable — structuralGuard refuses such binds loudly.
|
|
GetImportRoot() string
|
|
GetDockerVolumes(name string) []string // full Docker volume names (project-prefixed)
|
|
StopStack(name string) error
|
|
StartStack(name string) error
|
|
RefreshAndIsRunning(name string) bool
|
|
// GetStackRecoveryInfo returns the data needed to capture a recovery unit: the stack dir,
|
|
// pinned image tags, the non-secret env, the NAMES of the secret/data-key env vars, and (D5)
|
|
// the decrypted VALUES of the portable class. A WITHHELD secret's value is never returned —
|
|
// it is recovered at restore time from the guest's app.yaml, or regenerated. ok=false if the
|
|
// stack is unknown.
|
|
GetStackRecoveryInfo(name string) (RecoveryInfo, bool)
|
|
|
|
// --- Phase 2b: restore-from-recovery-unit ---
|
|
|
|
// RecoverStackSecrets returns the live decrypted values for the named secret env vars that are
|
|
// currently present (non-empty) in the stack's app.yaml (the guest's own — live rootfs, or
|
|
// PBS-restored). Names that are absent/empty are simply omitted from the map; the caller's
|
|
// fail-closed gate decides what to do. The unit is never the source of secrets.
|
|
RecoverStackSecrets(name string, names []string) map[string]string
|
|
|
|
// RecreateStackDefinitionFromUnit restores an app's DEFINITION from the unit's compose dir into
|
|
// the stack dir and writes app.yaml from fullEnv (encrypting secret fields). Secrets are NEVER
|
|
// regenerated. It starts NOTHING: the caller owns the bring-up order, because a DB-bearing app
|
|
// must have its database service started alone for the dump replay (R-47). It was
|
|
// `RecreateStackFromUnit` until v0.153.0 and ended in a full `docker compose up -d` — that full
|
|
// start before the replay IS the H4 race.
|
|
RecreateStackDefinitionFromUnit(name, composeSrcDir string, fullEnv map[string]string) error
|
|
|
|
// StartStackServices brings up ONLY the named compose services, leaving the rest of the stack
|
|
// down — the DB-only window in which a dump is replayed without the application racing it.
|
|
// Implementations must REFUSE an empty list (an argument-less `up -d` is a full start).
|
|
StartStackServices(name string, services []string) error
|
|
|
|
// GetStackClassifiedBinds returns the app's backup-classified compose binds + whether it carries a
|
|
// (valid) backup block (Task 2, referential coupling). INERT — no tier consumes it yet; wired now
|
|
// so Task 3 gets a tested seam. Implemented by delegating to stacks.Manager.ClassifiedBinds.
|
|
GetStackClassifiedBinds(name string) ([]ClassifiedBind, bool)
|
|
}
|
|
|
|
// RecoveryInfo carries everything needed to write a recovery unit for a stack.
|
|
//
|
|
// D5: it now carries the VALUES of the PORTABLE secret class (stacks.PortableSecretEnvVars — every
|
|
// `type: secret` field bar the nonPortableSecrets register), because a Tier-1/2 restore that depends
|
|
// on the guest for a data-encrypting key or a DB password is not independent of the guest at all: the
|
|
// data sits safely on the drive and cannot be read back. The EXCLUDED class (`type: password` admin
|
|
// logins) is still name-only and never leaves the guest.
|
|
type RecoveryInfo struct {
|
|
StackDir string // dir holding docker-compose.yml + .felhom.yml + app.yaml
|
|
DisplayName string // app display name
|
|
ImagePins []string // pinned image tags from compose `image:` lines (re-pulled on restore)
|
|
NonSecretEnv map[string]string // env with ALL secret/password values removed (plaintext only)
|
|
SecretEnvVars []string // NAMES of every secret/password field
|
|
DataKeyEnvVars []string // NAMES of data-encrypting-key fields (fail-closed gate on restore)
|
|
// PortableSecretEnvVars are the NAMES of the secrets that travel in the unit (D5), and
|
|
// PortableSecrets their DECRYPTED values. A name present here but absent from PortableSecrets was
|
|
// unset/empty in the guest's app.yaml — the restore's fail-closed gate decides what that means.
|
|
// Never logged, never in the manifest's value space: the values reach disk only inside the unit's
|
|
// 0600 app.yaml.
|
|
PortableSecretEnvVars []string
|
|
PortableSecrets map[string]string
|
|
}
|
|
|
|
// ParseComposeImages extracts the pinned image references (`image: repo:tag`) from a
|
|
// docker-compose.yml, in file order, de-duplicated. The image bytes are never stored in the
|
|
// recovery unit — only these pins, so restore re-pulls from the registry.
|
|
func ParseComposeImages(composePath string) []string {
|
|
data, err := os.ReadFile(composePath)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
var images []string
|
|
seen := make(map[string]bool)
|
|
scanner := bufio.NewScanner(strings.NewReader(string(data)))
|
|
for scanner.Scan() {
|
|
line := strings.TrimSpace(scanner.Text())
|
|
if !strings.HasPrefix(line, "image:") {
|
|
continue
|
|
}
|
|
img := strings.TrimSpace(strings.TrimPrefix(line, "image:"))
|
|
img = strings.Trim(img, "\"'")
|
|
// Skip variable-only images we can't pin (e.g. image: ${SOME_IMAGE})
|
|
if img == "" || strings.HasPrefix(img, "${") {
|
|
continue
|
|
}
|
|
if !seen[img] {
|
|
seen[img] = true
|
|
images = append(images, img)
|
|
}
|
|
}
|
|
return images
|
|
}
|
|
|
|
// StackSummary holds minimal stack info needed for app data discovery.
|
|
type StackSummary struct {
|
|
Name string
|
|
DisplayName string
|
|
ComposePath string
|
|
NeedsHDD bool
|
|
HasVolumes bool
|
|
}
|
|
|
|
// AppBackupInfo holds backup-relevant data paths for a deployed app.
|
|
type AppBackupInfo struct {
|
|
StackName string
|
|
DisplayName string
|
|
NeedsHDD bool
|
|
HDDPaths []AppDataPath
|
|
HDDTotalSize int64
|
|
HDDSizeHuman string
|
|
DockerVolumes []AppDockerVolume
|
|
BackupEnabled bool
|
|
HasHDDData bool
|
|
HasDBDump bool
|
|
HasVolumeData bool
|
|
StorageLabel string // resolved from registered storage paths
|
|
}
|
|
|
|
// AppDataPath represents a single HDD bind mount path.
|
|
type AppDataPath struct {
|
|
HostPath string
|
|
Exists bool
|
|
SizeHuman string
|
|
SizeBytes int64
|
|
}
|
|
|
|
// AppDockerVolume represents a named Docker volume.
|
|
type AppDockerVolume struct {
|
|
Name string
|
|
Contains string
|
|
}
|
|
|
|
// DiscoverAppData discovers backup-relevant data for all deployed apps.
|
|
// All apps with HDD data are backed up automatically (mandatory — no opt-in).
|
|
func DiscoverAppData(provider StackDataProvider, discoveredDBs []DiscoveredDB) []AppBackupInfo {
|
|
if provider == nil {
|
|
return nil
|
|
}
|
|
|
|
var result []AppBackupInfo
|
|
|
|
for _, stack := range provider.ListDeployedStacks() {
|
|
info := AppBackupInfo{
|
|
StackName: stack.Name,
|
|
DisplayName: stack.DisplayName,
|
|
NeedsHDD: stack.NeedsHDD,
|
|
}
|
|
|
|
// Discover HDD bind mounts via adapter
|
|
hddMounts := provider.GetStackHDDMounts(stack.Name)
|
|
for _, mount := range hddMounts {
|
|
path := AppDataPath{HostPath: mount}
|
|
if fi, err := os.Stat(mount); err == nil && fi.IsDir() {
|
|
path.Exists = true
|
|
path.SizeBytes, path.SizeHuman = appDirSize(mount)
|
|
}
|
|
info.HDDPaths = append(info.HDDPaths, path)
|
|
info.HDDTotalSize += path.SizeBytes
|
|
}
|
|
info.HDDSizeHuman = humanizeBytes(info.HDDTotalSize)
|
|
info.HasHDDData = len(info.HDDPaths) > 0
|
|
|
|
// Discover Docker named volumes from compose
|
|
info.DockerVolumes = ParseComposeNamedVolumes(stack.ComposePath)
|
|
info.HasVolumeData = len(info.DockerVolumes) > 0
|
|
|
|
// Check if app has a DB container (already backed up via DB dump)
|
|
for _, db := range discoveredDBs {
|
|
if db.StackName == stack.Name {
|
|
info.HasDBDump = true
|
|
break
|
|
}
|
|
}
|
|
|
|
// All apps with HDD data are backed up automatically (mandatory)
|
|
info.BackupEnabled = info.HasHDDData
|
|
|
|
result = append(result, info)
|
|
}
|
|
|
|
log.Printf("[INFO] [backup] Discovered app data: %d apps", len(result))
|
|
return result
|
|
}
|
|
|
|
// ParseComposeNamedVolumes extracts named Docker volumes from a docker-compose.yml.
|
|
func ParseComposeNamedVolumes(composePath string) []AppDockerVolume {
|
|
data, err := os.ReadFile(composePath)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
|
|
var compose struct {
|
|
Volumes map[string]interface{} `yaml:"volumes"`
|
|
}
|
|
if err := yaml.Unmarshal(data, &compose); err != nil {
|
|
return nil
|
|
}
|
|
|
|
var volumes []AppDockerVolume
|
|
for name, cfg := range compose.Volumes {
|
|
// Skip external volumes
|
|
if cfgMap, ok := cfg.(map[string]interface{}); ok {
|
|
if ext, ok := cfgMap["external"]; ok && ext == true {
|
|
continue
|
|
}
|
|
}
|
|
volumes = append(volumes, AppDockerVolume{Name: name})
|
|
}
|
|
return volumes
|
|
}
|
|
|
|
// ResolveDockerVolumeNames returns full Docker volume names with the compose project prefix.
|
|
// Docker Compose V2 creates volumes as <project>_<volumeName> where project = directory name.
|
|
func ResolveDockerVolumeNames(composePath string) []string {
|
|
vols := ParseComposeNamedVolumes(composePath)
|
|
if len(vols) == 0 {
|
|
return nil
|
|
}
|
|
project := filepath.Base(filepath.Dir(composePath))
|
|
names := make([]string, 0, len(vols))
|
|
for _, v := range vols {
|
|
names = append(names, project+"_"+v.Name)
|
|
}
|
|
return names
|
|
}
|
|
|
|
// appDirSize returns the total byte count and a human-readable string for a directory.
|
|
// H2/H3: Single du invocation with 30s timeout replaces two separate calls.
|
|
func appDirSize(path string) (int64, string) {
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
defer cancel()
|
|
cmd := exec.CommandContext(ctx, "du", "-sb", path)
|
|
output, err := cmd.Output()
|
|
if err != nil {
|
|
return 0, "?"
|
|
}
|
|
fields := strings.Fields(string(output))
|
|
if len(fields) == 0 {
|
|
return 0, "?"
|
|
}
|
|
var size int64
|
|
if n, _ := fmt.Sscanf(fields[0], "%d", &size); n != 1 {
|
|
return 0, "?"
|
|
}
|
|
return size, humanizeBytes(size)
|
|
}
|
|
|
|
// HumanizeBytes converts bytes to a human-readable string.
|
|
// Exported so the backup package can forward to it (shared helper).
|
|
func HumanizeBytes(b int64) string {
|
|
return humanizeBytes(b)
|
|
}
|
|
|
|
// humanizeBytes converts bytes to a human-readable string.
|
|
func humanizeBytes(b int64) string {
|
|
const (
|
|
KB = 1024
|
|
MB = KB * 1024
|
|
GB = MB * 1024
|
|
)
|
|
switch {
|
|
case b >= GB:
|
|
return fmt.Sprintf("%.1f GB", float64(b)/float64(GB))
|
|
case b >= MB:
|
|
return fmt.Sprintf("%.1f MB", float64(b)/float64(MB))
|
|
case b >= KB:
|
|
return fmt.Sprintf("%.1f KB", float64(b)/float64(KB))
|
|
default:
|
|
return fmt.Sprintf("%d B", b)
|
|
}
|
|
}
|