zfstools 0.2.1 → 0.2.2

data/LICENSE.txt

@@ -1,20 +1,21 @@
-Copyright (c) 2012 Bryan Drewery
+Copyright (c) 2012-2013, Bryan Drewery <bryan@shatow.net>
+All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -31,11 +31,11 @@ This will handle automatically snapshotting datasets similar to time-sliderd fro
 
 #### Crontab
 
-    15,30,45 * * * * /usr/local/bin/zfs-auto-snapshot frequent    4
-    0 * * * *        /usr/local/bin/zfs-auto-snapshot hourly     24
-    7 0 * * *        /usr/local/bin/zfs-auto-snapshot daily       7
-    14 0 * * 7       /usr/local/bin/zfs-auto-snapshot weekly      4
-    28 0 1 * *       /usr/local/bin/zfs-auto-snapshot monthly    12
+    15,30,45 * * * * root /usr/local/bin/zfs-auto-snapshot frequent  4
+    0        * * * * root /usr/local/bin/zfs-auto-snapshot hourly   24
+    7        0 * * * root /usr/local/bin/zfs-auto-snapshot daily     7
+    14       0 * * 7 root /usr/local/bin/zfs-auto-snapshot weekly    4
+    28       0 1 * * root /usr/local/bin/zfs-auto-snapshot monthly  12
 
 #### Dataset setup
 
@@ -89,12 +89,7 @@ These settings should be set before importing any data.
 #### Script Usage
 
 Setup a `/root/.my.cnf` with the relevant information on where to connect to, with the proper username/password that has access to `FLUSH LOGS` and `FLUSH TABLES WITH READ LOCK`.
-
-#### Crontab
-
-    */10 * * * * /usr/local/bin/zfs-snapshot-mysql DATASET
-
-* DATASET - The dataset that contains your mysql data
+The `zfs-auto-snapshot` script will automatically flush the tables before saving the snapshots.
 
 ### zfs-cleanup-snapshots
 

data/README.rdoc

@@ -14,5 +14,5 @@ Various scripts for administrating ZFS. Modeled after OpenSolaris time-slider
 
 == Copyright
 
-Copyright (c) 2012 Bryan Drewery. See LICENSE.txt for
+Copyright (c) 2012-2013 Bryan Drewery. See LICENSE.txt for
 further details.

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "zfstools"
   gem.homepage = "http://github.com/bdrewery/zfstools"
-  gem.license = "MIT"
+  gem.license = "BSD"
   gem.summary = %Q{ZFSTools}
   gem.description = %Q{ZFS admin scripts, such as automatic snapshots, mysql snapshotting, scrubbing, etc.}
   gem.email = "bryan@shatow.net"

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/bin/zfs-auto-snapshot

@@ -10,6 +10,7 @@ opts = GetoptLong.new(
   [ "--utc",                             "-u",           GetoptLong::NO_ARGUMENT ],
   [ "--keep-zero-sized-snapshots",       "-k",           GetoptLong::NO_ARGUMENT ],
   [ "--parallel-snapshots",              "-p",           GetoptLong::NO_ARGUMENT ],
+  [ "--pool",                            "-P",           GetoptLong::REQUIRED_ARGUMENT ],
   [ "--dry-run",                         "-n",           GetoptLong::NO_ARGUMENT ],
   [ "--verbose",                         "-v",           GetoptLong::NO_ARGUMENT ],
   [ "--debug",                           "-d",           GetoptLong::NO_ARGUMENT ]
@@ -18,6 +19,7 @@ opts = GetoptLong.new(
 $use_utc = false
 $dry_run = false
 should_destroy_zero_sized_snapshots = true
+pool = nil
 opts.each do |opt, arg|
   case opt
   when '--utc'
@@ -26,6 +28,8 @@ opts.each do |opt, arg|
     should_destroy_zero_sized_snapshots = false
   when '--parallel-snapshots'
     $use_threads = true
+  when '--pool'
+    pool = arg
   when '--dry-run'
     $dry_run = true
   when '--verbose'
@@ -38,13 +42,14 @@ end
 
 def usage
   puts <<-EOF
-Usage: $0 [-dknpuv] <INTERVAL> <KEEP>
+Usage: #{$0} [-dknpuv] <INTERVAL> <KEEP>
   EOF
   format = "    %-15s %s"
   puts format % ["-d", "Show debug output."]
   puts format % ["-k", "Keep zero-sized snapshots."]
   puts format % ["-n", "Do a dry-run. Nothing is committed. Only show what would be done."]
   puts format % ["-p", "Create snapshots in parallel."]
+  puts format % ["-P pool", "Act only on the specified pool."]
   puts format % ["-u", "Use UTC for snapshots."]
   puts format % ["-v", "Show what is being done."]
   puts format % ["INTERVAL", "The interval to snapshot."]
@@ -57,10 +62,10 @@ usage if ARGV.length < 2
 interval=ARGV[0]
 keep=ARGV[1].to_i
 
-datasets = find_eligible_datasets(interval)
+datasets = find_eligible_datasets(interval, pool)
 
 # Generate new snapshots
 do_new_snapshots(datasets, interval) if keep > 0
 
 # Delete expired
-cleanup_expired_snapshots(datasets, interval, keep, should_destroy_zero_sized_snapshots)
+cleanup_expired_snapshots(pool, datasets, interval, keep, should_destroy_zero_sized_snapshots)

data/bin/zfs-cleanup-snapshots

@@ -7,20 +7,24 @@ require 'getoptlong'
 require 'zfstools'
 
 opts = GetoptLong.new(
-  [ "--parallel-snapshots",              "-p",           GetoptLong::NO_ARGUMENT ],
   [ "--dry-run",                         "-n",           GetoptLong::NO_ARGUMENT ],
+  [ "--parallel-snapshots",              "-p",           GetoptLong::NO_ARGUMENT ],
+  [ "--pool",                            "-P",           GetoptLong::REQUIRED_ARGUMENT ],
   [ "--verbose",                         "-v",           GetoptLong::NO_ARGUMENT ],
   [ "--debug",                           "-d",           GetoptLong::NO_ARGUMENT ]
 )
 
 $dry_run = false
 $use_threads = false
+pool = nil
 opts.each do |opt, arg|
   case opt
   when '--dry-run'
     $dry_run = true
   when '--parallel-snapshots'
     $use_threads = true
+  when '--pool'
+    pool = arg
   when '--verbose'
     $verbose = true
   when '--debug'
@@ -31,19 +35,21 @@ end
 
 def usage
   puts <<-EOF
-Usage: $0 [-dnv]
+Usage: #{$0} [-dnv]
   EOF
   format = "    %-15s %s"
   puts format % ["-d", "Show debug output."]
   puts format % ["-n", "Do a dry-run. Nothing is committed. Only show what would be done."]
+  puts format % ["-p", "Create snapshots in parallel."]
+  puts format % ["-P pool", "Act only on the specified pool."]
   puts format % ["-v", "Show what is being done."]
   exit
 end
 
 usage if ARGV.length > 0
 
-snapshots = Zfs::Snapshot.list.select { |snapshot| snapshot.used == 0 and !snapshot.name.include?(snapshot_prefix) }
+snapshots = Zfs::Snapshot.list(pool).select { |snapshot| snapshot.used == 0 and !snapshot.name.include?(snapshot_prefix) }
 ## Group into datasets
-datasets = Zfs::Dataset.list
+datasets = Zfs::Dataset.list(pool)
 dataset_snapshots = group_snapshots_into_datasets(snapshots, datasets)
 dataset_snapshots = datasets_destroy_zero_sized_snapshots(dataset_snapshots)

data/bin/zfs-snapshot-mysql

@@ -27,7 +27,7 @@ end
 
 def usage
   puts <<-EOF
-Usage: $0 [-dnv] DATASET
+Usage: #{$0} [-dnv] DATASET
   EOF
   format = "    %-15s %s"
   puts format % ["-d", "Show debug output."]

data/lib/{zfs → zfstools}/dataset.rb

@@ -20,10 +20,11 @@ module Zfs
       self
     end
 
-    def self.list(properties=[])
+    def self.list(pool=nil, properties=[])
       datasets = []
       cmd_properties = ["name"] + properties
       cmd="zfs list -H -t filesystem,volume -o #{cmd_properties.join(",")} -s name"
+      cmd += " -r #{pool}" if pool
       puts cmd if $debug
       IO.popen cmd do |io|
         io.readlines.each do |line|

data/lib/zfstools.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 
-require 'zfs/snapshot'
-require 'zfs/dataset'
+require 'zfstools/snapshot'
+require 'zfstools/dataset'
 
 # Ruby 1.8 compat for select!
 class Hash
@@ -119,12 +119,12 @@ def filter_datasets(datasets, included_excluded_datasets, property)
   end
 end
 
-def find_eligible_datasets(interval)
+def find_eligible_datasets(interval, pool)
   properties = [
     "#{snapshot_property}:#{interval}",
     snapshot_property,
   ]
-  datasets = Zfs::Dataset.list(properties)
+  datasets = Zfs::Dataset.list(pool, properties)
 
   ### Group datasets into included/excluded for snapshotting
   included_excluded_datasets = {
@@ -209,9 +209,9 @@ def datasets_destroy_zero_sized_snapshots(dataset_snapshots)
 end
 
 ### Find and destroy expired snapshots
-def cleanup_expired_snapshots(datasets, interval, keep, should_destroy_zero_sized_snapshots)
+def cleanup_expired_snapshots(pool, datasets, interval, keep, should_destroy_zero_sized_snapshots)
   ### Find all snapshots matching this interval
-  snapshots = Zfs::Snapshot.list.select { |snapshot| snapshot.name.include?(snapshot_prefix(interval)) }
+  snapshots = Zfs::Snapshot.list(pool).select { |snapshot| snapshot.name.include?(snapshot_prefix(interval)) }
   dataset_snapshots = group_snapshots_into_datasets(snapshots, datasets['included'] + datasets['excluded'])
   ### Filter out datasets not included
   dataset_snapshots.select! { |dataset, snapshots| datasets['included'].include?(dataset) }

data/zfstools.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "zfstools"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bryan Drewery"]
-  s.date = "2012-05-05"
+  s.date = "2013-02-04"
   s.description = "ZFS admin scripts, such as automatic snapshots, mysql snapshotting, scrubbing, etc."
   s.email = "bryan@shatow.net"
   s.executables = ["zfs-auto-snapshot", "zfs-cleanup-snapshots", "zfs-snapshot-mysql"]
@@ -34,15 +34,15 @@ Gem::Specification.new do |s|
     "features/step_definitions/zfstools_steps.rb",
     "features/support/env.rb",
     "features/zfstools.feature",
-    "lib/zfs/dataset.rb",
-    "lib/zfs/snapshot.rb",
     "lib/zfstools.rb",
+    "lib/zfstools/dataset.rb",
+    "lib/zfstools/snapshot.rb",
     "spec/spec_helper.rb",
     "spec/zfstools_spec.rb",
     "zfstools.gemspec"
   ]
   s.homepage = "http://github.com/bdrewery/zfstools"
-  s.licenses = ["MIT"]
+  s.licenses = ["BSD"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.16"
   s.summary = "ZFSTools"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zfstools
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-05 00:00:00.000000000Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11694420 !ruby/object:Gem::Requirement
+  requirement: &20923260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *11694420
+  version_requirements: *20923260
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &11693740 !ruby/object:Gem::Requirement
+  requirement: &19966840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *11693740
+  version_requirements: *19966840
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &11693000 !ruby/object:Gem::Requirement
+  requirement: &19964120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *11693000
+  version_requirements: *19964120
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &11692360 !ruby/object:Gem::Requirement
+  requirement: &19963020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11692360
+  version_requirements: *19963020
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &11691580 !ruby/object:Gem::Requirement
+  requirement: &19960960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *11691580
+  version_requirements: *19960960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &11690960 !ruby/object:Gem::Requirement
+  requirement: &19960160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *11690960
+  version_requirements: *19960160
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &11690240 !ruby/object:Gem::Requirement
+  requirement: &19975720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11690240
+  version_requirements: *19975720
 description: ZFS admin scripts, such as automatic snapshots, mysql snapshotting, scrubbing,
   etc.
 email: bryan@shatow.net
@@ -116,15 +116,15 @@ files:
 - features/step_definitions/zfstools_steps.rb
 - features/support/env.rb
 - features/zfstools.feature
-- lib/zfs/dataset.rb
-- lib/zfs/snapshot.rb
 - lib/zfstools.rb
+- lib/zfstools/dataset.rb
+- lib/zfstools/snapshot.rb
 - spec/spec_helper.rb
 - spec/zfstools_spec.rb
 - zfstools.gemspec
 homepage: http://github.com/bdrewery/zfstools
 licenses:
-- MIT
+- BSD
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -137,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3654737398168327610
+      hash: 1946936266483183679
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: