Documentation
¶
Overview ¶
Package backup runs filesystem backups from the agent into Proxmox Backup Server with gopbs, over a session the FallBCK server opened on the agent's behalf.
Index ¶
Constants ¶
View Source
const DefaultArchiveName = "root"
DefaultArchiveName is used for jobs with more than one backup path
Variables ¶
This section is empty.
Functions ¶
func ArchiveEntryNames ¶ added in v0.6.0
ArchiveEntryNames decides how each backup path is named at the top of the archive when a job has several roots. Paths keep their basename (`/etc` → `etc`); when two paths share a basename, both are named after their full path with `/` replaced by `-` (`/etc/mydir` → `etc-mydir`, `/var/lib/mydir` → `var-lib-mydir`).
Types ¶
type DirectOptions ¶ added in v0.6.0
type DirectOptions struct {
Endpoint string
Fingerprint string
TLSVerify bool
// APIToken in canonical user@realm!tokenid:secret form
APIToken string
}
DirectOptions connects the agent straight to PBS (job setting direct_pbs)
type Options ¶ added in v0.6.0
type Options struct {
// Session carries the snapshot identity, format and paths from the server
Session *temporal.BackupSessionInfo
// Dial returns a connection on which the PBS backup session is already open
// (proxy.Dial through the FallBCK server). Ignored when Direct is set.
Dial func(ctx context.Context, ref pbs.SnapshotRef) (net.Conn, error)
// Direct, when set, makes gopbs connect to PBS itself with these credentials
Direct *DirectOptions
// Workers is the number of concurrent chunk uploads (0 = gopbs default)
Workers int
// ArchiveName names the pxar archive inside the snapshot (default: gopbs default)
ArchiveName string
// Blobs are small extra files stored in the snapshot as <name>.blob (manifests)
Blobs []gopbs.Blob
// OnProgress receives upload progress per archive
OnProgress func(archive string, stats pbs.UploadStats, done bool)
}
Options for one backup run
Click to show internal directories.
Click to hide internal directories.