Class: OsCtl::Image::OsCtldClient

Inherits:
Object
  • Object
show all
Defined in:
lib/osctl/image/osctld_client.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ OsCtldClient

Returns a new instance of OsCtldClient.



5
6
7
8
 
# File 'lib/osctl/image/osctld_client.rb', line 5

def initialize
  @client = OsCtl::Client.new
  @connected = false
end

Instance Method Details

#activate_mount(ctid, dst) ⇒ Object

Parameters:

  • ctid (String)
  • dst (String) 


251
252
253
254
255
256
257
258
259
 
# File 'lib/osctl/image/osctld_client.rb', line 251

def activate_mount(ctid, dst)
  connect do |client|
    client.cmd_data!(
      :ct_mount_activate,
      id: ctid,
      mountpoint: dst
    )
  end
end

#add_netif_bridge(ctid, netif, link) ⇒ Object

Parameters:

  • ctid (String) 


219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/osctl/image/osctld_client.rb', line 219

def add_netif_bridge(ctid, netif, link)
  connect do |client|
    client.cmd_data!(
      :netif_create,
      id: ctid,
      name: netif,
      type: 'bridge',
      link:,
      dhcp: true
    )
  end
end

#batch ⇒ Object

Execute multiple commands within one connection



11
12
13
14
15
16
 
# File 'lib/osctl/image/osctld_client.rb', line 11

def batch
  @batch = true
  yield(self)
ensure
  @batch = false
end

#bind_mount(ctid, src, dst) ⇒ Object

Parameters:

  • ctid (String)
  • src (String)
  • dst (String) 


235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/osctl/image/osctld_client.rb', line 235

def bind_mount(ctid, src, dst)
  connect do |client|
    client.cmd_data!(
      :ct_mount_create,
      id: ctid,
      fs: src,
      mountpoint: dst,
      type: 'bind',
      opts: 'bind,create=dir',
      automount: false
    )
  end
end

#connect {|client| ... } ⇒ Object (protected)

Yield Parameters:

  • client (OsCtl::Client) 


299
300
301
302
303
304
305
306
307
308
 
# File 'lib/osctl/image/osctld_client.rb', line 299

def connect
  @client.open unless @connected
  @connected = true
  yield(@client)
ensure
  unless @batch
    @client.close
    @connected = false
  end
end

#create_container_from_file(ctid, file, map_mode: 'native') ⇒ Object

Parameters:

  • ctid (String)
  • file (String)
  • map_mode ('native', 'zfs') (defaults to: 'native') 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/osctl/image/osctld_client.rb', line 67

def create_container_from_file(ctid, file, map_mode: 'native')
  connect do |client|
    client.cmd_data!(
      :ct_import,
      as_id: ctid,
      file: File.absolute_path(file),
      map_mode:
    )
  end
end

#create_container_from_repo(ctid, distribution, version, arch, vendor, variant, map_mode: 'zfs') ⇒ Object

Parameters:

  • ctid (String)
  • distribution (String)
  • version (String)
  • arch (String)
  • vendor (String)
  • variant (String)
  • map_mode ('native', 'zfs') (defaults to: 'zfs') 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/osctl/image/osctld_client.rb', line 47

def create_container_from_repo(ctid, distribution, version, arch, vendor, variant, map_mode: 'zfs')
  connect do |client|
    client.cmd_data!(
      :ct_create,
      id: ctid,
      image: {
        distribution:,
        version:,
        arch:,
        vendor:,
        variant:
      },
      map_mode:
    )
  end
end

#delete_container(ctid) ⇒ Object

Parameters:

  • ctid (String) 


212
213
214
215
216
 
# File 'lib/osctl/image/osctld_client.rb', line 212

def delete_container(ctid)
  connect do |client|
    client.cmd_data!(:ct_delete, id: ctid, force: true)
  end
end

#delete_user(user) ⇒ Object

Parameters:

  • user (String) 


287
288
289
290
291
292
293
294
 
# File 'lib/osctl/image/osctld_client.rb', line 287

def delete_user(user)
  connect do |client|
    client.cmd_data!(
      :user_delete,
      name: user
    )
  end
end

#exec(ctid, cmd) ⇒ Object

Parameters:

  • ctid (String)
  • cmd (Array<String>) 


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
 
# File 'lib/osctl/image/osctld_client.rb', line 147

def exec(ctid, cmd)
  connect do |client|
    cont = client.cmd_data!(
      :ct_exec,
      id: ctid,
      cmd:,
      run: false
    )

    if cont != 'continue'
      raise "exec not available: invalid response '#{cont}'"
    end

    null = File.open(File::NULL, 'r')

    client.send_io(null)
    client.send_io($stdout)
    client.send_io($stdout)

    null.close

    resp = client.receive_resp

    if resp.error?
      raise(resp['message'] || 'exec failed')
    end

    resp[:exitstatus]
  end
end

#find_container(ctid) ⇒ Object

Parameters:

  • ctid (String) 


32
33
34
35
36
37
38
 
# File 'lib/osctl/image/osctld_client.rb', line 32

def find_container(ctid)
  connect do |client|
    client.cmd_data!(:ct_show, id: ctid)
  end
rescue OsCtl::Client::Error
  nil
end

#ignore_error ⇒ Object 



18
19
20
21
22
 
# File 'lib/osctl/image/osctld_client.rb', line 18

def ignore_error
  yield(self)
rescue OsCtl::Client::Error
  # ignore
end

#kill_container(ctid) ⇒ Object

Parameters:

  • ctid (String) 


139
140
141
142
143
 
# File 'lib/osctl/image/osctld_client.rb', line 139

def kill_container(ctid)
  connect do |client|
    client.cmd_data!(:ct_stop, id: ctid, method: 'kill')
  end
end

#list_containers ⇒ Array

Returns:

  • (Array) 


25
26
27
28
29
 
# File 'lib/osctl/image/osctld_client.rb', line 25

def list_containers
  connect do |client|
    client.cmd_data!(:ct_list)
  end
end

#reinstall_container_from_image(ctid, image_path, remove_snapshots: false) ⇒ Object

Parameters:

  • ctid (String)
  • image_path (String)
  • remove_snapshots (Boolean) (defaults to: false) 


81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/osctl/image/osctld_client.rb', line 81

def reinstall_container_from_image(ctid, image_path, remove_snapshots: false)
  connect do |client|
    client.cmd_data!(
      :ct_reinstall,
      id: ctid,
      remove_snapshots:,
      type: :image,
      path: File.absolute_path(image_path)
    )
  end
end

#runscript(ctid, script) ⇒ Object

Parameters:

  • ctid (String)
  • script (String) 


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
 
# File 'lib/osctl/image/osctld_client.rb', line 180

def runscript(ctid, script)
  connect do |client|
    cont = client.cmd_data!(
      :ct_runscript,
      id: ctid,
      script:,
      run: false
    )

    if cont != 'continue'
      raise "runscript not available: invalid response '#{cont}'"
    end

    null = File.open(File::NULL, 'r')

    client.send_io(null)
    client.send_io($stdout)
    client.send_io($stdout)

    null.close

    resp = client.receive_resp

    if resp.error?
      raise(resp['message'] || 'runscript failed')
    end

    resp[:exitstatus]
  end
end

#set_container_attr(ctid, attr, value) ⇒ Object

Parameters:

  • ctid (String)
  • attr (String)
  • value (String) 


96
97
98
99
100
 
# File 'lib/osctl/image/osctld_client.rb', line 96

def set_container_attr(ctid, attr, value)
  connect do |client|
    client.cmd_data!(:ct_set, id: ctid, attrs: { attr => value })
  end
end

#set_container_dns_resolvers(ctid, dns_resolvers) ⇒ Object

Parameters:

  • ctid (String)
  • dns_resolvers (Array<String>) 


104
105
106
107
108
 
# File 'lib/osctl/image/osctld_client.rb', line 104

def set_container_dns_resolvers(ctid, dns_resolvers)
  connect do |client|
    client.cmd_data!(:ct_set, id: ctid, dns_resolvers:)
  end
end

#set_container_nesting(ctid) ⇒ Object

Parameters:

  • ctid (String) 


118
119
120
121
122
 
# File 'lib/osctl/image/osctld_client.rb', line 118

def set_container_nesting(ctid)
  connect do |client|
    client.cmd_data!(:ct_set, id: ctid, nesting: true)
  end
end

#start_container(ctid) ⇒ Object

Parameters:

  • ctid (String) 


125
126
127
128
129
 
# File 'lib/osctl/image/osctld_client.rb', line 125

def start_container(ctid)
  connect do |client|
    client.cmd_data!(:ct_start, id: ctid)
  end
end

#stop_container(ctid) ⇒ Object

Parameters:

  • ctid (String) 


132
133
134
135
136
 
# File 'lib/osctl/image/osctld_client.rb', line 132

def stop_container(ctid)
  connect do |client|
    client.cmd_data!(:ct_stop, id: ctid)
  end
end

#unmount(ctid, dst) ⇒ Object

Parameters:

  • ctid (String)
  • dst (String) 


263
264
265
266
267
268
269
270
271
 
# File 'lib/osctl/image/osctld_client.rb', line 263

def unmount(ctid, dst)
  connect do |client|
    client.cmd_data!(
      :ct_mount_delete,
      id: ctid,
      mountpoint: dst
    )
  end
end

#unset_container_start_menu(ctid) ⇒ Object

Parameters:

  • ctid (String) 


111
112
113
114
115
 
# File 'lib/osctl/image/osctld_client.rb', line 111

def unset_container_start_menu(ctid)
  connect do |client|
    client.cmd_data!(:ct_unset, id: ctid, start_menu: true)
  end
end

#user_idmap(user) ⇒ Array

Parameters:

  • user (String)

Returns:

  • (Array) 


275
276
277
278
279
280
281
282
283
284
 
# File 'lib/osctl/image/osctld_client.rb', line 275

def user_idmap(user)
  connect do |client|
    client.cmd_data!(
      :user_idmap_list,
      name: user,
      uid: true,
      gid: true
    )
  end
end