Class: Chef::Knife::EcBackup

Inherits:
Chef::Knife show all
Includes:
EcBase
Defined in:
lib/chef/knife/ec_backup.rb

Constant Summary collapse

PATHS = 
%w(chef_repo_path cookbook_path environment_path data_bag_path role_path node_path client_path acl_path group_path container_path)

Instance Method Summary collapse

Methods included from EcBase

#configure_chef, #ensure_webui_key_exists!, included, #org_admin, #rest, #server, #set_client_config!, #set_dest_dir_from_args!, #set_skip_user_acl!, #user_acl_rest

Instance Method Details

#chef_fs_copy_pattern(pattern_str, chef_fs_config) ⇒ Object 



177
178
179
180
181
182
183
 
# File 'lib/chef/knife/ec_backup.rb', line 177

def chef_fs_copy_pattern(pattern_str, chef_fs_config)
  pattern = Chef::ChefFS::FilePattern.new(pattern_str)
  Chef::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) })
end

#chef_fs_paths(pattern_str, chef_fs_config, exclude = nil) ⇒ Object 



170
171
172
173
174
175
 
# File 'lib/chef/knife/ec_backup.rb', line 170

def chef_fs_paths(pattern_str, chef_fs_config, exclude=nil)
  pattern = Chef::ChefFS::FilePattern.new(pattern_str)
  list = Chef::ChefFS::FileSystem.list(chef_fs_config.chef_fs, pattern)
  list = list.select { |entry| entry.name != exclude } if ! exclude.nil?
  list.map {|entry| entry.path }
end

#download_org_data(name) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/chef/knife/ec_backup.rb', line 132

def download_org_data(name)
  old_config = Chef::Config.save

  begin
    # Clear out paths
    PATHS.each do |path|
      Chef::Config.delete(path.to_sym)
    end
    Chef::Config.chef_repo_path = "#{dest_dir}/organizations/#{name}"
    Chef::Config.versioned_cookbooks = true

    Chef::Config.chef_server_url = "#{server.root_url}/organizations/#{name}"

    ensure_dir(Chef::Config.chef_repo_path)

    # Download the billing-admins ACL and group as pivotal
    chef_fs_config = Chef::ChefFS::Config.new
    chef_fs_copy_pattern('/acls/groups/billing-admins.json', chef_fs_config)
    chef_fs_copy_pattern('/groups/billing-admins.json', chef_fs_config)
    chef_fs_copy_pattern('/groups/admins.json', chef_fs_config)

    # Set Chef::Config to use an organization administrator
    Chef::Config.node_name = org_admin

    # Download the entire org skipping the billing admins group ACL and the group itself
    chef_fs_config = Chef::ChefFS::Config.new
    top_level_paths = chef_fs_config.chef_fs.children.select { |entry| entry.name != 'acls' && entry.name != 'groups' }.map { |entry| entry.path }
    acl_paths       = chef_fs_paths('/acls/*', chef_fs_config, 'groups')
    group_acl_paths = chef_fs_paths('/acls/groups/*', chef_fs_config, 'billing-admins.json')
    group_paths     = chef_fs_paths('/groups/*', chef_fs_config, 'billing-admins.json')
    (top_level_paths + group_acl_paths + acl_paths + group_paths).each do |path|
      chef_fs_copy_pattern(path, chef_fs_config)
    end
  ensure
    Chef::Config.restore(old_config)
  end
end

#download_org_invitations(name) ⇒ Object 



118
119
120
121
122
123
 
# File 'lib/chef/knife/ec_backup.rb', line 118

def download_org_invitations(name)
  ensure_dir("#{dest_dir}/organizations/#{name}")
  File.open("#{dest_dir}/organizations/#{name}/invitations.json", 'w') do |file|
    file.write(Chef::JSONCompat.to_json_pretty(rest.get_rest("/organizations/#{name}/association_requests")))
  end
end

#download_org_members(name) ⇒ Object 



111
112
113
114
115
116
 
# File 'lib/chef/knife/ec_backup.rb', line 111

def download_org_members(name)
  ensure_dir("#{dest_dir}/organizations/#{name}")
  File.open("#{dest_dir}/organizations/#{name}/members.json", 'w') do |file|
    file.write(Chef::JSONCompat.to_json_pretty(rest.get_rest("/organizations/#{name}/users")))
  end
end

#download_user(username, url) ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/chef/knife/ec_backup.rb', line 75

def download_user(username, url)
  ensure_dir("#{dest_dir}/users")
  File.open("#{dest_dir}/users/#{username}.json", 'w') do |file|
    file.write(Chef::JSONCompat.to_json_pretty(rest.get_rest(url)))
  end
end

#download_user_acl(username) ⇒ Object 



82
83
84
85
86
87
 
# File 'lib/chef/knife/ec_backup.rb', line 82

def download_user_acl(username)
  ensure_dir("#{dest_dir}/user_acls")
  File.open("#{dest_dir}/user_acls/#{username}.json", 'w') do |file|
    file.write(Chef::JSONCompat.to_json_pretty(user_acl_rest.get_rest("users/#{username}/_acl")))
  end
end

#ensure_dir(dir) ⇒ Object 



125
126
127
128
129
 
# File 'lib/chef/knife/ec_backup.rb', line 125

def ensure_dir(dir)
  if !File.exist?(dir)
    FileUtils.mkdir_p(dir)
  end
end

#export_from_sql ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/chef/knife/ec_backup.rb', line 89

def export_from_sql
  require 'chef/knife/ec_key_export'
  Chef::Knife::EcKeyExport.deps
  k = Chef::Knife::EcKeyExport.new
  k.name_args = ["#{dest_dir}/key_dump.json", "#{dest_dir}/key_table_dump.json"]
  k.config[:sql_host] = config[:sql_host]
  k.config[:sql_port] = config[:sql_port]
  k.config[:sql_user] = config[:sql_user]
  k.config[:sql_password] = config[:sql_password]
  k.config[:skip_users_table] = !config[:with_user_sql]
  k.config[:skip_keys_table] = !config[:with_key_sql]
  k.run
end

#for_each_organization ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/chef/knife/ec_backup.rb', line 56

def for_each_organization
  rest.get_rest('/organizations').each_pair do |name, url|
    next unless (config[:org].nil? || config[:org] == name)
    ui.msg "Downloading organization object for #{name} from #{url}"
    org = rest.get_rest(url)
    # Enterprise Chef 11 and below uses a pool of precreated
    # organizations to account for slow organization creation
    # using CouchDB. Thus, on server versions < 12 we want to
    # skip any of these precreated organizations by checking if
    # they have been assigned or not.  The Chef 12 API does not
    # return an assigned_at field.
    if org['assigned_at'] || server.version >= Gem::Version.new("12")
      yield org
    else
      ui.msg "Skipping pre-created org #{name}"
    end
  end
end

#for_each_user ⇒ Object 



50
51
52
53
54
 
# File 'lib/chef/knife/ec_backup.rb', line 50

def for_each_user
  rest.get_rest('/users').each_pair do |name, url|
    yield name, url
  end
end

#run ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/chef/knife/ec_backup.rb', line 21

def run
  set_dest_dir_from_args!
  set_client_config!
  set_skip_user_acl!
  ensure_webui_key_exists!

  for_each_user do |username, url|
    download_user(username, url)
    if config[:skip_useracl]
      ui.warn("Skipping user ACL download for #{username}. To download this ACL, remove --skip-useracl or upgrade your Enterprise Chef Server.")
    else
      download_user_acl(username)
    end
  end

  if config[:with_user_sql] || config[:with_key_sql]
    export_from_sql
  end

  ensure_dir("#{dest_dir}/organizations")
  for_each_organization do |org_object|
    name = org_object['name']
    write_org_object_to_disk(org_object)
    download_org_data(name)
    download_org_members(name)
    download_org_invitations(name)
  end
end

#write_org_object_to_disk(org_object) ⇒ Object 



103
104
105
106
107
108
109
 
# File 'lib/chef/knife/ec_backup.rb', line 103

def write_org_object_to_disk(org_object)
  name = org_object['name']
  ensure_dir("#{dest_dir}/organizations/#{name}")
  File.open("#{dest_dir}/organizations/#{name}/org.json", 'w') do |file|
    file.write(Chef::JSONCompat.to_json_pretty(org_object))
  end
end