Zelta Backup and Recovery Suite¶

Documentation Index¶

Zelta provides safe ZFS backup and recovery operations that remain straightforward to deploy and operate.

Zelta orchestrates backup operations across modern Unix systems. It has zero package dependencies and can run from an orchestrator without being installed on the ZFS endpoints.

Zelta requires ZFS. If ZFS isn't yet part of your workflow, see Getting Started with ZFS to begin.

Getting Started¶

Learn about Zelta and get your first backups running.

• About Zelta: Project overview and design philosophy.
• Definitions & Features: Endpoints, dataset trees, and backup operations.
• First Backup: Create a backup with zelta backup and verify it with zelta match.
• Installation & Configuration: Deploy, configure, and customize Zelta for your server or fleet.
• FAQ: Answers to common questions.

Core Tools¶

All Zelta commands operate recursively on dataset trees and work locally or remotely via SSH.

See the complete Manual Pages index for command references.

• Manual: zelta: Overview of the Zelta suite and common options.
• Manual: zelta backup: Backup with safe defaults, incremental detection, and optional pre-backup snapshots.
• Manual: zelta match: Compare dataset trees and report matching snapshots or discrepancies.
• Manual: zelta policy: Automate concurrent backup operations using policy-based configuration.
• Manual: zelta clone: Create temporary read-write clones for testing, recovery, or inspection.
• Manual: zelta revert: Rewind a dataset in place by renaming and cloning, preserving current state.
• Manual: zelta rotate: Keep backups rolling after divergence by preserving all versions.
• Manual: zelta snapshot: Create recursive snapshots on local or remote endpoints.
• Manual: zelta prune: Plan snapshot pruning without destroying data.
• Manual: zprune: Validate and destroy snapshots selected by zelta prune.
• Manual: zelta failover: Promote a backup target through a guarded failover workflow.
• Manual: zelta rebase: Rebase a dataset onto an upgraded upstream while preserving local files and backup continuity.
• Guide: Zelta Twin: Compose asynchronous cluster pairs from reciprocal backup policy and guarded failover commands.

Guides¶

See the complete Guides index.

• Simple Backups: Create and verify direct backups.
• Policy-Based Automatic Backups: Run multiple backup jobs from configuration.
• Zelta Twin: Asynchronous cluster pairs and guarded failover.
• Failover Workflows: Backup, lock/unlock, propsync, and failover.
• Rollback & Recovery: Snapshots, clones, revert, and rotate.
• Retention Strategies: Plan snapshot retention and safe destruction.
• JSON Output: Machine-readable output for monitoring.

Configuration Examples¶

See the complete Configuration index.

• Environment & Policy Files: Which file to edit, syntax, and precedence.
• Configuration: ssh: SSH best practices for efficient ZFS backup.
• Configuration: zfs allow: Set up ZFS permissions with minimal access.
• Configuration: zelta.conf: Policy configuration for complex backups.
• Configuration: zelta.env: Override default behavior, snapshot names, and zfs options.
• Configuration: zfs: Getting started with ZFS for new users.

Next Page: About¶