btrfs-snap-script, bash script to easily manage ubuntu btrfs snapshots
Jason Jorgensen <jasonj@innominatus.com>
Version 1.6
02-25-2014

1. Introduction
2. Installation
3. Usage 
4. Copyright

-----------------------------------------

1. Introduction

I wanted a simple bash script that I could install quickly and easily on 
ubuntu workstations and servers that would automatically snapshot btrfs volumes
for me.

Ubuntu sets up their btrfs volumes with @ and @home subvolumes.

  BTRFS Volume
  Root subvolume (0) --+-> Subvolume @ ---> Directory /
                       +-> Subvolume @home ---> Directory /home
                       +-> Subvolume snaptshots made by this script also stored at this level.

My debian installs also get converted to this layout.

I have been running this script on all my btrfs workstations and servers for months with no issues so far.


Current Features:
- Snapshot a btrfs subvolume based on a name and a timestamp
- Default snapshot from cron hourly, daily, weekly, monthly
- Automatically expire and remove old snapshots
- Easy to manual snapshot a volume before a big change and it will not auto expire via the default cron jobs
- List out all existing snapshots
- Easily delete existing snapshots


The latest version of btrfs-snap-script is available at http://www.innominatus.com

-----------------------------------------

2. Installation

- wget http://innominatus.com/releases/btrfs-snap-script/btrfs-snap-script_latest_all.deb
- dpkg -i btrfs-snap-script_latest_all.deb
- Change /etc/default/btrfs-snap-script "CRON=0" to "CRON=1" to enable it

-----------------------------------------

3. Usage 

Usage: btrfs-snap-script [options] <subvolume mount point> <time period name> <number of snapshots to keep>

Options:
  -h                    This usage help
  -l                    List all existing snapshots for the selected <subvolume mount point>
                        btrfs-snap-script -l /home  (to list all snapshots for the filesystem /home is on)
  -d <snapshot name>    Delete a snapshot from the selected <subvolume mount point>
                        btrfs-snap-script -d <name> /home (to delete the snapshots from the filesystem /home is on)

Defaults:
  time period name:            manual
  number of snapshots to keep: 10

Examples:
  btrfs-snap-script / hourly 24
  btrfs-snap-script /home monthly 3
  btrfs-snap-script /export whatever 9
  btrfs-snap-script /mountpoint  # this will keep '10' snapshots for time period 'manual'

Make a quick snapshot before some big filesystem change:
  btrfs-snap-script /
  Snapshotting '@' to '@_btrfs-snap-script_manual_2013-09-09_19:52:27' on '/dev/sda1... Success

List existing snapshots:
  btrfs-snap-script -l /
  Existing btrfs-snap-script snapshots on '/dev/sda1' that '/' is on:
    @_btrfs-snap-script_daily_2013-09-03_07:40:21
    @_btrfs-snap-script_daily_2013-09-04_07:48:36
    ...
    @_btrfs-snap-script_hourly_2013-09-08_20:17:01
    @_btrfs-snap-script_hourly_2013-09-08_21:17:01
    ...
    @_btrfs-snap-script_manual_2013-06-21_15:37:28
    @_btrfs-snap-script_monthly_2013-07-21_07:45:01
    @_btrfs-snap-script_monthly_2013-08-21_07:45:02
    @_btrfs-snap-script_weekly_2013-08-16_07:47:52
    @_btrfs-snap-script_weekly_2013-08-23_07:56:05
    @_btrfs-snap-script_weekly_2013-08-30_08:00:27
    @_btrfs-snap-script_weekly_2013-09-06_07:53:59

Delete existing snapshot:
  btrfs-snap-script -d @_btrfs-snap-script_manual_2013-06-15_23:43:44 /
  Deleting snapshot '@_btrfs-snap-script_manual_2013-06-15_23:43:44' from '/dev/sda1' that '/' is on... Success


-----------------------------------------

4. Copyright

btrfs-snap-script Copyright 2013 Jason Jorgensen, jasonj@innominatus.com 

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. 

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. 

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.