/
oob.py
377 lines (306 loc) · 12.6 KB
/
oob.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
233
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
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
352
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
# Copyright 2017 AT&T Intellectual Property. All other rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Driver for controlling OOB interface via libvirt api."""
import time
import libvirt
from urllib.parse import urlparse
import defusedxml.ElementTree as ET
from drydock_provisioner.orchestrator.actions.orchestrator import BaseAction
import drydock_provisioner.error as errors
import drydock_provisioner.objects.fields as hd_fields
class LibvirtBaseAction(BaseAction):
"""Base action for Pyghmi executed actions."""
def init_session(self, node):
"""Initialize a Libvirt session to the node hypervisor.
:param node: instance of objects.BaremetalNode
"""
if node.oob_type != 'libvirt':
raise errors.DriverError(
"Node OOB type %s is not 'libvirt'" % node.oob_type)
virsh_url = node.oob_parameters.get('libvirt_uri', None)
if not virsh_url:
raise errors.DriverError(
"Node %s has no 'libvirt_url' defined" % (node.name))
url_parts = urlparse(virsh_url)
if url_parts.scheme != "qemu+ssh":
raise errors.DriverError(
"Node %s has invalid libvirt URL scheme %s. "
"Only 'qemu+ssh' supported." % (node.name, url_parts.scheme))
self.logger.debug(
"Starting libvirt session to hypervisor %s " % (virsh_url))
virsh_ses = libvirt.open(virsh_url)
if not virsh_ses:
raise errors.DriverError(
"Unable to establish libvirt session to %s." % virsh_url)
return virsh_ses
def set_node_pxe(self, node):
"""Set a node to PXE boot first."""
ses = self.init_session(node)
domain = ses.lookupByName(node.name)
domain_xml = domain.XMLDesc(libvirt.VIR_DOMAIN_XML_SECURE
| libvirt.VIR_DOMAIN_XML_INACTIVE)
xmltree = ET.fromstring(domain_xml)
# Delete all the current boot entries
os_tree = xmltree.find("./os")
boot_elements = os_tree.findall("./boot")
for e in boot_elements:
os_tree.remove(e)
# Now apply our boot order which is 'network' and then 'hd'
os_tree.append(ET.fromstring("<boot dev='network' />"))
os_tree.append(ET.fromstring("<boot dev='hd' />"))
# And now save the new XML def to the hypervisor
domain_xml = ET.tostring(xmltree, encoding="utf-8")
ses.defineXML(domain_xml.decode('utf-8'))
ses.close()
def get_node_status(self, node):
"""Get node status via libvirt api."""
try:
ses = self.init_session(node)
domain = ses.lookupByName(node.name)
status = domain.isActive()
finally:
ses.close()
return status
def poweroff_node(self, node):
"""Power off a node."""
ses = self.init_session(node)
domain = ses.lookupByName(node.name)
if domain.isActive():
domain.destroy()
else:
self.logger.debug("Node already powered off.")
return
try:
i = 3
while i > 0:
self.logger.debug("Polling powerstate waiting for success.")
power_state = domain.isActive()
if not power_state:
return
time.sleep(10)
i = i - 1
raise errors.DriverError("Power state never matched off")
finally:
ses.close()
def poweron_node(self, node):
"""Power on a node."""
ses = self.init_session(node)
domain = ses.lookupByName(node.name)
if not domain.isActive():
domain.create()
else:
self.logger.debug("Node already powered on.")
return
try:
i = 3
while i > 0:
self.logger.debug("Polling powerstate waiting for success.")
power_state = domain.isActive()
if power_state:
return
time.sleep(10)
i = i - 1
raise errors.DriverError("Power state never matched on")
finally:
ses.close()
class ValidateOobServices(LibvirtBaseAction):
"""Action to validation OOB services are available."""
def start(self):
self.task.add_status_msg(
msg="OOB does not require services.",
error=False,
ctx='NA',
ctx_type='NA')
self.task.set_status(hd_fields.TaskStatus.Complete)
self.task.success()
self.task.save()
return
class ConfigNodePxe(LibvirtBaseAction):
"""Action to configure PXE booting via OOB."""
def start(self):
self.task.set_status(hd_fields.TaskStatus.Running)
self.task.save()
design_status, site_design = self.orchestrator.get_effective_site(
self.task.design_ref)
node_list = self.orchestrator.process_node_filter(
self.task.node_filter, site_design)
for n in node_list:
self.task.add_status_msg(
msg="Libvirt doesn't configure PXE options.",
error=True,
ctx=n.name,
ctx_type='node')
self.task.set_status(hd_fields.TaskStatus.Complete)
self.task.failure()
self.task.save()
return
class SetNodeBoot(LibvirtBaseAction):
"""Action to configure a node to PXE boot."""
def start(self):
self.task.set_status(hd_fields.TaskStatus.Running)
self.task.save()
design_status, site_design = self.orchestrator.get_effective_site(
self.task.design_ref)
node_list = self.orchestrator.process_node_filter(
self.task.node_filter, site_design)
for n in node_list:
self.logger.debug("Setting bootdev to PXE for %s" % n.name)
self.task.add_status_msg(
msg="Setting node to PXE boot.",
error=False,
ctx=n.name,
ctx_type='node')
try:
self.set_node_pxe(n)
except Exception as ex:
self.task.add_status_msg(
msg="Unable to set bootdev to PXE: %s" % str(ex),
error=True,
ctx=n.name,
ctx_type='node')
self.task.failure(focus=n.name)
self.logger.warning(
"Unable to set node %s to PXE boot." % (n.name))
else:
self.task.add_status_msg(
msg="Set bootdev to PXE.",
error=False,
ctx=n.name,
ctx_type='node')
self.logger.debug("%s reports bootdev of network" % n.name)
self.task.success(focus=n.name)
self.task.set_status(hd_fields.TaskStatus.Complete)
self.task.save()
return
class PowerOffNode(LibvirtBaseAction):
"""Action to power off a node via libvirt API."""
def start(self):
self.task.set_status(hd_fields.TaskStatus.Running)
self.task.save()
design_status, site_design = self.orchestrator.get_effective_site(
self.task.design_ref)
node_list = self.orchestrator.process_node_filter(
self.task.node_filter, site_design)
for n in node_list:
msg = "Shutting down domain %s" % n.name
self.logger.debug(msg)
self.task.add_status_msg(
msg=msg, error=False, ctx=n.name, ctx_type='node')
try:
self.poweroff_node(n)
except Exception as ex:
msg = "Node failed to power off: %s" % str(ex)
self.task.add_status_msg(
msg=msg, error=True, ctx=n.name, ctx_type='node')
self.logger.error(msg)
self.task.failure(focus=n.name)
else:
msg = "Node %s powered off." % n.name
self.task.add_status_msg(
msg=msg, error=False, ctx=n.name, ctx_type='node')
self.logger.debug(msg)
self.task.success(focus=n.name)
self.task.set_status(hd_fields.TaskStatus.Complete)
self.task.save()
return
class PowerOnNode(LibvirtBaseAction):
"""Action to power on a node via libvirt API."""
def start(self):
self.task.set_status(hd_fields.TaskStatus.Running)
self.task.save()
design_status, site_design = self.orchestrator.get_effective_site(
self.task.design_ref)
node_list = self.orchestrator.process_node_filter(
self.task.node_filter, site_design)
for n in node_list:
msg = "Starting domain %s" % n.name
self.logger.debug(msg)
self.task.add_status_msg(
msg=msg, error=False, ctx=n.name, ctx_type='node')
try:
self.poweron_node(n)
except Exception as ex:
msg = "Node failed to power on: %s" % str(ex)
self.task.add_status_msg(
msg=msg, error=True, ctx=n.name, ctx_type='node')
self.logger.error(msg)
self.task.failure(focus=n.name)
else:
msg = "Node %s powered on." % n.name
self.task.add_status_msg(
msg=msg, error=False, ctx=n.name, ctx_type='node')
self.logger.debug(msg)
self.task.success(focus=n.name)
self.task.set_status(hd_fields.TaskStatus.Complete)
self.task.save()
return
class PowerCycleNode(LibvirtBaseAction):
"""Action to hard powercycle a node via IPMI."""
def start(self):
self.task.set_status(hd_fields.TaskStatus.Running)
self.task.save()
design_status, site_design = self.orchestrator.get_effective_site(
self.task.design_ref)
node_list = self.orchestrator.process_node_filter(
self.task.node_filter, site_design)
for n in node_list:
msg = ("Power cycling domain for node %s" % n.name)
self.logger.debug(msg)
self.task.add_status_msg(
msg=msg, error=False, ctx=n.name, ctx_type='node')
try:
self.poweroff_node(n)
self.poweron_node(n)
except Exception as ex:
msg = "Node failed to power cycle: %s" % str(ex)
self.task.add_status_msg(
msg=msg, error=True, ctx=n.name, ctx_type='node')
self.logger.error(msg)
self.task.failure(focus=n.name)
else:
msg = "Node %s power cycled." % n.name
self.task.add_status_msg(
msg=msg, error=False, ctx=n.name, ctx_type='node')
self.logger.debug(msg)
self.task.success(focus=n.name)
self.task.set_status(hd_fields.TaskStatus.Complete)
self.task.save()
return
class InterrogateOob(LibvirtBaseAction):
"""Action to complete a basic interrogation of the node IPMI interface."""
def start(self):
self.task.set_status(hd_fields.TaskStatus.Running)
self.task.save()
design_status, site_design = self.orchestrator.get_effective_site(
self.task.design_ref)
node_list = self.orchestrator.process_node_filter(
self.task.node_filter, site_design)
for n in node_list:
try:
node_status = self.get_node_status(n)
except Exception as ex:
msg = "Node failed tatus check: %s" % str(ex)
self.task.add_status_msg(
msg=msg, error=True, ctx=n.name, ctx_type='node')
self.logger.error(msg)
self.task.failure(focus=n.name)
else:
msg = "Node %s status is %s." % (n.name, node_status)
self.task.add_status_msg(
msg=msg, error=False, ctx=n.name, ctx_type='node')
self.logger.debug(msg)
self.task.success(focus=n.name)
self.task.set_status(hd_fields.TaskStatus.Complete)
self.task.save()
return