knife-tarsnap 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,8 @@
-# Chef Tarsnap
+# Chef / Tarsnap
 
-Provides a chef cookbook with LWRP's to directory snapshots and maintain retention schedules. Includes a knife plugin for managing tarsnap keys, listing backups, and restoring files.
+Provides a chef cookbook with LWRP's to take directory snapshots and maintain retention schedules. Includes a knife plugin for managing tarsnap keys, listing backups, and restoring files.
+
+Backup services are handled by [Colin Percival's](https://twitter.com/cperciva) excellent [tarsnap](https://www.tarsnap.com/).
 
 
 ## Installation
@@ -37,7 +39,7 @@ Or install it yourself as:
 
 Alternatively, and add this line to your application's Gemfile:
 
-    gem 'chef-tarsnap', :path => 'cookbooks/tarsnap/knife-plugin'
+    gem 'knife-tarsnap', :path => 'cookbooks/tarsnap/knife-tarsnap'
 
 And then execute:
 
@@ -57,6 +59,7 @@ include_recipe 'tarsnap'
 
 tarsnap_backup 'app-data' do
   path '/opt/my_app/data'
+  exclude '/opt/my_app/data/bin'
   schedule 'hourly'
 end
 
@@ -167,6 +170,10 @@ Create the tarsnap key for a node by reading the key contents from a file.
 
 Output the decrypted tarsnap key for a node.
 
+#### $ knife tarsnap key export (options)
+
+Export all keys into a local directory named ./tarsnap-keys-TIMESTAMP. Override the directory with the `-D DIRNAME` option.
+
 
 ### Managing backups with the knife plugin
 
@@ -220,6 +227,11 @@ Example:
     DHOME=/home
 
 
+## Warning!
+
+You need to keep a copy of your keys somewhere safe. If you lose them, then it is **impossible** to recover anything from your tarsnap backups. The chef server provides a convenient storage system for this data through data bags, however I strongly suggest storing redundant copies of the keys in multiple locations.
+
+
 ## Contributing
 
 1. Fork it

data/lib/chef/knife/tarsnap/core.rb

@@ -91,11 +91,13 @@ class Chef
         end
 
         def pending_nodes
-          @_pending_nodes || @_pending_nodes = Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k =~ /^__/}.map{|k,v| k.gsub(/^__/, '').gsub("_",".")}
+          @_pending_nodes || @_pending_nodes =
+            Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k =~ /^__/}.map{|k,v| k.gsub(/^__/, '').gsub("_",".")}
         end
 
         def tarsnap_nodes
-          @_tarsnap_nodes || @_tarsnap_nodes = Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k !~ /^__/}.map{|k,v| k.gsub("_",".")}
+          @_tarsnap_nodes || @_tarsnap_nodes =
+            Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k !~ /^__/}.map{|k,v| k.gsub("_",".")}
         end
 
         def fetch_node(fqdn)

data/lib/chef/knife/tarsnap_backup_dump.rb

@@ -25,8 +25,8 @@ class Chef
       banner "knife tarsnap backup dump NODE ARCHIVE PATTERN (options)"
 
       option :directory,
-        :short => "-D USERNAME",
-        :long => "--directory KEY",
+        :short => "-D DIRNAME",
+        :long => "--directory DIRNAME",
         :description => "Retrieve matching files into this local directory"
 
       def run

data/lib/chef/knife/tarsnap_key_export.rb

@@ -0,0 +1,77 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapKeyExport < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap key export (options)"
+
+      option :directory,
+        :short => "-D DIRNAME",
+        :long => "--directory DIRNAME",
+        :default => File.join(Dir.getwd, "tarsnap-keys-#{Time.now.utc.to_i}"),
+        :description => "Export into this local directory (default: tarsnap-keys-TIMESTAMP)"
+
+      def run
+
+        begin
+          Dir.mkdir(config[:directory], 0700)
+        rescue Errno::EEXIST => e
+          # continue...
+        end
+
+        tarsnap_nodes.each do |n|
+          keyfile = File.join(config[:directory], "#{n}.key")
+          if confirm_overwrite?(keyfile)
+            ui.msg "Exporting #{keyfile}"
+            File.write(keyfile, fetch_key(n))
+          end
+        end
+
+        ui.msg "Export finished!"
+
+      end
+
+      def confirm_overwrite?(file)
+        return true if config[:yes]
+
+        if File.exists?(file)
+          stdout.print "Overwrite #{file}? (Y/N) "
+          answer = stdin.readline
+          answer.chomp!
+          case answer
+          when "Y", "y"
+            true
+          when "N", "n"
+            self.msg("Skipping #{file}")
+            false
+          else
+            self.msg("I have no idea what to do with #{answer}")
+            self.msg("Just say Y or N, please.")
+            confirm(question)
+          end
+        end
+        true
+      end
+
+    end
+  end
+end

data/lib/knife-tarsnap/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Tarsnap
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-tarsnap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-07 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -39,6 +39,7 @@ files:
 - lib/chef/knife/tarsnap_backup_dump.rb
 - lib/chef/knife/tarsnap_backup_show.rb
 - lib/chef/knife/tarsnap_key_create.rb
+- lib/chef/knife/tarsnap_key_export.rb
 - lib/chef/knife/tarsnap_key_from_file.rb
 - lib/chef/knife/tarsnap_key_list.rb
 - lib/chef/knife/tarsnap_key_show.rb