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) 


247
248
249
250
251
252
253
254
255
 
# File 'lib/osctl/image/osctld_client.rb', line 247

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) 


215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/osctl/image/osctld_client.rb', line 215

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) 


231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/osctl/image/osctld_client.rb', line 231

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) 


295
296
297
298
299
300
301
302
303
304
 
# File 'lib/osctl/image/osctld_client.rb', line 295

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) ⇒ Object

Parameters:

  • ctid (String)
  • file (String) 


64
65
66
67
68
69
70
71
72
 
# File 'lib/osctl/image/osctld_client.rb', line 64

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

#create_container_from_repo(ctid, distribution, version, arch, vendor, variant) ⇒ Object

Parameters:

  • ctid (String)
  • distribution (String)
  • version (String)
  • arch (String)
  • vendor (String)
  • variant (String) 


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

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

#delete_container(ctid) ⇒ Object

Parameters:

  • ctid (String) 


208
209
210
211
212
 
# File 'lib/osctl/image/osctld_client.rb', line 208

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) 


283
284
285
286
287
288
289
290
 
# File 'lib/osctl/image/osctld_client.rb', line 283

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>) 


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

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('/dev/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) 


135
136
137
138
139
 
# File 'lib/osctl/image/osctld_client.rb', line 135

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) 


77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/osctl/image/osctld_client.rb', line 77

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) 


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

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('/dev/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) 


92
93
94
95
96
 
# File 'lib/osctl/image/osctld_client.rb', line 92

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>) 


100
101
102
103
104
 
# File 'lib/osctl/image/osctld_client.rb', line 100

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) 


114
115
116
117
118
 
# File 'lib/osctl/image/osctld_client.rb', line 114

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) 


121
122
123
124
125
 
# File 'lib/osctl/image/osctld_client.rb', line 121

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

#stop_container(ctid) ⇒ Object

Parameters:

  • ctid (String) 


128
129
130
131
132
 
# File 'lib/osctl/image/osctld_client.rb', line 128

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) 


259
260
261
262
263
264
265
266
267
 
# File 'lib/osctl/image/osctld_client.rb', line 259

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) 


107
108
109
110
111
 
# File 'lib/osctl/image/osctld_client.rb', line 107

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) 


271
272
273
274
275
276
277
278
279
280
 
# File 'lib/osctl/image/osctld_client.rb', line 271

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