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
22 osconnector implements all the methods to interact with openstack using the python-neutronclient.
24 For the VNF forwarding graph, The OpenStack VIM connector calls the
25 networking-sfc Neutron extension methods, whose resources are mapped
26 to the VIM connector's SFC resources as follows:
27 - Classification (OSM) -> Flow Classifier (Neutron)
28 - Service Function Instance (OSM) -> Port Pair (Neutron)
29 - Service Function (OSM) -> Port Pair Group (Neutron)
30 - Service Function Path (OSM) -> Port Chain (Neutron)
34 from http
.client
import HTTPException
37 from pprint
import pformat
41 from typing
import Dict
, Optional
, Tuple
43 from cinderclient
import client
as cClient
44 from glanceclient
import client
as glClient
45 import glanceclient
.exc
as gl1Exceptions
46 from keystoneauth1
import session
47 from keystoneauth1
.identity
import v2
, v3
48 import keystoneclient
.exceptions
as ksExceptions
49 import keystoneclient
.v2_0
.client
as ksClient_v2
50 import keystoneclient
.v3
.client
as ksClient_v3
52 from neutronclient
.common
import exceptions
as neExceptions
53 from neutronclient
.neutron
import client
as neClient
54 from novaclient
import client
as nClient
, exceptions
as nvExceptions
55 from osm_ro_plugin
import vimconn
56 from requests
.exceptions
import ConnectionError
59 __author__
= "Alfonso Tierno, Gerardo Garcia, Pablo Montes, xFlow Research, Igor D.C., Eduardo Sousa"
60 __date__
= "$22-sep-2017 23:59:59$"
62 """contain the openstack virtual machine status to openmano status"""
63 vmStatus2manoFormat
= {
66 "SUSPENDED": "SUSPENDED",
67 "SHUTOFF": "INACTIVE",
72 netStatus2manoFormat
= {
75 "INACTIVE": "INACTIVE",
81 supportedClassificationTypes
= ["legacy_flow_classifier"]
83 # global var to have a timeout creating and deleting volumes
88 class SafeDumper(yaml
.SafeDumper
):
89 def represent_data(self
, data
):
90 # Openstack APIs use custom subclasses of dict and YAML safe dumper
91 # is designed to not handle that (reference issue 142 of pyyaml)
92 if isinstance(data
, dict) and data
.__class
__ != dict:
93 # A simple solution is to convert those items back to dicts
94 data
= dict(data
.items())
96 return super(SafeDumper
, self
).represent_data(data
)
99 class vimconnector(vimconn
.VimConnector
):
114 """using common constructor parameters. In this case
115 'url' is the keystone authorization url,
116 'url_admin' is not use
118 api_version
= config
.get("APIversion")
120 if api_version
and api_version
not in ("v3.3", "v2.0", "2", "3"):
121 raise vimconn
.VimConnException(
122 "Invalid value '{}' for config:APIversion. "
123 "Allowed values are 'v3.3', 'v2.0', '2' or '3'".format(api_version
)
126 vim_type
= config
.get("vim_type")
128 if vim_type
and vim_type
not in ("vio", "VIO"):
129 raise vimconn
.VimConnException(
130 "Invalid value '{}' for config:vim_type."
131 "Allowed values are 'vio' or 'VIO'".format(vim_type
)
134 if config
.get("dataplane_net_vlan_range") is not None:
135 # validate vlan ranges provided by user
136 self
._validate
_vlan
_ranges
(
137 config
.get("dataplane_net_vlan_range"), "dataplane_net_vlan_range"
140 if config
.get("multisegment_vlan_range") is not None:
141 # validate vlan ranges provided by user
142 self
._validate
_vlan
_ranges
(
143 config
.get("multisegment_vlan_range"), "multisegment_vlan_range"
146 vimconn
.VimConnector
.__init
__(
160 if self
.config
.get("insecure") and self
.config
.get("ca_cert"):
161 raise vimconn
.VimConnException(
162 "options insecure and ca_cert are mutually exclusive"
167 if self
.config
.get("insecure"):
170 if self
.config
.get("ca_cert"):
171 self
.verify
= self
.config
.get("ca_cert")
174 raise TypeError("url param can not be NoneType")
176 self
.persistent_info
= persistent_info
177 self
.availability_zone
= persistent_info
.get("availability_zone", None)
178 self
.session
= persistent_info
.get("session", {"reload_client": True})
179 self
.my_tenant_id
= self
.session
.get("my_tenant_id")
180 self
.nova
= self
.session
.get("nova")
181 self
.neutron
= self
.session
.get("neutron")
182 self
.cinder
= self
.session
.get("cinder")
183 self
.glance
= self
.session
.get("glance")
184 # self.glancev1 = self.session.get("glancev1")
185 self
.keystone
= self
.session
.get("keystone")
186 self
.api_version3
= self
.session
.get("api_version3")
187 self
.vim_type
= self
.config
.get("vim_type")
190 self
.vim_type
= self
.vim_type
.upper()
192 if self
.config
.get("use_internal_endpoint"):
193 self
.endpoint_type
= "internalURL"
195 self
.endpoint_type
= None
197 logging
.getLogger("urllib3").setLevel(logging
.WARNING
)
198 logging
.getLogger("keystoneauth").setLevel(logging
.WARNING
)
199 logging
.getLogger("novaclient").setLevel(logging
.WARNING
)
200 self
.logger
= logging
.getLogger("ro.vim.openstack")
202 # allow security_groups to be a list or a single string
203 if isinstance(self
.config
.get("security_groups"), str):
204 self
.config
["security_groups"] = [self
.config
["security_groups"]]
206 self
.security_groups_id
= None
208 # ###### VIO Specific Changes #########
209 if self
.vim_type
== "VIO":
210 self
.logger
= logging
.getLogger("ro.vim.vio")
213 self
.logger
.setLevel(getattr(logging
, log_level
))
215 def __getitem__(self
, index
):
216 """Get individuals parameters.
218 if index
== "project_domain_id":
219 return self
.config
.get("project_domain_id")
220 elif index
== "user_domain_id":
221 return self
.config
.get("user_domain_id")
223 return vimconn
.VimConnector
.__getitem
__(self
, index
)
225 def __setitem__(self
, index
, value
):
226 """Set individuals parameters and it is marked as dirty so to force connection reload.
228 if index
== "project_domain_id":
229 self
.config
["project_domain_id"] = value
230 elif index
== "user_domain_id":
231 self
.config
["user_domain_id"] = value
233 vimconn
.VimConnector
.__setitem
__(self
, index
, value
)
235 self
.session
["reload_client"] = True
237 def serialize(self
, value
):
238 """Serialization of python basic types.
240 In the case value is not serializable a message will be logged and a
241 simple representation of the data that cannot be converted back to
244 if isinstance(value
, str):
249 value
, Dumper
=SafeDumper
, default_flow_style
=True, width
=256
251 except yaml
.representer
.RepresenterError
:
253 "The following entity cannot be serialized in YAML:\n\n%s\n\n",
260 def _reload_connection(self
):
261 """Called before any operation, it check if credentials has changed
262 Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
264 # TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
265 if self
.session
["reload_client"]:
266 if self
.config
.get("APIversion"):
267 self
.api_version3
= (
268 self
.config
["APIversion"] == "v3.3"
269 or self
.config
["APIversion"] == "3"
271 else: # get from ending auth_url that end with v3 or with v2.0
272 self
.api_version3
= self
.url
.endswith("/v3") or self
.url
.endswith(
276 self
.session
["api_version3"] = self
.api_version3
278 if self
.api_version3
:
279 if self
.config
.get("project_domain_id") or self
.config
.get(
280 "project_domain_name"
282 project_domain_id_default
= None
284 project_domain_id_default
= "default"
286 if self
.config
.get("user_domain_id") or self
.config
.get(
289 user_domain_id_default
= None
291 user_domain_id_default
= "default"
295 password
=self
.passwd
,
296 project_name
=self
.tenant_name
,
297 project_id
=self
.tenant_id
,
298 project_domain_id
=self
.config
.get(
299 "project_domain_id", project_domain_id_default
301 user_domain_id
=self
.config
.get(
302 "user_domain_id", user_domain_id_default
304 project_domain_name
=self
.config
.get("project_domain_name"),
305 user_domain_name
=self
.config
.get("user_domain_name"),
311 password
=self
.passwd
,
312 tenant_name
=self
.tenant_name
,
313 tenant_id
=self
.tenant_id
,
316 sess
= session
.Session(auth
=auth
, verify
=self
.verify
)
317 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
318 # Titanium cloud and StarlingX
319 region_name
= self
.config
.get("region_name")
321 if self
.api_version3
:
322 self
.keystone
= ksClient_v3
.Client(
324 endpoint_type
=self
.endpoint_type
,
325 region_name
=region_name
,
328 self
.keystone
= ksClient_v2
.Client(
329 session
=sess
, endpoint_type
=self
.endpoint_type
332 self
.session
["keystone"] = self
.keystone
333 # In order to enable microversion functionality an explicit microversion must be specified in "config".
334 # This implementation approach is due to the warning message in
335 # https://developer.openstack.org/api-guide/compute/microversions.html
336 # where it is stated that microversion backwards compatibility is not guaranteed and clients should
337 # always require an specific microversion.
338 # To be able to use "device role tagging" functionality define "microversion: 2.32" in datacenter config
339 version
= self
.config
.get("microversion")
344 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
345 # Titanium cloud and StarlingX
346 self
.nova
= self
.session
["nova"] = nClient
.Client(
349 endpoint_type
=self
.endpoint_type
,
350 region_name
=region_name
,
352 self
.neutron
= self
.session
["neutron"] = neClient
.Client(
355 endpoint_type
=self
.endpoint_type
,
356 region_name
=region_name
,
358 self
.cinder
= self
.session
["cinder"] = cClient
.Client(
361 endpoint_type
=self
.endpoint_type
,
362 region_name
=region_name
,
366 self
.my_tenant_id
= self
.session
["my_tenant_id"] = sess
.get_project_id()
368 self
.logger
.error("Cannot get project_id from session", exc_info
=True)
370 if self
.endpoint_type
== "internalURL":
371 glance_service_id
= self
.keystone
.services
.list(name
="glance")[0].id
372 glance_endpoint
= self
.keystone
.endpoints
.list(
373 glance_service_id
, interface
="internal"
376 glance_endpoint
= None
378 self
.glance
= self
.session
["glance"] = glClient
.Client(
379 2, session
=sess
, endpoint
=glance_endpoint
381 # using version 1 of glance client in new_image()
382 # self.glancev1 = self.session["glancev1"] = glClient.Client("1", session=sess,
383 # endpoint=glance_endpoint)
384 self
.session
["reload_client"] = False
385 self
.persistent_info
["session"] = self
.session
386 # add availablity zone info inside self.persistent_info
387 self
._set
_availablity
_zones
()
388 self
.persistent_info
["availability_zone"] = self
.availability_zone
389 # force to get again security_groups_ids next time they are needed
390 self
.security_groups_id
= None
392 def __net_os2mano(self
, net_list_dict
):
393 """Transform the net openstack format to mano format
394 net_list_dict can be a list of dict or a single dict"""
395 if type(net_list_dict
) is dict:
396 net_list_
= (net_list_dict
,)
397 elif type(net_list_dict
) is list:
398 net_list_
= net_list_dict
400 raise TypeError("param net_list_dict must be a list or a dictionary")
401 for net
in net_list_
:
402 if net
.get("provider:network_type") == "vlan":
405 net
["type"] = "bridge"
407 def __classification_os2mano(self
, class_list_dict
):
408 """Transform the openstack format (Flow Classifier) to mano format
409 (Classification) class_list_dict can be a list of dict or a single dict
411 if isinstance(class_list_dict
, dict):
412 class_list_
= [class_list_dict
]
413 elif isinstance(class_list_dict
, list):
414 class_list_
= class_list_dict
416 raise TypeError("param class_list_dict must be a list or a dictionary")
417 for classification
in class_list_
:
418 id = classification
.pop("id")
419 name
= classification
.pop("name")
420 description
= classification
.pop("description")
421 project_id
= classification
.pop("project_id")
422 tenant_id
= classification
.pop("tenant_id")
423 original_classification
= copy
.deepcopy(classification
)
424 classification
.clear()
425 classification
["ctype"] = "legacy_flow_classifier"
426 classification
["definition"] = original_classification
427 classification
["id"] = id
428 classification
["name"] = name
429 classification
["description"] = description
430 classification
["project_id"] = project_id
431 classification
["tenant_id"] = tenant_id
433 def __sfi_os2mano(self
, sfi_list_dict
):
434 """Transform the openstack format (Port Pair) to mano format (SFI)
435 sfi_list_dict can be a list of dict or a single dict
437 if isinstance(sfi_list_dict
, dict):
438 sfi_list_
= [sfi_list_dict
]
439 elif isinstance(sfi_list_dict
, list):
440 sfi_list_
= sfi_list_dict
442 raise TypeError("param sfi_list_dict must be a list or a dictionary")
444 for sfi
in sfi_list_
:
445 sfi
["ingress_ports"] = []
446 sfi
["egress_ports"] = []
448 if sfi
.get("ingress"):
449 sfi
["ingress_ports"].append(sfi
["ingress"])
451 if sfi
.get("egress"):
452 sfi
["egress_ports"].append(sfi
["egress"])
456 params
= sfi
.get("service_function_parameters")
460 correlation
= params
.get("correlation")
465 sfi
["sfc_encap"] = sfc_encap
466 del sfi
["service_function_parameters"]
468 def __sf_os2mano(self
, sf_list_dict
):
469 """Transform the openstack format (Port Pair Group) to mano format (SF)
470 sf_list_dict can be a list of dict or a single dict
472 if isinstance(sf_list_dict
, dict):
473 sf_list_
= [sf_list_dict
]
474 elif isinstance(sf_list_dict
, list):
475 sf_list_
= sf_list_dict
477 raise TypeError("param sf_list_dict must be a list or a dictionary")
480 del sf
["port_pair_group_parameters"]
481 sf
["sfis"] = sf
["port_pairs"]
484 def __sfp_os2mano(self
, sfp_list_dict
):
485 """Transform the openstack format (Port Chain) to mano format (SFP)
486 sfp_list_dict can be a list of dict or a single dict
488 if isinstance(sfp_list_dict
, dict):
489 sfp_list_
= [sfp_list_dict
]
490 elif isinstance(sfp_list_dict
, list):
491 sfp_list_
= sfp_list_dict
493 raise TypeError("param sfp_list_dict must be a list or a dictionary")
495 for sfp
in sfp_list_
:
496 params
= sfp
.pop("chain_parameters")
500 correlation
= params
.get("correlation")
505 sfp
["sfc_encap"] = sfc_encap
506 sfp
["spi"] = sfp
.pop("chain_id")
507 sfp
["classifications"] = sfp
.pop("flow_classifiers")
508 sfp
["service_functions"] = sfp
.pop("port_pair_groups")
510 # placeholder for now; read TODO note below
511 def _validate_classification(self
, type, definition
):
512 # only legacy_flow_classifier Type is supported at this point
514 # TODO(igordcard): this method should be an abstract method of an
515 # abstract Classification class to be implemented by the specific
516 # Types. Also, abstract vimconnector should call the validation
517 # method before the implemented VIM connectors are called.
519 def _format_exception(self
, exception
):
520 """Transform a keystone, nova, neutron exception into a vimconn exception discovering the cause"""
521 message_error
= str(exception
)
527 neExceptions
.NetworkNotFoundClient
,
528 nvExceptions
.NotFound
,
529 ksExceptions
.NotFound
,
530 gl1Exceptions
.HTTPNotFound
,
533 raise vimconn
.VimConnNotFoundException(
534 type(exception
).__name
__ + ": " + message_error
540 gl1Exceptions
.HTTPException
,
541 gl1Exceptions
.CommunicationError
,
543 ksExceptions
.ConnectionError
,
544 neExceptions
.ConnectionFailed
,
547 if type(exception
).__name
__ == "SSLError":
548 tip
= " (maybe option 'insecure' must be added to the VIM)"
550 raise vimconn
.VimConnConnectionException(
551 "Invalid URL or credentials{}: {}".format(tip
, message_error
)
557 nvExceptions
.BadRequest
,
558 ksExceptions
.BadRequest
,
561 raise vimconn
.VimConnException(
562 type(exception
).__name
__ + ": " + message_error
567 nvExceptions
.ClientException
,
568 ksExceptions
.ClientException
,
569 neExceptions
.NeutronException
,
572 raise vimconn
.VimConnUnexpectedResponse(
573 type(exception
).__name
__ + ": " + message_error
575 elif isinstance(exception
, nvExceptions
.Conflict
):
576 raise vimconn
.VimConnConflictException(
577 type(exception
).__name
__ + ": " + message_error
579 elif isinstance(exception
, vimconn
.VimConnException
):
582 self
.logger
.error("General Exception " + message_error
, exc_info
=True)
584 raise vimconn
.VimConnConnectionException(
585 type(exception
).__name
__ + ": " + message_error
588 def _get_ids_from_name(self
):
590 Obtain ids from name of tenant and security_groups. Store at self .security_groups_id"
593 # get tenant_id if only tenant_name is supplied
594 self
._reload
_connection
()
596 if not self
.my_tenant_id
:
597 raise vimconn
.VimConnConnectionException(
598 "Error getting tenant information from name={} id={}".format(
599 self
.tenant_name
, self
.tenant_id
603 if self
.config
.get("security_groups") and not self
.security_groups_id
:
604 # convert from name to id
605 neutron_sg_list
= self
.neutron
.list_security_groups(
606 tenant_id
=self
.my_tenant_id
609 self
.security_groups_id
= []
610 for sg
in self
.config
.get("security_groups"):
611 for neutron_sg
in neutron_sg_list
:
612 if sg
in (neutron_sg
["id"], neutron_sg
["name"]):
613 self
.security_groups_id
.append(neutron_sg
["id"])
616 self
.security_groups_id
= None
618 raise vimconn
.VimConnConnectionException(
619 "Not found security group {} for this tenant".format(sg
)
622 def check_vim_connectivity(self
):
623 # just get network list to check connectivity and credentials
624 self
.get_network_list(filter_dict
={})
626 def get_tenant_list(self
, filter_dict
={}):
627 """Obtain tenants of VIM
628 filter_dict can contain the following keys:
629 name: filter by tenant name
630 id: filter by tenant uuid/id
632 Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
634 self
.logger
.debug("Getting tenants from VIM filter: '%s'", str(filter_dict
))
637 self
._reload
_connection
()
639 if self
.api_version3
:
640 project_class_list
= self
.keystone
.projects
.list(
641 name
=filter_dict
.get("name")
644 project_class_list
= self
.keystone
.tenants
.findall(**filter_dict
)
648 for project
in project_class_list
:
649 if filter_dict
.get("id") and filter_dict
["id"] != project
.id:
652 project_list
.append(project
.to_dict())
656 ksExceptions
.ConnectionError
,
657 ksExceptions
.ClientException
,
660 self
._format
_exception
(e
)
662 def new_tenant(self
, tenant_name
, tenant_description
):
663 """Adds a new tenant to openstack VIM. Returns the tenant identifier"""
664 self
.logger
.debug("Adding a new tenant name: %s", tenant_name
)
667 self
._reload
_connection
()
669 if self
.api_version3
:
670 project
= self
.keystone
.projects
.create(
672 self
.config
.get("project_domain_id", "default"),
673 description
=tenant_description
,
677 project
= self
.keystone
.tenants
.create(tenant_name
, tenant_description
)
681 ksExceptions
.ConnectionError
,
682 ksExceptions
.ClientException
,
683 ksExceptions
.BadRequest
,
686 self
._format
_exception
(e
)
688 def delete_tenant(self
, tenant_id
):
689 """Delete a tenant from openstack VIM. Returns the old tenant identifier"""
690 self
.logger
.debug("Deleting tenant %s from VIM", tenant_id
)
693 self
._reload
_connection
()
695 if self
.api_version3
:
696 self
.keystone
.projects
.delete(tenant_id
)
698 self
.keystone
.tenants
.delete(tenant_id
)
702 ksExceptions
.ConnectionError
,
703 ksExceptions
.ClientException
,
704 ksExceptions
.NotFound
,
707 self
._format
_exception
(e
)
715 provider_network_profile
=None,
717 """Adds a tenant network to VIM
719 'net_name': name of the network
721 'bridge': overlay isolated network
722 'data': underlay E-LAN network for Passthrough and SRIOV interfaces
723 'ptp': underlay E-LINE network for Passthrough and SRIOV interfaces.
724 'ip_profile': is a dict containing the IP parameters of the network
725 'ip_version': can be "IPv4" or "IPv6" (Currently only IPv4 is implemented)
726 'subnet_address': ip_prefix_schema, that is X.X.X.X/Y
727 'gateway_address': (Optional) ip_schema, that is X.X.X.X
728 'dns_address': (Optional) comma separated list of ip_schema, e.g. X.X.X.X[,X,X,X,X]
729 'dhcp_enabled': True or False
730 'dhcp_start_address': ip_schema, first IP to grant
731 'dhcp_count': number of IPs to grant.
732 'shared': if this network can be seen/use by other tenants/organization
733 'provider_network_profile': (optional) contains {segmentation-id: vlan, network-type: vlan|vxlan,
734 physical-network: physnet-label}
735 Returns a tuple with the network identifier and created_items, or raises an exception on error
736 created_items can be None or a dictionary where this method can include key-values that will be passed to
737 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
738 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
742 "Adding a new network to VIM name '%s', type '%s'", net_name
, net_type
744 # self.logger.debug(">>>>>>>>>>>>>>>>>> IP profile %s", str(ip_profile))
749 if provider_network_profile
:
750 vlan
= provider_network_profile
.get("segmentation-id")
754 self
._reload
_connection
()
755 network_dict
= {"name": net_name
, "admin_state_up": True}
757 if net_type
in ("data", "ptp") or provider_network_profile
:
758 provider_physical_network
= None
760 if provider_network_profile
and provider_network_profile
.get(
763 provider_physical_network
= provider_network_profile
.get(
767 # provider-network must be one of the dataplane_physcial_netowrk if this is a list. If it is string
768 # or not declared, just ignore the checking
771 self
.config
.get("dataplane_physical_net"), (tuple, list)
773 and provider_physical_network
774 not in self
.config
["dataplane_physical_net"]
776 raise vimconn
.VimConnConflictException(
777 "Invalid parameter 'provider-network:physical-network' "
778 "for network creation. '{}' is not one of the declared "
779 "list at VIM_config:dataplane_physical_net".format(
780 provider_physical_network
784 # use the default dataplane_physical_net
785 if not provider_physical_network
:
786 provider_physical_network
= self
.config
.get(
787 "dataplane_physical_net"
790 # if it is non empty list, use the first value. If it is a string use the value directly
792 isinstance(provider_physical_network
, (tuple, list))
793 and provider_physical_network
795 provider_physical_network
= provider_physical_network
[0]
797 if not provider_physical_network
:
798 raise vimconn
.VimConnConflictException(
799 "missing information needed for underlay networks. Provide "
800 "'dataplane_physical_net' configuration at VIM or use the NS "
801 "instantiation parameter 'provider-network.physical-network'"
805 if not self
.config
.get("multisegment_support"):
807 "provider:physical_network"
808 ] = provider_physical_network
811 provider_network_profile
812 and "network-type" in provider_network_profile
815 "provider:network_type"
816 ] = provider_network_profile
["network-type"]
818 network_dict
["provider:network_type"] = self
.config
.get(
819 "dataplane_network_type", "vlan"
823 network_dict
["provider:segmentation_id"] = vlan
828 "provider:physical_network": "",
829 "provider:network_type": "vxlan",
831 segment_list
.append(segment1_dict
)
833 "provider:physical_network": provider_physical_network
,
834 "provider:network_type": "vlan",
838 segment2_dict
["provider:segmentation_id"] = vlan
839 elif self
.config
.get("multisegment_vlan_range"):
840 vlanID
= self
._generate
_multisegment
_vlanID
()
841 segment2_dict
["provider:segmentation_id"] = vlanID
844 # raise vimconn.VimConnConflictException(
845 # "You must provide "multisegment_vlan_range" at config dict before creating a multisegment
847 segment_list
.append(segment2_dict
)
848 network_dict
["segments"] = segment_list
850 # VIO Specific Changes. It needs a concrete VLAN
851 if self
.vim_type
== "VIO" and vlan
is None:
852 if self
.config
.get("dataplane_net_vlan_range") is None:
853 raise vimconn
.VimConnConflictException(
854 "You must provide 'dataplane_net_vlan_range' in format "
855 "[start_ID - end_ID] at VIM_config for creating underlay "
859 network_dict
["provider:segmentation_id"] = self
._generate
_vlanID
()
861 network_dict
["shared"] = shared
863 if self
.config
.get("disable_network_port_security"):
864 network_dict
["port_security_enabled"] = False
866 if self
.config
.get("neutron_availability_zone_hints"):
867 hints
= self
.config
.get("neutron_availability_zone_hints")
869 if isinstance(hints
, str):
872 network_dict
["availability_zone_hints"] = hints
874 new_net
= self
.neutron
.create_network({"network": network_dict
})
876 # create subnetwork, even if there is no profile
881 if not ip_profile
.get("subnet_address"):
882 # Fake subnet is required
883 subnet_rand
= random
.randint(0, 255)
884 ip_profile
["subnet_address"] = "192.168.{}.0/24".format(subnet_rand
)
886 if "ip_version" not in ip_profile
:
887 ip_profile
["ip_version"] = "IPv4"
890 "name": net_name
+ "-subnet",
891 "network_id": new_net
["network"]["id"],
892 "ip_version": 4 if ip_profile
["ip_version"] == "IPv4" else 6,
893 "cidr": ip_profile
["subnet_address"],
896 # Gateway should be set to None if not needed. Otherwise openstack assigns one by default
897 if ip_profile
.get("gateway_address"):
898 subnet
["gateway_ip"] = ip_profile
["gateway_address"]
900 subnet
["gateway_ip"] = None
902 if ip_profile
.get("dns_address"):
903 subnet
["dns_nameservers"] = ip_profile
["dns_address"].split(";")
905 if "dhcp_enabled" in ip_profile
:
906 subnet
["enable_dhcp"] = (
908 if ip_profile
["dhcp_enabled"] == "false"
909 or ip_profile
["dhcp_enabled"] is False
913 if ip_profile
.get("dhcp_start_address"):
914 subnet
["allocation_pools"] = []
915 subnet
["allocation_pools"].append(dict())
916 subnet
["allocation_pools"][0]["start"] = ip_profile
[
920 if ip_profile
.get("dhcp_count"):
921 # parts = ip_profile["dhcp_start_address"].split(".")
922 # ip_int = (int(parts[0]) << 24) + (int(parts[1]) << 16) + (int(parts[2]) << 8) + int(parts[3])
923 ip_int
= int(netaddr
.IPAddress(ip_profile
["dhcp_start_address"]))
924 ip_int
+= ip_profile
["dhcp_count"] - 1
925 ip_str
= str(netaddr
.IPAddress(ip_int
))
926 subnet
["allocation_pools"][0]["end"] = ip_str
928 # self.logger.debug(">>>>>>>>>>>>>>>>>> Subnet: %s", str(subnet))
929 self
.neutron
.create_subnet({"subnet": subnet
})
931 if net_type
== "data" and self
.config
.get("multisegment_support"):
932 if self
.config
.get("l2gw_support"):
933 l2gw_list
= self
.neutron
.list_l2_gateways().get("l2_gateways", ())
934 for l2gw
in l2gw_list
:
936 "l2_gateway_id": l2gw
["id"],
937 "network_id": new_net
["network"]["id"],
938 "segmentation_id": str(vlanID
),
940 new_l2gw_conn
= self
.neutron
.create_l2_gateway_connection(
941 {"l2_gateway_connection": l2gw_conn
}
945 + str(new_l2gw_conn
["l2_gateway_connection"]["id"])
948 return new_net
["network"]["id"], created_items
949 except Exception as e
:
950 # delete l2gw connections (if any) before deleting the network
951 for k
, v
in created_items
.items():
952 if not v
: # skip already deleted
956 k_item
, _
, k_id
= k
.partition(":")
958 if k_item
== "l2gwconn":
959 self
.neutron
.delete_l2_gateway_connection(k_id
)
960 except Exception as e2
:
962 "Error deleting l2 gateway connection: {}: {}".format(
963 type(e2
).__name
__, e2
968 self
.neutron
.delete_network(new_net
["network"]["id"])
970 self
._format
_exception
(e
)
972 def get_network_list(self
, filter_dict
={}):
973 """Obtain tenant networks of VIM
979 admin_state_up: boolean
981 Returns the network list of dictionaries
983 self
.logger
.debug("Getting network from VIM filter: '%s'", str(filter_dict
))
986 self
._reload
_connection
()
987 filter_dict_os
= filter_dict
.copy()
989 if self
.api_version3
and "tenant_id" in filter_dict_os
:
991 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
993 net_dict
= self
.neutron
.list_networks(**filter_dict_os
)
994 net_list
= net_dict
["networks"]
995 self
.__net
_os
2mano
(net_list
)
999 neExceptions
.ConnectionFailed
,
1000 ksExceptions
.ClientException
,
1001 neExceptions
.NeutronException
,
1004 self
._format
_exception
(e
)
1006 def get_network(self
, net_id
):
1007 """Obtain details of network from VIM
1008 Returns the network information from a network id"""
1009 self
.logger
.debug(" Getting tenant network %s from VIM", net_id
)
1010 filter_dict
= {"id": net_id
}
1011 net_list
= self
.get_network_list(filter_dict
)
1013 if len(net_list
) == 0:
1014 raise vimconn
.VimConnNotFoundException(
1015 "Network '{}' not found".format(net_id
)
1017 elif len(net_list
) > 1:
1018 raise vimconn
.VimConnConflictException(
1019 "Found more than one network with this criteria"
1024 for subnet_id
in net
.get("subnets", ()):
1026 subnet
= self
.neutron
.show_subnet(subnet_id
)
1027 except Exception as e
:
1029 "osconnector.get_network(): Error getting subnet %s %s"
1032 subnet
= {"id": subnet_id
, "fault": str(e
)}
1034 subnets
.append(subnet
)
1036 net
["subnets"] = subnets
1037 net
["encapsulation"] = net
.get("provider:network_type")
1038 net
["encapsulation_type"] = net
.get("provider:network_type")
1039 net
["segmentation_id"] = net
.get("provider:segmentation_id")
1040 net
["encapsulation_id"] = net
.get("provider:segmentation_id")
1044 def delete_network(self
, net_id
, created_items
=None):
1046 Removes a tenant network from VIM and its associated elements
1047 :param net_id: VIM identifier of the network, provided by method new_network
1048 :param created_items: dictionary with extra items to be deleted. provided by method new_network
1049 Returns the network identifier or raises an exception upon error or when network is not found
1051 self
.logger
.debug("Deleting network '%s' from VIM", net_id
)
1053 if created_items
is None:
1057 self
._reload
_connection
()
1058 # delete l2gw connections (if any) before deleting the network
1059 for k
, v
in created_items
.items():
1060 if not v
: # skip already deleted
1064 k_item
, _
, k_id
= k
.partition(":")
1065 if k_item
== "l2gwconn":
1066 self
.neutron
.delete_l2_gateway_connection(k_id
)
1067 except Exception as e
:
1069 "Error deleting l2 gateway connection: {}: {}".format(
1074 # delete VM ports attached to this networks before the network
1075 ports
= self
.neutron
.list_ports(network_id
=net_id
)
1076 for p
in ports
["ports"]:
1078 self
.neutron
.delete_port(p
["id"])
1079 except Exception as e
:
1080 self
.logger
.error("Error deleting port %s: %s", p
["id"], str(e
))
1082 self
.neutron
.delete_network(net_id
)
1086 neExceptions
.ConnectionFailed
,
1087 neExceptions
.NetworkNotFoundClient
,
1088 neExceptions
.NeutronException
,
1089 ksExceptions
.ClientException
,
1090 neExceptions
.NeutronException
,
1093 self
._format
_exception
(e
)
1095 def refresh_nets_status(self
, net_list
):
1096 """Get the status of the networks
1097 Params: the list of network identifiers
1098 Returns a dictionary with:
1099 net_id: #VIM id of this network
1100 status: #Mandatory. Text with one of:
1101 # DELETED (not found at vim)
1102 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1103 # OTHER (Vim reported other status not understood)
1104 # ERROR (VIM indicates an ERROR status)
1105 # ACTIVE, INACTIVE, DOWN (admin down),
1106 # BUILD (on building process)
1108 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
1109 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1113 for net_id
in net_list
:
1117 net_vim
= self
.get_network(net_id
)
1119 if net_vim
["status"] in netStatus2manoFormat
:
1120 net
["status"] = netStatus2manoFormat
[net_vim
["status"]]
1122 net
["status"] = "OTHER"
1123 net
["error_msg"] = "VIM status reported " + net_vim
["status"]
1125 if net
["status"] == "ACTIVE" and not net_vim
["admin_state_up"]:
1126 net
["status"] = "DOWN"
1128 net
["vim_info"] = self
.serialize(net_vim
)
1130 if net_vim
.get("fault"): # TODO
1131 net
["error_msg"] = str(net_vim
["fault"])
1132 except vimconn
.VimConnNotFoundException
as e
:
1133 self
.logger
.error("Exception getting net status: %s", str(e
))
1134 net
["status"] = "DELETED"
1135 net
["error_msg"] = str(e
)
1136 except vimconn
.VimConnException
as e
:
1137 self
.logger
.error("Exception getting net status: %s", str(e
))
1138 net
["status"] = "VIM_ERROR"
1139 net
["error_msg"] = str(e
)
1140 net_dict
[net_id
] = net
1143 def get_flavor(self
, flavor_id
):
1144 """Obtain flavor details from the VIM. Returns the flavor dict details"""
1145 self
.logger
.debug("Getting flavor '%s'", flavor_id
)
1148 self
._reload
_connection
()
1149 flavor
= self
.nova
.flavors
.find(id=flavor_id
)
1150 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
1152 return flavor
.to_dict()
1154 nvExceptions
.NotFound
,
1155 nvExceptions
.ClientException
,
1156 ksExceptions
.ClientException
,
1159 self
._format
_exception
(e
)
1161 def get_flavor_id_from_data(self
, flavor_dict
):
1162 """Obtain flavor id that match the flavor description
1163 Returns the flavor_id or raises a vimconnNotFoundException
1164 flavor_dict: contains the required ram, vcpus, disk
1165 If 'use_existing_flavors' is set to True at config, the closer flavor that provides same or more ram, vcpus
1166 and disk is returned. Otherwise a flavor with exactly same ram, vcpus and disk is returned or a
1167 vimconnNotFoundException is raised
1169 exact_match
= False if self
.config
.get("use_existing_flavors") else True
1172 self
._reload
_connection
()
1173 flavor_candidate_id
= None
1174 flavor_candidate_data
= (10000, 10000, 10000)
1177 flavor_dict
["vcpus"],
1178 flavor_dict
["disk"],
1179 flavor_dict
.get("ephemeral", 0),
1180 flavor_dict
.get("swap", 0),
1183 extended
= flavor_dict
.get("extended", {})
1186 raise vimconn
.VimConnNotFoundException(
1187 "Flavor with EPA still not implemented"
1189 # if len(numas) > 1:
1190 # raise vimconn.VimConnNotFoundException("Cannot find any flavor with more than one numa")
1192 # numas = extended.get("numas")
1193 for flavor
in self
.nova
.flavors
.list():
1194 epa
= flavor
.get_keys()
1205 flavor
.swap
if isinstance(flavor
.swap
, int) else 0,
1207 if flavor_data
== flavor_target
:
1211 and flavor_target
< flavor_data
< flavor_candidate_data
1213 flavor_candidate_id
= flavor
.id
1214 flavor_candidate_data
= flavor_data
1216 if not exact_match
and flavor_candidate_id
:
1217 return flavor_candidate_id
1219 raise vimconn
.VimConnNotFoundException(
1220 "Cannot find any flavor matching '{}'".format(flavor_dict
)
1223 nvExceptions
.NotFound
,
1224 nvExceptions
.ClientException
,
1225 ksExceptions
.ClientException
,
1228 self
._format
_exception
(e
)
1230 def process_resource_quota(self
, quota
, prefix
, extra_specs
):
1236 if "limit" in quota
:
1237 extra_specs
["quota:" + prefix
+ "_limit"] = quota
["limit"]
1239 if "reserve" in quota
:
1240 extra_specs
["quota:" + prefix
+ "_reservation"] = quota
["reserve"]
1242 if "shares" in quota
:
1243 extra_specs
["quota:" + prefix
+ "_shares_level"] = "custom"
1244 extra_specs
["quota:" + prefix
+ "_shares_share"] = quota
["shares"]
1246 def new_flavor(self
, flavor_data
, change_name_if_used
=True):
1247 """Adds a tenant flavor to openstack VIM
1248 if change_name_if_used is True, it will change name in case of conflict, because it is not supported name
1250 Returns the flavor identifier
1252 self
.logger
.debug("Adding flavor '%s'", str(flavor_data
))
1258 name
= flavor_data
["name"]
1259 while retry
< max_retries
:
1262 self
._reload
_connection
()
1264 if change_name_if_used
:
1267 fl
= self
.nova
.flavors
.list()
1270 fl_names
.append(f
.name
)
1272 while name
in fl_names
:
1274 name
= flavor_data
["name"] + "-" + str(name_suffix
)
1276 ram
= flavor_data
.get("ram", 64)
1277 vcpus
= flavor_data
.get("vcpus", 1)
1280 extended
= flavor_data
.get("extended")
1282 numas
= extended
.get("numas")
1285 numa_nodes
= len(numas
)
1287 extra_specs
["hw:numa_nodes"] = str(numa_nodes
)
1289 if self
.vim_type
== "VIO":
1291 "vmware:extra_config"
1292 ] = '{"numa.nodeAffinity":"0"}'
1293 extra_specs
["vmware:latency_sensitivity_level"] = "high"
1297 node_id
= numa
["id"]
1299 if "memory" in numa
:
1300 memory_mb
= numa
["memory"] * 1024
1301 memory
= "hw:numa_mem.{}".format(node_id
)
1302 extra_specs
[memory
] = int(memory_mb
)
1306 cpu
= "hw:numa_cpus.{}".format(node_id
)
1307 vcpu
= ",".join(map(str, vcpu
))
1308 extra_specs
[cpu
] = vcpu
1310 # overwrite ram and vcpus
1311 # check if key "memory" is present in numa else use ram value at flavor
1312 # See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/
1313 # implemented/virt-driver-cpu-thread-pinning.html
1314 extra_specs
["hw:cpu_sockets"] = str(numa_nodes
)
1316 if "paired-threads" in numa
:
1317 vcpus
= numa
["paired-threads"] * 2
1318 # cpu_thread_policy "require" implies that the compute node must have an
1320 extra_specs
["hw:cpu_thread_policy"] = "require"
1321 extra_specs
["hw:cpu_policy"] = "dedicated"
1322 elif "cores" in numa
:
1323 vcpus
= numa
["cores"]
1324 # cpu_thread_policy "prefer" implies that the host must not have an SMT
1325 # architecture, or a non-SMT architecture will be emulated
1326 extra_specs
["hw:cpu_thread_policy"] = "isolate"
1327 extra_specs
["hw:cpu_policy"] = "dedicated"
1328 elif "threads" in numa
:
1329 vcpus
= numa
["threads"]
1330 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT
1332 extra_specs
["hw:cpu_thread_policy"] = "prefer"
1333 extra_specs
["hw:cpu_policy"] = "dedicated"
1334 # for interface in numa.get("interfaces",() ):
1335 # if interface["dedicated"]=="yes":
1336 # raise vimconn.VimConnException("Passthrough interfaces are not supported
1337 # for the openstack connector", http_code=vimconn.HTTP_Service_Unavailable)
1338 # #TODO, add the key 'pci_passthrough:alias"="<label at config>:<number ifaces>"'
1339 # when a way to connect it is available
1340 elif extended
.get("cpu-quota"):
1341 self
.process_resource_quota(
1342 extended
.get("cpu-quota"), "cpu", extra_specs
1345 if extended
.get("mem-quota"):
1346 self
.process_resource_quota(
1347 extended
.get("mem-quota"), "memory", extra_specs
1350 if extended
.get("vif-quota"):
1351 self
.process_resource_quota(
1352 extended
.get("vif-quota"), "vif", extra_specs
1355 if extended
.get("disk-io-quota"):
1356 self
.process_resource_quota(
1357 extended
.get("disk-io-quota"), "disk_io", extra_specs
1360 # Set the mempage size as specified in the descriptor
1361 if extended
.get("mempage-size"):
1362 if extended
.get("mempage-size") == "LARGE":
1363 extra_specs
["hw:mem_page_size"] = "large"
1364 elif extended
.get("mempage-size") == "SMALL":
1365 extra_specs
["hw:mem_page_size"] = "small"
1366 elif extended
.get("mempage-size") == "SIZE_2MB":
1367 extra_specs
["hw:mem_page_size"] = "2MB"
1368 elif extended
.get("mempage-size") == "SIZE_1GB":
1369 extra_specs
["hw:mem_page_size"] = "1GB"
1370 elif extended
.get("mempage-size") == "PREFER_LARGE":
1371 extra_specs
["hw:mem_page_size"] = "any"
1373 # The validations in NBI should make reaching here not possible.
1374 # If this message is shown, check validations
1376 "Invalid mempage-size %s. Will be ignored",
1377 extended
.get("mempage-size"),
1379 if extended
.get("cpu-pinning-policy"):
1380 extra_specs
["hw:cpu_policy"] = extended
.get(
1381 "cpu-pinning-policy"
1384 # Set the cpu thread pinning policy as specified in the descriptor
1385 if extended
.get("cpu-thread-pinning-policy"):
1386 extra_specs
["hw:cpu_thread_policy"] = extended
.get(
1387 "cpu-thread-pinning-policy"
1390 # Set the mem policy as specified in the descriptor
1391 if extended
.get("mem-policy"):
1392 extra_specs
["hw:numa_mempolicy"] = extended
.get(
1397 new_flavor
= self
.nova
.flavors
.create(
1401 disk
=flavor_data
.get("disk", 0),
1402 ephemeral
=flavor_data
.get("ephemeral", 0),
1403 swap
=flavor_data
.get("swap", 0),
1404 is_public
=flavor_data
.get("is_public", True),
1408 new_flavor
.set_keys(extra_specs
)
1410 return new_flavor
.id
1411 except nvExceptions
.Conflict
as e
:
1412 if change_name_if_used
and retry
< max_retries
:
1415 self
._format
_exception
(e
)
1416 # except nvExceptions.BadRequest as e:
1418 ksExceptions
.ClientException
,
1419 nvExceptions
.ClientException
,
1423 self
._format
_exception
(e
)
1425 def delete_flavor(self
, flavor_id
):
1426 """Deletes a tenant flavor from openstack VIM. Returns the old flavor_id"""
1428 self
._reload
_connection
()
1429 self
.nova
.flavors
.delete(flavor_id
)
1432 # except nvExceptions.BadRequest as e:
1434 nvExceptions
.NotFound
,
1435 ksExceptions
.ClientException
,
1436 nvExceptions
.ClientException
,
1439 self
._format
_exception
(e
)
1441 def new_image(self
, image_dict
):
1443 Adds a tenant image to VIM. imge_dict is a dictionary with:
1445 disk_format: qcow2, vhd, vmdk, raw (by default), ...
1446 location: path or URI
1447 public: "yes" or "no"
1448 metadata: metadata of the image
1449 Returns the image_id
1454 while retry
< max_retries
:
1457 self
._reload
_connection
()
1459 # determine format http://docs.openstack.org/developer/glance/formats.html
1460 if "disk_format" in image_dict
:
1461 disk_format
= image_dict
["disk_format"]
1462 else: # autodiscover based on extension
1463 if image_dict
["location"].endswith(".qcow2"):
1464 disk_format
= "qcow2"
1465 elif image_dict
["location"].endswith(".vhd"):
1467 elif image_dict
["location"].endswith(".vmdk"):
1468 disk_format
= "vmdk"
1469 elif image_dict
["location"].endswith(".vdi"):
1471 elif image_dict
["location"].endswith(".iso"):
1473 elif image_dict
["location"].endswith(".aki"):
1475 elif image_dict
["location"].endswith(".ari"):
1477 elif image_dict
["location"].endswith(".ami"):
1483 "new_image: '%s' loading from '%s'",
1485 image_dict
["location"],
1487 if self
.vim_type
== "VIO":
1488 container_format
= "bare"
1489 if "container_format" in image_dict
:
1490 container_format
= image_dict
["container_format"]
1492 new_image
= self
.glance
.images
.create(
1493 name
=image_dict
["name"],
1494 container_format
=container_format
,
1495 disk_format
=disk_format
,
1498 new_image
= self
.glance
.images
.create(name
=image_dict
["name"])
1500 if image_dict
["location"].startswith("http"):
1501 # TODO there is not a method to direct download. It must be downloaded locally with requests
1502 raise vimconn
.VimConnNotImplemented("Cannot create image from URL")
1504 with
open(image_dict
["location"]) as fimage
:
1505 self
.glance
.images
.upload(new_image
.id, fimage
)
1506 # new_image = self.glancev1.images.create(name=image_dict["name"], is_public=
1507 # image_dict.get("public","yes")=="yes",
1508 # container_format="bare", data=fimage, disk_format=disk_format)
1510 metadata_to_load
= image_dict
.get("metadata")
1512 # TODO location is a reserved word for current openstack versions. fixed for VIO please check
1514 if self
.vim_type
== "VIO":
1515 metadata_to_load
["upload_location"] = image_dict
["location"]
1517 metadata_to_load
["location"] = image_dict
["location"]
1519 self
.glance
.images
.update(new_image
.id, **metadata_to_load
)
1523 nvExceptions
.Conflict
,
1524 ksExceptions
.ClientException
,
1525 nvExceptions
.ClientException
,
1527 self
._format
_exception
(e
)
1530 gl1Exceptions
.HTTPException
,
1531 gl1Exceptions
.CommunicationError
,
1534 if retry
== max_retries
:
1537 self
._format
_exception
(e
)
1538 except IOError as e
: # can not open the file
1539 raise vimconn
.VimConnConnectionException(
1540 "{}: {} for {}".format(type(e
).__name
__, e
, image_dict
["location"]),
1541 http_code
=vimconn
.HTTP_Bad_Request
,
1544 def delete_image(self
, image_id
):
1545 """Deletes a tenant image from openstack VIM. Returns the old id"""
1547 self
._reload
_connection
()
1548 self
.glance
.images
.delete(image_id
)
1552 nvExceptions
.NotFound
,
1553 ksExceptions
.ClientException
,
1554 nvExceptions
.ClientException
,
1555 gl1Exceptions
.CommunicationError
,
1556 gl1Exceptions
.HTTPNotFound
,
1558 ) as e
: # TODO remove
1559 self
._format
_exception
(e
)
1561 def get_image_id_from_path(self
, path
):
1562 """Get the image id from image path in the VIM database. Returns the image_id"""
1564 self
._reload
_connection
()
1565 images
= self
.glance
.images
.list()
1567 for image
in images
:
1568 if image
.metadata
.get("location") == path
:
1571 raise vimconn
.VimConnNotFoundException(
1572 "image with location '{}' not found".format(path
)
1575 ksExceptions
.ClientException
,
1576 nvExceptions
.ClientException
,
1577 gl1Exceptions
.CommunicationError
,
1580 self
._format
_exception
(e
)
1582 def get_image_list(self
, filter_dict
={}):
1583 """Obtain tenant images from VIM
1587 checksum: image checksum
1588 Returns the image list of dictionaries:
1589 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1592 self
.logger
.debug("Getting image list from VIM filter: '%s'", str(filter_dict
))
1595 self
._reload
_connection
()
1596 # filter_dict_os = filter_dict.copy()
1597 # First we filter by the available filter fields: name, id. The others are removed.
1598 image_list
= self
.glance
.images
.list()
1601 for image
in image_list
:
1603 if filter_dict
.get("name") and image
["name"] != filter_dict
["name"]:
1606 if filter_dict
.get("id") and image
["id"] != filter_dict
["id"]:
1610 filter_dict
.get("checksum")
1611 and image
["checksum"] != filter_dict
["checksum"]
1615 filtered_list
.append(image
.copy())
1616 except gl1Exceptions
.HTTPNotFound
:
1619 return filtered_list
1621 ksExceptions
.ClientException
,
1622 nvExceptions
.ClientException
,
1623 gl1Exceptions
.CommunicationError
,
1626 self
._format
_exception
(e
)
1628 def __wait_for_vm(self
, vm_id
, status
):
1629 """wait until vm is in the desired status and return True.
1630 If the VM gets in ERROR status, return false.
1631 If the timeout is reached generate an exception"""
1633 while elapsed_time
< server_timeout
:
1634 vm_status
= self
.nova
.servers
.get(vm_id
).status
1636 if vm_status
== status
:
1639 if vm_status
== "ERROR":
1645 # if we exceeded the timeout rollback
1646 if elapsed_time
>= server_timeout
:
1647 raise vimconn
.VimConnException(
1648 "Timeout waiting for instance " + vm_id
+ " to get " + status
,
1649 http_code
=vimconn
.HTTP_Request_Timeout
,
1652 def _get_openstack_availablity_zones(self
):
1654 Get from openstack availability zones available
1658 openstack_availability_zone
= self
.nova
.availability_zones
.list()
1659 openstack_availability_zone
= [
1661 for zone
in openstack_availability_zone
1662 if zone
.zoneName
!= "internal"
1665 return openstack_availability_zone
1669 def _set_availablity_zones(self
):
1671 Set vim availablity zone
1674 if "availability_zone" in self
.config
:
1675 vim_availability_zones
= self
.config
.get("availability_zone")
1677 if isinstance(vim_availability_zones
, str):
1678 self
.availability_zone
= [vim_availability_zones
]
1679 elif isinstance(vim_availability_zones
, list):
1680 self
.availability_zone
= vim_availability_zones
1682 self
.availability_zone
= self
._get
_openstack
_availablity
_zones
()
1684 def _get_vm_availability_zone(
1685 self
, availability_zone_index
, availability_zone_list
1688 Return thge availability zone to be used by the created VM.
1689 :return: The VIM availability zone to be used or None
1691 if availability_zone_index
is None:
1692 if not self
.config
.get("availability_zone"):
1694 elif isinstance(self
.config
.get("availability_zone"), str):
1695 return self
.config
["availability_zone"]
1697 # TODO consider using a different parameter at config for default AV and AV list match
1698 return self
.config
["availability_zone"][0]
1700 vim_availability_zones
= self
.availability_zone
1701 # check if VIM offer enough availability zones describe in the VNFD
1702 if vim_availability_zones
and len(availability_zone_list
) <= len(
1703 vim_availability_zones
1705 # check if all the names of NFV AV match VIM AV names
1706 match_by_index
= False
1707 for av
in availability_zone_list
:
1708 if av
not in vim_availability_zones
:
1709 match_by_index
= True
1713 return vim_availability_zones
[availability_zone_index
]
1715 return availability_zone_list
[availability_zone_index
]
1717 raise vimconn
.VimConnConflictException(
1718 "No enough availability zones at VIM for this deployment"
1721 def _prepare_port_dict_security_groups(self
, net
: dict, port_dict
: dict) -> None:
1722 """Fill up the security_groups in the port_dict.
1725 net (dict): Network details
1726 port_dict (dict): Port details
1730 self
.config
.get("security_groups")
1731 and net
.get("port_security") is not False
1732 and not self
.config
.get("no_port_security_extension")
1734 if not self
.security_groups_id
:
1735 self
._get
_ids
_from
_name
()
1737 port_dict
["security_groups"] = self
.security_groups_id
1739 def _prepare_port_dict_binding(self
, net
: dict, port_dict
: dict) -> None:
1740 """Fill up the network binding depending on network type in the port_dict.
1743 net (dict): Network details
1744 port_dict (dict): Port details
1747 if not net
.get("type"):
1748 raise vimconn
.VimConnException("Type is missing in the network details.")
1750 if net
["type"] == "virtual":
1754 elif net
["type"] == "VF" or net
["type"] == "SR-IOV":
1755 port_dict
["binding:vnic_type"] = "direct"
1757 # VIO specific Changes
1758 if self
.vim_type
== "VIO":
1759 # Need to create port with port_security_enabled = False and no-security-groups
1760 port_dict
["port_security_enabled"] = False
1761 port_dict
["provider_security_groups"] = []
1762 port_dict
["security_groups"] = []
1765 # For PT PCI-PASSTHROUGH
1766 port_dict
["binding:vnic_type"] = "direct-physical"
1769 def _set_fixed_ip(new_port
: dict, net
: dict) -> None:
1770 """Set the "ip" parameter in net dictionary.
1773 new_port (dict): New created port
1774 net (dict): Network details
1777 fixed_ips
= new_port
["port"].get("fixed_ips")
1780 net
["ip"] = fixed_ips
[0].get("ip_address")
1785 def _prepare_port_dict_mac_ip_addr(net
: dict, port_dict
: dict) -> None:
1786 """Fill up the mac_address and fixed_ips in port_dict.
1789 net (dict): Network details
1790 port_dict (dict): Port details
1793 if net
.get("mac_address"):
1794 port_dict
["mac_address"] = net
["mac_address"]
1796 if net
.get("ip_address"):
1797 port_dict
["fixed_ips"] = [{"ip_address": net
["ip_address"]}]
1798 # TODO add "subnet_id": <subnet_id>
1800 def _create_new_port(self
, port_dict
: dict, created_items
: dict, net
: dict) -> Dict
:
1801 """Create new port using neutron.
1804 port_dict (dict): Port details
1805 created_items (dict): All created items
1806 net (dict): Network details
1809 new_port (dict): New created port
1812 new_port
= self
.neutron
.create_port({"port": port_dict
})
1813 created_items
["port:" + str(new_port
["port"]["id"])] = True
1814 net
["mac_adress"] = new_port
["port"]["mac_address"]
1815 net
["vim_id"] = new_port
["port"]["id"]
1820 self
, net
: dict, name
: str, created_items
: dict
1821 ) -> Tuple
[dict, dict]:
1822 """Create port using net details.
1825 net (dict): Network details
1826 name (str): Name to be used as network name if net dict does not include name
1827 created_items (dict): All created items
1830 new_port, port New created port, port dictionary
1835 "network_id": net
["net_id"],
1836 "name": net
.get("name"),
1837 "admin_state_up": True,
1840 if not port_dict
["name"]:
1841 port_dict
["name"] = name
1843 self
._prepare
_port
_dict
_security
_groups
(net
, port_dict
)
1845 self
._prepare
_port
_dict
_binding
(net
, port_dict
)
1847 vimconnector
._prepare
_port
_dict
_mac
_ip
_addr
(net
, port_dict
)
1849 new_port
= self
._create
_new
_port
(port_dict
, created_items
, net
)
1851 vimconnector
._set
_fixed
_ip
(new_port
, net
)
1853 port
= {"port-id": new_port
["port"]["id"]}
1855 if float(self
.nova
.api_version
.get_string()) >= 2.32:
1856 port
["tag"] = new_port
["port"]["name"]
1858 return new_port
, port
1860 def _prepare_network_for_vminstance(
1864 created_items
: dict,
1866 external_network
: list,
1867 no_secured_ports
: list,
1869 """Create port and fill up net dictionary for new VM instance creation.
1872 name (str): Name of network
1873 net_list (list): List of networks
1874 created_items (dict): All created items belongs to a VM
1875 net_list_vim (list): List of ports
1876 external_network (list): List of external-networks
1877 no_secured_ports (list): Port security disabled ports
1880 self
._reload
_connection
()
1882 for net
in net_list
:
1883 # Skip non-connected iface
1884 if not net
.get("net_id"):
1887 new_port
, port
= self
._create
_port
(net
, name
, created_items
)
1889 net_list_vim
.append(port
)
1891 if net
.get("floating_ip", False):
1892 net
["exit_on_floating_ip_error"] = True
1893 external_network
.append(net
)
1895 elif net
["use"] == "mgmt" and self
.config
.get("use_floating_ip"):
1896 net
["exit_on_floating_ip_error"] = False
1897 external_network
.append(net
)
1898 net
["floating_ip"] = self
.config
.get("use_floating_ip")
1900 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic
1901 # is dropped. As a workaround we wait until the VM is active and then disable the port-security
1902 if net
.get("port_security") is False and not self
.config
.get(
1903 "no_port_security_extension"
1905 no_secured_ports
.append(
1907 new_port
["port"]["id"],
1908 net
.get("port_security_disable_strategy"),
1912 def _prepare_persistent_root_volumes(
1917 base_disk_index
: int,
1918 block_device_mapping
: dict,
1919 existing_vim_volumes
: list,
1920 created_items
: dict,
1922 """Prepare persistent root volumes for new VM instance.
1925 name (str): Name of VM instance
1926 vm_av_zone (list): List of availability zones
1927 disk (dict): Disk details
1928 base_disk_index (int): Disk index
1929 block_device_mapping (dict): Block device details
1930 existing_vim_volumes (list): Existing disk details
1931 created_items (dict): All created items belongs to VM
1934 boot_volume_id (str): ID of boot volume
1937 # Disk may include only vim_volume_id or only vim_id."
1938 # Use existing persistent root volume finding with volume_id or vim_id
1939 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
1941 if disk
.get(key_id
):
1942 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
1943 existing_vim_volumes
.append({"id": disk
[key_id
]})
1946 # Create persistent root volume
1947 volume
= self
.cinder
.volumes
.create(
1949 name
=name
+ "vd" + chr(base_disk_index
),
1950 imageRef
=disk
["image_id"],
1951 # Make sure volume is in the same AZ as the VM to be attached to
1952 availability_zone
=vm_av_zone
,
1954 boot_volume_id
= volume
.id
1955 created_items
["volume:" + str(volume
.id)] = True
1956 block_device_mapping
["vd" + chr(base_disk_index
)] = volume
.id
1958 return boot_volume_id
1960 def _prepare_non_root_persistent_volumes(
1965 block_device_mapping
: dict,
1966 base_disk_index
: int,
1967 existing_vim_volumes
: list,
1968 created_items
: dict,
1970 """Prepare persistent volumes for new VM instance.
1973 name (str): Name of VM instance
1974 disk (dict): Disk details
1975 vm_av_zone (list): List of availability zones
1976 block_device_mapping (dict): Block device details
1977 base_disk_index (int): Disk index
1978 existing_vim_volumes (list): Existing disk details
1979 created_items (dict): All created items belongs to VM
1981 # Non-root persistent volumes
1982 # Disk may include only vim_volume_id or only vim_id."
1983 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
1985 if disk
.get(key_id
):
1986 # Use existing persistent volume
1987 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
1988 existing_vim_volumes
.append({"id": disk
[key_id
]})
1991 # Create persistent volume
1992 volume
= self
.cinder
.volumes
.create(
1994 name
=name
+ "vd" + chr(base_disk_index
),
1995 # Make sure volume is in the same AZ as the VM to be attached to
1996 availability_zone
=vm_av_zone
,
1998 created_items
["volume:" + str(volume
.id)] = True
1999 block_device_mapping
["vd" + chr(base_disk_index
)] = volume
.id
2001 def _wait_for_created_volumes_availability(
2002 self
, elapsed_time
: int, created_items
: dict
2004 """Wait till created volumes become available.
2007 elapsed_time (int): Passed time while waiting
2008 created_items (dict): All created items belongs to VM
2011 elapsed_time (int): Time spent while waiting
2015 while elapsed_time
< volume_timeout
:
2016 for created_item
in created_items
:
2017 v
, _
, volume_id
= created_item
.partition(":")
2019 if self
.cinder
.volumes
.get(volume_id
).status
!= "available":
2022 # All ready: break from while
2030 def _wait_for_existing_volumes_availability(
2031 self
, elapsed_time
: int, existing_vim_volumes
: list
2033 """Wait till existing volumes become available.
2036 elapsed_time (int): Passed time while waiting
2037 existing_vim_volumes (list): Existing volume details
2040 elapsed_time (int): Time spent while waiting
2044 while elapsed_time
< volume_timeout
:
2045 for volume
in existing_vim_volumes
:
2046 if self
.cinder
.volumes
.get(volume
["id"]).status
!= "available":
2048 else: # all ready: break from while
2056 def _prepare_disk_for_vminstance(
2059 existing_vim_volumes
: list,
2060 created_items
: dict,
2062 disk_list
: list = None,
2064 """Prepare all volumes for new VM instance.
2067 name (str): Name of Instance
2068 existing_vim_volumes (list): List of existing volumes
2069 created_items (dict): All created items belongs to VM
2070 vm_av_zone (list): VM availability zone
2071 disk_list (list): List of disks
2074 # Create additional volumes in case these are present in disk_list
2075 base_disk_index
= ord("b")
2076 boot_volume_id
= None
2079 block_device_mapping
= {}
2080 for disk
in disk_list
:
2081 if "image_id" in disk
:
2082 # Root persistent volume
2083 base_disk_index
= ord("a")
2084 boot_volume_id
= self
._prepare
_persistent
_root
_volumes
(
2086 vm_av_zone
=vm_av_zone
,
2088 base_disk_index
=base_disk_index
,
2089 block_device_mapping
=block_device_mapping
,
2090 existing_vim_volumes
=existing_vim_volumes
,
2091 created_items
=created_items
,
2094 # Non-root persistent volume
2095 self
._prepare
_non
_root
_persistent
_volumes
(
2098 vm_av_zone
=vm_av_zone
,
2099 block_device_mapping
=block_device_mapping
,
2100 base_disk_index
=base_disk_index
,
2101 existing_vim_volumes
=existing_vim_volumes
,
2102 created_items
=created_items
,
2104 base_disk_index
+= 1
2106 # Wait until created volumes are with status available
2107 elapsed_time
= self
._wait
_for
_created
_volumes
_availability
(
2108 elapsed_time
, created_items
2110 # Wait until existing volumes in vim are with status available
2111 elapsed_time
= self
._wait
_for
_existing
_volumes
_availability
(
2112 elapsed_time
, existing_vim_volumes
2114 # If we exceeded the timeout rollback
2115 if elapsed_time
>= volume_timeout
:
2116 raise vimconn
.VimConnException(
2117 "Timeout creating volumes for instance " + name
,
2118 http_code
=vimconn
.HTTP_Request_Timeout
,
2121 self
.cinder
.volumes
.set_bootable(boot_volume_id
, True)
2123 def _find_the_external_network_for_floating_ip(self
):
2124 """Get the external network ip in order to create floating IP.
2127 pool_id (str): External network pool ID
2131 # Find the external network
2132 external_nets
= list()
2134 for net
in self
.neutron
.list_networks()["networks"]:
2135 if net
["router:external"]:
2136 external_nets
.append(net
)
2138 if len(external_nets
) == 0:
2139 raise vimconn
.VimConnException(
2140 "Cannot create floating_ip automatically since "
2141 "no external network is present",
2142 http_code
=vimconn
.HTTP_Conflict
,
2145 if len(external_nets
) > 1:
2146 raise vimconn
.VimConnException(
2147 "Cannot create floating_ip automatically since "
2148 "multiple external networks are present",
2149 http_code
=vimconn
.HTTP_Conflict
,
2153 return external_nets
[0].get("id")
2155 def _neutron_create_float_ip(self
, param
: dict, created_items
: dict) -> None:
2156 """Trigger neutron to create a new floating IP using external network ID.
2159 param (dict): Input parameters to create a floating IP
2160 created_items (dict): All created items belongs to new VM instance
2167 self
.logger
.debug("Creating floating IP")
2168 new_floating_ip
= self
.neutron
.create_floatingip(param
)
2169 free_floating_ip
= new_floating_ip
["floatingip"]["id"]
2170 created_items
["floating_ip:" + str(free_floating_ip
)] = True
2172 except Exception as e
:
2173 raise vimconn
.VimConnException(
2174 type(e
).__name
__ + ": Cannot create new floating_ip " + str(e
),
2175 http_code
=vimconn
.HTTP_Conflict
,
2178 def _create_floating_ip(
2179 self
, floating_network
: dict, server
: object, created_items
: dict
2181 """Get the available Pool ID and create a new floating IP.
2184 floating_network (dict): Dict including external network ID
2185 server (object): Server object
2186 created_items (dict): All created items belongs to new VM instance
2190 # Pool_id is available
2192 isinstance(floating_network
["floating_ip"], str)
2193 and floating_network
["floating_ip"].lower() != "true"
2195 pool_id
= floating_network
["floating_ip"]
2199 pool_id
= self
._find
_the
_external
_network
_for
_floating
_ip
()
2203 "floating_network_id": pool_id
,
2204 "tenant_id": server
.tenant_id
,
2208 self
._neutron
_create
_float
_ip
(param
, created_items
)
2210 def _find_floating_ip(
2214 floating_network
: dict,
2216 """Find the available free floating IPs if there are.
2219 server (object): Server object
2220 floating_ips (list): List of floating IPs
2221 floating_network (dict): Details of floating network such as ID
2224 free_floating_ip (str): Free floating ip address
2227 for fip
in floating_ips
:
2228 if fip
.get("port_id") or fip
.get("tenant_id") != server
.tenant_id
:
2231 if isinstance(floating_network
["floating_ip"], str):
2232 if fip
.get("floating_network_id") != floating_network
["floating_ip"]:
2237 def _assign_floating_ip(
2238 self
, free_floating_ip
: str, floating_network
: dict
2240 """Assign the free floating ip address to port.
2243 free_floating_ip (str): Floating IP to be assigned
2244 floating_network (dict): ID of floating network
2247 fip (dict) (dict): Floating ip details
2250 # The vim_id key contains the neutron.port_id
2251 self
.neutron
.update_floatingip(
2253 {"floatingip": {"port_id": floating_network
["vim_id"]}},
2255 # For race condition ensure not re-assigned to other VM after 5 seconds
2258 return self
.neutron
.show_floatingip(free_floating_ip
)
2260 def _get_free_floating_ip(
2261 self
, server
: object, floating_network
: dict
2263 """Get the free floating IP address.
2266 server (object): Server Object
2267 floating_network (dict): Floating network details
2270 free_floating_ip (str): Free floating ip addr
2274 floating_ips
= self
.neutron
.list_floatingips().get("floatingips", ())
2277 random
.shuffle(floating_ips
)
2279 return self
._find
_floating
_ip
(server
, floating_ips
, floating_network
)
2281 def _prepare_external_network_for_vminstance(
2283 external_network
: list,
2285 created_items
: dict,
2286 vm_start_time
: float,
2288 """Assign floating IP address for VM instance.
2291 external_network (list): ID of External network
2292 server (object): Server Object
2293 created_items (dict): All created items belongs to new VM instance
2294 vm_start_time (float): Time as a floating point number expressed in seconds since the epoch, in UTC
2300 for floating_network
in external_network
:
2303 floating_ip_retries
= 3
2304 # In case of RO in HA there can be conflicts, two RO trying to assign same floating IP, so retry
2307 free_floating_ip
= self
._get
_free
_floating
_ip
(
2308 server
, floating_network
2311 if not free_floating_ip
:
2312 self
._create
_floating
_ip
(
2313 floating_network
, server
, created_items
2317 # For race condition ensure not already assigned
2318 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2320 if fip
["floatingip"].get("port_id"):
2323 # Assign floating ip
2324 fip
= self
._assign
_floating
_ip
(
2325 free_floating_ip
, floating_network
2328 if fip
["floatingip"]["port_id"] != floating_network
["vim_id"]:
2329 self
.logger
.warning(
2330 "floating_ip {} re-assigned to other port".format(
2337 "Assigned floating_ip {} to VM {}".format(
2338 free_floating_ip
, server
.id
2344 except Exception as e
:
2345 # Openstack need some time after VM creation to assign an IP. So retry if fails
2346 vm_status
= self
.nova
.servers
.get(server
.id).status
2348 if vm_status
not in ("ACTIVE", "ERROR"):
2349 if time
.time() - vm_start_time
< server_timeout
:
2352 elif floating_ip_retries
> 0:
2353 floating_ip_retries
-= 1
2356 raise vimconn
.VimConnException(
2357 "Cannot create floating_ip: {} {}".format(
2360 http_code
=vimconn
.HTTP_Conflict
,
2363 except Exception as e
:
2364 if not floating_network
["exit_on_floating_ip_error"]:
2365 self
.logger
.error("Cannot create floating_ip. %s", str(e
))
2370 def _update_port_security_for_vminstance(
2372 no_secured_ports
: list,
2375 """Updates the port security according to no_secured_ports list.
2378 no_secured_ports (list): List of ports that security will be disabled
2379 server (object): Server Object
2385 # Wait until the VM is active and then disable the port-security
2386 if no_secured_ports
:
2387 self
.__wait
_for
_vm
(server
.id, "ACTIVE")
2389 for port
in no_secured_ports
:
2391 "port": {"port_security_enabled": False, "security_groups": None}
2394 if port
[1] == "allow-address-pairs":
2396 "port": {"allowed_address_pairs": [{"ip_address": "0.0.0.0/0"}]}
2400 self
.neutron
.update_port(port
[0], port_update
)
2403 raise vimconn
.VimConnException(
2404 "It was not possible to disable port security for port {}".format(
2416 affinity_group_list
: list,
2420 availability_zone_index
=None,
2421 availability_zone_list
=None,
2423 """Adds a VM instance to VIM.
2426 name (str): name of VM
2427 description (str): description
2428 start (bool): indicates if VM must start or boot in pause mode. Ignored
2429 image_id (str) image uuid
2430 flavor_id (str) flavor uuid
2431 affinity_group_list (list): list of affinity groups, each one is a dictionary.Ignore if empty.
2432 net_list (list): list of interfaces, each one is a dictionary with:
2433 name: name of network
2434 net_id: network uuid to connect
2435 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
2436 model: interface model, ignored #TODO
2437 mac_address: used for SR-IOV ifaces #TODO for other types
2438 use: 'data', 'bridge', 'mgmt'
2439 type: 'virtual', 'PCI-PASSTHROUGH'('PF'), 'SR-IOV'('VF'), 'VFnotShared'
2440 vim_id: filled/added by this function
2441 floating_ip: True/False (or it can be None)
2442 port_security: True/False
2443 cloud_config (dict): (optional) dictionary with:
2444 key-pairs: (optional) list of strings with the public key to be inserted to the default user
2445 users: (optional) list of users to be inserted, each item is a dict with:
2446 name: (mandatory) user name,
2447 key-pairs: (optional) list of strings with the public key to be inserted to the user
2448 user-data: (optional) string is a text script to be passed directly to cloud-init
2449 config-files: (optional). List of files to be transferred. Each item is a dict with:
2450 dest: (mandatory) string with the destination absolute path
2451 encoding: (optional, by default text). Can be one of:
2452 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
2453 content : (mandatory) string with the content of the file
2454 permissions: (optional) string with file permissions, typically octal notation '0644'
2455 owner: (optional) file owner, string with the format 'owner:group'
2456 boot-data-drive: boolean to indicate if user-data must be passed using a boot drive (hard disk)
2457 disk_list: (optional) list with additional disks to the VM. Each item is a dict with:
2458 image_id: (optional). VIM id of an existing image. If not provided an empty disk must be mounted
2459 size: (mandatory) string with the size of the disk in GB
2460 vim_id: (optional) should use this existing volume id
2461 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
2462 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
2463 availability_zone_index is None
2464 #TODO ip, security groups
2467 A tuple with the instance identifier and created_items or raises an exception on error
2468 created_items can be None or a dictionary where this method can include key-values that will be passed to
2469 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
2470 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
2474 "new_vminstance input: image='%s' flavor='%s' nics='%s'",
2484 # list of external networks to be connected to instance, later on used to create floating_ip
2485 external_network
= []
2486 # List of ports with port-security disabled
2487 no_secured_ports
= []
2488 block_device_mapping
= None
2489 existing_vim_volumes
= []
2490 server_group_id
= None
2491 scheduller_hints
= {}
2493 # Check the Openstack Connection
2494 self
._reload
_connection
()
2496 # Prepare network list
2497 self
._prepare
_network
_for
_vminstance
(
2500 created_items
=created_items
,
2501 net_list_vim
=net_list_vim
,
2502 external_network
=external_network
,
2503 no_secured_ports
=no_secured_ports
,
2507 config_drive
, userdata
= self
._create
_user
_data
(cloud_config
)
2509 # Get availability Zone
2510 vm_av_zone
= self
._get
_vm
_availability
_zone
(
2511 availability_zone_index
, availability_zone_list
2516 self
._prepare
_disk
_for
_vminstance
(
2518 existing_vim_volumes
=existing_vim_volumes
,
2519 created_items
=created_items
,
2520 vm_av_zone
=vm_av_zone
,
2521 disk_list
=disk_list
,
2524 if affinity_group_list
:
2525 # Only first id on the list will be used. Openstack restriction
2526 server_group_id
= affinity_group_list
[0]["affinity_group_id"]
2527 scheduller_hints
["group"] = server_group_id
2530 "nova.servers.create({}, {}, {}, nics={}, security_groups={}, "
2531 "availability_zone={}, key_name={}, userdata={}, config_drive={}, "
2532 "block_device_mapping={}, server_group={})".format(
2537 self
.config
.get("security_groups"),
2539 self
.config
.get("keypair"),
2542 block_device_mapping
,
2548 server
= self
.nova
.servers
.create(
2553 security_groups
=self
.config
.get("security_groups"),
2554 # TODO remove security_groups in future versions. Already at neutron port
2555 availability_zone
=vm_av_zone
,
2556 key_name
=self
.config
.get("keypair"),
2558 config_drive
=config_drive
,
2559 block_device_mapping
=block_device_mapping
,
2560 scheduler_hints
=scheduller_hints
,
2563 vm_start_time
= time
.time()
2565 self
._update
_port
_security
_for
_vminstance
(no_secured_ports
, server
)
2567 self
._prepare
_external
_network
_for
_vminstance
(
2568 external_network
=external_network
,
2570 created_items
=created_items
,
2571 vm_start_time
=vm_start_time
,
2574 return server
.id, created_items
2576 except Exception as e
:
2579 server_id
= server
.id
2582 self
.delete_vminstance(server_id
, created_items
)
2584 except Exception as e2
:
2585 self
.logger
.error("new_vminstance rollback fail {}".format(e2
))
2587 self
._format
_exception
(e
)
2589 def get_vminstance(self
, vm_id
):
2590 """Returns the VM instance information from VIM"""
2591 # self.logger.debug("Getting VM from VIM")
2593 self
._reload
_connection
()
2594 server
= self
.nova
.servers
.find(id=vm_id
)
2595 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
2597 return server
.to_dict()
2599 ksExceptions
.ClientException
,
2600 nvExceptions
.ClientException
,
2601 nvExceptions
.NotFound
,
2604 self
._format
_exception
(e
)
2606 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
2608 Get a console for the virtual machine
2610 vm_id: uuid of the VM
2611 console_type, can be:
2612 "novnc" (by default), "xvpvnc" for VNC types,
2613 "rdp-html5" for RDP types, "spice-html5" for SPICE types
2614 Returns dict with the console parameters:
2615 protocol: ssh, ftp, http, https, ...
2616 server: usually ip address
2617 port: the http, ssh, ... port
2618 suffix: extra text, e.g. the http path and query string
2620 self
.logger
.debug("Getting VM CONSOLE from VIM")
2623 self
._reload
_connection
()
2624 server
= self
.nova
.servers
.find(id=vm_id
)
2626 if console_type
is None or console_type
== "novnc":
2627 console_dict
= server
.get_vnc_console("novnc")
2628 elif console_type
== "xvpvnc":
2629 console_dict
= server
.get_vnc_console(console_type
)
2630 elif console_type
== "rdp-html5":
2631 console_dict
= server
.get_rdp_console(console_type
)
2632 elif console_type
== "spice-html5":
2633 console_dict
= server
.get_spice_console(console_type
)
2635 raise vimconn
.VimConnException(
2636 "console type '{}' not allowed".format(console_type
),
2637 http_code
=vimconn
.HTTP_Bad_Request
,
2640 console_dict1
= console_dict
.get("console")
2643 console_url
= console_dict1
.get("url")
2647 protocol_index
= console_url
.find("//")
2649 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2652 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2657 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2659 -vimconn
.HTTP_Internal_Server_Error
,
2660 "Unexpected response from VIM",
2664 "protocol": console_url
[0:protocol_index
],
2665 "server": console_url
[protocol_index
+ 2 : port_index
],
2666 "port": console_url
[port_index
:suffix_index
],
2667 "suffix": console_url
[suffix_index
+ 1 :],
2672 raise vimconn
.VimConnUnexpectedResponse("Unexpected response from VIM")
2674 nvExceptions
.NotFound
,
2675 ksExceptions
.ClientException
,
2676 nvExceptions
.ClientException
,
2677 nvExceptions
.BadRequest
,
2680 self
._format
_exception
(e
)
2682 def _delete_ports_by_id_wth_neutron(self
, k_id
: str) -> None:
2683 """Neutron delete ports by id.
2685 k_id (str): Port id in the VIM
2688 port_dict
= self
.neutron
.list_ports()
2689 existing_ports
= [port
["id"] for port
in port_dict
["ports"] if port_dict
]
2691 if k_id
in existing_ports
:
2692 self
.neutron
.delete_port(k_id
)
2694 except Exception as e
:
2695 self
.logger
.error("Error deleting port: {}: {}".format(type(e
).__name
__, e
))
2697 def _delete_volumes_by_id_wth_cinder(
2698 self
, k
: str, k_id
: str, volumes_to_hold
: list, created_items
: dict
2700 """Cinder delete volume by id.
2702 k (str): Full item name in created_items
2703 k_id (str): ID of floating ip in VIM
2704 volumes_to_hold (list): Volumes not to delete
2705 created_items (dict): All created items belongs to VM
2708 if k_id
in volumes_to_hold
:
2711 if self
.cinder
.volumes
.get(k_id
).status
!= "available":
2715 self
.cinder
.volumes
.delete(k_id
)
2716 created_items
[k
] = None
2718 except Exception as e
:
2720 "Error deleting volume: {}: {}".format(type(e
).__name
__, e
)
2723 def _delete_floating_ip_by_id(self
, k
: str, k_id
: str, created_items
: dict) -> None:
2724 """Neutron delete floating ip by id.
2726 k (str): Full item name in created_items
2727 k_id (str): ID of floating ip in VIM
2728 created_items (dict): All created items belongs to VM
2731 self
.neutron
.delete_floatingip(k_id
)
2732 created_items
[k
] = None
2734 except Exception as e
:
2736 "Error deleting floating ip: {}: {}".format(type(e
).__name
__, e
)
2740 def _get_item_name_id(k
: str) -> Tuple
[str, str]:
2741 k_item
, _
, k_id
= k
.partition(":")
2744 def _delete_vm_ports_attached_to_network(self
, created_items
: dict) -> None:
2745 """Delete VM ports attached to the networks before deleting virtual machine.
2747 created_items (dict): All created items belongs to VM
2750 for k
, v
in created_items
.items():
2751 if not v
: # skip already deleted
2755 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2756 if k_item
== "port":
2757 self
._delete
_ports
_by
_id
_wth
_neutron
(k_id
)
2759 except Exception as e
:
2761 "Error deleting port: {}: {}".format(type(e
).__name
__, e
)
2764 def _delete_created_items(
2765 self
, created_items
: dict, volumes_to_hold
: list, keep_waiting
: bool
2767 """Delete Volumes and floating ip if they exist in created_items."""
2768 for k
, v
in created_items
.items():
2769 if not v
: # skip already deleted
2773 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2775 if k_item
== "volume":
2776 unavailable_vol
= self
._delete
_volumes
_by
_id
_wth
_cinder
(
2777 k
, k_id
, volumes_to_hold
, created_items
2783 elif k_item
== "floating_ip":
2784 self
._delete
_floating
_ip
_by
_id
(k
, k_id
, created_items
)
2786 except Exception as e
:
2787 self
.logger
.error("Error deleting {}: {}".format(k
, e
))
2791 def delete_vminstance(
2792 self
, vm_id
: str, created_items
: dict = None, volumes_to_hold
: list = None
2794 """Removes a VM instance from VIM. Returns the old identifier.
2796 vm_id (str): Identifier of VM instance
2797 created_items (dict): All created items belongs to VM
2798 volumes_to_hold (list): Volumes_to_hold
2800 if created_items
is None:
2802 if volumes_to_hold
is None:
2803 volumes_to_hold
= []
2806 self
._reload
_connection
()
2808 # Delete VM ports attached to the networks before the virtual machine
2810 self
._delete
_vm
_ports
_attached
_to
_network
(created_items
)
2813 self
.nova
.servers
.delete(vm_id
)
2815 # Although having detached, volumes should have in active status before deleting.
2816 # We ensure in this loop
2820 while keep_waiting
and elapsed_time
< volume_timeout
:
2821 keep_waiting
= False
2823 # Delete volumes and floating IP.
2824 keep_waiting
= self
._delete
_created
_items
(
2825 created_items
, volumes_to_hold
, keep_waiting
2833 nvExceptions
.NotFound
,
2834 ksExceptions
.ClientException
,
2835 nvExceptions
.ClientException
,
2838 self
._format
_exception
(e
)
2840 def refresh_vms_status(self
, vm_list
):
2841 """Get the status of the virtual machines and their interfaces/ports
2842 Params: the list of VM identifiers
2843 Returns a dictionary with:
2844 vm_id: #VIM id of this Virtual Machine
2845 status: #Mandatory. Text with one of:
2846 # DELETED (not found at vim)
2847 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2848 # OTHER (Vim reported other status not understood)
2849 # ERROR (VIM indicates an ERROR status)
2850 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
2851 # CREATING (on building process), ERROR
2852 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
2854 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2855 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2857 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2858 mac_address: #Text format XX:XX:XX:XX:XX:XX
2859 vim_net_id: #network id where this interface is connected
2860 vim_interface_id: #interface/port VIM id
2861 ip_address: #null, or text with IPv4, IPv6 address
2862 compute_node: #identification of compute node where PF,VF interface is allocated
2863 pci: #PCI address of the NIC that hosts the PF,VF
2864 vlan: #physical VLAN used for VF
2868 "refresh_vms status: Getting tenant VM instance information from VIM"
2871 for vm_id
in vm_list
:
2875 vm_vim
= self
.get_vminstance(vm_id
)
2877 if vm_vim
["status"] in vmStatus2manoFormat
:
2878 vm
["status"] = vmStatus2manoFormat
[vm_vim
["status"]]
2880 vm
["status"] = "OTHER"
2881 vm
["error_msg"] = "VIM status reported " + vm_vim
["status"]
2883 vm_vim
.pop("OS-EXT-SRV-ATTR:user_data", None)
2884 vm_vim
.pop("user_data", None)
2885 vm
["vim_info"] = self
.serialize(vm_vim
)
2887 vm
["interfaces"] = []
2888 if vm_vim
.get("fault"):
2889 vm
["error_msg"] = str(vm_vim
["fault"])
2893 self
._reload
_connection
()
2894 port_dict
= self
.neutron
.list_ports(device_id
=vm_id
)
2896 for port
in port_dict
["ports"]:
2898 interface
["vim_info"] = self
.serialize(port
)
2899 interface
["mac_address"] = port
.get("mac_address")
2900 interface
["vim_net_id"] = port
["network_id"]
2901 interface
["vim_interface_id"] = port
["id"]
2902 # check if OS-EXT-SRV-ATTR:host is there,
2903 # in case of non-admin credentials, it will be missing
2905 if vm_vim
.get("OS-EXT-SRV-ATTR:host"):
2906 interface
["compute_node"] = vm_vim
["OS-EXT-SRV-ATTR:host"]
2908 interface
["pci"] = None
2910 # check if binding:profile is there,
2911 # in case of non-admin credentials, it will be missing
2912 if port
.get("binding:profile"):
2913 if port
["binding:profile"].get("pci_slot"):
2914 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting
2916 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
2917 # CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2) assuming there are 2 ports per nic
2918 pci
= port
["binding:profile"]["pci_slot"]
2919 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
2920 interface
["pci"] = pci
2922 interface
["vlan"] = None
2924 if port
.get("binding:vif_details"):
2925 interface
["vlan"] = port
["binding:vif_details"].get("vlan")
2927 # Get vlan from network in case not present in port for those old openstacks and cases where
2928 # it is needed vlan at PT
2929 if not interface
["vlan"]:
2930 # if network is of type vlan and port is of type direct (sr-iov) then set vlan id
2931 network
= self
.neutron
.show_network(port
["network_id"])
2934 network
["network"].get("provider:network_type")
2937 # and port.get("binding:vnic_type") in ("direct", "direct-physical"):
2938 interface
["vlan"] = network
["network"].get(
2939 "provider:segmentation_id"
2943 # look for floating ip address
2945 floating_ip_dict
= self
.neutron
.list_floatingips(
2949 if floating_ip_dict
.get("floatingips"):
2951 floating_ip_dict
["floatingips"][0].get(
2952 "floating_ip_address"
2958 for subnet
in port
["fixed_ips"]:
2959 ips
.append(subnet
["ip_address"])
2961 interface
["ip_address"] = ";".join(ips
)
2962 vm
["interfaces"].append(interface
)
2963 except Exception as e
:
2965 "Error getting vm interface information {}: {}".format(
2970 except vimconn
.VimConnNotFoundException
as e
:
2971 self
.logger
.error("Exception getting vm status: %s", str(e
))
2972 vm
["status"] = "DELETED"
2973 vm
["error_msg"] = str(e
)
2974 except vimconn
.VimConnException
as e
:
2975 self
.logger
.error("Exception getting vm status: %s", str(e
))
2976 vm
["status"] = "VIM_ERROR"
2977 vm
["error_msg"] = str(e
)
2983 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
2984 """Send and action over a VM instance from VIM
2985 Returns None or the console dict if the action was successfully sent to the VIM
2987 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
2990 self
._reload
_connection
()
2991 server
= self
.nova
.servers
.find(id=vm_id
)
2993 if "start" in action_dict
:
2994 if action_dict
["start"] == "rebuild":
2997 if server
.status
== "PAUSED":
2999 elif server
.status
== "SUSPENDED":
3001 elif server
.status
== "SHUTOFF":
3005 "ERROR : Instance is not in SHUTOFF/PAUSE/SUSPEND state"
3007 raise vimconn
.VimConnException(
3008 "Cannot 'start' instance while it is in active state",
3009 http_code
=vimconn
.HTTP_Bad_Request
,
3012 elif "pause" in action_dict
:
3014 elif "resume" in action_dict
:
3016 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
3017 self
.logger
.debug("server status %s", server
.status
)
3018 if server
.status
== "ACTIVE":
3021 self
.logger
.debug("ERROR: VM is not in Active state")
3022 raise vimconn
.VimConnException(
3023 "VM is not in active state, stop operation is not allowed",
3024 http_code
=vimconn
.HTTP_Bad_Request
,
3026 elif "forceOff" in action_dict
:
3027 server
.stop() # TODO
3028 elif "terminate" in action_dict
:
3030 elif "createImage" in action_dict
:
3031 server
.create_image()
3032 # "path":path_schema,
3033 # "description":description_schema,
3034 # "name":name_schema,
3035 # "metadata":metadata_schema,
3036 # "imageRef": id_schema,
3037 # "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
3038 elif "rebuild" in action_dict
:
3039 server
.rebuild(server
.image
["id"])
3040 elif "reboot" in action_dict
:
3041 server
.reboot() # reboot_type="SOFT"
3042 elif "console" in action_dict
:
3043 console_type
= action_dict
["console"]
3045 if console_type
is None or console_type
== "novnc":
3046 console_dict
= server
.get_vnc_console("novnc")
3047 elif console_type
== "xvpvnc":
3048 console_dict
= server
.get_vnc_console(console_type
)
3049 elif console_type
== "rdp-html5":
3050 console_dict
= server
.get_rdp_console(console_type
)
3051 elif console_type
== "spice-html5":
3052 console_dict
= server
.get_spice_console(console_type
)
3054 raise vimconn
.VimConnException(
3055 "console type '{}' not allowed".format(console_type
),
3056 http_code
=vimconn
.HTTP_Bad_Request
,
3060 console_url
= console_dict
["console"]["url"]
3062 protocol_index
= console_url
.find("//")
3064 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
3067 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
3072 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
3073 raise vimconn
.VimConnException(
3074 "Unexpected response from VIM " + str(console_dict
)
3078 "protocol": console_url
[0:protocol_index
],
3079 "server": console_url
[protocol_index
+ 2 : port_index
],
3080 "port": int(console_url
[port_index
+ 1 : suffix_index
]),
3081 "suffix": console_url
[suffix_index
+ 1 :],
3084 return console_dict2
3086 raise vimconn
.VimConnException(
3087 "Unexpected response from VIM " + str(console_dict
)
3092 ksExceptions
.ClientException
,
3093 nvExceptions
.ClientException
,
3094 nvExceptions
.NotFound
,
3097 self
._format
_exception
(e
)
3098 # TODO insert exception vimconn.HTTP_Unauthorized
3100 # ###### VIO Specific Changes #########
3101 def _generate_vlanID(self
):
3103 Method to get unused vlanID
3111 networks
= self
.get_network_list()
3113 for net
in networks
:
3114 if net
.get("provider:segmentation_id"):
3115 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3117 used_vlanIDs
= set(usedVlanIDs
)
3119 # find unused VLAN ID
3120 for vlanID_range
in self
.config
.get("dataplane_net_vlan_range"):
3122 start_vlanid
, end_vlanid
= map(
3123 int, vlanID_range
.replace(" ", "").split("-")
3126 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3127 if vlanID
not in used_vlanIDs
:
3129 except Exception as exp
:
3130 raise vimconn
.VimConnException(
3131 "Exception {} occurred while generating VLAN ID.".format(exp
)
3134 raise vimconn
.VimConnConflictException(
3135 "Unable to create the SRIOV VLAN network. All given Vlan IDs {} are in use.".format(
3136 self
.config
.get("dataplane_net_vlan_range")
3140 def _generate_multisegment_vlanID(self
):
3142 Method to get unused vlanID
3150 networks
= self
.get_network_list()
3151 for net
in networks
:
3152 if net
.get("provider:network_type") == "vlan" and net
.get(
3153 "provider:segmentation_id"
3155 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3156 elif net
.get("segments"):
3157 for segment
in net
.get("segments"):
3158 if segment
.get("provider:network_type") == "vlan" and segment
.get(
3159 "provider:segmentation_id"
3161 usedVlanIDs
.append(segment
.get("provider:segmentation_id"))
3163 used_vlanIDs
= set(usedVlanIDs
)
3165 # find unused VLAN ID
3166 for vlanID_range
in self
.config
.get("multisegment_vlan_range"):
3168 start_vlanid
, end_vlanid
= map(
3169 int, vlanID_range
.replace(" ", "").split("-")
3172 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3173 if vlanID
not in used_vlanIDs
:
3175 except Exception as exp
:
3176 raise vimconn
.VimConnException(
3177 "Exception {} occurred while generating VLAN ID.".format(exp
)
3180 raise vimconn
.VimConnConflictException(
3181 "Unable to create the VLAN segment. All VLAN IDs {} are in use.".format(
3182 self
.config
.get("multisegment_vlan_range")
3186 def _validate_vlan_ranges(self
, input_vlan_range
, text_vlan_range
):
3188 Method to validate user given vlanID ranges
3192 for vlanID_range
in input_vlan_range
:
3193 vlan_range
= vlanID_range
.replace(" ", "")
3195 vlanID_pattern
= r
"(\d)*-(\d)*$"
3196 match_obj
= re
.match(vlanID_pattern
, vlan_range
)
3198 raise vimconn
.VimConnConflictException(
3199 "Invalid VLAN range for {}: {}.You must provide "
3200 "'{}' in format [start_ID - end_ID].".format(
3201 text_vlan_range
, vlanID_range
, text_vlan_range
3205 start_vlanid
, end_vlanid
= map(int, vlan_range
.split("-"))
3206 if start_vlanid
<= 0:
3207 raise vimconn
.VimConnConflictException(
3208 "Invalid VLAN range for {}: {}. Start ID can not be zero. For VLAN "
3209 "networks valid IDs are 1 to 4094 ".format(
3210 text_vlan_range
, vlanID_range
3214 if end_vlanid
> 4094:
3215 raise vimconn
.VimConnConflictException(
3216 "Invalid VLAN range for {}: {}. End VLAN ID can not be "
3217 "greater than 4094. For VLAN networks valid IDs are 1 to 4094 ".format(
3218 text_vlan_range
, vlanID_range
3222 if start_vlanid
> end_vlanid
:
3223 raise vimconn
.VimConnConflictException(
3224 "Invalid VLAN range for {}: {}. You must provide '{}'"
3225 " in format start_ID - end_ID and start_ID < end_ID ".format(
3226 text_vlan_range
, vlanID_range
, text_vlan_range
3230 # NOT USED FUNCTIONS
3232 def new_external_port(self
, port_data
):
3233 """Adds a external port to VIM
3234 Returns the port identifier"""
3235 # TODO openstack if needed
3237 -vimconn
.HTTP_Internal_Server_Error
,
3238 "osconnector.new_external_port() not implemented",
3241 def connect_port_network(self
, port_id
, network_id
, admin
=False):
3242 """Connects a external port to a network
3243 Returns status code of the VIM response"""
3244 # TODO openstack if needed
3246 -vimconn
.HTTP_Internal_Server_Error
,
3247 "osconnector.connect_port_network() not implemented",
3250 def new_user(self
, user_name
, user_passwd
, tenant_id
=None):
3251 """Adds a new user to openstack VIM
3252 Returns the user identifier"""
3253 self
.logger
.debug("osconnector: Adding a new user to VIM")
3256 self
._reload
_connection
()
3257 user
= self
.keystone
.users
.create(
3258 user_name
, password
=user_passwd
, default_project
=tenant_id
3260 # self.keystone.tenants.add_user(self.k_creds["username"], #role)
3263 except ksExceptions
.ConnectionError
as e
:
3264 error_value
= -vimconn
.HTTP_Bad_Request
3268 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3270 except ksExceptions
.ClientException
as e
: # TODO remove
3271 error_value
= -vimconn
.HTTP_Bad_Request
3275 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3278 # TODO insert exception vimconn.HTTP_Unauthorized
3279 # if reaching here is because an exception
3280 self
.logger
.debug("new_user " + error_text
)
3282 return error_value
, error_text
3284 def delete_user(self
, user_id
):
3285 """Delete a user from openstack VIM
3286 Returns the user identifier"""
3288 print("osconnector: Deleting a user from VIM")
3291 self
._reload
_connection
()
3292 self
.keystone
.users
.delete(user_id
)
3295 except ksExceptions
.ConnectionError
as e
:
3296 error_value
= -vimconn
.HTTP_Bad_Request
3300 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3302 except ksExceptions
.NotFound
as e
:
3303 error_value
= -vimconn
.HTTP_Not_Found
3307 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3309 except ksExceptions
.ClientException
as e
: # TODO remove
3310 error_value
= -vimconn
.HTTP_Bad_Request
3314 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3317 # TODO insert exception vimconn.HTTP_Unauthorized
3318 # if reaching here is because an exception
3319 self
.logger
.debug("delete_tenant " + error_text
)
3321 return error_value
, error_text
3323 def get_hosts_info(self
):
3324 """Get the information of deployed hosts
3325 Returns the hosts content"""
3327 print("osconnector: Getting Host info from VIM")
3331 self
._reload
_connection
()
3332 hypervisors
= self
.nova
.hypervisors
.list()
3334 for hype
in hypervisors
:
3335 h_list
.append(hype
.to_dict())
3337 return 1, {"hosts": h_list
}
3338 except nvExceptions
.NotFound
as e
:
3339 error_value
= -vimconn
.HTTP_Not_Found
3340 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3341 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
3342 error_value
= -vimconn
.HTTP_Bad_Request
3346 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3349 # TODO insert exception vimconn.HTTP_Unauthorized
3350 # if reaching here is because an exception
3351 self
.logger
.debug("get_hosts_info " + error_text
)
3353 return error_value
, error_text
3355 def get_hosts(self
, vim_tenant
):
3356 """Get the hosts and deployed instances
3357 Returns the hosts content"""
3358 r
, hype_dict
= self
.get_hosts_info()
3363 hypervisors
= hype_dict
["hosts"]
3366 servers
= self
.nova
.servers
.list()
3367 for hype
in hypervisors
:
3368 for server
in servers
:
3370 server
.to_dict()["OS-EXT-SRV-ATTR:hypervisor_hostname"]
3371 == hype
["hypervisor_hostname"]
3374 hype
["vm"].append(server
.id)
3376 hype
["vm"] = [server
.id]
3379 except nvExceptions
.NotFound
as e
:
3380 error_value
= -vimconn
.HTTP_Not_Found
3381 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3382 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
3383 error_value
= -vimconn
.HTTP_Bad_Request
3387 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3390 # TODO insert exception vimconn.HTTP_Unauthorized
3391 # if reaching here is because an exception
3392 self
.logger
.debug("get_hosts " + error_text
)
3394 return error_value
, error_text
3396 def new_classification(self
, name
, ctype
, definition
):
3398 "Adding a new (Traffic) Classification to VIM, named %s", name
3403 self
._reload
_connection
()
3405 if ctype
not in supportedClassificationTypes
:
3406 raise vimconn
.VimConnNotSupportedException(
3407 "OpenStack VIM connector does not support provided "
3408 "Classification Type {}, supported ones are: {}".format(
3409 ctype
, supportedClassificationTypes
3413 if not self
._validate
_classification
(ctype
, definition
):
3414 raise vimconn
.VimConnException(
3415 "Incorrect Classification definition for the type specified."
3418 classification_dict
= definition
3419 classification_dict
["name"] = name
3420 new_class
= self
.neutron
.create_sfc_flow_classifier(
3421 {"flow_classifier": classification_dict
}
3424 return new_class
["flow_classifier"]["id"]
3426 neExceptions
.ConnectionFailed
,
3427 ksExceptions
.ClientException
,
3428 neExceptions
.NeutronException
,
3431 self
.logger
.error("Creation of Classification failed.")
3432 self
._format
_exception
(e
)
3434 def get_classification(self
, class_id
):
3435 self
.logger
.debug(" Getting Classification %s from VIM", class_id
)
3436 filter_dict
= {"id": class_id
}
3437 class_list
= self
.get_classification_list(filter_dict
)
3439 if len(class_list
) == 0:
3440 raise vimconn
.VimConnNotFoundException(
3441 "Classification '{}' not found".format(class_id
)
3443 elif len(class_list
) > 1:
3444 raise vimconn
.VimConnConflictException(
3445 "Found more than one Classification with this criteria"
3448 classification
= class_list
[0]
3450 return classification
3452 def get_classification_list(self
, filter_dict
={}):
3454 "Getting Classifications from VIM filter: '%s'", str(filter_dict
)
3458 filter_dict_os
= filter_dict
.copy()
3459 self
._reload
_connection
()
3461 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3462 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3464 classification_dict
= self
.neutron
.list_sfc_flow_classifiers(
3467 classification_list
= classification_dict
["flow_classifiers"]
3468 self
.__classification
_os
2mano
(classification_list
)
3470 return classification_list
3472 neExceptions
.ConnectionFailed
,
3473 ksExceptions
.ClientException
,
3474 neExceptions
.NeutronException
,
3477 self
._format
_exception
(e
)
3479 def delete_classification(self
, class_id
):
3480 self
.logger
.debug("Deleting Classification '%s' from VIM", class_id
)
3483 self
._reload
_connection
()
3484 self
.neutron
.delete_sfc_flow_classifier(class_id
)
3488 neExceptions
.ConnectionFailed
,
3489 neExceptions
.NeutronException
,
3490 ksExceptions
.ClientException
,
3491 neExceptions
.NeutronException
,
3494 self
._format
_exception
(e
)
3496 def new_sfi(self
, name
, ingress_ports
, egress_ports
, sfc_encap
=True):
3498 "Adding a new Service Function Instance to VIM, named '%s'", name
3503 self
._reload
_connection
()
3509 if len(ingress_ports
) != 1:
3510 raise vimconn
.VimConnNotSupportedException(
3511 "OpenStack VIM connector can only have 1 ingress port per SFI"
3514 if len(egress_ports
) != 1:
3515 raise vimconn
.VimConnNotSupportedException(
3516 "OpenStack VIM connector can only have 1 egress port per SFI"
3521 "ingress": ingress_ports
[0],
3522 "egress": egress_ports
[0],
3523 "service_function_parameters": {"correlation": correlation
},
3525 new_sfi
= self
.neutron
.create_sfc_port_pair({"port_pair": sfi_dict
})
3527 return new_sfi
["port_pair"]["id"]
3529 neExceptions
.ConnectionFailed
,
3530 ksExceptions
.ClientException
,
3531 neExceptions
.NeutronException
,
3536 self
.neutron
.delete_sfc_port_pair(new_sfi
["port_pair"]["id"])
3539 "Creation of Service Function Instance failed, with "
3540 "subsequent deletion failure as well."
3543 self
._format
_exception
(e
)
3545 def get_sfi(self
, sfi_id
):
3546 self
.logger
.debug("Getting Service Function Instance %s from VIM", sfi_id
)
3547 filter_dict
= {"id": sfi_id
}
3548 sfi_list
= self
.get_sfi_list(filter_dict
)
3550 if len(sfi_list
) == 0:
3551 raise vimconn
.VimConnNotFoundException(
3552 "Service Function Instance '{}' not found".format(sfi_id
)
3554 elif len(sfi_list
) > 1:
3555 raise vimconn
.VimConnConflictException(
3556 "Found more than one Service Function Instance with this criteria"
3563 def get_sfi_list(self
, filter_dict
={}):
3565 "Getting Service Function Instances from VIM filter: '%s'", str(filter_dict
)
3569 self
._reload
_connection
()
3570 filter_dict_os
= filter_dict
.copy()
3572 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3573 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3575 sfi_dict
= self
.neutron
.list_sfc_port_pairs(**filter_dict_os
)
3576 sfi_list
= sfi_dict
["port_pairs"]
3577 self
.__sfi
_os
2mano
(sfi_list
)
3581 neExceptions
.ConnectionFailed
,
3582 ksExceptions
.ClientException
,
3583 neExceptions
.NeutronException
,
3586 self
._format
_exception
(e
)
3588 def delete_sfi(self
, sfi_id
):
3589 self
.logger
.debug("Deleting Service Function Instance '%s' from VIM", sfi_id
)
3592 self
._reload
_connection
()
3593 self
.neutron
.delete_sfc_port_pair(sfi_id
)
3597 neExceptions
.ConnectionFailed
,
3598 neExceptions
.NeutronException
,
3599 ksExceptions
.ClientException
,
3600 neExceptions
.NeutronException
,
3603 self
._format
_exception
(e
)
3605 def new_sf(self
, name
, sfis
, sfc_encap
=True):
3606 self
.logger
.debug("Adding a new Service Function to VIM, named '%s'", name
)
3610 self
._reload
_connection
()
3611 # correlation = None
3613 # correlation = "nsh"
3615 for instance
in sfis
:
3616 sfi
= self
.get_sfi(instance
)
3618 if sfi
.get("sfc_encap") != sfc_encap
:
3619 raise vimconn
.VimConnNotSupportedException(
3620 "OpenStack VIM connector requires all SFIs of the "
3621 "same SF to share the same SFC Encapsulation"
3624 sf_dict
= {"name": name
, "port_pairs": sfis
}
3625 new_sf
= self
.neutron
.create_sfc_port_pair_group(
3626 {"port_pair_group": sf_dict
}
3629 return new_sf
["port_pair_group"]["id"]
3631 neExceptions
.ConnectionFailed
,
3632 ksExceptions
.ClientException
,
3633 neExceptions
.NeutronException
,
3638 self
.neutron
.delete_sfc_port_pair_group(
3639 new_sf
["port_pair_group"]["id"]
3643 "Creation of Service Function failed, with "
3644 "subsequent deletion failure as well."
3647 self
._format
_exception
(e
)
3649 def get_sf(self
, sf_id
):
3650 self
.logger
.debug("Getting Service Function %s from VIM", sf_id
)
3651 filter_dict
= {"id": sf_id
}
3652 sf_list
= self
.get_sf_list(filter_dict
)
3654 if len(sf_list
) == 0:
3655 raise vimconn
.VimConnNotFoundException(
3656 "Service Function '{}' not found".format(sf_id
)
3658 elif len(sf_list
) > 1:
3659 raise vimconn
.VimConnConflictException(
3660 "Found more than one Service Function with this criteria"
3667 def get_sf_list(self
, filter_dict
={}):
3669 "Getting Service Function from VIM filter: '%s'", str(filter_dict
)
3673 self
._reload
_connection
()
3674 filter_dict_os
= filter_dict
.copy()
3676 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3677 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3679 sf_dict
= self
.neutron
.list_sfc_port_pair_groups(**filter_dict_os
)
3680 sf_list
= sf_dict
["port_pair_groups"]
3681 self
.__sf
_os
2mano
(sf_list
)
3685 neExceptions
.ConnectionFailed
,
3686 ksExceptions
.ClientException
,
3687 neExceptions
.NeutronException
,
3690 self
._format
_exception
(e
)
3692 def delete_sf(self
, sf_id
):
3693 self
.logger
.debug("Deleting Service Function '%s' from VIM", sf_id
)
3696 self
._reload
_connection
()
3697 self
.neutron
.delete_sfc_port_pair_group(sf_id
)
3701 neExceptions
.ConnectionFailed
,
3702 neExceptions
.NeutronException
,
3703 ksExceptions
.ClientException
,
3704 neExceptions
.NeutronException
,
3707 self
._format
_exception
(e
)
3709 def new_sfp(self
, name
, classifications
, sfs
, sfc_encap
=True, spi
=None):
3710 self
.logger
.debug("Adding a new Service Function Path to VIM, named '%s'", name
)
3714 self
._reload
_connection
()
3715 # In networking-sfc the MPLS encapsulation is legacy
3716 # should be used when no full SFC Encapsulation is intended
3717 correlation
= "mpls"
3724 "flow_classifiers": classifications
,
3725 "port_pair_groups": sfs
,
3726 "chain_parameters": {"correlation": correlation
},
3730 sfp_dict
["chain_id"] = spi
3732 new_sfp
= self
.neutron
.create_sfc_port_chain({"port_chain": sfp_dict
})
3734 return new_sfp
["port_chain"]["id"]
3736 neExceptions
.ConnectionFailed
,
3737 ksExceptions
.ClientException
,
3738 neExceptions
.NeutronException
,
3743 self
.neutron
.delete_sfc_port_chain(new_sfp
["port_chain"]["id"])
3746 "Creation of Service Function Path failed, with "
3747 "subsequent deletion failure as well."
3750 self
._format
_exception
(e
)
3752 def get_sfp(self
, sfp_id
):
3753 self
.logger
.debug(" Getting Service Function Path %s from VIM", sfp_id
)
3755 filter_dict
= {"id": sfp_id
}
3756 sfp_list
= self
.get_sfp_list(filter_dict
)
3758 if len(sfp_list
) == 0:
3759 raise vimconn
.VimConnNotFoundException(
3760 "Service Function Path '{}' not found".format(sfp_id
)
3762 elif len(sfp_list
) > 1:
3763 raise vimconn
.VimConnConflictException(
3764 "Found more than one Service Function Path with this criteria"
3771 def get_sfp_list(self
, filter_dict
={}):
3773 "Getting Service Function Paths from VIM filter: '%s'", str(filter_dict
)
3777 self
._reload
_connection
()
3778 filter_dict_os
= filter_dict
.copy()
3780 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3781 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3783 sfp_dict
= self
.neutron
.list_sfc_port_chains(**filter_dict_os
)
3784 sfp_list
= sfp_dict
["port_chains"]
3785 self
.__sfp
_os
2mano
(sfp_list
)
3789 neExceptions
.ConnectionFailed
,
3790 ksExceptions
.ClientException
,
3791 neExceptions
.NeutronException
,
3794 self
._format
_exception
(e
)
3796 def delete_sfp(self
, sfp_id
):
3797 self
.logger
.debug("Deleting Service Function Path '%s' from VIM", sfp_id
)
3800 self
._reload
_connection
()
3801 self
.neutron
.delete_sfc_port_chain(sfp_id
)
3805 neExceptions
.ConnectionFailed
,
3806 neExceptions
.NeutronException
,
3807 ksExceptions
.ClientException
,
3808 neExceptions
.NeutronException
,
3811 self
._format
_exception
(e
)
3813 def refresh_sfps_status(self
, sfp_list
):
3814 """Get the status of the service function path
3815 Params: the list of sfp identifiers
3816 Returns a dictionary with:
3817 vm_id: #VIM id of this service function path
3818 status: #Mandatory. Text with one of:
3819 # DELETED (not found at vim)
3820 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3821 # OTHER (Vim reported other status not understood)
3822 # ERROR (VIM indicates an ERROR status)
3824 # CREATING (on building process)
3825 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3826 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)F
3830 "refresh_sfps status: Getting tenant SFP information from VIM"
3833 for sfp_id
in sfp_list
:
3837 sfp_vim
= self
.get_sfp(sfp_id
)
3840 sfp
["status"] = vmStatus2manoFormat
["ACTIVE"]
3842 sfp
["status"] = "OTHER"
3843 sfp
["error_msg"] = "VIM status reported " + sfp
["status"]
3845 sfp
["vim_info"] = self
.serialize(sfp_vim
)
3847 if sfp_vim
.get("fault"):
3848 sfp
["error_msg"] = str(sfp_vim
["fault"])
3849 except vimconn
.VimConnNotFoundException
as e
:
3850 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3851 sfp
["status"] = "DELETED"
3852 sfp
["error_msg"] = str(e
)
3853 except vimconn
.VimConnException
as e
:
3854 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3855 sfp
["status"] = "VIM_ERROR"
3856 sfp
["error_msg"] = str(e
)
3858 sfp_dict
[sfp_id
] = sfp
3862 def refresh_sfis_status(self
, sfi_list
):
3863 """Get the status of the service function instances
3864 Params: the list of sfi identifiers
3865 Returns a dictionary with:
3866 vm_id: #VIM id of this service function instance
3867 status: #Mandatory. Text with one of:
3868 # DELETED (not found at vim)
3869 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3870 # OTHER (Vim reported other status not understood)
3871 # ERROR (VIM indicates an ERROR status)
3873 # CREATING (on building process)
3874 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3875 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3879 "refresh_sfis status: Getting tenant sfi information from VIM"
3882 for sfi_id
in sfi_list
:
3886 sfi_vim
= self
.get_sfi(sfi_id
)
3889 sfi
["status"] = vmStatus2manoFormat
["ACTIVE"]
3891 sfi
["status"] = "OTHER"
3892 sfi
["error_msg"] = "VIM status reported " + sfi
["status"]
3894 sfi
["vim_info"] = self
.serialize(sfi_vim
)
3896 if sfi_vim
.get("fault"):
3897 sfi
["error_msg"] = str(sfi_vim
["fault"])
3898 except vimconn
.VimConnNotFoundException
as e
:
3899 self
.logger
.error("Exception getting sfi status: %s", str(e
))
3900 sfi
["status"] = "DELETED"
3901 sfi
["error_msg"] = str(e
)
3902 except vimconn
.VimConnException
as e
:
3903 self
.logger
.error("Exception getting sfi status: %s", str(e
))
3904 sfi
["status"] = "VIM_ERROR"
3905 sfi
["error_msg"] = str(e
)
3907 sfi_dict
[sfi_id
] = sfi
3911 def refresh_sfs_status(self
, sf_list
):
3912 """Get the status of the service functions
3913 Params: the list of sf identifiers
3914 Returns a dictionary with:
3915 vm_id: #VIM id of this service function
3916 status: #Mandatory. Text with one of:
3917 # DELETED (not found at vim)
3918 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3919 # OTHER (Vim reported other status not understood)
3920 # ERROR (VIM indicates an ERROR status)
3922 # CREATING (on building process)
3923 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3924 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3927 self
.logger
.debug("refresh_sfs status: Getting tenant sf information from VIM")
3929 for sf_id
in sf_list
:
3933 sf_vim
= self
.get_sf(sf_id
)
3936 sf
["status"] = vmStatus2manoFormat
["ACTIVE"]
3938 sf
["status"] = "OTHER"
3939 sf
["error_msg"] = "VIM status reported " + sf_vim
["status"]
3941 sf
["vim_info"] = self
.serialize(sf_vim
)
3943 if sf_vim
.get("fault"):
3944 sf
["error_msg"] = str(sf_vim
["fault"])
3945 except vimconn
.VimConnNotFoundException
as e
:
3946 self
.logger
.error("Exception getting sf status: %s", str(e
))
3947 sf
["status"] = "DELETED"
3948 sf
["error_msg"] = str(e
)
3949 except vimconn
.VimConnException
as e
:
3950 self
.logger
.error("Exception getting sf status: %s", str(e
))
3951 sf
["status"] = "VIM_ERROR"
3952 sf
["error_msg"] = str(e
)
3958 def refresh_classifications_status(self
, classification_list
):
3959 """Get the status of the classifications
3960 Params: the list of classification identifiers
3961 Returns a dictionary with:
3962 vm_id: #VIM id of this classifier
3963 status: #Mandatory. Text with one of:
3964 # DELETED (not found at vim)
3965 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3966 # OTHER (Vim reported other status not understood)
3967 # ERROR (VIM indicates an ERROR status)
3969 # CREATING (on building process)
3970 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3971 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3973 classification_dict
= {}
3975 "refresh_classifications status: Getting tenant classification information from VIM"
3978 for classification_id
in classification_list
:
3982 classification_vim
= self
.get_classification(classification_id
)
3984 if classification_vim
:
3985 classification
["status"] = vmStatus2manoFormat
["ACTIVE"]
3987 classification
["status"] = "OTHER"
3988 classification
["error_msg"] = (
3989 "VIM status reported " + classification
["status"]
3992 classification
["vim_info"] = self
.serialize(classification_vim
)
3994 if classification_vim
.get("fault"):
3995 classification
["error_msg"] = str(classification_vim
["fault"])
3996 except vimconn
.VimConnNotFoundException
as e
:
3997 self
.logger
.error("Exception getting classification status: %s", str(e
))
3998 classification
["status"] = "DELETED"
3999 classification
["error_msg"] = str(e
)
4000 except vimconn
.VimConnException
as e
:
4001 self
.logger
.error("Exception getting classification status: %s", str(e
))
4002 classification
["status"] = "VIM_ERROR"
4003 classification
["error_msg"] = str(e
)
4005 classification_dict
[classification_id
] = classification
4007 return classification_dict
4009 def new_affinity_group(self
, affinity_group_data
):
4010 """Adds a server group to VIM
4011 affinity_group_data contains a dictionary with information, keys:
4012 name: name in VIM for the server group
4013 type: affinity or anti-affinity
4014 scope: Only nfvi-node allowed
4015 Returns the server group identifier"""
4016 self
.logger
.debug("Adding Server Group '%s'", str(affinity_group_data
))
4019 name
= affinity_group_data
["name"]
4020 policy
= affinity_group_data
["type"]
4022 self
._reload
_connection
()
4023 new_server_group
= self
.nova
.server_groups
.create(name
, policy
)
4025 return new_server_group
.id
4027 ksExceptions
.ClientException
,
4028 nvExceptions
.ClientException
,
4032 self
._format
_exception
(e
)
4034 def get_affinity_group(self
, affinity_group_id
):
4035 """Obtain server group details from the VIM. Returns the server group detais as a dict"""
4036 self
.logger
.debug("Getting flavor '%s'", affinity_group_id
)
4038 self
._reload
_connection
()
4039 server_group
= self
.nova
.server_groups
.find(id=affinity_group_id
)
4041 return server_group
.to_dict()
4043 nvExceptions
.NotFound
,
4044 nvExceptions
.ClientException
,
4045 ksExceptions
.ClientException
,
4048 self
._format
_exception
(e
)
4050 def delete_affinity_group(self
, affinity_group_id
):
4051 """Deletes a server group from the VIM. Returns the old affinity_group_id"""
4052 self
.logger
.debug("Getting server group '%s'", affinity_group_id
)
4054 self
._reload
_connection
()
4055 self
.nova
.server_groups
.delete(affinity_group_id
)
4057 return affinity_group_id
4059 nvExceptions
.NotFound
,
4060 ksExceptions
.ClientException
,
4061 nvExceptions
.ClientException
,
4064 self
._format
_exception
(e
)
4066 def get_vdu_state(self
, vm_id
):
4068 Getting the state of a vdu
4070 vm_id: ID of an instance
4072 self
.logger
.debug("Getting the status of VM")
4073 self
.logger
.debug("VIM VM ID %s", vm_id
)
4074 self
._reload
_connection
()
4075 server
= self
.nova
.servers
.find(id=vm_id
)
4076 server_dict
= server
.to_dict()
4078 server_dict
["status"],
4079 server_dict
["flavor"]["id"],
4080 server_dict
["OS-EXT-SRV-ATTR:host"],
4081 server_dict
["OS-EXT-AZ:availability_zone"],
4083 self
.logger
.debug("vdu_data %s", vdu_data
)
4086 def check_compute_availability(self
, host
, server_flavor_details
):
4087 self
._reload
_connection
()
4088 hypervisor_search
= self
.nova
.hypervisors
.search(
4089 hypervisor_match
=host
, servers
=True
4091 for hypervisor
in hypervisor_search
:
4092 hypervisor_id
= hypervisor
.to_dict()["id"]
4093 hypervisor_details
= self
.nova
.hypervisors
.get(hypervisor
=hypervisor_id
)
4094 hypervisor_dict
= hypervisor_details
.to_dict()
4095 hypervisor_temp
= json
.dumps(hypervisor_dict
)
4096 hypervisor_json
= json
.loads(hypervisor_temp
)
4097 resources_available
= [
4098 hypervisor_json
["free_ram_mb"],
4099 hypervisor_json
["disk_available_least"],
4100 hypervisor_json
["vcpus"] - hypervisor_json
["vcpus_used"],
4102 compute_available
= all(
4103 x
> y
for x
, y
in zip(resources_available
, server_flavor_details
)
4105 if compute_available
:
4108 def check_availability_zone(
4109 self
, old_az
, server_flavor_details
, old_host
, host
=None
4111 self
._reload
_connection
()
4112 az_check
= {"zone_check": False, "compute_availability": None}
4113 aggregates_list
= self
.nova
.aggregates
.list()
4114 for aggregate
in aggregates_list
:
4115 aggregate_details
= aggregate
.to_dict()
4116 aggregate_temp
= json
.dumps(aggregate_details
)
4117 aggregate_json
= json
.loads(aggregate_temp
)
4118 if aggregate_json
["availability_zone"] == old_az
:
4119 hosts_list
= aggregate_json
["hosts"]
4120 if host
is not None:
4121 if host
in hosts_list
:
4122 az_check
["zone_check"] = True
4123 available_compute_id
= self
.check_compute_availability(
4124 host
, server_flavor_details
4126 if available_compute_id
is not None:
4127 az_check
["compute_availability"] = available_compute_id
4129 for check_host
in hosts_list
:
4130 if check_host
!= old_host
:
4131 available_compute_id
= self
.check_compute_availability(
4132 check_host
, server_flavor_details
4134 if available_compute_id
is not None:
4135 az_check
["zone_check"] = True
4136 az_check
["compute_availability"] = available_compute_id
4139 az_check
["zone_check"] = True
4142 def migrate_instance(self
, vm_id
, compute_host
=None):
4146 vm_id: ID of an instance
4147 compute_host: Host to migrate the vdu to
4149 self
._reload
_connection
()
4151 instance_state
= self
.get_vdu_state(vm_id
)
4152 server_flavor_id
= instance_state
[1]
4153 server_hypervisor_name
= instance_state
[2]
4154 server_availability_zone
= instance_state
[3]
4156 server_flavor
= self
.nova
.flavors
.find(id=server_flavor_id
).to_dict()
4157 server_flavor_details
= [
4158 server_flavor
["ram"],
4159 server_flavor
["disk"],
4160 server_flavor
["vcpus"],
4162 if compute_host
== server_hypervisor_name
:
4163 raise vimconn
.VimConnException(
4164 "Unable to migrate instance '{}' to the same host '{}'".format(
4167 http_code
=vimconn
.HTTP_Bad_Request
,
4169 az_status
= self
.check_availability_zone(
4170 server_availability_zone
,
4171 server_flavor_details
,
4172 server_hypervisor_name
,
4175 availability_zone_check
= az_status
["zone_check"]
4176 available_compute_id
= az_status
.get("compute_availability")
4178 if availability_zone_check
is False:
4179 raise vimconn
.VimConnException(
4180 "Unable to migrate instance '{}' to a different availability zone".format(
4183 http_code
=vimconn
.HTTP_Bad_Request
,
4185 if available_compute_id
is not None:
4186 self
.nova
.servers
.live_migrate(
4188 host
=available_compute_id
,
4189 block_migration
=True,
4190 disk_over_commit
=False,
4193 changed_compute_host
= ""
4194 if state
== "MIGRATING":
4195 vm_state
= self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4196 changed_compute_host
= self
.get_vdu_state(vm_id
)[2]
4197 if vm_state
and changed_compute_host
== available_compute_id
:
4199 "Instance '{}' migrated to the new compute host '{}'".format(
4200 vm_id
, changed_compute_host
4203 return state
, available_compute_id
4205 raise vimconn
.VimConnException(
4206 "Migration Failed. Instance '{}' not moved to the new host {}".format(
4207 vm_id
, available_compute_id
4209 http_code
=vimconn
.HTTP_Bad_Request
,
4212 raise vimconn
.VimConnException(
4213 "Compute '{}' not available or does not have enough resources to migrate the instance".format(
4214 available_compute_id
4216 http_code
=vimconn
.HTTP_Bad_Request
,
4219 nvExceptions
.BadRequest
,
4220 nvExceptions
.ClientException
,
4221 nvExceptions
.NotFound
,
4223 self
._format
_exception
(e
)
4225 def resize_instance(self
, vm_id
, new_flavor_id
):
4227 For resizing the vm based on the given
4230 vm_id : ID of an instance
4231 new_flavor_id : Flavor id to be resized
4232 Return the status of a resized instance
4234 self
._reload
_connection
()
4235 self
.logger
.debug("resize the flavor of an instance")
4236 instance_status
, old_flavor_id
, compute_host
, az
= self
.get_vdu_state(vm_id
)
4237 old_flavor_disk
= self
.nova
.flavors
.find(id=old_flavor_id
).to_dict()["disk"]
4238 new_flavor_disk
= self
.nova
.flavors
.find(id=new_flavor_id
).to_dict()["disk"]
4240 if instance_status
== "ACTIVE" or instance_status
== "SHUTOFF":
4241 if old_flavor_disk
> new_flavor_disk
:
4242 raise nvExceptions
.BadRequest(
4244 message
="Server disk resize failed. Resize to lower disk flavor is not allowed",
4247 self
.nova
.servers
.resize(server
=vm_id
, flavor
=new_flavor_id
)
4248 vm_state
= self
.__wait
_for
_vm
(vm_id
, "VERIFY_RESIZE")
4250 instance_resized_status
= self
.confirm_resize(vm_id
)
4251 return instance_resized_status
4253 raise nvExceptions
.BadRequest(
4255 message
="Cannot 'resize' vm_state is in ERROR",
4259 self
.logger
.debug("ERROR : Instance is not in ACTIVE or SHUTOFF state")
4260 raise nvExceptions
.BadRequest(
4262 message
="Cannot 'resize' instance while it is in vm_state resized",
4265 nvExceptions
.BadRequest
,
4266 nvExceptions
.ClientException
,
4267 nvExceptions
.NotFound
,
4269 self
._format
_exception
(e
)
4271 def confirm_resize(self
, vm_id
):
4273 Confirm the resize of an instance
4275 vm_id: ID of an instance
4277 self
._reload
_connection
()
4278 self
.nova
.servers
.confirm_resize(server
=vm_id
)
4279 if self
.get_vdu_state(vm_id
)[0] == "VERIFY_RESIZE":
4280 self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4281 instance_status
= self
.get_vdu_state(vm_id
)[0]
4282 return instance_status