Class: OsCtld::Container::Importer

Inherits:
Object
  • Object
show all
Includes:
OsCtl::Lib::Utils::Log, OsCtl::Lib::Utils::System
Defined in:
lib/osctld/container/importer.rb

Overview

An interface for reading tar archives generated by OsCtl::Lib::Container::Exporter

Constant Summary collapse

BLOCK_SIZE = 
32*1024

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pool, io, ct_id: nil, image_file: nil) ⇒ Importer

Returns a new instance of Importer.



15
16
17
18
19
20
 
# File 'lib/osctld/container/importer.rb', line 15

def initialize(pool, io, ct_id: nil, image_file: nil)
  @pool = pool
  @tar = Gem::Package::TarReader.new(io)
  @image_file = image_file
  @ct_id = ct_id
end

Instance Attribute Details

#image_file ⇒ Object (readonly, protected)

Returns the value of attribute image_file.



249
250
251
 
# File 'lib/osctld/container/importer.rb', line 249

def image_file
  @image_file
end

#metadata ⇒ Object (readonly, protected)

Returns the value of attribute metadata.



249
250
251
 
# File 'lib/osctld/container/importer.rb', line 249

def metadata
  @metadata
end

#pool ⇒ Object (readonly, protected)

Returns the value of attribute pool.



249
250
251
 
# File 'lib/osctld/container/importer.rb', line 249

def pool
  @pool
end

#tar ⇒ Object (readonly, protected)

Returns the value of attribute tar.



249
250
251
 
# File 'lib/osctld/container/importer.rb', line 249

def tar
  @tar
end

Instance Method Details

#close ⇒ Object 



244
245
246
 
# File 'lib/osctld/container/importer.rb', line 244

def close
  tar.close
end

#copy_file_to_disk(entry, dst) ⇒ Object (protected)

Copy file from the tar archive to disk

Parameters:

  • entry (Gem::Package::TarReader::Entry)
  • dst (String) 


389
390
391
392
393
 
# File 'lib/osctld/container/importer.rb', line 389

def copy_file_to_disk(entry, dst)
  File.open(dst, 'w', entry.header.mode & 07777) do |df|
    df.write(entry.read(BLOCK_SIZE)) until entry.eof?
  end
end

#create_datasets(builder, accept_existing: false) ⇒ Object

Create the root and all descendants datasets

Parameters:



193
194
195
196
197
198
199
 
# File 'lib/osctld/container/importer.rb', line 193

def create_datasets(builder, accept_existing: false)
  datasets(builder).each do |ds|
    next if accept_existing && ds.exist?

    builder.create_dataset(ds, mapping: true, parents: ds.root?)
  end
end

#create_new_user ⇒ User (protected)

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/osctld/container/importer.rb', line 287

def create_new_user
  name = ct_id

  db = DB::Users.find(name, pool)
  return db if db

  # The user does not exist, create him
  Commands::User::Create.run!(
    pool: pool.name,
    name: name,
    standalone: false,
  )

  DB::Users.find(name, pool) || (fail 'expected user')
end

#ct_id ⇒ Object 



51
52
53
 
# File 'lib/osctld/container/importer.rb', line 51

def ct_id
  @ct_id || metadata['container']
end

#datasets(builder) ⇒ Array<OsCtl::Lib::Zfs::Dataset>

Parameters:

Returns:

  • (Array<OsCtl::Lib::Zfs::Dataset>) 


233
234
235
236
237
238
239
240
241
242
 
# File 'lib/osctld/container/importer.rb', line 233

def datasets(builder)
  return @datasets if @datasets

  @datasets = [builder.ctrc.dataset] + metadata['datasets'].map do |name|
    OsCtl::Lib::Zfs::Dataset.new(
      File.join(builder.ctrc.dataset.name, name),
      base: builder.ctrc.dataset.name,
    )
  end
end

#get_container_config ⇒ Hash

Returns:

  • (Hash) 


124
125
126
 
# File 'lib/osctld/container/importer.rb', line 124

def get_container_config
  OsCtl::Lib::ConfigFile.load_yaml(tar.seek('config/container.yml') { |entry| entry.read })
end

#get_or_create_group ⇒ Group

Load the group from the archive and register it, or create a new group

If a group with the same name already exists and all its parameters are the same, the existing group is returned. Otherwise an exception is raised.

Returns:



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/osctld/container/importer.rb', line 146

def get_or_create_group
  if has_group?
    name = metadata['group']

    db = DB::Groups.find(name, pool)
    grp = load_group

    if db.nil?
      # The group does not exist, create it
      Commands::Group::Create.run!(
        pool: pool.name,
        name: grp.name
      )

      return DB::Groups.find(name, pool) || (fail 'expected group')
    end

    db

  else
    DB::Groups.default(pool)
  end
end

#get_or_create_user ⇒ User

Load the user from the archive and register him, or create a new user

If a user with the same name already exists and all his parameters are the same, the existing user is returned. Otherwise an exception is raised.

Returns:



133
134
135
136
137
138
139
 
# File 'lib/osctld/container/importer.rb', line 133

def get_or_create_user
  if has_user?
    load_or_create_user
  else
    create_new_user
  end
end

#group_name ⇒ Object 



43
44
45
 
# File 'lib/osctld/container/importer.rb', line 43

def group_name
  metadata['group']
end

#has_ct_id? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/osctld/container/importer.rb', line 55

def has_ct_id?
  !ct_id.nil?
end

#has_group? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/osctld/container/importer.rb', line 47

def has_group?
  !group_name.nil?
end

#has_user? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/osctld/container/importer.rb', line 39

def has_user?
  !user_name.nil?
end

#import_all_datasets(builder) ⇒ Object

Import all datasets

Parameters:



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/osctld/container/importer.rb', line 203

def import_all_datasets(builder)
  case metadata['format']
  when 'zfs'
    import_streams(builder, datasets(builder))

  when 'tar'
    unpack_rootfs(builder)

  else
    fail "unsupported archive format '#{metadata['format']}'"
  end
end

#import_root_dataset(builder) ⇒ Object

Import just the root dataset

Parameters:



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/osctld/container/importer.rb', line 218

def import_root_dataset(builder)
  case metadata['format']
  when 'zfs'
    import_streams(builder, [datasets(builder).first])

  when 'tar'
    unpack_rootfs(builder)

  else
    fail "unsupported archive format '#{metadata['format']}'"
  end
end

#import_stream(builder, ds, name, required) ⇒ Object (protected) 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/osctld/container/importer.rb', line 353

def import_stream(builder, ds, name, required)
  fail "image_file needs to be set for import_stream()" if image_file.nil?

  found = nil

  stream_names(name).each do |file, compression|
    tf = tar.find { |entry| entry.full_name == file }

    if tf.nil?
      tar.rewind
      next
    end

    found = [tf, compression]
    break
  end

  if found.nil?
    tar.rewind
    fail "unable to import: #{name} not found" if required
    return
  end

  entry, compression = found
  builder.from_tar_stream(image_file, entry.full_name, compression, ds)
  tar.rewind
end

#import_streams(builder, datasets) ⇒ Object (protected)

Load ZFS data streams from the archive and write them to appropriate datasets

Parameters:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/osctld/container/importer.rb', line 308

def import_streams(builder, datasets)
  datasets.each do |ds|
    import_stream(builder, ds, File.join(ds.relative_name, 'base'), true)
    import_stream(builder, ds, File.join(ds.relative_name, 'incremental'), false)
  end

  tar.seek('snapshots.yml') do |entry|
    snapshots = OsCtl::Lib::ConfigFile.load_yaml(entry.read)

    datasets(builder).each do |ds|
      snapshots.each { |snap| zfs(:destroy, nil, "#{ds}@#{snap}") }
    end
  end
end

#install_user_hook_scripts(ct) ⇒ Object

Load user-defined script hooks from the archive and install them

Parameters:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/osctld/container/importer.rb', line 172

def install_user_hook_scripts(ct)
  tar.each do |entry|
    next if !entry.full_name.start_with?('hooks/')

    name = entry.full_name[ ('hooks/'.length-1) .. -1 ]

    if entry.directory?
      FileUtils.mkdir_p(
        File.join(ct.user_hook_script_dir, name),
        mode: entry.header.mode & 07777,
      )
    elsif entry.file?
      copy_file_to_disk(entry, File.join(ct.user_hook_script_dir, name))
    end
  end
end

#load_ct(opts) ⇒ Container

Create a new instance of OsCtld::Container as described by the tar archive

The returned CT is not registered in the internal database, it may even conflict with a CT already registered in the database.

Parameters:

  • opts (Hash) —

    options

Options Hash (opts):

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/osctld/container/importer.rb', line 106

def load_ct(opts)
  id = opts[:id] || metadata['container']
  user = opts[:user] || get_or_create_user
  group = opts[:group] || get_or_create_group
  ct_opts = opts[:ct_opts] || {}
  ct_opts[:load_from] = tar.seek('config/container.yml') { |entry| entry.read }

  Container.new(
    pool,
    id,
    user,
    group,
    opts[:dataset] || Container.default_dataset(pool, id),
    ct_opts
  )
end

#load_group ⇒ Group?

Create a new instance of Group as described by the tar archive

The returned group is not registered in the internal database, it may even conflict with a group already registered in the database.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/osctld/container/importer.rb', line 81

def load_group
  if has_group?
    Group.new(
      pool,
      metadata['group'],
      config: tar.seek('config/group.yml') { |entry| entry.read },
      devices: false
    )
  else
    nil
  end
end

#load_metadata ⇒ Object

Load metadata describing the archive

Loading the metadata is the first thing that should be done, because all other methods depend on its result.



26
27
28
29
30
31
32
33
 
# File 'lib/osctld/container/importer.rb', line 26

def load_metadata
  ret = tar.seek('metadata.yml') do |entry|
    OsCtl::Lib::ConfigFile.load_yaml(entry.read)
  end
  fail 'metadata.yml not found' unless ret
  @metadata = ret
  ret
end

#load_or_create_user ⇒ User (protected)

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/osctld/container/importer.rb', line 252

def load_or_create_user
  name = metadata['user']

  db = DB::Users.find(name, pool)
  u = load_user

  if db.nil?
    # The user does not exist, create him
    Commands::User::Create.run!(
      pool: pool.name,
      name: u.name,
      ugid: u.ugid,
      uid_map: u.uid_map.export,
      gid_map: u.gid_map.export,
    )

    return DB::Users.find(name, pool) || (fail 'expected user')
  end

  # Free the newly allocated ugid, use ugid from the existing user
  UGidRegistry.remove(u.ugid) if u.ugid != db.ugid

  %i(uid_map gid_map).each do |param|
    mine = db.send(param)
    other = u.send(param)
    next if mine == other

    fail "user #{pool.name}:#{name} already exists: #{param} mismatch: "+
         "existing #{mine}, trying to import #{other}"
  end

  db
end

#load_user ⇒ User?

Create a new instance of User as described by the tar archive

The returned user is not registered in the internal database, it may even conflict with a user already registered in the database.

Returns:



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/osctld/container/importer.rb', line 64

def load_user
  if has_user?
    User.new(
      pool,
      metadata['user'],
      config: tar.seek('config/user.yml') { |entry| entry.read }
    )
  else
    nil
  end
end

#stream_names(name) ⇒ Object (protected) 



381
382
383
384
 
# File 'lib/osctld/container/importer.rb', line 381

def stream_names(name)
  base = File.join('rootfs', "#{name}.dat")
  [[base, :off], ["#{base}.gz", :gzip]]
end

#unpack_rootfs(builder) ⇒ Object (protected)

Parameters:



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/osctld/container/importer.rb', line 324

def unpack_rootfs(builder)
  fail "image_file needs to be set for import_stream()" if image_file.nil?

  # Ensure the dataset is mounted
  builder.ctrc.dataset.mount(recursive: true)

  # Create private/
  builder.setup_rootfs

  tf = tar.find { |entry| entry.full_name == 'rootfs/base.tar.gz' }
  fail 'rootfs archive not found' if tf.nil?
  tar.rewind

  commands = [
    ['tar', '-xOf', image_file, tf.full_name],
    ['tar', '--xattrs-include=security.capability', '--xattrs', '-xz', '-C', builder.ctrc.rootfs],
  ]

  command_string = commands.map { |c| c.join(' ') }.join(' | ')

  pid = Process.spawn(command_string)
  Process.wait(pid)

  if $?.exitstatus != 0
    fail "failed to unpack rootfs: command '#{command_string}' "+
         "exited with #{$?.exitstatus}"
  end
end

#user_name ⇒ Object 



35
36
37
 
# File 'lib/osctld/container/importer.rb', line 35

def user_name
  metadata['user']
end