1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U.
5 # This file is part of openmano
8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
9 # not use this file except in compliance with the License. You may obtain
10 # a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 # License for the specific language governing permissions and limitations
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact with: nfvlabs@tid.es
25 vimconn implement an Abstract class for the vim connector plugins
26 with the definition of the method to be implemented.
29 from email
.mime
.multipart
import MIMEMultipart
30 from email
.mime
.text
import MIMEText
31 from http
import HTTPStatus
32 from io
import StringIO
42 __author__
= "Alfonso Tierno, Igor D.C."
43 __date__
= "$14-aug-2017 23:59:59$"
46 def deprecated(message
):
47 def deprecated_decorator(func
):
48 def deprecated_func(*args
, **kwargs
):
50 "{} is a deprecated function. {}".format(func
.__name
__, message
),
51 category
=DeprecationWarning,
54 warnings
.simplefilter("default", DeprecationWarning)
56 return func(*args
, **kwargs
)
58 return deprecated_func
60 return deprecated_decorator
64 HTTP_Bad_Request
= HTTPStatus
.BAD_REQUEST
.value
65 HTTP_Unauthorized
= HTTPStatus
.UNAUTHORIZED
.value
66 HTTP_Not_Found
= HTTPStatus
.NOT_FOUND
.value
67 HTTP_Method_Not_Allowed
= HTTPStatus
.METHOD_NOT_ALLOWED
.value
68 HTTP_Request_Timeout
= HTTPStatus
.REQUEST_TIMEOUT
.value
69 HTTP_Conflict
= HTTPStatus
.CONFLICT
.value
70 HTTP_Not_Implemented
= HTTPStatus
.NOT_IMPLEMENTED
.value
71 HTTP_Service_Unavailable
= HTTPStatus
.SERVICE_UNAVAILABLE
.value
72 HTTP_Internal_Server_Error
= HTTPStatus
.INTERNAL_SERVER_ERROR
.value
75 class VimConnException(Exception):
76 """Common and base class Exception for all VimConnector exceptions"""
78 def __init__(self
, message
, http_code
=HTTP_Bad_Request
):
79 Exception.__init
__(self
, message
)
80 self
.http_code
= http_code
83 class VimConnConnectionException(VimConnException
):
84 """Connectivity error with the VIM"""
86 def __init__(self
, message
, http_code
=HTTP_Service_Unavailable
):
87 VimConnException
.__init
__(self
, message
, http_code
)
90 class VimConnUnexpectedResponse(VimConnException
):
91 """Get an wrong response from VIM"""
93 def __init__(self
, message
, http_code
=HTTP_Service_Unavailable
):
94 VimConnException
.__init
__(self
, message
, http_code
)
97 class VimConnAuthException(VimConnException
):
98 """Invalid credentials or authorization to perform this action over the VIM"""
100 def __init__(self
, message
, http_code
=HTTP_Unauthorized
):
101 VimConnException
.__init
__(self
, message
, http_code
)
104 class VimConnNotFoundException(VimConnException
):
105 """The item is not found at VIM"""
107 def __init__(self
, message
, http_code
=HTTP_Not_Found
):
108 VimConnException
.__init
__(self
, message
, http_code
)
111 class VimConnConflictException(VimConnException
):
112 """There is a conflict, e.g. more item found than one"""
114 def __init__(self
, message
, http_code
=HTTP_Conflict
):
115 VimConnException
.__init
__(self
, message
, http_code
)
118 class VimConnNotSupportedException(VimConnException
):
119 """The request is not supported by connector"""
121 def __init__(self
, message
, http_code
=HTTP_Service_Unavailable
):
122 VimConnException
.__init
__(self
, message
, http_code
)
125 class VimConnNotImplemented(VimConnException
):
126 """The method is not implemented by the connector"""
128 def __init__(self
, message
, http_code
=HTTP_Not_Implemented
):
129 VimConnException
.__init
__(self
, message
, http_code
)
132 class VimConnInsufficientCredentials(VimConnException
):
133 """The VIM account does not have efficient permissions to perform the requested operation."""
135 def __init__(self
, message
, http_code
=HTTP_Unauthorized
):
136 VimConnException
.__init
__(self
, message
, http_code
)
140 """Abstract base class for all the VIM connector plugins
141 These plugins must implement a VimConnector class derived from this
142 and all these privated methods
160 Constructor of VIM. Raise an exception is some needed parameter is missing, but it must not do any connectivity
161 checking against the VIM
162 :param uuid: internal id of this VIM
163 :param name: name assigned to this VIM, can be used for logging
164 :param tenant_id: 'tenant_id': (only one of them is mandatory) VIM tenant to be used
165 :param tenant_name: 'tenant_name': (only one of them is mandatory) VIM tenant to be used
166 :param url: url used for normal operations
167 :param url_admin: (optional), url used for administrative tasks
168 :param user: user to access
169 :param passwd: password
170 :param log_level: provided if it should use a different log_level than the general one
171 :param config: dictionary with extra VIM information. This contains a consolidate version of VIM config
172 at VIM_ACCOUNT (attach)
173 :param persitent_info: dict where the class can store information that will be available among class
174 destroy/creation cycles. This info is unique per VIM/credential. At first call it will contain an
175 empty dict. Useful to store login/tokens information for speed up communication
181 self
.url_admin
= url_admin
182 self
.tenant_id
= tenant_id
183 self
.tenant_name
= tenant_name
186 self
.config
= config
or {}
187 self
.availability_zone
= None
188 self
.logger
= logging
.getLogger("ro.vim")
191 self
.logger
.setLevel(getattr(logging
, log_level
))
193 if not self
.url_admin
: # try to use normal url
194 self
.url_admin
= self
.url
196 def __getitem__(self
, index
):
197 if index
== "tenant_id":
198 return self
.tenant_id
200 if index
== "tenant_name":
201 return self
.tenant_name
204 elif index
== "name":
206 elif index
== "user":
208 elif index
== "passwd":
212 elif index
== "url_admin":
213 return self
.url_admin
214 elif index
== "config":
217 raise KeyError("Invalid key '{}'".format(index
))
219 def __setitem__(self
, index
, value
):
220 if index
== "tenant_id":
221 self
.tenant_id
= value
223 if index
== "tenant_name":
224 self
.tenant_name
= value
227 elif index
== "name":
229 elif index
== "user":
231 elif index
== "passwd":
235 elif index
== "url_admin":
236 self
.url_admin
= value
238 raise KeyError("Invalid key '{}'".format(index
))
241 def _create_mimemultipart(content_list
):
242 """Creates a MIMEmultipart text combining the content_list
243 :param content_list: list of text scripts to be combined
244 :return: str of the created MIMEmultipart. If the list is empty returns None, if the list contains only one
245 element MIMEmultipart is not created and this content is returned
249 elif len(content_list
) == 1:
250 return content_list
[0]
252 combined_message
= MIMEMultipart()
254 for content
in content_list
:
255 if content
.startswith("#include"):
256 mime_format
= "text/x-include-url"
257 elif content
.startswith("#include-once"):
258 mime_format
= "text/x-include-once-url"
259 elif content
.startswith("#!"):
260 mime_format
= "text/x-shellscript"
261 elif content
.startswith("#cloud-config"):
262 mime_format
= "text/cloud-config"
263 elif content
.startswith("#cloud-config-archive"):
264 mime_format
= "text/cloud-config-archive"
265 elif content
.startswith("#upstart-job"):
266 mime_format
= "text/upstart-job"
267 elif content
.startswith("#part-handler"):
268 mime_format
= "text/part-handler"
269 elif content
.startswith("#cloud-boothook"):
270 mime_format
= "text/cloud-boothook"
272 mime_format
= "text/x-shellscript"
274 sub_message
= MIMEText(content
, mime_format
, sys
.getdefaultencoding())
275 combined_message
.attach(sub_message
)
277 return combined_message
.as_string()
279 def _create_user_data(self
, cloud_config
):
281 Creates a script user database on cloud_config info
282 :param cloud_config: dictionary with
283 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
284 'users': (optional) list of users to be inserted, each item is a dict with:
285 'name': (mandatory) user name,
286 'key-pairs': (optional) list of strings with the public key to be inserted to the user
287 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
288 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
289 'config-files': (optional). List of files to be transferred. Each item is a dict with:
290 'dest': (mandatory) string with the destination absolute path
291 'encoding': (optional, by default text). Can be one of:
292 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
293 'content' (mandatory): string with the content of the file
294 'permissions': (optional) string with file permissions, typically octal notation '0644'
295 'owner': (optional) file owner, string with the format 'owner:group'
296 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
297 :return: config_drive, userdata. The first is a boolean or None, the second a string or None
303 # For more information, check https://cloudinit.readthedocs.io/en/latest/reference/merging.html
304 # Basically, with this, we don't override the provider's cloud config
305 merge_how
= yaml
.safe_dump(
310 "settings": ["append", "recurse_dict", "recurse_list"],
314 "settings": ["no_replace", "recurse_list", "recurse_dict"],
319 default_flow_style
=False,
322 if isinstance(cloud_config
, dict):
323 if cloud_config
.get("user-data"):
324 if isinstance(cloud_config
["user-data"], str):
325 userdata_list
.append(cloud_config
["user-data"] + f
"\n{merge_how}")
327 for u
in cloud_config
["user-data"]:
328 userdata_list
.append(u
+ f
"\n{merge_how}")
330 if cloud_config
.get("boot-data-drive") is not None:
331 config_drive
= cloud_config
["boot-data-drive"]
334 cloud_config
.get("config-files")
335 or cloud_config
.get("users")
336 or cloud_config
.get("key-pairs")
341 if cloud_config
.get("key-pairs"):
342 userdata_dict
["ssh-authorized-keys"] = cloud_config
["key-pairs"]
343 userdata_dict
["system_info"] = {
345 "ssh_authorized_keys": cloud_config
["key-pairs"],
348 userdata_dict
["users"] = ["default"]
350 if cloud_config
.get("users"):
351 if "users" not in userdata_dict
:
352 userdata_dict
["users"] = ["default"]
354 for user
in cloud_config
["users"]:
356 "name": user
["name"],
357 "sudo": "ALL = (ALL)NOPASSWD:ALL",
360 if "user-info" in user
:
361 user_info
["gecos"] = user
["user-info"]
363 if user
.get("key-pairs"):
364 user_info
["ssh-authorized-keys"] = user
["key-pairs"]
366 userdata_dict
["users"].append(user_info
)
368 if cloud_config
.get("config-files"):
369 userdata_dict
["write_files"] = []
370 for file in cloud_config
["config-files"]:
371 file_info
= {"path": file["dest"], "content": file["content"]}
373 if file.get("encoding"):
374 file_info
["encoding"] = file["encoding"]
376 if file.get("permissions"):
377 file_info
["permissions"] = file["permissions"]
379 if file.get("owner"):
380 file_info
["owner"] = file["owner"]
382 userdata_dict
["write_files"].append(file_info
)
384 userdata_list
.append(
386 + yaml
.safe_dump(userdata_dict
, indent
=4, default_flow_style
=False)
389 userdata
= self
._create
_mimemultipart
(userdata_list
)
390 self
.logger
.debug("userdata: %s", userdata
)
391 elif isinstance(cloud_config
, str):
392 userdata
= cloud_config
394 return config_drive
, userdata
396 def check_vim_connectivity(self
):
397 """Checks VIM can be reached and user credentials are ok.
398 Returns None if success or raises VimConnConnectionException, VimConnAuthException, ...
400 # by default no checking until each connector implements it
403 def get_tenant_list(self
, filter_dict
={}):
404 """Obtain tenants of VIM
405 filter_dict dictionary that can contain the following keys:
406 name: filter by tenant name
407 id: filter by tenant uuid/id
409 Returns the tenant list of dictionaries, and empty list if no tenant match all the filers:
410 [{'name':'<name>, 'id':'<id>, ...}, ...]
412 raise VimConnNotImplemented("Should have implemented this")
420 provider_network_profile
=None,
422 """Adds a tenant network to VIM
424 'net_name': name of the network
426 'bridge': overlay isolated network
427 'data': underlay E-LAN network for Passthrough and SRIOV interfaces
428 'ptp': underlay E-LINE network for Passthrough and SRIOV interfaces.
429 'ip_profile': is a dict containing the IP parameters of the network
430 'ip_version': can be "IPv4" or "IPv6" (Currently only IPv4 is implemented)
431 'subnet_address': ip_prefix_schema, that is X.X.X.X/Y
432 'gateway_address': (Optional) ip_schema, that is X.X.X.X
433 'dns_address': (Optional) comma separated list of ip_schema, e.g. X.X.X.X[,X,X,X,X]
434 'dhcp_enabled': True or False
435 'dhcp_start_address': ip_schema, first IP to grant
436 'dhcp_count': number of IPs to grant.
437 'shared': if this network can be seen/use by other tenants/organization
438 'provider_network_profile': (optional) contains {segmentation-id: vlan, provider-network: vim_netowrk}
439 Returns a tuple with the network identifier and created_items, or raises an exception on error
440 created_items can be None or a dictionary where this method can include key-values that will be passed to
441 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
442 Format is VimConnector dependent, but do not use nested dictionaries and a value of None should be the same
445 raise VimConnNotImplemented("Should have implemented this")
447 def get_network_list(self
, filter_dict
={}):
448 """Obtain tenant networks of VIM
450 'filter_dict' (optional) contains entries to return only networks that matches ALL entries:
451 name: string => returns only networks with this name
452 id: string => returns networks with this VIM id, this imply returns one network at most
453 shared: boolean >= returns only networks that are (or are not) shared
454 tenant_id: sting => returns only networks that belong to this tenant/project
455 ,#(not used yet) admin_state_up: boolean => returns only networks that are (or are not) in admin state
457 #(not used yet) status: 'ACTIVE','ERROR',... => filter networks that are on this status
458 Returns the network list of dictionaries. each dictionary contains:
459 'id': (mandatory) VIM network id
460 'name': (mandatory) VIM network name
461 'status': (mandatory) can be 'ACTIVE', 'INACTIVE', 'DOWN', 'BUILD', 'ERROR', 'VIM_ERROR', 'OTHER'
462 'network_type': (optional) can be 'vxlan', 'vlan' or 'flat'
463 'segmentation_id': (optional) in case network_type is vlan or vxlan this field contains the segmentation id
464 'error_msg': (optional) text that explains the ERROR status
465 other VIM specific fields: (optional) whenever possible using the same naming of filter_dict param
466 List can be empty if no network map the filter_dict. Raise an exception only upon VIM connectivity,
467 authorization, or some other unspecific error
469 raise VimConnNotImplemented("Should have implemented this")
471 def get_network(self
, net_id
):
472 """Obtain network details from the 'net_id' VIM network
473 Return a dict that contains:
474 'id': (mandatory) VIM network id, that is, net_id
475 'name': (mandatory) VIM network name
476 'status': (mandatory) can be 'ACTIVE', 'INACTIVE', 'DOWN', 'BUILD', 'ERROR', 'VIM_ERROR', 'OTHER'
477 'error_msg': (optional) text that explains the ERROR status
478 other VIM specific fields: (optional) whenever possible using the same naming of filter_dict param
479 Raises an exception upon error or when network is not found
481 raise VimConnNotImplemented("Should have implemented this")
483 def delete_network(self
, net_id
, created_items
=None):
485 Removes a tenant network from VIM and its associated elements
486 :param net_id: VIM identifier of the network, provided by method new_network
487 :param created_items: dictionary with extra items to be deleted. provided by method new_network
488 Returns the network identifier or raises an exception upon error or when network is not found
490 raise VimConnNotImplemented("Should have implemented this")
492 def refresh_nets_status(self
, net_list
):
493 """Get the status of the networks
495 'net_list': a list with the VIM network id to be get the status
496 Returns a dictionary with:
497 'net_id': #VIM id of this network
498 status: #Mandatory. Text with one of:
499 # DELETED (not found at vim)
500 # VIM_ERROR (Cannot connect to VIM, authentication problems, VIM response error, ...)
501 # OTHER (Vim reported other status not understood)
502 # ERROR (VIM indicates an ERROR status)
503 # ACTIVE, INACTIVE, DOWN (admin down),
504 # BUILD (on building process)
505 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
506 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
509 raise VimConnNotImplemented("Should have implemented this")
511 def get_flavor(self
, flavor_id
):
512 """Obtain flavor details from the VIM
513 Returns the flavor dict details {'id':<>, 'name':<>, other vim specific }
514 Raises an exception upon error or if not found
516 raise VimConnNotImplemented("Should have implemented this")
518 def get_flavor_id_from_data(self
, flavor_dict
):
519 """Obtain flavor id that match the flavor description
521 'flavor_dict': dictionary that contains:
522 'disk': main hard disk in GB
524 'vcpus': number of virtual cpus
525 #TODO: complete parameters for EPA
526 Returns the flavor_id or raises a VimConnNotFoundException
528 raise VimConnNotImplemented("Should have implemented this")
530 def new_flavor(self
, flavor_data
):
531 """Adds a tenant flavor to VIM
532 flavor_data contains a dictionary with information, keys:
534 ram: memory (cloud type) in MBytes
535 vpcus: cpus (cloud type)
536 extended: EPA parameters
537 - numas: #items requested in same NUMA
538 memory: number of 1G huge pages memory
539 paired-threads|cores|threads: number of paired hyperthreads, complete cores OR individual
541 interfaces: # passthrough(PT) or SRIOV interfaces attached to this numa
542 - name: interface name
543 dedicated: yes|no|yes:sriov; for PT, SRIOV or only one SRIOV for the physical NIC
544 bandwidth: X Gbps; requested guarantee bandwidth
545 vpci: requested virtual PCI address
549 Returns the flavor identifier
551 raise VimConnNotImplemented("Should have implemented this")
553 def delete_flavor(self
, flavor_id
):
554 """Deletes a tenant flavor from VIM identify by its id
555 Returns the used id or raise an exception
557 raise VimConnNotImplemented("Should have implemented this")
559 def get_affinity_group(self
, affinity_group_id
):
560 """Obtain affinity or anti affinity group details from the VIM
561 Returns the flavor dict details {'id':<>, 'name':<>, other vim specific }
562 Raises an exception upon error or if not found
564 raise VimConnNotImplemented("Should have implemented this")
566 def new_affinity_group(self
, affinity_group_data
):
567 """Adds an affinity or anti affinity group to VIM
568 affinity_group_data contains a dictionary with information, keys:
569 name: name in VIM for the affinity or anti-affinity group
570 type: affinity or anti-affinity
571 scope: Only nfvi-node allowed
572 Returns the affinity or anti affinity group identifier
574 raise VimConnNotImplemented("Should have implemented this")
576 def delete_affinity_group(self
, affinity_group_id
):
577 """Deletes an affinity or anti affinity group from the VIM identified by its id
578 Returns the used id or raise an exception
580 raise VimConnNotImplemented("Should have implemented this")
582 def new_image(self
, image_dict
):
583 """Adds a tenant image to VIM
584 Returns the image id or raises an exception if failed
586 raise VimConnNotImplemented("Should have implemented this")
588 def delete_image(self
, image_id
):
589 """Deletes a tenant image from VIM
590 Returns the image_id if image is deleted or raises an exception on error
592 raise VimConnNotImplemented("Should have implemented this")
594 def get_image_id_from_path(self
, path
):
595 """Get the image id from image path in the VIM database.
596 Returns the image_id or raises a VimConnNotFoundException
598 raise VimConnNotImplemented("Should have implemented this")
600 def get_image_list(self
, filter_dict
={}):
601 """Obtain tenant images from VIM
605 checksum: image checksum
607 Returns the image list of dictionaries:
608 [{<the fields at Filter_dict plus some VIM specific>}, ...]
611 raise VimConnNotImplemented("Should have implemented this")
624 availability_zone_index
=None,
625 availability_zone_list
=None,
627 """Adds a VM instance to VIM
629 'start': (boolean) indicates if VM must start or created in pause mode.
630 'image_id','flavor_id': image and flavor VIM id to use for the VM
631 affinity_group_list: list of affinity groups, each one is a dictionary.
633 'net_list': list of interfaces, each one is a dictionary with:
634 'name': (optional) name for the interface.
635 'net_id': VIM network id where this interface must be connect to. Mandatory for type==virtual
636 'vpci': (optional) virtual vPCI address to assign at the VM. Can be ignored depending on VIM
638 'model': (optional and only have sense for type==virtual) interface model: virtio, e1000, ...
639 'mac_address': (optional) mac address to assign to this interface
640 'ip_address': (optional) IP address to assign to this interface
641 #TODO: CHECK if an optional 'vlan' parameter is needed for VIMs when type if VF and net_id is not
642 provided, the VLAN tag to be used. In case net_id is provided, the internal network vlan is used
644 'type': (mandatory) can be one of:
645 'virtual', in this case always connected to a network of type 'net_type=bridge'
646 'PCI-PASSTHROUGH' or 'PF' (passthrough): depending on VIM capabilities it can be connected to a
647 data/ptp network ot it
648 can created unconnected
649 'SR-IOV' or 'VF' (SRIOV with VLAN tag): same as PF for network connectivity.
650 'VFnotShared'(SRIOV without VLAN tag) same as PF for network connectivity. VF where no other VFs
651 are allocated on the same physical NIC
652 'bw': (optional) only for PF/VF/VFnotShared. Minimal Bandwidth required for the interface in GBPS
653 'port_security': (optional) If False it must avoid any traffic filtering at this interface. If missing
654 or True, it must apply the default VIM behaviour
655 After execution the method will add the key:
656 'vim_id': must be filled/added by this method with the VIM identifier generated by the VIM for this
657 interface. 'net_list' is modified
658 'cloud_config': (optional) dictionary with:
659 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
660 'users': (optional) list of users to be inserted, each item is a dict with:
661 'name': (mandatory) user name,
662 'key-pairs': (optional) list of strings with the public key to be inserted to the user
663 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
664 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
665 'config-files': (optional). List of files to be transferred. Each item is a dict with:
666 'dest': (mandatory) string with the destination absolute path
667 'encoding': (optional, by default text). Can be one of:
668 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
669 'content' (mandatory): string with the content of the file
670 'permissions': (optional) string with file permissions, typically octal notation '0644'
671 'owner': (optional) file owner, string with the format 'owner:group'
672 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
673 'disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
674 'image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
675 'size': (mandatory) string with the size of the disk in GB
676 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
677 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
678 availability_zone_index is None
679 Returns a tuple with the instance identifier and created_items or raises an exception on error
680 created_items can be None or a dictionary where this method can include key-values that will be passed to
681 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
682 Format is VimConnector dependent, but do not use nested dictionaries and a value of None should be the same
685 raise VimConnNotImplemented("Should have implemented this")
687 def get_vminstance(self
, vm_id
):
688 """Returns the VM instance information from VIM"""
689 raise VimConnNotImplemented("Should have implemented this")
691 def delete_vminstance(self
, vm_id
, created_items
=None, volumes_to_hold
=None):
693 Removes a VM instance from VIM and its associated elements
694 :param vm_id: VIM identifier of the VM, provided by method new_vminstance
695 :param created_items: dictionary with extra items to be deleted. provided by method new_vminstance and/or method
697 :return: None or the same vm_id. Raises an exception on fail
699 raise VimConnNotImplemented("Should have implemented this")
701 def refresh_vms_status(self
, vm_list
):
702 """Get the status of the virtual machines and their interfaces/ports
703 Params: the list of VM identifiers
704 Returns a dictionary with:
705 vm_id: #VIM id of this Virtual Machine
706 status: #Mandatory. Text with one of:
707 # DELETED (not found at vim)
708 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
709 # OTHER (Vim reported other status not understood)
710 # ERROR (VIM indicates an ERROR status)
711 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
712 # BUILD (on building process), ERROR
713 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
715 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
716 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
717 interfaces: list with interface info. Each item a dictionary with:
718 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
719 mac_address: #Text format XX:XX:XX:XX:XX:XX
720 vim_net_id: #network id where this interface is connected, if provided at creation
721 vim_interface_id: #interface/port VIM id
722 ip_address: #null, or text with IPv4, IPv6 address
723 compute_node: #identification of compute node where PF,VF interface is allocated
724 pci: #PCI address of the NIC that hosts the PF,VF
725 vlan: #physical VLAN used for VF
727 raise VimConnNotImplemented("Should have implemented this")
729 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
731 Send and action over a VM instance. Returns created_items if the action was successfully sent to the VIM.
732 created_items is a dictionary with items that
733 :param vm_id: VIM identifier of the VM, provided by method new_vminstance
734 :param action_dict: dictionary with the action to perform
735 :param created_items: provided by method new_vminstance is a dictionary with key-values that will be passed to
736 the method delete_vminstance. Can be used to store created ports, volumes, etc. Format is VimConnector
737 dependent, but do not use nested dictionaries and a value of None should be the same as not present. This
738 method can modify this value
739 :return: None, or a console dict
741 raise VimConnNotImplemented("Should have implemented this")
743 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
745 Get a console for the virtual machine
747 vm_id: uuid of the VM
748 console_type, can be:
749 "novnc" (by default), "xvpvnc" for VNC types,
750 "rdp-html5" for RDP types, "spice-html5" for SPICE types
751 Returns dict with the console parameters:
752 protocol: ssh, ftp, http, https, ...
753 server: usually ip address
754 port: the http, ssh, ... port
755 suffix: extra text, e.g. the http path and query string
757 raise VimConnNotImplemented("Should have implemented this")
760 self
, ip_addr
=None, user
=None, key
=None, ro_key
=None, password
=None
763 Inject a ssh public key in a VM
765 ip_addr: ip address of the VM
766 user: username (default-user) to enter in the VM
767 key: public key to be injected in the VM
768 ro_key: private key of the RO, used to enter in the VM if the password is not provided
769 password: password of the user to enter in the VM
770 The function doesn't return a value:
772 if not ip_addr
or not user
:
773 raise VimConnNotSupportedException(
774 "All parameters should be different from 'None'"
776 elif not ro_key
and not password
:
777 raise VimConnNotSupportedException(
778 "All parameters should be different from 'None'"
783 'echo "{}" >> ~/.ssh/authorized_keys'.format(key
),
784 "chmod 644 ~/.ssh/authorized_keys",
789 format
="%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
791 logging
.getLogger("paramiko").setLevel(logging
.DEBUG
)
792 client
= paramiko
.SSHClient()
796 pkey
= paramiko
.RSAKey
.from_private_key(StringIO(ro_key
))
800 client
.set_missing_host_key_policy(paramiko
.AutoAddPolicy())
811 for command
in commands
:
812 (i
, o
, e
) = client
.exec_command(command
, timeout
=30)
813 returncode
= o
.channel
.recv_exit_status()
817 text
= "run_command='{}' Error='{}'".format(command
, outerror
)
818 self
.logger
.debug(traceback
.format_tb(e
.__traceback
__))
819 raise VimConnUnexpectedResponse(
820 "Cannot inject ssh key in VM: '{}'".format(text
)
825 paramiko
.AuthenticationException
,
826 paramiko
.SSHException
,
828 self
.logger
.debug(traceback
.format_exc())
829 raise VimConnUnexpectedResponse(
830 "Cannot inject ssh key in VM: '{}' - {}".format(
831 ip_addr
, str(message
)
837 def new_tenant(self
, tenant_name
, tenant_description
):
838 """Adds a new tenant to VIM with this name and description, this is done using admin_url if provided
839 "tenant_name": string max lenght 64
840 "tenant_description": string max length 256
841 returns the tenant identifier or raise exception
843 raise VimConnNotImplemented("Should have implemented this")
845 def delete_tenant(self
, tenant_id
):
846 """Delete a tenant from VIM
847 tenant_id: returned VIM tenant_id on "new_tenant"
848 Returns None on success. Raises and exception of failure. If tenant is not found raises VimConnNotFoundException
850 raise VimConnNotImplemented("Should have implemented this")
852 def migrate_instance(self
, vm_id
, compute_host
=None):
855 vm_id: ID of an instance
856 compute_host: Host to migrate the vdu to
857 Returns the vm state or raises an exception upon error
859 raise VimConnNotImplemented("Should have implemented this")
861 def resize_instance(self
, vm_id
, flavor_id
=None):
865 vm_id: ID of an instance
866 flavor_id: flavor_id to resize the vdu to
868 raise VimConnNotImplemented("Should have implemented this")