You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-41Lines changed: 2 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
# About the Zelta Replication Suite
4
4
5
+
[Zelta Wiki](https://zelta.space)
6
+
5
7
**Zelta** is a suite of tools offering a streamlined approach to managing ZFS replication across systems. It's built with the intention of simplifying complex ZFS functions into safe and user-friendly commands while also being the foundation for large-scale backup and failover environments. It's easy and accessible while working with most UNIX and UNIX-like base systems without additional packages. It's optimized for environments with strict permission separation and integrates well into many types of existing ZFS workflows.
6
8
7
9
Zelta can be used to safely perform workstation backups with a single command, but it was designed for large environments with significant regulatory compliance concerns. Zelta is currently being used in production to replicate millions of snapshots across hundreds of systems automatically and in tandem with alerting and analytics systems.
@@ -23,55 +25,14 @@ By "safe", we mean:
23
25
- Zelta creates read-only replicas by default and resets ("inherits") mountpoints below the parent dataset to avoid dangerous overlapping mounts.
24
26
- Zelta never suggests or requires using forced deletion overwrite option, but instead provides a **--rotate** feature that performs a cloning operation to preserve divergent datasets, e.g., after a rollback or cloned sorce event.
25
27
26
-
<<<<<<< HEAD
27
28
Zelta is designed with the Unix philosophy in mind. It is modular, extensible, and almost anything (including our safe defaults) can be changed with a tiny bit of elbow grease. Since Zelta commands and switches are designed with similar flags and phrases as the upstream ZFS tools, it's an excellent teaching tool for new ZFS administrators.
28
-
=======
29
-
Zelta is designed with Unix philosophy in mind. It is modular, extensible, and almost anything (including our safe defaults) can be changed with a tiny bit of elbow grease. Since Zelta commands and switches are designed with the similar flags and phrases as the upstream ZFS tools, it's an excellent teaching tool for new ZFS administrators.
30
-
31
-
32
-
## Quick-Start
33
-
To install, go to the top of the cloned repo and run: `./install.sh`
34
-
Given `pool1` and `pool2` on a local system, you can back up one to the other with: `zelta backup pool1 pool2/pool1-backup`
35
-
36
-
37
-
## Detailed Instructions
38
-
You do **not** need to be root to perform ZFS replication, but additional setups steps are required to create users and set up `zfs allow`. Additionally, working with remote systems requires setting up your infrastructure for efficient use of `ssh`. Documentation and examples can be found on our [wiki](https://github.com/bellhyve/zelta/wiki/Home-&-FAQ). We are actively adding use case examples and updating the manpage drafts to reflect Zelta's active feature development.
39
-
40
-
Point-of-use documentation is also provided in the installed examples:
41
-
-[zelta.conf](https://github.com/bellhyve/zelta/blob/main/zelta.conf) for policy-based backups
42
-
-[zelta.env](https://github.com/bellhyve/zelta/blob/main/zelta.env) for location and behavior overrides
43
-
-`zelta help` (From the command line.)
44
-
>>>>>>> 9d7bb241cf95fe9fae05865a4e005327fd8897b2
45
29
46
30
47
31
## Early-Release Software Notice, and a Commitment to Safety and Community Collaboration
48
32
49
33
Although Zelta is a relatively recent addition to the open source world, it has been rigorously used in production for over five years. It has successfully managed the replication of millions of datasets, with a primary emphasis on safety. We're currently refining features and enhancing documentation.
50
34
51
35
We invite individuals of all technical backgrounds who want to protect both personal and organizational mission-critical data to collaborate with us. Your input is crucial in making Zelta, and ZFS at large, more accessible and user-friendly. By engaging with us, you'll not only contribute to the development of Zelta but also gain the opportunity to receive direct support and insights from our team at [Bell Tower](https://belltower.it/).
52
-
<<<<<<< HEAD
53
-
=======
54
-
55
-
56
-
## Goals and Methodology
57
-
58
-
ZFS's versatility is unparalleled in the open source world, but users of all experience levels wrestle with its complex command structures with non-intuitive and often destructive defaults. Zelta addresses this by providing streamlined commands and safer defaults for common backup and migration tasks.
59
-
60
-
The act of simply backing up a boot drive with the basic ZFS commands (`zfs send -R zroot@latest | zfs receive backup/zroot`) is difficult to construct and will likely result in errors, overlapping mounts, and sometimes lost data. Zelta simplifies this process to:
61
-
-`zelta backup zroot backup/zroot`: Backs up the latest `zroot` snapshots to `backup/zroot`
62
-
-`zelta match zroot backup/zroot`: Confirms that the latest snapshots on the backup are identical.
63
-
64
-
Zelta is both safer and easier to use, and simplifies complex backup and migration tasks for experts. We find it to be ideal for both routine maintenance and complex tasks like fleet backup management and asynchronous clustering. Zelta **never** destroys target data, but provides tools to help delicately untangle mismatched replicas.
65
-
66
-
Zelta works with any snapshot management system or system scheduler. It's currently used to back up thousands of datasets in conjunction with [zfsnap](https://github.com/zfsnap/zfsnap), however, basic snapshot and pruning features are being added to Zelta that will be sufficient for many users. See the `zelta.env` example to change Zelta's naming schemes.
67
-
68
-
## Installation Notes
69
-
70
-
- The scripts were written on FreeBSD's built-in (Kernighan) awk.
71
-
- All updates to the main branch are additionally tested on Illumos, MacOS, and Debian GNU/Linux with the packages nawk, mawk, and gawk.
72
-
- PLEASE open an issue if Zelta is not working as expected on your system; see the FAQ for know problems and workarounds.
73
-
- Make sure ssh auth and "zfs allow" is correctly configured for all involved systems.
0 commit comments