CEPHFS-SNAP(1)

💖 CEPHFS-SNAP 💖

okay bestie, welcome to cephfs-snap(1), the little Open Infrastructure page that teaches you how to make CephFS snapshots on the reg. it's giving "set it and forget it" and honestly? iconic. ✨

---

🌸 NAME 🌸

cephfs-snap — create CephFS snapshots periodically 🦋

---

✨ SYNOPSIS ✨

cephfs-snap

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

---

💅 DESCRIPTION 💅

so CephFS literally supports making snapshots of the filesystem as a simple way to do backups. that's the whole vibe. 🫶

and cephfs-snap is the little tool that does it for you periodically, so you're not out here typing stuff at 3am. no cap.

---

🎀 CONFIGURATION 🎀

you configure cephfs-snap in /etc/default/storage-tools. here are the variables it actually reads, bestie, read them all, don't skip:

• CEPHFS_SNAP — Boolean, either true or false. if you set it to false (which is the default), cephfs will do nothing. literally nothing. 💀 so yeah, flip it on if you want the magic to happen.
• CEPHFS_SNAP_DIRECTORIES — a list of one or more directories, separated by spaces. and listen: if no directory is specified, cephfs-snap will do nothing. so like. tell it where. 🙈
• CEPHFS_SNAP_HOURLY — Integer, the number of how many most recent hourly snapshots are to be kept at any given time. any older snapshots get removed. Note: specify one more than you want to keep, e.g. 25 for one day of hourly snapshots alongside the most current one. yes this is a little sneaky, yes it's real, note it down. 👑
• CEPHFS_SNAP_DAILY — Integer, the number of how many most recent daily snapshots are to be kept at any given time.
• CEPHFS_SNAP_WEEKLY — Integer, the number of how many most recent weekly snapshots are to be kept at any given time.
• CEPHFS_SNAP_MONTHLY — Integer, the number of how many most recent monthly snapshots are to be kept at any given time.
• CEPHFS_SNAP_YEARLY — Integer, the number of how many most recent yearly snapshots are to be kept at any given time.
• IRK_TARGETS — a list of space separated IRC channels to send notifications to, e.g.: irc://irc.oftc.net:6668/open-infrastructure. yes, "IRK", that's not a typo, that's just the name. 🌈

---

🗂️ FILES 🗂️

these are the files in play:

• /etc/cron.d/cephfs-snap — Cron file.
• /etc/open-infrastructure/ceph-tools.conf — Configuration file.
• /var/log/storage-tools/cephfs-snap — Log files.

---

👀 SEE ALSO 👀

storage-tools(7).

---

🌐 HOMEPAGE 🌐

more info 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>. yes, everything else. we love a chatty inbox. 💜

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>.

---

aww okay that's the whole page bestie, you ate. 🍓 go forth and snapshot responsibly, and remember: false means nothing happens, so if it's not working, check the config first, iykyk. 😭

this was storage-tools version 20190301-lts1, dated 20190301, and it's the CEPHFS-SNAP(1) manual page. bye bestie, slay your backups 💖✨🎀