NAME

       cephfs-snap - create CephFS snapshots periodically

SYNOPSIS

       cephfs-snap

       cephfs-snap [hourly|daily|weekly|monthly]

DESCRIPTION

       CephFS supports creating snapshots of the filesystem as a simple means of backups.

       The cephfs-snap program is a simple tool to do this periodically.

CONFIGURATION

       cephfs-snap is configured in /etc/default/storage-tools. The following variables are used:

       CEPHFS_SNAP
           Boolean, either true or false. If set to false (default), cephfs will do nothing.

       CEPHFS_SNAP_DIRECTORIES
           List of one or more space separated directories. If no directory is specified,
           cephfs-snap will do nothing.

       CEPHFS_SNAP_HOURLY
           Integer, number of how many most recent hourly snapshots are to be kept at any given
           time. Any older snapshots will be removed. Note: specify one more than you wan to
           keep, e.g. 25 for one day of hourly snapshots alongside the most current one.

       CEPHFS_SNAP_DAILY
           Integer, number of how many most recent daily snapshots are to be kept at any given
           time.

       CEPHFS_SNAP_WEEKLY
           Integer, number of how many most recent weekly snapshots are to be kept at any given
           time.

       CEPHFS_SNAP_MONTHLY
           Integer, number of how many most recent monthly snapshots are to be kept at any given
           time.

       CEPHFS_SNAP_YEARLY
           Integer, number of how many most recent yearly snapshots are to be kept at any given
           time.

       IRK_TARGETS
           List of space separated IRC channels to send notifications to, e.g.:
           irc://irc.oftc.net:6668/open-infrastructure

FILES

       The following files are used:

       /etc/cron.d/cephfs-snap
           Cron file.

       /etc/default/storage-tools
           Configuration file.

       /var/log/storage-tools/cephfs-snap
           Log files.

SEE ALSO

       storage-tools(7).

HOMEPAGE

       More information about storage-tools and the Open Infrastructure project can be found on
       the homepage at https://open-infrastructure.net.

CONTACT

       Bug reports, feature requests, help, patches, support and everything else are welcome on
       the Open Infrastructure Software Mailing List <software@lists.open-infrastructure.net>.

       Debian specific bugs can also be reported in the Debian Bug Tracking System at
       https://bugs.debian.org.

AUTHORS

       storage-tools was written by Daniel Baumann <daniel.baumann@open-infrastructure.net>.