mirror of https://github.com/jimsalterjrs/sanoid
Removed some things from my patch and added missing args
This commit is contained in:
Shawn Perry
GitHub
parent
5a39629109
commit
959642349b
77
README.md
77
README.md
|
|
@ -1,11 +1,9 @@
|
|||
<p align="center"><img src="http://www.openoid.net/wp-content/themes/openoid/images/sanoid_logo.png" alt="sanoid logo" title="sanoid logo"></p>
|
||||
======
|
||||
|
||||
# Sanoid
|
||||
<img src="http://openoid.net/gplv3-127x51.png" width=127 height=51 align="right">Sanoid is a policy-driven snapshot management tool for ZFS filesystems. When combined with the Linux KVM hypervisor, you can use it to make your systems <a href="http://openoid.net/transcend" target="_blank">functionally immortal</a>.
|
||||
|
||||
# Note that the snapshots it takes are not atomic!
|
||||
|
||||
Sanoid is a policy-driven snapshot management tool for ZFS filesystems. When combined with the Linux KVM hypervisor, you can use it to make your systems <a href="http://openoid.net/transcend" target="_blank">functionally immortal</a>.
|
||||
<p align="center"><a href="https://youtu.be/ZgowLNBsu00" target="_blank"><img src="http://www.openoid.net/sanoid_video_launcher.png" alt="sanoid rollback demo" title="sanoid rollback demo"></a><br clear="all"><sup>(Real time demo: rolling back a full-scale cryptomalware infection in seconds!)</sup></p>
|
||||
|
||||
More prosaically, you can use Sanoid to create, automatically thin, and monitor snapshots and pool health from a single eminently human-readable TOML config file at /etc/sanoid/sanoid.conf. (Sanoid also requires a "defaults" file located at /etc/sanoid/sanoid.defaults.conf, which is not user-editable.) A typical Sanoid system would have a single cron job:
|
||||
```
|
||||
|
|
@ -45,9 +43,13 @@ Which would be enough to tell sanoid to take and keep 36 hourly snapshots, 30 da
|
|||
|
||||
This will process your sanoid.conf file, create snapshots, then purge expired ones.
|
||||
|
||||
+ --configdir
|
||||
|
||||
Specify a location for the config file named sanoid.conf. Defaults to /etc/sanoid
|
||||
|
||||
+ --take-snapshots
|
||||
|
||||
This will process your sanoid.conf file, create snapshots, but it will NOT purge expired ones.
|
||||
This will process your sanoid.conf file, create snapshots, but it will NOT purge expired ones. Note that snapshots are not atomic relative to one another.
|
||||
|
||||
+ --prune-snapshots
|
||||
|
||||
|
|
@ -61,18 +63,22 @@ Which would be enough to tell sanoid to take and keep 36 hourly snapshots, 30 da
|
|||
|
||||
This option is designed to be run by a Nagios monitoring system. It reports on the health of the zpool your filesystems are on. It only monitors filesystems that are configured in the sanoid.conf file.
|
||||
|
||||
+ --force-update
|
||||
|
||||
This clears out sanoid's zfs snapshot listing cache. This is normally not needed.
|
||||
|
||||
+ --version
|
||||
|
||||
This prints the version number, and exits.
|
||||
|
||||
+ --quiet
|
||||
|
||||
Supress non-error output.
|
||||
|
||||
+ --verbose
|
||||
|
||||
This prints additional information during the sanoid run.
|
||||
|
||||
+ --force-update
|
||||
|
||||
This clears out sanoid's zfs snapshot listing cache. This is normally not needed.
|
||||
|
||||
+ --debug
|
||||
|
||||
This prints out quite alot of additional information during a sanoid run, and is normally not needed.
|
||||
|
|
@ -82,8 +88,6 @@ Which would be enough to tell sanoid to take and keep 36 hourly snapshots, 30 da
|
|||
|
||||
# Syncoid
|
||||
|
||||
# Note that the snapshots it takes and transfers are not atomic!
|
||||
|
||||
Sanoid also includes a replication tool, syncoid, which facilitates the asynchronous incremental replication of ZFS filesystems. A typical syncoid command might look like this:
|
||||
|
||||
```
|
||||
|
|
@ -122,7 +126,7 @@ Syncoid supports recursive replication (replication of a dataset and all its chi
|
|||
|
||||
+ --compress <compression type>
|
||||
|
||||
Currently accepts gzip, pigz, lzo, bzip2, pbzip2, lbzip2, lzip, plzip, xz, pxz, pixz. lzo is fast and light on the processsor and is the default, if available. pigz is fast and heavy on the processor. bzip2, pbzip2, lbzip2, lzip, plzip, xz, pxz, and pixz should only be used on very low bandwidth connections. If the selected compression method is unavailable on the source and destination, no compression will be used.
|
||||
Currently accepts gzip and lzo. lzo is fast and light on the processsor and is the default. If the selected compression method is unavailable on the source and destination, no compression will be used.
|
||||
|
||||
+ --source-bwlimit <limit t|g|m|k>
|
||||
|
||||
|
|
@ -136,22 +140,6 @@ Syncoid supports recursive replication (replication of a dataset and all its chi
|
|||
|
||||
Do not check the existance of commands before attempting the transfer. It assumes all programs are available. This should never be used.
|
||||
|
||||
+ --verbose
|
||||
|
||||
This prints additional information during the sanoid run.
|
||||
|
||||
+ --debug
|
||||
|
||||
This prints out quite alot of additional information during a sanoid run, and is normally not needed.
|
||||
|
||||
+ --dumpsnaps
|
||||
|
||||
This prints a list of snapshots during the run.
|
||||
|
||||
+ --monitor-version
|
||||
|
||||
This doesn't do anything right now.
|
||||
|
||||
+ --no-stream
|
||||
|
||||
This argument tells syncoid to use -i incrementals, not -I. This updates the target with the newest snapshot from the source, without replicating the intermediate snapshots in between. (If used for an initial synchronization, will do a full replication from newest snapshot and exit immediately, rather than starting with the oldest and then doing an immediate -i to the newest.)
|
||||
|
|
@ -160,5 +148,36 @@ Syncoid supports recursive replication (replication of a dataset and all its chi
|
|||
|
||||
This argument tells syncoid to restrict itself to existing snapshots, instead of creating a semi-ephemeral syncoid snapshot at execution time. Especially useful in multi-target (A->B, A->C) replication schemes, where you might otherwise accumulate a large number of foreign syncoid snapshots.
|
||||
|
||||
+ --dumpsnaps
|
||||
|
||||
This prints a list of snapshots during the run.
|
||||
|
||||
+ --sshport
|
||||
Allow sync to/from boxes running SSH on non-standard ports
|
||||
|
||||
Allow sync to/from boxes running SSH on non-standard ports.
|
||||
|
||||
+ --sshkey
|
||||
|
||||
Use specified identity file as per ssh -i.
|
||||
|
||||
+ --quiet
|
||||
|
||||
Supress non-error output.
|
||||
|
||||
+ --verbose
|
||||
|
||||
This prints additional information during the sanoid run.
|
||||
|
||||
+ --debug
|
||||
|
||||
This prints out quite alot of additional information during a sanoid run, and is normally not needed.
|
||||
|
||||
+ --version
|
||||
|
||||
Print the version and exit.
|
||||
|
||||
+ --monitor-version
|
||||
|
||||
This doesn't do anything right now.
|
||||
|
||||
Note that the snapshots it takes and transfers are not atomic relative to one another
|
||||
|
|
|
|||
Loading…
Reference in New Issue