Class: OsCtld::Mount::Manager

Inherits:
Object
  • Object
show all
Includes:
Enumerable, OsCtl::Lib::Utils::Log, Lockable, Utils::SwitchUser
Defined in:
lib/osctld/mount/manager.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::SwitchUser

#ct_attach, #ct_syscmd

Methods included from Lockable

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

Constructor Details

#initialize(ct, entries: []) ⇒ Manager

Returns a new instance of Manager.

Parameters:



20
21
22
23
24
25
 
# File 'lib/osctld/mount/manager.rb', line 20

def initialize(ct, entries: [])
  init_lock
  @ct = ct
  @entries = entries
  @shared_dir = Mount::SharedDir.new(ct)
end

Instance Attribute Details

#ct ⇒ Object (readonly, protected)

Returns the value of attribute ct.



171
172
173
 
# File 'lib/osctld/mount/manager.rb', line 171

def ct
  @ct
end

#entries ⇒ Object (readonly, protected)

Returns the value of attribute entries.



171
172
173
 
# File 'lib/osctld/mount/manager.rb', line 171

def entries
  @entries
end

#shared_dir ⇒ Object (readonly)

Returns the value of attribute shared_dir.



17
18
19
 
# File 'lib/osctld/mount/manager.rb', line 17

def shared_dir
  @shared_dir
end

Class Method Details

.load(ct, cfg) ⇒ Object

Load mounts from config

Parameters:



13
14
15
 
# File 'lib/osctld/mount/manager.rb', line 13

def self.load(ct, cfg)
  new(ct, entries: cfg.map { |v| Mount::Entry.load(ct, v) })
end

Instance Method Details

#<<(mnt) ⇒ Object

Parameters:



46
47
48
 
# File 'lib/osctld/mount/manager.rb', line 46

def <<(mnt)
  add(mnt)
end

#activate(mountpoint) ⇒ Object

Mount the directory inside the container

WARNING: this method can mount the directory multiple times! It is the caller’s responsibility to ensure that the container is running.

Parameters:

  • mountpoint (String) 


137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/osctld/mount/manager.rb', line 137

def activate(mountpoint)
  mnt = find_at(mountpoint)

  if mnt.nil?
    raise MountNotFound, mountpoint
  elsif !mnt.fs || !mnt.type || !mnt.opts
    raise MountInvalid, 'incomplete mount: missing fs, type or opts'
  elsif !%w[bind none].include?(mnt.type)
    raise MountInvalid, "can activate only bind mounts, not #{mnt.type}"
  end

  shared_dir.propagate(mnt)
end

#add(mnt) ⇒ Object

Parameters:



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/osctld/mount/manager.rb', line 28

def add(mnt)
  exclusively do
    entries << mnt
  end

  ct.save_config
  ct.lxc_config.configure_mounts

  return if !mnt.automount? || mnt.type != 'bind'

  ct.exclusively do
    next unless ct.fresh_state == :running

    shared_dir.propagate(mnt)
  end
end

#all_entries ⇒ Array<Mount::Entry>

Return all mount entries, including internal entries

Returns:



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/osctld/mount/manager.rb', line 119

def all_entries
  inclusively do
    [Mount::Entry.new(
      shared_dir.path,
      shared_dir.mountpoint,
      'none',
      'bind,create=dir,ro',
      true
    )] + entries.select { |m| m.in_config? || (m.automount? && !m.temp?) }
  end
end

#clear ⇒ Object

Remove all mounts



87
88
89
90
91
92
93
94
95
 
# File 'lib/osctld/mount/manager.rb', line 87

def clear
  exclusively do
    if ct.fresh_state == :running
      entries.reverse_each { |m| unmount(m) }
    end

    entries.clear
  end
end

#deactivate(mountpoint) ⇒ Object

Unmount the directory from the container

Parameters:

  • mountpoint (String)

Raises:



153
154
155
156
157
158
 
# File 'lib/osctld/mount/manager.rb', line 153

def deactivate(mountpoint)
  mnt = find_at(mountpoint)
  raise MountNotFound, mountpoint unless mnt

  unmount(mnt)
end

#delete_at(mountpoint) ⇒ Object

Parameters:

  • mountpoint (String) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/osctld/mount/manager.rb', line 68

def delete_at(mountpoint)
  exclusively do
    mnt = entries.detect { |m| m.mountpoint == mountpoint }
    next unless mnt

    ct.exclusively do
      next unless ct.fresh_state == :running

      unmount(mnt)
    end

    entries.delete(mnt)
  end

  ct.save_config
  ct.lxc_config.configure_mounts
end

#dump ⇒ Object

Dump mounts into config



113
114
115
 
# File 'lib/osctld/mount/manager.rb', line 113

def dump
  map(&:dump)
end

#dup(new_ct) ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/osctld/mount/manager.rb', line 160

def dup(new_ct)
  ret = super()
  ret.init_lock
  ret.instance_variable_set('@ct', new_ct)
  ret.instance_variable_set('@entries', entries.map { |v| v.dup(new_ct) })
  ret.instance_variable_set('@shared_dir', shared_dir.dup(new_ct))
  ret
end

#each(&block) ⇒ Object 



104
105
106
107
108
 
# File 'lib/osctld/mount/manager.rb', line 104

def each(&block)
  inclusively do
    entries.each(&block)
  end
end

#find_at(mountpoint) ⇒ Object

Parameters:

  • mountpoint (String) 


61
62
63
64
65
 
# File 'lib/osctld/mount/manager.rb', line 61

def find_at(mountpoint)
  inclusively do
    entries.detect { |m| m.mountpoint == mountpoint }
  end
end

#prune ⇒ Object

Remote temporal mounts



98
99
100
101
102
 
# File 'lib/osctld/mount/manager.rb', line 98

def prune
  exclusively do
    entries.delete_if(&:temp?)
  end
end

#register(mnt) ⇒ Object

Parameters:



51
52
53
54
55
56
57
58
 
# File 'lib/osctld/mount/manager.rb', line 51

def register(mnt)
  exclusively do
    entries << mnt
  end

  ct.save_config
  ct.lxc_config.configure_mounts
end

#unmount(mnt) ⇒ Object (protected) 



173
174
175
176
177
 
# File 'lib/osctld/mount/manager.rb', line 173

def unmount(mnt)
  ContainerControl::Commands::Unmount.run!(ct, mnt.mountpoint)
rescue ContainerControl::Error => e
  raise UnmountError, e.message
end