knife-backup 0.0.8 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04b6c3af80a1e59f1a86f7d5e28302fe9e1db33a
-  data.tar.gz: 558fee3f51e25c3df03258627361085e7ecfdcfb
+  metadata.gz: e3b74fdf9a67ae00a32a68e1b37201dd7d27e318
+  data.tar.gz: 0cfa2a717cc5223e068424beab952813c250805a
 SHA512:
-  metadata.gz: e775afdf8af2aa7bdca73c118f864e81c830b54f8a9e20562c6dc670d5fd841e69ef81e88db75f4915d0040a52244f28fa798a265a89997f4b49049526f90988
-  data.tar.gz: 21e76c6903269dc2a0f8cb5f9269a56df36d4c762f41d4dd680922288d5c81301590a3744ebdef26ad322a200bac865d65b1e67f97c705a5c2bcf1c56ed83aec
+  metadata.gz: 766023ac2102bc799dd8eb27af1bf53b3175ecb601007722411ca2ff88609c463ea390adf0f2df22a89e262e88699fc1e7ac9a99824a1e83ccadee8811548ef9
+  data.tar.gz: 2bd111ebe9cb9a58526293976d30a33ad92ca915ae69c7adbd164d9bb085fa49e13876945dafbbcbd4f406983263345cfd05a72585d0135396e4a31832dc2ae7

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
 .bundle
+.chef
 Gemfile.lock
 pkg/*
+bin/

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in knife-backup.gemspec
 gemspec

data/README.md

@@ -4,6 +4,7 @@ Knife-Backup
 Knife-Backup is a [Knife](http://wiki.opscode.com/display/chef/Knife) plugin that can help you backup and restore a chef server. It is based on the great work of [Steven Danna][stevendanna] and [Joshua Timberman][jtimberman] on the [BackupExport][backup_export] and [BackupRestore][backup_restore] plugins. Currently knife-backup has support for the following objects:
 
   * clients
+  * users (chef 11 - Open Source)
   * nodes
   * roles
   * environments
@@ -12,7 +13,9 @@ Knife-Backup is a [Knife](http://wiki.opscode.com/display/chef/Knife) plugin tha
 
 knife-backup will backup all cookbook versions available on the chef server. Cookbooks are normally available in a repository and should be easy to upload like that, but if you are using various cookbook versions in each environment then it might not be so trivial to find and upload them back to the server; downloading them and having them available to upload like that is simple and clean. If you have too many cookbook [versions](http://www.ducea.com/2013/02/26/knife-cleanup/) then you might want to cleanup them first using something like [knife-cleanup][knifecleanup]
 
-*Known limitation*: currently it is not possible to overwritte a client object already available on the target server and these will be skipped. 
+Users are a bit tricky, knife-backup can't gather the crypted passwords via the chef server so it's forced to reset them to a random string on restore. Be sure to copy them from the restore output or reset them.
+
+*Known limitation*: currently it is not possible to overwrite a client object already available on the target server and these will be skipped.
 
 ## Installation
 
@@ -24,25 +27,36 @@ gem install knife-backup
 
 ## Usage
 
-For a list of commands:
+Currently the available commands are:
 
 ```bash
-knife backup --help
+knife backup export [component component ...] [-D DIR] [options]
+knife backup restore [component component ...] [-D DIR]
+
+#Example:
+knife backup export cookbooks roles environments -D ~/my_chef_backup
 ```
+#### Optional Switches for export
 
-Currently the available commands are:
+- `-N`, `--latest` only download the latest version of a cookbook
+- `-I`, `--ignore-permissions` ignore any permission errors during export
+
+#### Optional Switches for restore
+
+- `-I`, `--ignore-metadata-errors` Ignore json metadata errors when restoring cookbooks
+
+
+For more information on commands:
 
 ```bash
-knife backup export [-D DIR]
-knife backup restore [-D DIR]
+knife backup SUB-COMMAND --help
 ```
 
 Note: you should treat this as beta software; I'm using it with success for my needs and hopefully you will find it useful too.
 
 ## Todo/Ideas
-  
+
   * Timestamp for the backup folder
-  * Limit the backup to just some objects (for ex, just backup the cookbooks or just the nodes)
   * Track the failed downloads and report them at the end
   * Find out if there is a way to overwrite a client object.
 

data/knife-backup.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/mdxp/knife-backup"
   s.summary     = %q{Chef knife plugins to help backup and restore chef servers}
   s.description = s.summary
+  s.license     = "Apache 2.0"
 
   s.rubyforge_project = "knife-backup"
 

data/lib/chef/knife/backup_export.rb

@@ -19,6 +19,10 @@
 
 require 'chef/node'
 require 'chef/api_client'
+
+if Chef::VERSION =~ /^11\./
+  require 'chef/user'
+end
 require 'chef/knife/cookbook_download'
 
 module ServerBackup
@@ -32,16 +36,22 @@ module ServerBackup
     banner "knife backup export [COMPONENT [COMPONENT ...]] [-D DIR] (options)"
 
     option :backup_dir,
-    :short => "-D DIR",
-    :long => "--backup-directory DIR",
-    :description => "Store backup data in DIR.  DIR will be created if it does not already exist.",
-    :default => Chef::Config[:knife][:chef_server_backup_dir] ? Chef::Config[:knife][:chef_server_backup_dir] : File.join(".chef", "chef_server_backup")
+      :short => "-D DIR",
+      :long => "--backup-directory DIR",
+      :description => "Store backup data in DIR.  DIR will be created if it does not already exist.",
+      :default => Chef::Config[:knife][:chef_server_backup_dir] ? Chef::Config[:knife][:chef_server_backup_dir] : File.join(".chef", "chef_server_backup")
 
     option :latest,
-     :short => "-N",
-     :long => "--latest",
-     :description => "The version of the cookbook to download",
-     :boolean => true
+      :short => "-N",
+      :long => "--latest",
+      :description => "The version of the cookbook to download",
+      :boolean => true
+
+    option :ignore_perm,
+      :short => "-I",
+      :long => "--ignore-permissions",
+      :description => "Continue in case a permission problem occurs",
+      :boolean => true
 
     def run
       validate!
@@ -50,7 +60,8 @@ module ServerBackup
     end
 
     private
-    COMPONENTS = %w(clients nodes roles data_bags environments cookbooks)
+    COMPONENTS = %w(clients users nodes roles data_bags environments cookbooks)
+    LOAD_TRIES = 5
 
     def validate!
       bad_names = name_args - COMPONENTS
@@ -68,6 +79,14 @@ module ServerBackup
       backup_standard("clients", Chef::ApiClient)
     end
 
+    def users
+      if Chef::VERSION =~ /^1[1]\./
+        backup_standard("users", Chef::User)
+      else
+        ui.warn "users export only supported on chef == 11"
+      end
+    end
+
     def roles
       backup_standard("roles", Chef::Role)
     end
@@ -99,14 +118,34 @@ module ServerBackup
       klass.list.each do |component_name, url|
         next if component == "environments" && component_name == "_default"
         ui.msg "Backing up #{component} #{component_name}"
-        component_obj = klass.load(component_name)
+        component_obj = load_object(klass, component_name).to_hash
+        unless component_obj
+          ui.error "Could not load #{klass} #{component_name}."
+          next
+        end
         File.open(File.join(dir, "#{component_name}.json"), "w") do |component_file|
-          #component_file.print(component_obj.to_json)
           component_file.print(JSON.pretty_generate(component_obj))
         end
       end
     end
 
+    def load_object(klass, name, try = 1)
+      klass.load(name)
+    rescue NoMethodError
+      ui.warn "Problem loading #{klass} #{name}. Try #{try}/#{LOAD_TRIES}"
+      if try < LOAD_TRIES
+        try += 1
+        load_object(klass, name, try)
+      end
+    rescue Net::HTTPServerException => e
+      if config[:ignore_perm]
+        ui.warn "Problem loading #{name} #{e.message}."
+        ui.warn "Possibly an issue with permissions on the chef server... Skipping"
+      else
+        raise
+      end
+    end
+
     def cookbooks
       ui.msg "Backing up cookbooks"
       dir = File.join(config[:backup_dir], "cookbooks")

data/lib/chef/knife/backup_restore.rb

@@ -32,27 +32,36 @@ module ServerBackup
       require 'chef/knife/core/object_loader'
       require 'chef/cookbook_uploader'
       require 'chef/api_client'
+      require 'securerandom'
+      require 'json'
     end
 
     banner "knife backup restore [COMPONENT [COMPONENT ...]] [-D DIR] (options)"
 
     option :backup_dir,
-    :short => "-D DIR",
-    :long => "--backup-directory DIR",
-    :description => "Restore backup data from DIR.",
-    :default => Chef::Config[:knife][:chef_server_backup_dir] ? Chef::Config[:knife][:chef_server_backup_dir] : File.join(".chef", "chef_server_backup")
+      :short => "-D DIR",
+      :long => "--backup-directory DIR",
+      :description => "Restore backup data from DIR.",
+      :default => Chef::Config[:knife][:chef_server_backup_dir] ? Chef::Config[:knife][:chef_server_backup_dir] : File.join(".chef", "chef_server_backup")
+
+    option :ignore_metadata_errors,
+      :short => "-I",
+      :long => "--ignore-metadata-errors",
+      :description => "Ignore json metadata errors when restoring cookbooks",
+      :boolean => true,
+      :default => Chef::Config[:knife][:ignore_metadata_errors] ? Chef::Config[:knife][:ignore_metadata_errors] : false
 
     def run
       ui.warn "This will overwrite existing data!"
       ui.warn "Backup is at least 1 day old" if (Time.now - File.atime(config[:backup_dir])) > 86400
-      ui.confirm "Do you want to restore backup, possibly overwriting exisitng data"
+      ui.confirm "Do you want to restore backup, possibly overwriting existing data"
       validate!
       components = name_args.empty? ? COMPONENTS : name_args
       Array(components).each { |component| self.send(component) }
     end
 
     private
-    COMPONENTS = %w(clients nodes roles data_bags environments cookbooks)
+    COMPONENTS = %w(clients users nodes roles data_bags environments cookbooks)
 
     def validate!
       bad_names = name_args - COMPONENTS
@@ -116,12 +125,14 @@ module ServerBackup
       ui.info "=== Restoring clients ==="
       clients = Dir.glob(File.join(config[:backup_dir], "clients", "*.json"))
       clients.each do |file|
+        ui.info "Restoring clients from #{file}"
         client = JSON.parse(IO.read(file))
         begin
           rest.post_rest("clients", {
             :name => client['name'],
             :public_key => client['public_key'],
-            :admin => client['admin']
+            :admin => client['admin'],
+            :validator => client['validator']
           })
         rescue Net::HTTPServerException => e
           handle_error 'client', client['name'], e
@@ -129,32 +140,83 @@ module ServerBackup
       end
     end
 
+    def users
+      JSON.create_id = "no_thanks"
+      ui.info "=== Restoring users ==="
+      users = Dir.glob(File.join(config[:backup_dir], "users", "*.json"))
+      if !users.empty? and Chef::VERSION !~ /^11\./
+        ui.warn "users restore only supported on chef == 11"
+        return
+      end
+      users.each do |file|
+        user = JSON.parse(IO.read(file))
+        password = SecureRandom.hex[0..7]
+        begin
+          rest.post_rest("users", {
+            :name => user['name'],
+            :public_key => user['public_key'],
+            :admin => user['admin'],
+            :password => password
+          })
+          ui.info "Set password for #{user['name']} to #{password}, please update"
+        rescue Net::HTTPServerException => e
+          handle_error 'user', user['name'], e
+        end
+      end
+    end
+
     def cookbooks
+      count = 0
       ui.info "=== Restoring cookbooks ==="
       cookbooks = Dir.glob(File.join(config[:backup_dir], "cookbooks", '*'))
+      #Make tmp dir
+      FileUtils.rm_rf(config[:backup_dir] + "/tmp")
+      Dir.mkdir config[:backup_dir] + "/tmp"
       cookbooks.each do |cb|
-        full_cb = cb.split("/").last
-        cookbook = full_cb.reverse.split('-',2).last.reverse
-        full_path = File.join(config[:backup_dir], "cookbooks", cookbook)
-
+        full_cb = File.expand_path(cb)
+        cb_name = File.basename(cb)
+        cookbook = cb_name.reverse.split('-',2).last.reverse
+        full_path = File.join(config[:backup_dir] + "/tmp", cookbook)
         begin
-          File.symlink(full_cb, full_path)
+          count += 1
+          if Chef::Platform.windows?
+            Dir.mkdir config[:backup_dir] + "/tmp/#{cb_name}"
+            full_path = File.join(config[:backup_dir] + "/tmp/#{cb_name}", cookbook)
+            ui.info "Copy cookbook #{full_cb} to #{full_path}"
+            FileUtils.copy_entry(full_cb, full_path)
+          else
+            full_path = File.join(config[:backup_dir] + "/tmp", cookbook)
+            File.symlink(full_cb, full_path)
+          end
           cbu = Chef::Knife::CookbookUpload.new
           Chef::Knife::CookbookUpload.load_deps
           cbu.name_args = [ cookbook ]
-          cbu.config[:cookbook_path] = File.join(config[:backup_dir], "cookbooks")
+          cbu.config[:cookbook_path] = File.dirname(full_path)
           ui.info "Restoring cookbook #{cbu.name_args}"
           cbu.run
         rescue Net::HTTPServerException => e
-          handle_error 'cookbook', full_cb, e
+          handle_error 'cookbook', cb_name, e
+        rescue Chef::Exceptions::JSON::ParseError => e
+          handle_error 'cookbook', cb_name, e
+          throw e unless config[:ignore_metadata_errors]
         ensure
-          File.unlink(full_path)
+          if Chef::Platform.windows?
+            rm_path = config[:backup_dir] + "/tmp/#{cb_name}"
+            ui.info "remove dir #{rm_path}"
+            FileUtils.remove_dir(rm_path, force = true)
+          else
+            File.unlink(full_path)
+          end
         end
       end
+      ui.info "Uploaded #{count} Cookbooks"
+      FileUtils.rm_rf(config[:backup_dir] + "/tmp")
     end
 
     def handle_error(type, name, error)
       thing = "#{type}[#{name}]"
+      return ui.error "Error parsing JSON for: #{thing}" if error.kind_of?(Chef::Exceptions::JSON::ParseError)
+
       case error.response
       when Net::HTTPConflict # 409
         ui.warn "#{thing} already exists; skipping"

data/lib/knife-backup/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Backup
-    VERSION = "0.0.8"
+    VERSION = "0.0.12"
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: knife-backup
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.12
 platform: ruby
 authors:
 - Marius Ducea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.10
 description: Chef knife plugins to help backup and restore chef servers
@@ -31,7 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -42,7 +42,8 @@ files:
 - lib/knife-backup.rb
 - lib/knife-backup/version.rb
 homepage: https://github.com/mdxp/knife-backup
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -50,18 +51,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: knife-backup
-rubygems_version: 2.0.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Chef knife plugins to help backup and restore chef servers
 test_files: []
+has_rdoc: