knife-ec-backup 0.9.6 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d743d3c24edc2f864712dc85b514c6bd4cb2e8ac
-  data.tar.gz: 252ddd602cbd529f553452017ac5d15ab71e840d
+  metadata.gz: 80ef809cf9b6913773b6359560563034d86afed2
+  data.tar.gz: e2daaccc75106518a75e027c87d37df7c4e0ca55
 SHA512:
-  metadata.gz: 597e0846978c7eb975b6b54bad856c132165a84846f379716a9ed9529659e3f93c4745548a7c5aa5c38f38c94399001cc8152f95d423c52149e3bf0e5918235c
-  data.tar.gz: e2f96abddc1c81cbb58a1ae78dd271f1b560134297bb70aaadce62adc969a1285d45ea1c32183a5f80263cb27f4238984e6fb3e0943f083c53e78fb4824da793
+  metadata.gz: 55efc9670ec8899eb1940fbaa88b92becbed3c4fd1c0377385873892740da213389ceca8d82f60f8b36b83d662ee6518bc66c15a71951cc01596013c4a23e9b2
+  data.tar.gz: 65dc9db1074a0c2997e7390224abae16c9264c72bf61ff0c3379ce05f2012ee60907708a6f03bb32f09f8bcc6de0efdfb6098a7ff20fca4d37a79dfb51f43542

data/README.md

@@ -0,0 +1,108 @@
+# knife EC backup
+
+# Description
+
+This is an UNOFFICIAL and EXPERIMENTAL knife plugin intended to back up and restore an entire Enterprise Chef / Private Chef server, preserving the data in an intermediate, editable text format.
+
+# Installation
+
+This knife plugin is packaged as a gem.  To install it, clone the
+git repository and run the following:
+
+    gem build knife-ec-backup.gemspec
+    gem install knife-ec-backup-0.9.6.gem
+
+# Configuration
+
+## knife.rb
+Unlike other knife subcommands the subcommands in the knife-ec-backup plugin make API calls against the root of your EC installations API endpoint.
+
+Typically the chef_server_url for your OPC installation may look like this:
+
+    chef_server_url https://chef.yourdomain.com/organizations/ORGNAME
+
+To configure knife-ec-backup, set the `chef_server_root` option to the root of your OPC installation:
+
+    chef_server_root https://chef.yourdomain.com/
+
+Note that most users in an EC installation lack the permissions to pull most of the data from all organizations and other users.
+
+# Subcommands
+
+## knife ec backup DEST_DIR WEBUI_KEY \[USER_ACL_REST\] (options)
+
+*Options*
+
+  * `--concurrency`:
+    Maximum number of simultaneous requests to send (default: 10)
+  * `--skip-useracl`:
+    Whether to skip downloading User ACLs.  This is required for EC 11.0.0 and lower (default: false)
+
+Creates a repository of an entire Enterprise Chef / Private Chef server.
+
+The format of the repository is based on the `knife-essentials` (`knife download`) format and looks like this:
+
+    users
+      <name>.json
+    user_acls
+      <name>.json
+    organizations
+      <orgname>
+        acls
+          <type>
+            <name>.json
+        clients
+          <name>.json
+        containers
+          <name>.json
+        cookbooks
+          <name>-<version>
+        data_bags
+          <bag name>
+            <item name>
+        environments
+          <name>.json
+        groups
+          <name>.json
+        nodes
+          <name>.json
+        roles
+          <name>.json
+        org.json
+        members.json
+        invitations.json
+
+This compares very closely with the "knife download /" from an OSC server:
+
+    clients
+      <name>.json
+    cookbooks
+      <name>-<version>
+    data_bags
+      <bag name>
+        <item name>
+    environments
+      <name>.json
+    nodes
+      <name>.json
+    roles
+      <name>.json
+    users
+      <name>.json>
+
+## knife ec restore DEST_DIR WEBUI_KEY \[USER_ACL_REST\] (options)
+
+*Options*
+
+  * `--concurrency`:
+    Maximum number of simultaneous requests to send (default: 10)
+  * `--overwrite-pivotal`:
+    Whether to overwrite pivotal's key.  Once this is done, future requests will fail until you fix the private key (default: false)
+  * `--skip-useracl`:
+    Whether to skip downloading User ACLs.  This is required for EC 11.0.0 and lower (default: false)
+
+Restores all data from a repository to an Enterprise Chef / Private Chef server.
+
+# TODO
+
+* Prevent 403 error for Billing Admins ACL as it is downloaded in another method.

data/lib/chef/knife/ec_backup.rb

@@ -9,6 +9,12 @@ class Chef
         :long => '--concurrency THREADS',
         :description => 'Maximum number of simultaneous requests to send (default: 10)'
 
+      option :skip_useracl,
+        :long => '--skip-useracl',
+        :boolean => true,
+        :default => false,
+        :description => "Whether to skip downloading User ACLs.  This is required for EC 11.0.0 and lower"
+
       deps do
         require 'chef_fs/config'
         require 'chef_fs/file_system'
@@ -30,7 +36,7 @@ class Chef
 
         dest_dir = name_args[0]
         webui_key = name_args[1]
-        rest = Chef::REST.new(Chef::Config.chef_server_url)
+        rest = Chef::REST.new(Chef::Config.chef_server_root)
         if name_args.length >= 3
           user_acl_rest = Chef::REST.new(name_args[2])
         else
@@ -46,6 +52,12 @@ class Chef
           File.open("#{dest_dir}/users/#{name}.json", 'w') do |file|
             file.write(Chef::JSONCompat.to_json_pretty(rest.get_rest(url)))
           end
+
+          if config[:skip_useracl]
+            ui.warn("Skipping user ACL download for #{name}. To download this ACL, remove --skip-useracl.")
+            next
+          end
+
           File.open("#{dest_dir}/user_acls/#{name}.json", 'w') do |file|
             file.write(Chef::JSONCompat.to_json_pretty(user_acl_rest.get_rest("users/#{name}/_acl")))
           end
@@ -83,7 +95,7 @@ class Chef
       end
 
       PATHS = %w(chef_repo_path cookbook_path environment_path data_bag_path role_path node_path client_path acl_path group_path container_path)
-      CONFIG_VARS = %w(chef_server_url custom_http_headers node_name client_key) + PATHS
+      CONFIG_VARS = %w(chef_server_url chef_server_root custom_http_headers node_name client_key versioned_cookbooks) + PATHS
       def download_org(dest_dir, webui_key, name)
         old_config = {}
         CONFIG_VARS.each do |key|
@@ -95,18 +107,17 @@ class Chef
             Chef::Config[path_var.to_sym] = nil
           end
           Chef::Config.chef_repo_path = "#{dest_dir}/organizations/#{name}"
+          Chef::Config.versioned_cookbooks = true
 
-          Chef::Config.chef_server_url = "#{Chef::Config.chef_server_url}/organizations/#{name}"
+          Chef::Config.chef_server_url = "#{Chef::Config.chef_server_root}/organizations/#{name}"
 
           ensure_dir(Chef::Config.chef_repo_path)
 
           # Download the billing-admins acls as pivotal
           chef_fs_config = ::ChefFS::Config.new
-          %w(/acls/groups/billing-admins.json).each do |name|
-            pattern = ::ChefFS::FilePattern.new(name) 
-            if ::ChefFS::FileSystem.copy_to(pattern, chef_fs_config.local_fs, chef_fs_config.chef_fs, nil, config, ui, proc { |entry| chef_fs_config.format_path(entry) })
-              @error = true
-            end
+          pattern = ::ChefFS::FilePattern.new('/acls/groups/billing-admins.json') 
+          if ::ChefFS::FileSystem.copy_to(pattern, chef_fs_config.chef_fs, chef_fs_config.local_fs, nil, config, ui, proc { |entry| chef_fs_config.format_path(entry) })
+            @error = true
           end
 
           # Figure out who the admin is so we can spoof him and retrieve his stuff

data/lib/chef/knife/ec_restore.rb

@@ -15,6 +15,13 @@ class Chef
         :default => false,
         :description => "Whether to overwrite pivotal's key.  Once this is done, future requests will fail until you fix the private key."
 
+      option :skip_useracl,
+        :long => '--skip-useracl',
+        :boolean => true,
+        :default => false,
+        :description => "Whether to skip restoring User ACLs.  This is required for EC 11.0.2 and lower"
+
+
       deps do
         require 'chef/json_compat'
         require 'chef_fs/config'
@@ -40,7 +47,7 @@ class Chef
 
         dest_dir = name_args[0]
         webui_key = name_args[1]
-        rest = Chef::REST.new(Chef::Config.chef_server_url)
+        rest = Chef::REST.new(Chef::Config.chef_server_root)
         if name_args.length >= 3
           user_acl_rest = Chef::REST.new(name_args[2])
         else
@@ -72,10 +79,6 @@ class Chef
             end
           end
 
-          # Update user acl
-          # Doesn't work at present due to server
-          #user_acl = JSONCompat.from_json(IO.read("#{dest_dir}/user_acls/#{name}.json"))
-          #put_acl(user_acl_rest, "users/#{name}/_acl", user_acl)
         end
 
         # Restore organizations
@@ -126,13 +129,33 @@ class Chef
           upload_org(dest_dir, webui_key, name)
         end
 
+        # Restore user ACLs
+        puts "Restoring user ACLs ..."
+        Dir.foreach("#{dest_dir}/users") do |filename|
+          next if filename !~ /(.+)\.json/
+          name = $1
+          if config[:skip_useracl]
+            ui.warn("Skipping user ACL update for #{name}. To update this ACL, remove --skip-useracl.")
+            next
+          end
+          if name == 'pivotal' && !config[:overwrite_pivotal]
+            ui.warn("Skipping pivotal update.  To overwrite pivotal, pass --overwrite-pivotal.  Once pivotal is updated, you will need to modify #{Chef::Config.client_key} to be the corresponding private key.")
+            next
+          end
+
+          # Update user acl
+          user_acl = JSONCompat.from_json(IO.read("#{dest_dir}/user_acls/#{name}.json"))
+          put_acl(user_acl_rest, "users/#{name}/_acl", user_acl)          
+        end
+
+
         if @error
           exit 1
         end
       end
 
       PATHS = %w(chef_repo_path cookbook_path environment_path data_bag_path role_path node_path client_path acl_path group_path container_path)
-      CONFIG_VARS = %w(chef_server_url custom_http_headers node_name client_key) + PATHS
+      CONFIG_VARS = %w(chef_server_url chef_server_root custom_http_headers node_name client_key versioned_cookbooks) + PATHS
       def upload_org(dest_dir, webui_key, name)
         old_config = {}
         CONFIG_VARS.each do |key|
@@ -144,8 +167,9 @@ class Chef
             Chef::Config[path_var.to_sym] = nil
           end
           Chef::Config.chef_repo_path = "#{dest_dir}/organizations/#{name}"
+          Chef::Config.versioned_cookbooks = true
 
-          Chef::Config.chef_server_url = "#{Chef::Config.chef_server_url}/organizations/#{name}"
+          Chef::Config.chef_server_url = "#{Chef::Config.chef_server_root}/organizations/#{name}"
 
           # Upload the admins group and billing-admins acls
           chef_fs_config = ::ChefFS::Config.new

data/lib/knife_ec_backup/version.rb

@@ -1,3 +1,3 @@
 module KnifeECBackup
-  VERSION = '0.9.6'
-end
+  VERSION = '1.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-ec-backup
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: '1.0'
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec