zfs_mgmt 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5acd67ede82b58715afd30c8a353c0ac04eae765f37d46fabbc17c50f1e815d1
-  data.tar.gz: 3d0327b103d260acaeb8c9859f56a5a8995f006562a72b88c13dc538ac7a0d56
+  metadata.gz: bce5f90411d08b54334f8694e7956f718c1e63995f2c799b95cb170b302c2c8a
+  data.tar.gz: 1d82a41657f40fe371814210be392d8c34be333816530fcff6a67ae778dc120b
 SHA512:
-  metadata.gz: 73b14068379306c891f6156d6d8b950de23d5dd2d40fdcee7a455abc19d7cd98a204c2e32ee809b7548ca189b9454f7f0fd7169d3f4da68abea526f0e647d364
-  data.tar.gz: bf8d5142caa75a686991ad999956b7a093e68283d5cacec0e27c2897efa2e3d44db49c82e0dab8553843be69c1cdd7df124a5ed59cea86066f7b943ed9301edb
+  metadata.gz: e500b4cc3b155528c470c5aa26338a948e783a5f951a7a5e0d6c05b6739c07cccd6bfe0a1dd001a34722f47e611cc85e2f931d8e3cbca58e37b0f3b0d23606da
+  data.tar.gz: d3ca6969f760260449f85d99e05133f542700f9d0322a84f771cd157d3ec0729c2e86dc33f0326c53b1f35065cb28b879bbad85c6e422c4bae95b20cc9d21f06

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zfs_mgmt (0.3.0)
+    zfs_mgmt (0.3.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -180,7 +180,11 @@ oldest and unless the property is set to youngest oldest will be used.
 ### zfsmgmt:snapshot
 If this property is 'true' then create a snapshot in the format of
 zfsmgmt-%FT%T%z.  If this property is 'recursive' then create a
-recursive snapshot of this zfs.
+recursive snapshot of this zfs, but only on zfs where this property is
+local.  If this property is set to the string 'local' and the property
+is set locally, it will create a snapshot.  The intention is that you
+would use 'local' when you want a zfs snapshot for the filesystem, but
+NOT it's descendant filesystems.
 
 ### zfsmgmt:snap_prefix
 Change the zfsmgmt portion of created snapshots, ie: 'autosnap' would

data/bin/zfsmgr

@@ -35,6 +35,10 @@ class ZfsMgr < Thor
   end
   desc "snapshot SUBCOMMAND ...ARGS", "manage snapshots"
   subcommand "snapshot", Snapshot
+  desc "list SUBCOMMAND ...ARGS", "list filesystems"
+  subcommand "list", ZfsMgmtList
+  desc "restic SUBCOMMAND ...ARGS", "backup zfs to restic"
+  subcommand "restic", ZfsMgmtRestic
 end
 
 ZfsMgr.start(ARGV)

data/lib/zfs_mgmt.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 require "zfs_mgmt/version"
+require "zfs_mgmt/restic"
 require 'pp'
 require 'date'
 require 'logger'
@@ -230,10 +231,10 @@ module ZfsMgmt
       end
       # print a table of saved snapshots with the reasons it is being saved
       table = Text::Table.new
-      table.head = ['snap','creation','hourly','daily','weekly','monthly','yearly']
+      table.head = [zfs,'creation','hourly','daily','weekly','monthly','yearly']
       table.rows = []
       saved_snaps.sort { |a,b| snaps[b]['creation'] <=> snaps[a]['creation'] }.each do |snap|
-        table.rows << [snap,local_epoch_to_datetime(snaps[snap]['creation'])] + find_saved_reason(saved,snap)
+        table.rows << [snap.split('@')[1],local_epoch_to_datetime(snaps[snap]['creation'])] + find_saved_reason(saved,snap)
       end
       print table.to_s
     end
@@ -250,6 +251,11 @@ module ZfsMgmt
       (saved,saved_snaps,deleteme) = snapshot_destroy_policy(zfs,props,snaps)
     
       $logger.info("deleting #{deleteme.length} snapshots for #{zfs}")
+      deleteme.reverse! # oldest first for removal
+      deleteme.each do |snap_name|
+        $logger.debug("delete: #{snap_name} #{local_epoch_to_datetime(snaps[snap_name]['creation']).strftime('%F %T')}")
+      end
+
       com_base = "zfs destroy -p"
       if deleteme.length > 0
         com_base = "#{com_base}d"
@@ -260,10 +266,6 @@ module ZfsMgmt
       if verbopt
         com_base = "#{com_base}v"
       end
-      deleteme.reverse! # oldest first for removal
-      deleteme.each do |snap_name|
-        $logger.debug("delete: #{snap_name} #{local_epoch_to_datetime(snaps[snap_name]['creation']).strftime('%F %T')}")
-      end
       while deleteme.length > 0
         for i in 0..(deleteme.length - 1) do
           max = deleteme.length - 1 - i
@@ -277,6 +279,9 @@ module ZfsMgmt
           $logger.info(com)
           deleteme = deleteme - deleteme[0..max]
           system(com)
+          if $?.exitstatus != 0
+            $logger.error("zfs exited with non-zero status: #{$?.exitstatus}")
+          end
           break
         end
       end
@@ -306,8 +311,15 @@ module ZfsMgmt
     end
     dt = DateTime.now
     zfsget(properties: custom_properties()).each do |zfs,props|
+      unless /#{filter}/ =~ zfs
+        next
+      end
       # zfs must have snapshot set to true or recursive
-      if props.has_key?('zfsmgmt:snapshot') and props['zfsmgmt:snapshot'] == 'true' or ( props['zfsmgmt:snapshot'] == 'recursive' and props['zfsmgmt:snapshot@source'] == 'local' )
+      if props.has_key?('zfsmgmt:snapshot') and
+        props['zfsmgmt:snapshot'] == 'true' or
+        ( props['zfsmgmt:snapshot'] == 'recursive' and props['zfsmgmt:snapshot@source'] == 'local' ) or
+        ( props['zfsmgmt:snapshot'] == 'local' and props['zfsmgmt:snapshot@source'] == 'local' )
+        
         prefix = ( props.has_key?('zfsmgmt:snap_prefix') ? props['zfsmgmt:snap_prefix'] : 'zfsmgmt' )
         ts = ( props.has_key?('zfsmgmt:snap_timestamp') ? props['zfsmgmt:snap_timestamp'] : '%FT%T%z' )
         com = ['zfs','snapshot']
@@ -321,3 +333,26 @@ module ZfsMgmt
     end
   end
 end
+class ZfsMgmtList < Thor
+  class_option :filter, :type => :string, :default => '.+',
+               :desc => 'only act on zfs matching this regexp'
+  desc "stale", "list all zfs with stale snapshots"
+  method_option :age, :desc => "timeframe outside of which the zfs will be considered stale", :default => '1d'
+  def stale()
+    cutoff = Time.at(Time.now.to_i -  ZfsMgmt.timespec_to_seconds(options[:age]))
+    table = Text::Table.new
+    table.head = ['zfs','snapshot','age']
+    table.rows = []
+    ZfsMgmt.zfs_managed_list(filter: options[:filter]).each do |blob|
+      zfs,props,snaps = blob
+      last = snaps.keys.sort { |a,b| snaps[a]['creation'] <=> snaps[b]['creation'] }.last
+      snap_time = Time.at(snaps[last]['creation'])
+      if snap_time < cutoff
+        table.rows << [zfs,last.split('@')[1],snap_time]
+      end
+    end
+    if table.rows.count > 0
+      print table.to_s
+    end
+  end
+end

data/lib/zfs_mgmt/restic.rb

@@ -0,0 +1,33 @@
+
+module ZfsMgmt::Restic
+  def self.backup(backup_type: 'incremental', force: false, filter: '.+')
+    pp backup_type, force, filter
+  end
+end
+
+class ZfsMgmtResticBackup < Thor
+  class_option :filter, :type => :string, :default => '.+',
+               :desc => 'only act on zfs matching this regexp'
+  class_option :force, :type => :boolean, :default => false,
+               :desc => 'force create this backup type, fail if it cannot be forced'
+  desc "incremental", "perform incremental backup"
+  def incremental()
+    ZfsMgmt::Restic.backup(backup_type: 'incremental', force: options[:force])
+  end
+  desc "differential", "perform differential backup"
+  def differential()
+    ZfsMgmt::Restic.backup(backup_type: 'differential', force: options[:force])
+  end
+  desc "full", "perform full backup"
+  def full()
+    ZfsMgmt::Restic.backup(backup_type: 'full', force: options[:force])
+  end
+end
+
+class ZfsMgmtRestic < Thor
+  desc "restic SUBCOMMAND ...ARGS", "backup all configured zfs to restic"
+  subcommand "backup", ZfsMgmtResticBackup
+
+end
+
+  

data/lib/zfs_mgmt/version.rb

@@ -1,3 +1,3 @@
 module ZfsMgmt
-  VERSION = "0.3.0"
+  VERSION = "0.3.5"
 end

data/zfs_mgmt.gemspec

@@ -39,8 +39,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "thor", "~> 1.0.1"
-  spec.add_development_dependency "text-table", "~> 1.2.4"
-  spec.add_development_dependency "filesize", "~> 0.2.0"
+  spec.add_development_dependency "thor", "~> 1.0"
+  spec.add_development_dependency "text-table", "~> 1.2"
+  spec.add_development_dependency "filesize", "~> 0.2"
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zfs_mgmt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Aran Cox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: text-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: filesize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
 description: 
 email:
 - arancox@gmail.com
@@ -125,6 +125,7 @@ files:
 - bin/zfssendman
 - bin/zfssnapman
 - lib/zfs_mgmt.rb
+- lib/zfs_mgmt/restic.rb
 - lib/zfs_mgmt/version.rb
 - zfs_mgmt.gemspec
 homepage: https://github.com/aranc23/zfs_mgmt
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Misc. helpers regarding snapshots and send/recv.