Class: OsCtld::Pool

Inherits:
Object
  • Object
show all
Includes:
OsCtl::Lib::Utils::File, OsCtl::Lib::Utils::Log, OsCtl::Lib::Utils::System, Assets::Definition, Lockable, Manipulable
Defined in:
lib/osctld/pool.rb

Overview

This class represents a data pool

Data pool contains users, groups and containers, both data and configuration. Each user/group/ct belongs to exactly one pool.

Constant Summary collapse

PROPERTY_ACTIVE =
'org.vpsadminos.osctl:active'
PROPERTY_DATASET =
'org.vpsadminos.osctl:dataset'
CT_DS =
'ct'
CONF_DS =
'conf'
HOOK_DS =
'hook'
LOG_DS =
'log'
REPOSITORY_DS =
'repository'
MIGRATION_DS =
'migration'
OPTIONS =
%i(parallel_start parallel_stop)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Assets::Definition

#define_assets

Methods included from Manipulable

#acquire_manipulation_lock, #init_manipulable, #is_being_manipulated?, #manipulate, #manipulated_by, #release_manipulation_lock

Methods included from Lockable

#exclusively, included, #inclusively, #init_lock, #lock, #unlock

Constructor Details

#initialize(name, dataset) ⇒ Pool

Returns a new instance of Pool.



35
36
37
38
39
40
41
42
43
# File 'lib/osctld/pool.rb', line 35

def initialize(name, dataset)
  init_lock
  init_manipulable

  @name = name
  @dataset = dataset || name
  @state = :importing
  @attrs = Attributes.new
end

Instance Attribute Details

#attrsObject (readonly)

Returns the value of attribute attrs.



32
33
34
# File 'lib/osctld/pool.rb', line 32

def attrs
  @attrs
end

#autostart_planObject (readonly)

Returns the value of attribute autostart_plan.



32
33
34
# File 'lib/osctld/pool.rb', line 32

def autostart_plan
  @autostart_plan
end

#datasetObject (readonly)

Returns the value of attribute dataset.



32
33
34
# File 'lib/osctld/pool.rb', line 32

def dataset
  @dataset
end

#nameObject (readonly)

Returns the value of attribute name.



32
33
34
# File 'lib/osctld/pool.rb', line 32

def name
  @name
end

#send_receive_key_chainObject (readonly)

Returns the value of attribute send_receive_key_chain.



32
33
34
# File 'lib/osctld/pool.rb', line 32

def send_receive_key_chain
  @send_receive_key_chain
end

#stateObject (readonly)

Returns the value of attribute state.



32
33
34
# File 'lib/osctld/pool.rb', line 32

def state
  @state
end

Instance Method Details

#active?Boolean

Returns:

  • (Boolean)


333
334
335
# File 'lib/osctld/pool.rb', line 333

def active?
  state == :active
end

#apparmor_dirObject



393
394
395
# File 'lib/osctld/pool.rb', line 393

def apparmor_dir
  File.join(run_dir, 'apparmor')
end

#assetsObject



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/osctld/pool.rb', line 62

def assets
  define_assets do |add|
    # Datasets
    add.dataset(
      ds(CT_DS),
      desc: 'Contains container root filesystems',
      user: 0,
      group: 0,
      mode: 0511
    )
    add.dataset(
      ds(CONF_DS),
      desc: 'Configuration files',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.dataset(
      ds(HOOK_DS),
      desc: 'User supplied script hooks',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.dataset(
      ds(LOG_DS),
      desc: 'Container log files, pool history',
      user: 0,
      group: 0,
      mode: 0511
    )
    add.dataset(
      ds(REPOSITORY_DS),
      desc: 'Local image repository cache',
      user: Repository::UID,
      group: 0,
      mode: 0500
    )
    add.dataset(
      ds(MIGRATION_DS),
      desc: 'Data for OS migrations',
      user: 0,
      group: 0,
      mode: 0500
    )

    # Configs
    add.directory(
      File.join(conf_path, 'pool'),
      desc: 'Pool configuration files for osctld',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.file(
      config_path,
      desc: 'Pool configuration file for osctld',
      optional: true
    )
    add.directory(
      File.join(conf_path, 'user'),
      desc: 'User configuration files for osctld',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.directory(
      File.join(conf_path, 'group'),
      desc: 'Group configuration files for osctld',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.directory(
      File.join(conf_path, 'ct'),
      desc: 'Container configuration files for osctld',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.directory(
      File.join(conf_path, 'send-receive'),
      desc: 'Identity and authorized keys for container send/receive',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.directory(
      File.join(conf_path, 'repository'),
      desc: 'Repository configuration files for osctld',
      user: 0,
      group: 0,
      mode: 0500
    )
    add.directory(
      File.join(conf_path, 'id-range'),
      desc: 'ID range configuration files for osctld',
      user: 0,
      group: 0,
      mode: 0500
    )

    # Logs
    add.directory(
      File.join(log_path, 'ct'),
      desc: 'Container log files',
      user: 0,
      group: 0
    )

    # Hooks
    add.directory(
      File.join(user_hook_script_dir, 'ct'),
      desc: 'User supplied container script hooks',
      user: 0,
      group: 0
    )

    # Pool history
    History.assets(pool, add)

    # Send/Receive
    send_receive_key_chain.assets(add)

    # Runstate
    add.directory(
      run_dir,
      desc: 'Runtime configuration',
      user: 0,
      group: 0,
      mode: 0711
    )
    add.directory(
      user_dir,
      desc: 'Contains user homes and LXC configuration',
      user: 0,
      group: 0,
      mode: 0511
    )
    add.directory(
      console_dir,
      desc: 'Sockets for container consoles',
      user: 0,
      group: 0,
      mode: 0711
    )
    add.directory(
      hook_dir,
      desc: 'Container hooks',
      user: 0,
      group: 0,
      mode: 0711
    )
    add.directory(
      mount_dir,
      desc: 'Mount helper directories for containers',
      user: 0,
      group: 0,
      mode: 0711
    )
    add.directory(
      apparmor_dir,
      desc: 'AppArmor files',
      user: 0,
      group: 0,
      mode: 0700
    )

    AppArmor.assets(add, pool)
  end
end

#autostartObject



325
326
327
# File 'lib/osctld/pool.rb', line 325

def autostart
  autostart_plan.start
end

#check_user_conflict(user) ⇒ Object (protected)



616
617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'lib/osctld/pool.rb', line 616

def check_user_conflict(user)
  DB::Users.sync do
    if u = DB::Users.by_ugid(user.ugid)
      log(
        :warn,
        "Unable to load user '#{user.name}': "+
        "user/group ID #{user.ugid} already taken by pool '#{u.pool.name}'"
      )
      return false
    end
  end

  true
end

#conf_pathObject



349
350
351
# File 'lib/osctld/pool.rb', line 349

def conf_path
  path(CONF_DS)
end

#config_pathObject



397
398
399
# File 'lib/osctld/pool.rb', line 397

def config_path
  File.join(conf_path, 'pool', 'config.yml')
end

#console_dirObject



385
386
387
# File 'lib/osctld/pool.rb', line 385

def console_dir
  File.join(run_dir, 'console')
end

#ct_dsObject



345
346
347
# File 'lib/osctld/pool.rb', line 345

def ct_ds
  ds(CT_DS)
end

#default_optsObject (protected)



420
421
422
423
424
425
# File 'lib/osctld/pool.rb', line 420

def default_opts
  {
    parallel_start: 2,
    parallel_stop: 4,
  }
end

#disableObject



341
342
343
# File 'lib/osctld/pool.rb', line 341

def disable
  @state = :disabled
end

#ds(path) ⇒ Object (protected)



637
638
639
# File 'lib/osctld/pool.rb', line 637

def ds(path)
  File.join(dataset, path)
end

#dump_optsObject (protected)



427
428
429
430
431
432
433
434
435
436
# File 'lib/osctld/pool.rb', line 427

def dump_opts
  ret = {}

  OPTIONS.each do |k|
    v = instance_variable_get("@#{k}")
    ret[k.to_s] = v unless v.nil?
  end

  ret
end

#ensure_limits(ct) ⇒ Object (protected)



631
632
633
634
635
# File 'lib/osctld/pool.rb', line 631

def ensure_limits(ct)
  if ct.prlimits.contains?('nofile')
    SystemLimits.ensure_nofile(ct.prlimits['nofile'].hard)
  end
end

#hook_dirObject



381
382
383
# File 'lib/osctld/pool.rb', line 381

def hook_dir
  File.join(run_dir, 'hooks')
end

#idObject



54
55
56
# File 'lib/osctld/pool.rb', line 54

def id
  name
end

#imported?Boolean

Returns:

  • (Boolean)


337
338
339
# File 'lib/osctld/pool.rb', line 337

def imported?
  state != :importing
end

#initObject



45
46
47
48
49
50
51
52
# File 'lib/osctld/pool.rb', line 45

def init
  exclusively do
    load_config

    @send_receive_key_chain = SendReceive::KeyChain.new(self)
    @autostart_plan = AutoStart::Plan.new(self)
  end
end

#load_configObject (protected)



410
411
412
413
414
415
416
417
418
# File 'lib/osctld/pool.rb', line 410

def load_config
  return unless File.exist?(config_path)

  cfg = YAML.load_file(config_path)

  @parallel_start = cfg['parallel_start']
  @parallel_stop = cfg['parallel_stop']
  @attrs = Attributes.load(cfg['attrs'] || {})
end

#load_ctsObject (protected)



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'lib/osctld/pool.rb', line 527

def load_cts
  log(:info, "Loading containers")

  ds_cache = OsCtl::Lib::Zfs::DatasetCache.new(
    OsCtl::Lib::Zfs::Dataset.new(ds(CT_DS)).list(properties: %w(name mountpoint))
  )

  ep = ExecutionPlan.new

  Dir.glob(File.join(conf_path, 'ct', '*.yml')).each do |f|
    ep << File.basename(f)[0..(('.yml'.length+1) * -1)]
  end

  nproc = Etc.nprocessors
  log(:info, "Going to load #{ep.length} containers, #{nproc} at a time")

  ep.run(nproc) do |ctid|
    log(:info, "Loading container #{ctid}")
    ct = Container.new(self, ctid, nil, nil, nil, dataset_cache: ds_cache)
    ensure_limits(ct)

    builder = Container::Builder.new(ct)
    builder.setup_lxc_home
    builder.setup_log_file

    ct.lxc_config.configure
    Monitor::Master.monitor(ct)
    Console.reconnect_tty0(ct) if ct.current_state == :running
    DB::Containers.add(ct)
  end

  ep.wait
  log(:info, "All containers loaded")
end

#load_groupsObject (protected)



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
# File 'lib/osctld/pool.rb', line 502

def load_groups
  log(:info, "Loading groups")
  DB::Groups.setup(self)

  rx = /^#{Regexp.escape(File.join(conf_path, 'group'))}(.*)\/config\.yml$/

  Dir.glob(File.join(conf_path, 'group', '**', 'config.yml')).each do |file|
    next unless rx =~ file
    name = $1
    next if ['', '/default'].include?(name)

    DB::Groups.add(Group.new(self, name, devices: false))
  end

  # The devices in the root group have to be configured as soon as possible,
  # because `echo a > devices.deny` will not work when the root cgroup has
  # any children.
  root = DB::Groups.root(self)

  # Initialize devices of all groups, from the root group down
  root.descendants.each do |grp|
    grp.devices.init
  end
end

#load_id_rangesObject (protected)



477
478
479
480
481
482
483
484
485
486
487
488
# File 'lib/osctld/pool.rb', line 477

def load_id_ranges
  log(:info, "Loading ID ranges")
  DB::IdRanges.setup(self)

  Dir.glob(File.join(conf_path, 'id-range', '*.yml')).each do |f|
    name = File.basename(f)[0..(('.yml'.length+1) * -1)]
    next if name == 'default'

    range = IdRange.new(self, name)
    DB::IdRanges.add(range)
  end
end

#load_repositoriesObject (protected)



562
563
564
565
566
567
568
569
570
571
572
573
# File 'lib/osctld/pool.rb', line 562

def load_repositories
  log(:info, "Loading repositories")
  DB::Repositories.setup(self)

  Dir.glob(File.join(conf_path, 'repository', '*.yml')).each do |f|
    name = File.basename(f)[0..(('.yml'.length+1) * -1)]
    next if name == 'default'

    repo = Repository.new(self, name)
    DB::Repositories.add(repo)
  end
end

#load_usersObject (protected)



490
491
492
493
494
495
496
497
498
499
500
# File 'lib/osctld/pool.rb', line 490

def load_users
  log(:info, "Loading users")

  Dir.glob(File.join(conf_path, 'user', '*.yml')).each do |f|
    name = File.basename(f)[0..(('.yml'.length+1) * -1)]
    u = User.new(self, name)
    next unless check_user_conflict(u)

    Commands::User::Setup.run!(user: u)
  end
end

#log_pathObject



353
354
355
# File 'lib/osctld/pool.rb', line 353

def log_path
  path(LOG_DS)
end

#log_typeObject



365
366
367
# File 'lib/osctld/pool.rb', line 365

def log_type
  "pool=#{name}"
end

#manipulation_resourceObject



369
370
371
# File 'lib/osctld/pool.rb', line 369

def manipulation_resource
  ['pool', name]
end

#mkdatasetsObject (protected)



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
# File 'lib/osctld/pool.rb', line 444

def mkdatasets
  log(:info, "Ensuring presence of base datasets and directories")
  zfs(:create, '-p', ds(CT_DS))
  zfs(:create, '-p', ds(CONF_DS))
  zfs(:create, '-p', ds(HOOK_DS))
  zfs(:create, '-p', ds(LOG_DS))
  zfs(:create, '-p', ds(REPOSITORY_DS))
  zfs(:create, '-p', ds(MIGRATION_DS))

  File.chmod(0511, path(CT_DS))
  File.chmod(0500, path(CONF_DS))
  File.chmod(0500, path(HOOK_DS))
  File.chmod(0511, path(LOG_DS))

  File.chown(Repository::UID, 0, path(REPOSITORY_DS))
  File.chmod(0500, path(REPOSITORY_DS))

  File.chmod(0500, path(MIGRATION_DS))

  # Configuration directories
  %w(pool ct group user send-receive repository id-range).each do |dir|
    path = File.join(conf_path, dir)
    Dir.mkdir(path, 0500) unless Dir.exist?(path)
  end

  [
    File.join(user_hook_script_dir, 'ct'),
    File.join(log_path, 'ct'),
  ].each do |path|
    Dir.mkdir(path) unless Dir.exist?(path)
  end
end

#mount_dirObject



389
390
391
# File 'lib/osctld/pool.rb', line 389

def mount_dir
  File.join(run_dir, 'mounts')
end

#path(ds = '') ⇒ Object (protected)



641
642
643
# File 'lib/osctld/pool.rb', line 641

def path(ds = '')
  File.join('/', dataset, ds)
end

#poolObject



58
59
60
# File 'lib/osctld/pool.rb', line 58

def pool
  self
end

#repo_pathObject



361
362
363
# File 'lib/osctld/pool.rb', line 361

def repo_path
  path(REPOSITORY_DS)
end

#run_dirObject



373
374
375
# File 'lib/osctld/pool.rb', line 373

def run_dir
  File.join(RunState::POOL_DIR, name)
end

#runstateObject (protected)



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
# File 'lib/osctld/pool.rb', line 575

def runstate
  Dir.mkdir(run_dir, 0711) unless Dir.exist?(run_dir)

  if Dir.exist?(user_dir)
    File.chmod(0511, user_dir)
  else
    Dir.mkdir(user_dir, 0511)
  end
  File.chown(0, 0, user_dir)

  [console_dir, hook_dir, mount_dir].each do |dir|
    Dir.mkdir(dir, 0711) unless Dir.exist?(dir)
  end

  [apparmor_dir].each do |dir|
    Dir.mkdir(dir, 0700) unless Dir.exist?(dir)
  end

  %w(
    ct-pre-start
    ct-pre-mount
    ct-post-mount
    ct-autodev
    ct-on-start
    ct-post-stop
  ).each do |hook|
    symlink = OsCtld.hook_run(hook, self)
    hook_src = OsCtld::hook_src(hook)

    if File.symlink?(symlink)
      if File.readlink(symlink) == hook_src
        next
      else
        File.unlink(symlink)
      end
    end

    File.symlink(hook_src, symlink)
  end
end

#save_configObject (protected)



438
439
440
441
442
# File 'lib/osctld/pool.rb', line 438

def save_config
  regenerate_file(config_path, 0400) do |f|
    f.write(YAML.dump(dump_opts.merge(attrs.dump)))
  end
end

#set(opts) ⇒ Object

Set pool options

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :parallel_start (Integer)
  • :parallel_stop (Integer)
  • :attrs (Hash)


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/osctld/pool.rb', line 282

def set(opts)
  opts.each do |k, v|
    case k
    when :parallel_start
      instance_variable_set(:"@#{k}", opts[k])
      pool.autostart_plan.resize(opts[k])

    when :parallel_stop
      instance_variable_set(:"@#{k}", opts[k])

    when :attrs
      attrs.update(v)

    else
      fail "unsupported option '#{k}'"
    end
  end

  save_config
end

#setupObject



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/osctld/pool.rb', line 234

def setup
  # Ensure needed datasets are present
  mkdatasets

  # Setup run state, i.e. hooks
  runstate

  # Load ID ranges
  load_id_ranges

  # Load users from zpool
  load_users

  # Register loaded users into the system
  Commands::User::Register.run(all: true)

  # Generate /etc/subuid and /etc/subgid
  Commands::User::SubUGIds.run

  # Load groups
  load_groups

  # Load containers from zpool
  load_cts

  # Setup AppArmor profiles
  AppArmor.setup_pool(pool)

  # Allow containers to create veth interfaces
  Commands::User::LxcUsernet.run

  # Load send/receive keys
  send_receive_key_chain.setup

  # Load repositories
  load_repositories

  # Open history
  History.open(self)

  exclusively { @state = :active }
end

#stopObject



329
330
331
# File 'lib/osctld/pool.rb', line 329

def stop
  autostart_plan.stop
end

#unset(opts) ⇒ Object

Reset pool options

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :options (Array<Symbol>)
  • :attrs (Array<String>)


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

def unset(opts)
  opts.each do |k, v|
    case k
    when :options
      OPTIONS.each do |opt|
        next unless v.include?(opt)

        remove_instance_variable(:"@#{opt}")
      end

    when :attrs
      v.each { |attr| attrs.unset(attr) }
    end
  end

  save_config
end

#user_dirObject



377
378
379
# File 'lib/osctld/pool.rb', line 377

def user_dir
  File.join(run_dir, 'users')
end

#user_hook_script_dirObject



357
358
359
# File 'lib/osctld/pool.rb', line 357

def user_hook_script_dir
  path(HOOK_DS)
end