Skip to content

Commit

Permalink
update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
makhomed committed Nov 18, 2017
1 parent bf1acd5 commit 0cb6a9a
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
========
autosnap
========

ZFS snapshot automation tool

Installation
------------

- ``cd /opt``
- ``git clone https://github.com/makhomed/autosnap.git autosnap```

Configuration
-------------

- ``vim /opt/autosnap/autosnap.conf``
- write to config something like this:

Expand Down Expand Up @@ -43,6 +46,7 @@ if it was directive ``include`` - dataset will be included.

Schedule autosnap
-----------------

- ``vim /etc/cron.d/autosnap``
- write to cron file something like this:

Expand All @@ -60,15 +64,18 @@ be the name of interval from configuration file.
During execution, autosnap will create one new snapshot for each included dataset
and delete all oldest snapshots exceeding the allowed snapshots count for given interval.

Also ``autosnap`` supports two specila commands, ``list-unmanaged-snapshots`` and ``list-managed-snapshots``.
Additional commands
-------------------

``autosnap`` supports two special commands, ``list-unmanaged-snapshots`` and ``list-managed-snapshots``.

Command ``/opt/autosnap/autosnap list-unmanaged-snapshots`` will list all existing snapshots, which are not managed by ``autosnap``.

Command ``/opt/autosnap/autosnap list-managed-snapshots`` will list all existing snapshots, which are managed by ``autosnap``.

If all snapshots are managed by ``autosnap`` it will be useful to schedule in cron command ``/opt/autosnap/autosnap list-unmanaged-snapshots``
for periodic execution. If abandoned snapshots appears - it will be listed by command ``/opt/autosnap/autosnap list-unmanaged-snapshots``
and report with such abandoned snapshots will be sent to system administrator mail.
and report about such abandoned snapshots will be sent to system administrator mail.

If all snapshots are managed by ``autosnap`` and ``autobackup`` cron command ``/opt/autosnap/autosnap list-unmanaged-snapshots | grep -v "@autobackup"``
will be useful.
Expand Down

0 comments on commit 0cb6a9a

Please sign in to comment.