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
, List
, 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
)
1231 def process_resource_quota(quota
: dict, prefix
: str, extra_specs
: dict) -> None:
1232 """Process resource quota and fill up extra_specs.
1234 quota (dict): Keeping the quota of resurces
1236 extra_specs (dict) Dict to be filled to be used during flavor creation
1239 if "limit" in quota
:
1240 extra_specs
["quota:" + prefix
+ "_limit"] = quota
["limit"]
1242 if "reserve" in quota
:
1243 extra_specs
["quota:" + prefix
+ "_reservation"] = quota
["reserve"]
1245 if "shares" in quota
:
1246 extra_specs
["quota:" + prefix
+ "_shares_level"] = "custom"
1247 extra_specs
["quota:" + prefix
+ "_shares_share"] = quota
["shares"]
1250 def process_numa_memory(
1251 numa
: dict, node_id
: Optional
[int], extra_specs
: dict
1253 """Set the memory in extra_specs.
1255 numa (dict): A dictionary which includes numa information
1256 node_id (int): ID of numa node
1257 extra_specs (dict): To be filled.
1260 if not numa
.get("memory"):
1262 memory_mb
= numa
["memory"] * 1024
1263 memory
= "hw:numa_mem.{}".format(node_id
)
1264 extra_specs
[memory
] = int(memory_mb
)
1267 def process_numa_vcpu(numa
: dict, node_id
: int, extra_specs
: dict) -> None:
1268 """Set the cpu in extra_specs.
1270 numa (dict): A dictionary which includes numa information
1271 node_id (int): ID of numa node
1272 extra_specs (dict): To be filled.
1275 if not numa
.get("vcpu"):
1278 cpu
= "hw:numa_cpus.{}".format(node_id
)
1279 vcpu
= ",".join(map(str, vcpu
))
1280 extra_specs
[cpu
] = vcpu
1283 def process_numa_paired_threads(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1284 """Fill up extra_specs if numa has paired-threads.
1286 numa (dict): A dictionary which includes numa information
1287 extra_specs (dict): To be filled.
1290 threads (int) Number of virtual cpus
1293 if not numa
.get("paired-threads"):
1296 # cpu_thread_policy "require" implies that compute node must have an STM architecture
1297 threads
= numa
["paired-threads"] * 2
1298 extra_specs
["hw:cpu_thread_policy"] = "require"
1299 extra_specs
["hw:cpu_policy"] = "dedicated"
1303 def process_numa_cores(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1304 """Fill up extra_specs if numa has cores.
1306 numa (dict): A dictionary which includes numa information
1307 extra_specs (dict): To be filled.
1310 cores (int) Number of virtual cpus
1313 # cpu_thread_policy "isolate" implies that the host must not have an SMT
1314 # architecture, or a non-SMT architecture will be emulated
1315 if not numa
.get("cores"):
1317 cores
= numa
["cores"]
1318 extra_specs
["hw:cpu_thread_policy"] = "isolate"
1319 extra_specs
["hw:cpu_policy"] = "dedicated"
1323 def process_numa_threads(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1324 """Fill up extra_specs if numa has threads.
1326 numa (dict): A dictionary which includes numa information
1327 extra_specs (dict): To be filled.
1330 threads (int) Number of virtual cpus
1333 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT architecture
1334 if not numa
.get("threads"):
1336 threads
= numa
["threads"]
1337 extra_specs
["hw:cpu_thread_policy"] = "prefer"
1338 extra_specs
["hw:cpu_policy"] = "dedicated"
1341 def _process_numa_parameters_of_flavor(
1342 self
, numas
: List
, extra_specs
: Dict
1344 """Process numa parameters and fill up extra_specs.
1347 numas (list): List of dictionary which includes numa information
1348 extra_specs (dict): To be filled.
1351 numa_nodes
= len(numas
)
1352 extra_specs
["hw:numa_nodes"] = str(numa_nodes
)
1353 cpu_cores
, cpu_threads
= 0, 0
1355 if self
.vim_type
== "VIO":
1356 extra_specs
["vmware:extra_config"] = '{"numa.nodeAffinity":"0"}'
1357 extra_specs
["vmware:latency_sensitivity_level"] = "high"
1361 node_id
= numa
["id"]
1362 # overwrite ram and vcpus
1363 # check if key "memory" is present in numa else use ram value at flavor
1364 self
.process_numa_memory(numa
, node_id
, extra_specs
)
1365 self
.process_numa_vcpu(numa
, node_id
, extra_specs
)
1367 # See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/implemented/virt-driver-cpu-thread-pinning.html
1368 extra_specs
["hw:cpu_sockets"] = str(numa_nodes
)
1370 if "paired-threads" in numa
:
1371 threads
= self
.process_numa_paired_threads(numa
, extra_specs
)
1372 cpu_threads
+= threads
1374 elif "cores" in numa
:
1375 cores
= self
.process_numa_cores(numa
, extra_specs
)
1378 elif "threads" in numa
:
1379 threads
= self
.process_numa_threads(numa
, extra_specs
)
1380 cpu_threads
+= threads
1383 extra_specs
["hw:cpu_cores"] = str(cpu_cores
)
1385 extra_specs
["hw:cpu_threads"] = str(cpu_threads
)
1387 def _change_flavor_name(
1388 self
, name
: str, name_suffix
: int, flavor_data
: dict
1390 """Change the flavor name if the name already exists.
1393 name (str): Flavor name to be checked
1394 name_suffix (int): Suffix to be appended to name
1395 flavor_data (dict): Flavor dict
1398 name (str): New flavor name to be used
1402 fl
= self
.nova
.flavors
.list()
1403 fl_names
= [f
.name
for f
in fl
]
1405 while name
in fl_names
:
1407 name
= flavor_data
["name"] + "-" + str(name_suffix
)
1411 def _process_extended_config_of_flavor(
1412 self
, extended
: dict, extra_specs
: dict
1414 """Process the extended dict to fill up extra_specs.
1417 extended (dict): Keeping the extra specification of flavor
1418 extra_specs (dict) Dict to be filled to be used during flavor creation
1423 "mem-quota": "memory",
1425 "disk-io-quota": "disk_io",
1433 "PREFER_LARGE": "any",
1437 "cpu-pinning-policy": "hw:cpu_policy",
1438 "cpu-thread-pinning-policy": "hw:cpu_thread_policy",
1439 "mem-policy": "hw:numa_mempolicy",
1442 numas
= extended
.get("numas")
1444 self
._process
_numa
_parameters
_of
_flavor
(numas
, extra_specs
)
1446 for quota
, item
in quotas
.items():
1447 if quota
in extended
.keys():
1448 self
.process_resource_quota(extended
.get(quota
), item
, extra_specs
)
1450 # Set the mempage size as specified in the descriptor
1451 if extended
.get("mempage-size"):
1452 if extended
["mempage-size"] in page_sizes
.keys():
1453 extra_specs
["hw:mem_page_size"] = page_sizes
[extended
["mempage-size"]]
1455 # Normally, validations in NBI should not allow to this condition.
1457 "Invalid mempage-size %s. Will be ignored",
1458 extended
.get("mempage-size"),
1461 for policy
, hw_policy
in policies
.items():
1462 if extended
.get(policy
):
1463 extra_specs
[hw_policy
] = extended
[policy
].lower()
1466 def _get_flavor_details(flavor_data
: dict) -> Tuple
:
1467 """Returns the details of flavor
1469 flavor_data (dict): Dictionary that includes required flavor details
1472 ram, vcpus, extra_specs, extended (tuple): Main items of required flavor
1476 flavor_data
.get("ram", 64),
1477 flavor_data
.get("vcpus", 1),
1479 flavor_data
.get("extended"),
1482 def new_flavor(self
, flavor_data
: dict, change_name_if_used
: bool = True) -> str:
1483 """Adds a tenant flavor to openstack VIM.
1484 if change_name_if_used is True, it will change name in case of conflict,
1485 because it is not supported name repetition.
1488 flavor_data (dict): Flavor details to be processed
1489 change_name_if_used (bool): Change name in case of conflict
1492 flavor_id (str): flavor identifier
1495 self
.logger
.debug("Adding flavor '%s'", str(flavor_data
))
1501 name
= flavor_data
["name"]
1502 while retry
< max_retries
:
1505 self
._reload
_connection
()
1507 if change_name_if_used
:
1508 name
= self
._change
_flavor
_name
(name
, name_suffix
, flavor_data
)
1510 ram
, vcpus
, extra_specs
, extended
= self
._get
_flavor
_details
(
1514 self
._process
_extended
_config
_of
_flavor
(extended
, extra_specs
)
1518 new_flavor
= self
.nova
.flavors
.create(
1522 disk
=flavor_data
.get("disk", 0),
1523 ephemeral
=flavor_data
.get("ephemeral", 0),
1524 swap
=flavor_data
.get("swap", 0),
1525 is_public
=flavor_data
.get("is_public", True),
1530 new_flavor
.set_keys(extra_specs
)
1532 return new_flavor
.id
1534 except nvExceptions
.Conflict
as e
:
1536 if change_name_if_used
and retry
< max_retries
:
1539 self
._format
_exception
(e
)
1542 ksExceptions
.ClientException
,
1543 nvExceptions
.ClientException
,
1547 self
._format
_exception
(e
)
1549 def delete_flavor(self
, flavor_id
):
1550 """Deletes a tenant flavor from openstack VIM. Returns the old flavor_id"""
1552 self
._reload
_connection
()
1553 self
.nova
.flavors
.delete(flavor_id
)
1556 # except nvExceptions.BadRequest as e:
1558 nvExceptions
.NotFound
,
1559 ksExceptions
.ClientException
,
1560 nvExceptions
.ClientException
,
1563 self
._format
_exception
(e
)
1565 def new_image(self
, image_dict
):
1567 Adds a tenant image to VIM. imge_dict is a dictionary with:
1569 disk_format: qcow2, vhd, vmdk, raw (by default), ...
1570 location: path or URI
1571 public: "yes" or "no"
1572 metadata: metadata of the image
1573 Returns the image_id
1578 while retry
< max_retries
:
1581 self
._reload
_connection
()
1583 # determine format http://docs.openstack.org/developer/glance/formats.html
1584 if "disk_format" in image_dict
:
1585 disk_format
= image_dict
["disk_format"]
1586 else: # autodiscover based on extension
1587 if image_dict
["location"].endswith(".qcow2"):
1588 disk_format
= "qcow2"
1589 elif image_dict
["location"].endswith(".vhd"):
1591 elif image_dict
["location"].endswith(".vmdk"):
1592 disk_format
= "vmdk"
1593 elif image_dict
["location"].endswith(".vdi"):
1595 elif image_dict
["location"].endswith(".iso"):
1597 elif image_dict
["location"].endswith(".aki"):
1599 elif image_dict
["location"].endswith(".ari"):
1601 elif image_dict
["location"].endswith(".ami"):
1607 "new_image: '%s' loading from '%s'",
1609 image_dict
["location"],
1611 if self
.vim_type
== "VIO":
1612 container_format
= "bare"
1613 if "container_format" in image_dict
:
1614 container_format
= image_dict
["container_format"]
1616 new_image
= self
.glance
.images
.create(
1617 name
=image_dict
["name"],
1618 container_format
=container_format
,
1619 disk_format
=disk_format
,
1622 new_image
= self
.glance
.images
.create(name
=image_dict
["name"])
1624 if image_dict
["location"].startswith("http"):
1625 # TODO there is not a method to direct download. It must be downloaded locally with requests
1626 raise vimconn
.VimConnNotImplemented("Cannot create image from URL")
1628 with
open(image_dict
["location"]) as fimage
:
1629 self
.glance
.images
.upload(new_image
.id, fimage
)
1630 # new_image = self.glancev1.images.create(name=image_dict["name"], is_public=
1631 # image_dict.get("public","yes")=="yes",
1632 # container_format="bare", data=fimage, disk_format=disk_format)
1634 metadata_to_load
= image_dict
.get("metadata")
1636 # TODO location is a reserved word for current openstack versions. fixed for VIO please check
1638 if self
.vim_type
== "VIO":
1639 metadata_to_load
["upload_location"] = image_dict
["location"]
1641 metadata_to_load
["location"] = image_dict
["location"]
1643 self
.glance
.images
.update(new_image
.id, **metadata_to_load
)
1647 nvExceptions
.Conflict
,
1648 ksExceptions
.ClientException
,
1649 nvExceptions
.ClientException
,
1651 self
._format
_exception
(e
)
1654 gl1Exceptions
.HTTPException
,
1655 gl1Exceptions
.CommunicationError
,
1658 if retry
== max_retries
:
1661 self
._format
_exception
(e
)
1662 except IOError as e
: # can not open the file
1663 raise vimconn
.VimConnConnectionException(
1664 "{}: {} for {}".format(type(e
).__name
__, e
, image_dict
["location"]),
1665 http_code
=vimconn
.HTTP_Bad_Request
,
1668 def delete_image(self
, image_id
):
1669 """Deletes a tenant image from openstack VIM. Returns the old id"""
1671 self
._reload
_connection
()
1672 self
.glance
.images
.delete(image_id
)
1676 nvExceptions
.NotFound
,
1677 ksExceptions
.ClientException
,
1678 nvExceptions
.ClientException
,
1679 gl1Exceptions
.CommunicationError
,
1680 gl1Exceptions
.HTTPNotFound
,
1682 ) as e
: # TODO remove
1683 self
._format
_exception
(e
)
1685 def get_image_id_from_path(self
, path
):
1686 """Get the image id from image path in the VIM database. Returns the image_id"""
1688 self
._reload
_connection
()
1689 images
= self
.glance
.images
.list()
1691 for image
in images
:
1692 if image
.metadata
.get("location") == path
:
1695 raise vimconn
.VimConnNotFoundException(
1696 "image with location '{}' not found".format(path
)
1699 ksExceptions
.ClientException
,
1700 nvExceptions
.ClientException
,
1701 gl1Exceptions
.CommunicationError
,
1704 self
._format
_exception
(e
)
1706 def get_image_list(self
, filter_dict
={}):
1707 """Obtain tenant images from VIM
1711 checksum: image checksum
1712 Returns the image list of dictionaries:
1713 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1716 self
.logger
.debug("Getting image list from VIM filter: '%s'", str(filter_dict
))
1719 self
._reload
_connection
()
1720 # filter_dict_os = filter_dict.copy()
1721 # First we filter by the available filter fields: name, id. The others are removed.
1722 image_list
= self
.glance
.images
.list()
1725 for image
in image_list
:
1727 if filter_dict
.get("name") and image
["name"] != filter_dict
["name"]:
1730 if filter_dict
.get("id") and image
["id"] != filter_dict
["id"]:
1734 filter_dict
.get("checksum")
1735 and image
["checksum"] != filter_dict
["checksum"]
1739 filtered_list
.append(image
.copy())
1740 except gl1Exceptions
.HTTPNotFound
:
1743 return filtered_list
1745 ksExceptions
.ClientException
,
1746 nvExceptions
.ClientException
,
1747 gl1Exceptions
.CommunicationError
,
1750 self
._format
_exception
(e
)
1752 def __wait_for_vm(self
, vm_id
, status
):
1753 """wait until vm is in the desired status and return True.
1754 If the VM gets in ERROR status, return false.
1755 If the timeout is reached generate an exception"""
1757 while elapsed_time
< server_timeout
:
1758 vm_status
= self
.nova
.servers
.get(vm_id
).status
1760 if vm_status
== status
:
1763 if vm_status
== "ERROR":
1769 # if we exceeded the timeout rollback
1770 if elapsed_time
>= server_timeout
:
1771 raise vimconn
.VimConnException(
1772 "Timeout waiting for instance " + vm_id
+ " to get " + status
,
1773 http_code
=vimconn
.HTTP_Request_Timeout
,
1776 def _get_openstack_availablity_zones(self
):
1778 Get from openstack availability zones available
1782 openstack_availability_zone
= self
.nova
.availability_zones
.list()
1783 openstack_availability_zone
= [
1785 for zone
in openstack_availability_zone
1786 if zone
.zoneName
!= "internal"
1789 return openstack_availability_zone
1793 def _set_availablity_zones(self
):
1795 Set vim availablity zone
1798 if "availability_zone" in self
.config
:
1799 vim_availability_zones
= self
.config
.get("availability_zone")
1801 if isinstance(vim_availability_zones
, str):
1802 self
.availability_zone
= [vim_availability_zones
]
1803 elif isinstance(vim_availability_zones
, list):
1804 self
.availability_zone
= vim_availability_zones
1806 self
.availability_zone
= self
._get
_openstack
_availablity
_zones
()
1808 def _get_vm_availability_zone(
1809 self
, availability_zone_index
, availability_zone_list
1812 Return thge availability zone to be used by the created VM.
1813 :return: The VIM availability zone to be used or None
1815 if availability_zone_index
is None:
1816 if not self
.config
.get("availability_zone"):
1818 elif isinstance(self
.config
.get("availability_zone"), str):
1819 return self
.config
["availability_zone"]
1821 # TODO consider using a different parameter at config for default AV and AV list match
1822 return self
.config
["availability_zone"][0]
1824 vim_availability_zones
= self
.availability_zone
1825 # check if VIM offer enough availability zones describe in the VNFD
1826 if vim_availability_zones
and len(availability_zone_list
) <= len(
1827 vim_availability_zones
1829 # check if all the names of NFV AV match VIM AV names
1830 match_by_index
= False
1831 for av
in availability_zone_list
:
1832 if av
not in vim_availability_zones
:
1833 match_by_index
= True
1837 return vim_availability_zones
[availability_zone_index
]
1839 return availability_zone_list
[availability_zone_index
]
1841 raise vimconn
.VimConnConflictException(
1842 "No enough availability zones at VIM for this deployment"
1845 def _prepare_port_dict_security_groups(self
, net
: dict, port_dict
: dict) -> None:
1846 """Fill up the security_groups in the port_dict.
1849 net (dict): Network details
1850 port_dict (dict): Port details
1854 self
.config
.get("security_groups")
1855 and net
.get("port_security") is not False
1856 and not self
.config
.get("no_port_security_extension")
1858 if not self
.security_groups_id
:
1859 self
._get
_ids
_from
_name
()
1861 port_dict
["security_groups"] = self
.security_groups_id
1863 def _prepare_port_dict_binding(self
, net
: dict, port_dict
: dict) -> None:
1864 """Fill up the network binding depending on network type in the port_dict.
1867 net (dict): Network details
1868 port_dict (dict): Port details
1871 if not net
.get("type"):
1872 raise vimconn
.VimConnException("Type is missing in the network details.")
1874 if net
["type"] == "virtual":
1878 elif net
["type"] == "VF" or net
["type"] == "SR-IOV":
1880 port_dict
["binding:vnic_type"] = "direct"
1882 # VIO specific Changes
1883 if self
.vim_type
== "VIO":
1884 # Need to create port with port_security_enabled = False and no-security-groups
1885 port_dict
["port_security_enabled"] = False
1886 port_dict
["provider_security_groups"] = []
1887 port_dict
["security_groups"] = []
1890 # For PT PCI-PASSTHROUGH
1891 port_dict
["binding:vnic_type"] = "direct-physical"
1894 def _set_fixed_ip(new_port
: dict, net
: dict) -> None:
1895 """Set the "ip" parameter in net dictionary.
1898 new_port (dict): New created port
1899 net (dict): Network details
1902 fixed_ips
= new_port
["port"].get("fixed_ips")
1905 net
["ip"] = fixed_ips
[0].get("ip_address")
1910 def _prepare_port_dict_mac_ip_addr(net
: dict, port_dict
: dict) -> None:
1911 """Fill up the mac_address and fixed_ips in port_dict.
1914 net (dict): Network details
1915 port_dict (dict): Port details
1918 if net
.get("mac_address"):
1919 port_dict
["mac_address"] = net
["mac_address"]
1921 if net
.get("ip_address"):
1922 port_dict
["fixed_ips"] = [{"ip_address": net
["ip_address"]}]
1923 # TODO add "subnet_id": <subnet_id>
1925 def _create_new_port(self
, port_dict
: dict, created_items
: dict, net
: dict) -> Dict
:
1926 """Create new port using neutron.
1929 port_dict (dict): Port details
1930 created_items (dict): All created items
1931 net (dict): Network details
1934 new_port (dict): New created port
1937 new_port
= self
.neutron
.create_port({"port": port_dict
})
1938 created_items
["port:" + str(new_port
["port"]["id"])] = True
1939 net
["mac_adress"] = new_port
["port"]["mac_address"]
1940 net
["vim_id"] = new_port
["port"]["id"]
1945 self
, net
: dict, name
: str, created_items
: dict
1946 ) -> Tuple
[dict, dict]:
1947 """Create port using net details.
1950 net (dict): Network details
1951 name (str): Name to be used as network name if net dict does not include name
1952 created_items (dict): All created items
1955 new_port, port New created port, port dictionary
1960 "network_id": net
["net_id"],
1961 "name": net
.get("name"),
1962 "admin_state_up": True,
1965 if not port_dict
["name"]:
1966 port_dict
["name"] = name
1968 self
._prepare
_port
_dict
_security
_groups
(net
, port_dict
)
1970 self
._prepare
_port
_dict
_binding
(net
, port_dict
)
1972 vimconnector
._prepare
_port
_dict
_mac
_ip
_addr
(net
, port_dict
)
1974 new_port
= self
._create
_new
_port
(port_dict
, created_items
, net
)
1976 vimconnector
._set
_fixed
_ip
(new_port
, net
)
1978 port
= {"port-id": new_port
["port"]["id"]}
1980 if float(self
.nova
.api_version
.get_string()) >= 2.32:
1981 port
["tag"] = new_port
["port"]["name"]
1983 return new_port
, port
1985 def _prepare_network_for_vminstance(
1989 created_items
: dict,
1991 external_network
: list,
1992 no_secured_ports
: list,
1994 """Create port and fill up net dictionary for new VM instance creation.
1997 name (str): Name of network
1998 net_list (list): List of networks
1999 created_items (dict): All created items belongs to a VM
2000 net_list_vim (list): List of ports
2001 external_network (list): List of external-networks
2002 no_secured_ports (list): Port security disabled ports
2005 self
._reload
_connection
()
2007 for net
in net_list
:
2008 # Skip non-connected iface
2009 if not net
.get("net_id"):
2012 new_port
, port
= self
._create
_port
(net
, name
, created_items
)
2014 net_list_vim
.append(port
)
2016 if net
.get("floating_ip", False):
2017 net
["exit_on_floating_ip_error"] = True
2018 external_network
.append(net
)
2020 elif net
["use"] == "mgmt" and self
.config
.get("use_floating_ip"):
2021 net
["exit_on_floating_ip_error"] = False
2022 external_network
.append(net
)
2023 net
["floating_ip"] = self
.config
.get("use_floating_ip")
2025 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic
2026 # is dropped. As a workaround we wait until the VM is active and then disable the port-security
2027 if net
.get("port_security") is False and not self
.config
.get(
2028 "no_port_security_extension"
2030 no_secured_ports
.append(
2032 new_port
["port"]["id"],
2033 net
.get("port_security_disable_strategy"),
2037 def _prepare_persistent_root_volumes(
2042 base_disk_index
: int,
2043 block_device_mapping
: dict,
2044 existing_vim_volumes
: list,
2045 created_items
: dict,
2047 """Prepare persistent root volumes for new VM instance.
2050 name (str): Name of VM instance
2051 vm_av_zone (list): List of availability zones
2052 disk (dict): Disk details
2053 base_disk_index (int): Disk index
2054 block_device_mapping (dict): Block device details
2055 existing_vim_volumes (list): Existing disk details
2056 created_items (dict): All created items belongs to VM
2059 boot_volume_id (str): ID of boot volume
2062 # Disk may include only vim_volume_id or only vim_id."
2063 # Use existing persistent root volume finding with volume_id or vim_id
2064 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
2066 if disk
.get(key_id
):
2068 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
2069 existing_vim_volumes
.append({"id": disk
[key_id
]})
2072 # Create persistent root volume
2073 volume
= self
.cinder
.volumes
.create(
2075 name
=name
+ "vd" + chr(base_disk_index
),
2076 imageRef
=disk
["image_id"],
2077 # Make sure volume is in the same AZ as the VM to be attached to
2078 availability_zone
=vm_av_zone
,
2080 boot_volume_id
= volume
.id
2081 self
.update_block_device_mapping(
2083 block_device_mapping
=block_device_mapping
,
2084 base_disk_index
=base_disk_index
,
2086 created_items
=created_items
,
2089 return boot_volume_id
2092 def update_block_device_mapping(
2094 block_device_mapping
: dict,
2095 base_disk_index
: int,
2097 created_items
: dict,
2099 """Add volume information to block device mapping dict.
2101 volume (object): Created volume object
2102 block_device_mapping (dict): Block device details
2103 base_disk_index (int): Disk index
2104 disk (dict): Disk details
2105 created_items (dict): All created items belongs to VM
2108 raise vimconn
.VimConnException("Volume is empty.")
2110 if not hasattr(volume
, "id"):
2111 raise vimconn
.VimConnException(
2112 "Created volume is not valid, does not have id attribute."
2115 volume_txt
= "volume:" + str(volume
.id)
2116 if disk
.get("keep"):
2117 volume_txt
+= ":keep"
2118 created_items
[volume_txt
] = True
2119 block_device_mapping
["vd" + chr(base_disk_index
)] = volume
.id
2121 def _prepare_non_root_persistent_volumes(
2126 block_device_mapping
: dict,
2127 base_disk_index
: int,
2128 existing_vim_volumes
: list,
2129 created_items
: dict,
2131 """Prepare persistent volumes for new VM instance.
2134 name (str): Name of VM instance
2135 disk (dict): Disk details
2136 vm_av_zone (list): List of availability zones
2137 block_device_mapping (dict): Block device details
2138 base_disk_index (int): Disk index
2139 existing_vim_volumes (list): Existing disk details
2140 created_items (dict): All created items belongs to VM
2142 # Non-root persistent volumes
2143 # Disk may include only vim_volume_id or only vim_id."
2144 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
2146 if disk
.get(key_id
):
2148 # Use existing persistent volume
2149 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
2150 existing_vim_volumes
.append({"id": disk
[key_id
]})
2153 # Create persistent volume
2154 volume
= self
.cinder
.volumes
.create(
2156 name
=name
+ "vd" + chr(base_disk_index
),
2157 # Make sure volume is in the same AZ as the VM to be attached to
2158 availability_zone
=vm_av_zone
,
2160 self
.update_block_device_mapping(
2162 block_device_mapping
=block_device_mapping
,
2163 base_disk_index
=base_disk_index
,
2165 created_items
=created_items
,
2168 def _wait_for_created_volumes_availability(
2169 self
, elapsed_time
: int, created_items
: dict
2171 """Wait till created volumes become available.
2174 elapsed_time (int): Passed time while waiting
2175 created_items (dict): All created items belongs to VM
2178 elapsed_time (int): Time spent while waiting
2182 while elapsed_time
< volume_timeout
:
2183 for created_item
in created_items
:
2185 created_item
.split(":")[0],
2186 created_item
.split(":")[1],
2189 if self
.cinder
.volumes
.get(volume_id
).status
!= "available":
2192 # All ready: break from while
2200 def _wait_for_existing_volumes_availability(
2201 self
, elapsed_time
: int, existing_vim_volumes
: list
2203 """Wait till existing volumes become available.
2206 elapsed_time (int): Passed time while waiting
2207 existing_vim_volumes (list): Existing volume details
2210 elapsed_time (int): Time spent while waiting
2214 while elapsed_time
< volume_timeout
:
2215 for volume
in existing_vim_volumes
:
2216 if self
.cinder
.volumes
.get(volume
["id"]).status
!= "available":
2218 else: # all ready: break from while
2226 def _prepare_disk_for_vminstance(
2229 existing_vim_volumes
: list,
2230 created_items
: dict,
2232 block_device_mapping
: dict,
2233 disk_list
: list = None,
2235 """Prepare all volumes for new VM instance.
2238 name (str): Name of Instance
2239 existing_vim_volumes (list): List of existing volumes
2240 created_items (dict): All created items belongs to VM
2241 vm_av_zone (list): VM availability zone
2242 block_device_mapping (dict): Block devices to be attached to VM
2243 disk_list (list): List of disks
2246 # Create additional volumes in case these are present in disk_list
2247 base_disk_index
= ord("b")
2248 boot_volume_id
= None
2251 for disk
in disk_list
:
2252 if "image_id" in disk
:
2253 # Root persistent volume
2254 base_disk_index
= ord("a")
2255 boot_volume_id
= self
._prepare
_persistent
_root
_volumes
(
2257 vm_av_zone
=vm_av_zone
,
2259 base_disk_index
=base_disk_index
,
2260 block_device_mapping
=block_device_mapping
,
2261 existing_vim_volumes
=existing_vim_volumes
,
2262 created_items
=created_items
,
2265 # Non-root persistent volume
2266 self
._prepare
_non
_root
_persistent
_volumes
(
2269 vm_av_zone
=vm_av_zone
,
2270 block_device_mapping
=block_device_mapping
,
2271 base_disk_index
=base_disk_index
,
2272 existing_vim_volumes
=existing_vim_volumes
,
2273 created_items
=created_items
,
2275 base_disk_index
+= 1
2277 # Wait until created volumes are with status available
2278 elapsed_time
= self
._wait
_for
_created
_volumes
_availability
(
2279 elapsed_time
, created_items
2281 # Wait until existing volumes in vim are with status available
2282 elapsed_time
= self
._wait
_for
_existing
_volumes
_availability
(
2283 elapsed_time
, existing_vim_volumes
2285 # If we exceeded the timeout rollback
2286 if elapsed_time
>= volume_timeout
:
2287 raise vimconn
.VimConnException(
2288 "Timeout creating volumes for instance " + name
,
2289 http_code
=vimconn
.HTTP_Request_Timeout
,
2292 self
.cinder
.volumes
.set_bootable(boot_volume_id
, True)
2294 def _find_the_external_network_for_floating_ip(self
):
2295 """Get the external network ip in order to create floating IP.
2298 pool_id (str): External network pool ID
2302 # Find the external network
2303 external_nets
= list()
2305 for net
in self
.neutron
.list_networks()["networks"]:
2306 if net
["router:external"]:
2307 external_nets
.append(net
)
2309 if len(external_nets
) == 0:
2310 raise vimconn
.VimConnException(
2311 "Cannot create floating_ip automatically since "
2312 "no external network is present",
2313 http_code
=vimconn
.HTTP_Conflict
,
2316 if len(external_nets
) > 1:
2317 raise vimconn
.VimConnException(
2318 "Cannot create floating_ip automatically since "
2319 "multiple external networks are present",
2320 http_code
=vimconn
.HTTP_Conflict
,
2324 return external_nets
[0].get("id")
2326 def _neutron_create_float_ip(self
, param
: dict, created_items
: dict) -> None:
2327 """Trigger neutron to create a new floating IP using external network ID.
2330 param (dict): Input parameters to create a floating IP
2331 created_items (dict): All created items belongs to new VM instance
2338 self
.logger
.debug("Creating floating IP")
2339 new_floating_ip
= self
.neutron
.create_floatingip(param
)
2340 free_floating_ip
= new_floating_ip
["floatingip"]["id"]
2341 created_items
["floating_ip:" + str(free_floating_ip
)] = True
2343 except Exception as e
:
2344 raise vimconn
.VimConnException(
2345 type(e
).__name
__ + ": Cannot create new floating_ip " + str(e
),
2346 http_code
=vimconn
.HTTP_Conflict
,
2349 def _create_floating_ip(
2350 self
, floating_network
: dict, server
: object, created_items
: dict
2352 """Get the available Pool ID and create a new floating IP.
2355 floating_network (dict): Dict including external network ID
2356 server (object): Server object
2357 created_items (dict): All created items belongs to new VM instance
2361 # Pool_id is available
2363 isinstance(floating_network
["floating_ip"], str)
2364 and floating_network
["floating_ip"].lower() != "true"
2366 pool_id
= floating_network
["floating_ip"]
2370 pool_id
= self
._find
_the
_external
_network
_for
_floating
_ip
()
2374 "floating_network_id": pool_id
,
2375 "tenant_id": server
.tenant_id
,
2379 self
._neutron
_create
_float
_ip
(param
, created_items
)
2381 def _find_floating_ip(
2385 floating_network
: dict,
2387 """Find the available free floating IPs if there are.
2390 server (object): Server object
2391 floating_ips (list): List of floating IPs
2392 floating_network (dict): Details of floating network such as ID
2395 free_floating_ip (str): Free floating ip address
2398 for fip
in floating_ips
:
2399 if fip
.get("port_id") or fip
.get("tenant_id") != server
.tenant_id
:
2402 if isinstance(floating_network
["floating_ip"], str):
2403 if fip
.get("floating_network_id") != floating_network
["floating_ip"]:
2408 def _assign_floating_ip(
2409 self
, free_floating_ip
: str, floating_network
: dict
2411 """Assign the free floating ip address to port.
2414 free_floating_ip (str): Floating IP to be assigned
2415 floating_network (dict): ID of floating network
2418 fip (dict) (dict): Floating ip details
2421 # The vim_id key contains the neutron.port_id
2422 self
.neutron
.update_floatingip(
2424 {"floatingip": {"port_id": floating_network
["vim_id"]}},
2426 # For race condition ensure not re-assigned to other VM after 5 seconds
2429 return self
.neutron
.show_floatingip(free_floating_ip
)
2431 def _get_free_floating_ip(
2432 self
, server
: object, floating_network
: dict
2434 """Get the free floating IP address.
2437 server (object): Server Object
2438 floating_network (dict): Floating network details
2441 free_floating_ip (str): Free floating ip addr
2445 floating_ips
= self
.neutron
.list_floatingips().get("floatingips", ())
2448 random
.shuffle(floating_ips
)
2450 return self
._find
_floating
_ip
(server
, floating_ips
, floating_network
)
2452 def _prepare_external_network_for_vminstance(
2454 external_network
: list,
2456 created_items
: dict,
2457 vm_start_time
: float,
2459 """Assign floating IP address for VM instance.
2462 external_network (list): ID of External network
2463 server (object): Server Object
2464 created_items (dict): All created items belongs to new VM instance
2465 vm_start_time (float): Time as a floating point number expressed in seconds since the epoch, in UTC
2471 for floating_network
in external_network
:
2474 floating_ip_retries
= 3
2475 # In case of RO in HA there can be conflicts, two RO trying to assign same floating IP, so retry
2479 free_floating_ip
= self
._get
_free
_floating
_ip
(
2480 server
, floating_network
2483 if not free_floating_ip
:
2484 self
._create
_floating
_ip
(
2485 floating_network
, server
, created_items
2489 # For race condition ensure not already assigned
2490 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2492 if fip
["floatingip"].get("port_id"):
2495 # Assign floating ip
2496 fip
= self
._assign
_floating
_ip
(
2497 free_floating_ip
, floating_network
2500 if fip
["floatingip"]["port_id"] != floating_network
["vim_id"]:
2501 self
.logger
.warning(
2502 "floating_ip {} re-assigned to other port".format(
2509 "Assigned floating_ip {} to VM {}".format(
2510 free_floating_ip
, server
.id
2516 except Exception as e
:
2517 # Openstack need some time after VM creation to assign an IP. So retry if fails
2518 vm_status
= self
.nova
.servers
.get(server
.id).status
2520 if vm_status
not in ("ACTIVE", "ERROR"):
2521 if time
.time() - vm_start_time
< server_timeout
:
2524 elif floating_ip_retries
> 0:
2525 floating_ip_retries
-= 1
2528 raise vimconn
.VimConnException(
2529 "Cannot create floating_ip: {} {}".format(
2532 http_code
=vimconn
.HTTP_Conflict
,
2535 except Exception as e
:
2536 if not floating_network
["exit_on_floating_ip_error"]:
2537 self
.logger
.error("Cannot create floating_ip. %s", str(e
))
2542 def _update_port_security_for_vminstance(
2544 no_secured_ports
: list,
2547 """Updates the port security according to no_secured_ports list.
2550 no_secured_ports (list): List of ports that security will be disabled
2551 server (object): Server Object
2557 # Wait until the VM is active and then disable the port-security
2558 if no_secured_ports
:
2559 self
.__wait
_for
_vm
(server
.id, "ACTIVE")
2561 for port
in no_secured_ports
:
2563 "port": {"port_security_enabled": False, "security_groups": None}
2566 if port
[1] == "allow-address-pairs":
2568 "port": {"allowed_address_pairs": [{"ip_address": "0.0.0.0/0"}]}
2572 self
.neutron
.update_port(port
[0], port_update
)
2576 raise vimconn
.VimConnException(
2577 "It was not possible to disable port security for port {}".format(
2589 affinity_group_list
: list,
2593 availability_zone_index
=None,
2594 availability_zone_list
=None,
2596 """Adds a VM instance to VIM.
2599 name (str): name of VM
2600 description (str): description
2601 start (bool): indicates if VM must start or boot in pause mode. Ignored
2602 image_id (str) image uuid
2603 flavor_id (str) flavor uuid
2604 affinity_group_list (list): list of affinity groups, each one is a dictionary.Ignore if empty.
2605 net_list (list): list of interfaces, each one is a dictionary with:
2606 name: name of network
2607 net_id: network uuid to connect
2608 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
2609 model: interface model, ignored #TODO
2610 mac_address: used for SR-IOV ifaces #TODO for other types
2611 use: 'data', 'bridge', 'mgmt'
2612 type: 'virtual', 'PCI-PASSTHROUGH'('PF'), 'SR-IOV'('VF'), 'VFnotShared'
2613 vim_id: filled/added by this function
2614 floating_ip: True/False (or it can be None)
2615 port_security: True/False
2616 cloud_config (dict): (optional) dictionary with:
2617 key-pairs: (optional) list of strings with the public key to be inserted to the default user
2618 users: (optional) list of users to be inserted, each item is a dict with:
2619 name: (mandatory) user name,
2620 key-pairs: (optional) list of strings with the public key to be inserted to the user
2621 user-data: (optional) string is a text script to be passed directly to cloud-init
2622 config-files: (optional). List of files to be transferred. Each item is a dict with:
2623 dest: (mandatory) string with the destination absolute path
2624 encoding: (optional, by default text). Can be one of:
2625 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
2626 content : (mandatory) string with the content of the file
2627 permissions: (optional) string with file permissions, typically octal notation '0644'
2628 owner: (optional) file owner, string with the format 'owner:group'
2629 boot-data-drive: boolean to indicate if user-data must be passed using a boot drive (hard disk)
2630 disk_list: (optional) list with additional disks to the VM. Each item is a dict with:
2631 image_id: (optional). VIM id of an existing image. If not provided an empty disk must be mounted
2632 size: (mandatory) string with the size of the disk in GB
2633 vim_id: (optional) should use this existing volume id
2634 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
2635 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
2636 availability_zone_index is None
2637 #TODO ip, security groups
2640 A tuple with the instance identifier and created_items or raises an exception on error
2641 created_items can be None or a dictionary where this method can include key-values that will be passed to
2642 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
2643 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
2648 "new_vminstance input: image='%s' flavor='%s' nics='%s'",
2658 # list of external networks to be connected to instance, later on used to create floating_ip
2659 external_network
= []
2660 # List of ports with port-security disabled
2661 no_secured_ports
= []
2662 block_device_mapping
= {}
2663 existing_vim_volumes
= []
2664 server_group_id
= None
2665 scheduller_hints
= {}
2667 # Check the Openstack Connection
2668 self
._reload
_connection
()
2670 # Prepare network list
2671 self
._prepare
_network
_for
_vminstance
(
2674 created_items
=created_items
,
2675 net_list_vim
=net_list_vim
,
2676 external_network
=external_network
,
2677 no_secured_ports
=no_secured_ports
,
2681 config_drive
, userdata
= self
._create
_user
_data
(cloud_config
)
2683 # Get availability Zone
2684 vm_av_zone
= self
._get
_vm
_availability
_zone
(
2685 availability_zone_index
, availability_zone_list
2690 self
._prepare
_disk
_for
_vminstance
(
2692 existing_vim_volumes
=existing_vim_volumes
,
2693 created_items
=created_items
,
2694 vm_av_zone
=vm_av_zone
,
2695 block_device_mapping
=block_device_mapping
,
2696 disk_list
=disk_list
,
2699 if affinity_group_list
:
2700 # Only first id on the list will be used. Openstack restriction
2701 server_group_id
= affinity_group_list
[0]["affinity_group_id"]
2702 scheduller_hints
["group"] = server_group_id
2705 "nova.servers.create({}, {}, {}, nics={}, security_groups={}, "
2706 "availability_zone={}, key_name={}, userdata={}, config_drive={}, "
2707 "block_device_mapping={}, server_group={})".format(
2712 self
.config
.get("security_groups"),
2714 self
.config
.get("keypair"),
2717 block_device_mapping
,
2723 server
= self
.nova
.servers
.create(
2728 security_groups
=self
.config
.get("security_groups"),
2729 # TODO remove security_groups in future versions. Already at neutron port
2730 availability_zone
=vm_av_zone
,
2731 key_name
=self
.config
.get("keypair"),
2733 config_drive
=config_drive
,
2734 block_device_mapping
=block_device_mapping
,
2735 scheduler_hints
=scheduller_hints
,
2738 vm_start_time
= time
.time()
2740 self
._update
_port
_security
_for
_vminstance
(no_secured_ports
, server
)
2742 self
._prepare
_external
_network
_for
_vminstance
(
2743 external_network
=external_network
,
2745 created_items
=created_items
,
2746 vm_start_time
=vm_start_time
,
2749 return server
.id, created_items
2751 except Exception as e
:
2754 server_id
= server
.id
2757 created_items
= self
.remove_keep_tag_from_persistent_volumes(
2761 self
.delete_vminstance(server_id
, created_items
)
2763 except Exception as e2
:
2764 self
.logger
.error("new_vminstance rollback fail {}".format(e2
))
2766 self
._format
_exception
(e
)
2769 def remove_keep_tag_from_persistent_volumes(created_items
: Dict
) -> Dict
:
2770 """Removes the keep flag from persistent volumes. So, those volumes could be removed.
2773 created_items (dict): All created items belongs to VM
2776 updated_created_items (dict): Dict which does not include keep flag for volumes.
2780 key
.replace(":keep", ""): value
for (key
, value
) in created_items
.items()
2783 def get_vminstance(self
, vm_id
):
2784 """Returns the VM instance information from VIM"""
2785 # self.logger.debug("Getting VM from VIM")
2787 self
._reload
_connection
()
2788 server
= self
.nova
.servers
.find(id=vm_id
)
2789 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
2791 return server
.to_dict()
2793 ksExceptions
.ClientException
,
2794 nvExceptions
.ClientException
,
2795 nvExceptions
.NotFound
,
2798 self
._format
_exception
(e
)
2800 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
2802 Get a console for the virtual machine
2804 vm_id: uuid of the VM
2805 console_type, can be:
2806 "novnc" (by default), "xvpvnc" for VNC types,
2807 "rdp-html5" for RDP types, "spice-html5" for SPICE types
2808 Returns dict with the console parameters:
2809 protocol: ssh, ftp, http, https, ...
2810 server: usually ip address
2811 port: the http, ssh, ... port
2812 suffix: extra text, e.g. the http path and query string
2814 self
.logger
.debug("Getting VM CONSOLE from VIM")
2817 self
._reload
_connection
()
2818 server
= self
.nova
.servers
.find(id=vm_id
)
2820 if console_type
is None or console_type
== "novnc":
2821 console_dict
= server
.get_vnc_console("novnc")
2822 elif console_type
== "xvpvnc":
2823 console_dict
= server
.get_vnc_console(console_type
)
2824 elif console_type
== "rdp-html5":
2825 console_dict
= server
.get_rdp_console(console_type
)
2826 elif console_type
== "spice-html5":
2827 console_dict
= server
.get_spice_console(console_type
)
2829 raise vimconn
.VimConnException(
2830 "console type '{}' not allowed".format(console_type
),
2831 http_code
=vimconn
.HTTP_Bad_Request
,
2834 console_dict1
= console_dict
.get("console")
2837 console_url
= console_dict1
.get("url")
2841 protocol_index
= console_url
.find("//")
2843 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2846 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2851 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2853 -vimconn
.HTTP_Internal_Server_Error
,
2854 "Unexpected response from VIM",
2858 "protocol": console_url
[0:protocol_index
],
2859 "server": console_url
[protocol_index
+ 2 : port_index
],
2860 "port": console_url
[port_index
:suffix_index
],
2861 "suffix": console_url
[suffix_index
+ 1 :],
2866 raise vimconn
.VimConnUnexpectedResponse("Unexpected response from VIM")
2868 nvExceptions
.NotFound
,
2869 ksExceptions
.ClientException
,
2870 nvExceptions
.ClientException
,
2871 nvExceptions
.BadRequest
,
2874 self
._format
_exception
(e
)
2876 def _delete_ports_by_id_wth_neutron(self
, k_id
: str) -> None:
2877 """Neutron delete ports by id.
2879 k_id (str): Port id in the VIM
2883 port_dict
= self
.neutron
.list_ports()
2884 existing_ports
= [port
["id"] for port
in port_dict
["ports"] if port_dict
]
2886 if k_id
in existing_ports
:
2887 self
.neutron
.delete_port(k_id
)
2889 except Exception as e
:
2891 self
.logger
.error("Error deleting port: {}: {}".format(type(e
).__name
__, e
))
2893 def _delete_volumes_by_id_wth_cinder(
2894 self
, k
: str, k_id
: str, volumes_to_hold
: list, created_items
: dict
2896 """Cinder delete volume by id.
2898 k (str): Full item name in created_items
2899 k_id (str): ID of floating ip in VIM
2900 volumes_to_hold (list): Volumes not to delete
2901 created_items (dict): All created items belongs to VM
2904 if k_id
in volumes_to_hold
:
2907 if self
.cinder
.volumes
.get(k_id
).status
!= "available":
2911 self
.cinder
.volumes
.delete(k_id
)
2912 created_items
[k
] = None
2914 except Exception as e
:
2916 "Error deleting volume: {}: {}".format(type(e
).__name
__, e
)
2919 def _delete_floating_ip_by_id(self
, k
: str, k_id
: str, created_items
: dict) -> None:
2920 """Neutron delete floating ip by id.
2922 k (str): Full item name in created_items
2923 k_id (str): ID of floating ip in VIM
2924 created_items (dict): All created items belongs to VM
2927 self
.neutron
.delete_floatingip(k_id
)
2928 created_items
[k
] = None
2930 except Exception as e
:
2932 "Error deleting floating ip: {}: {}".format(type(e
).__name
__, e
)
2936 def _get_item_name_id(k
: str) -> Tuple
[str, str]:
2937 k_item
, _
, k_id
= k
.partition(":")
2940 def _delete_vm_ports_attached_to_network(self
, created_items
: dict) -> None:
2941 """Delete VM ports attached to the networks before deleting virtual machine.
2943 created_items (dict): All created items belongs to VM
2946 for k
, v
in created_items
.items():
2947 if not v
: # skip already deleted
2951 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2952 if k_item
== "port":
2953 self
._delete
_ports
_by
_id
_wth
_neutron
(k_id
)
2955 except Exception as e
:
2957 "Error deleting port: {}: {}".format(type(e
).__name
__, e
)
2960 def _delete_created_items(
2961 self
, created_items
: dict, volumes_to_hold
: list, keep_waiting
: bool
2963 """Delete Volumes and floating ip if they exist in created_items."""
2964 for k
, v
in created_items
.items():
2965 if not v
: # skip already deleted
2969 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2971 if k_item
== "volume":
2973 unavailable_vol
= self
._delete
_volumes
_by
_id
_wth
_cinder
(
2974 k
, k_id
, volumes_to_hold
, created_items
2980 elif k_item
== "floating_ip":
2982 self
._delete
_floating
_ip
_by
_id
(k
, k_id
, created_items
)
2984 except Exception as e
:
2985 self
.logger
.error("Error deleting {}: {}".format(k
, e
))
2990 def _extract_items_wth_keep_flag_from_created_items(created_items
: dict) -> dict:
2991 """Remove the volumes which has key flag from created_items
2994 created_items (dict): All created items belongs to VM
2997 created_items (dict): Persistent volumes eliminated created_items
3001 for (key
, value
) in created_items
.items()
3002 if len(key
.split(":")) == 2
3005 def delete_vminstance(
3006 self
, vm_id
: str, created_items
: dict = None, volumes_to_hold
: list = None
3008 """Removes a VM instance from VIM. Returns the old identifier.
3010 vm_id (str): Identifier of VM instance
3011 created_items (dict): All created items belongs to VM
3012 volumes_to_hold (list): Volumes_to_hold
3014 if created_items
is None:
3016 if volumes_to_hold
is None:
3017 volumes_to_hold
= []
3020 created_items
= self
._extract
_items
_wth
_keep
_flag
_from
_created
_items
(
3024 self
._reload
_connection
()
3026 # Delete VM ports attached to the networks before the virtual machine
3028 self
._delete
_vm
_ports
_attached
_to
_network
(created_items
)
3031 self
.nova
.servers
.delete(vm_id
)
3033 # Although having detached, volumes should have in active status before deleting.
3034 # We ensure in this loop
3038 while keep_waiting
and elapsed_time
< volume_timeout
:
3039 keep_waiting
= False
3041 # Delete volumes and floating IP.
3042 keep_waiting
= self
._delete
_created
_items
(
3043 created_items
, volumes_to_hold
, keep_waiting
3051 nvExceptions
.NotFound
,
3052 ksExceptions
.ClientException
,
3053 nvExceptions
.ClientException
,
3056 self
._format
_exception
(e
)
3058 def refresh_vms_status(self
, vm_list
):
3059 """Get the status of the virtual machines and their interfaces/ports
3060 Params: the list of VM identifiers
3061 Returns a dictionary with:
3062 vm_id: #VIM id of this Virtual Machine
3063 status: #Mandatory. Text with one of:
3064 # DELETED (not found at vim)
3065 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3066 # OTHER (Vim reported other status not understood)
3067 # ERROR (VIM indicates an ERROR status)
3068 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
3069 # CREATING (on building process), ERROR
3070 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
3072 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3073 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3075 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3076 mac_address: #Text format XX:XX:XX:XX:XX:XX
3077 vim_net_id: #network id where this interface is connected
3078 vim_interface_id: #interface/port VIM id
3079 ip_address: #null, or text with IPv4, IPv6 address
3080 compute_node: #identification of compute node where PF,VF interface is allocated
3081 pci: #PCI address of the NIC that hosts the PF,VF
3082 vlan: #physical VLAN used for VF
3086 "refresh_vms status: Getting tenant VM instance information from VIM"
3089 for vm_id
in vm_list
:
3093 vm_vim
= self
.get_vminstance(vm_id
)
3095 if vm_vim
["status"] in vmStatus2manoFormat
:
3096 vm
["status"] = vmStatus2manoFormat
[vm_vim
["status"]]
3098 vm
["status"] = "OTHER"
3099 vm
["error_msg"] = "VIM status reported " + vm_vim
["status"]
3101 vm_vim
.pop("OS-EXT-SRV-ATTR:user_data", None)
3102 vm_vim
.pop("user_data", None)
3103 vm
["vim_info"] = self
.serialize(vm_vim
)
3105 vm
["interfaces"] = []
3106 if vm_vim
.get("fault"):
3107 vm
["error_msg"] = str(vm_vim
["fault"])
3111 self
._reload
_connection
()
3112 port_dict
= self
.neutron
.list_ports(device_id
=vm_id
)
3114 for port
in port_dict
["ports"]:
3116 interface
["vim_info"] = self
.serialize(port
)
3117 interface
["mac_address"] = port
.get("mac_address")
3118 interface
["vim_net_id"] = port
["network_id"]
3119 interface
["vim_interface_id"] = port
["id"]
3120 # check if OS-EXT-SRV-ATTR:host is there,
3121 # in case of non-admin credentials, it will be missing
3123 if vm_vim
.get("OS-EXT-SRV-ATTR:host"):
3124 interface
["compute_node"] = vm_vim
["OS-EXT-SRV-ATTR:host"]
3126 interface
["pci"] = None
3128 # check if binding:profile is there,
3129 # in case of non-admin credentials, it will be missing
3130 if port
.get("binding:profile"):
3131 if port
["binding:profile"].get("pci_slot"):
3132 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting
3134 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
3135 # CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2) assuming there are 2 ports per nic
3136 pci
= port
["binding:profile"]["pci_slot"]
3137 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
3138 interface
["pci"] = pci
3140 interface
["vlan"] = None
3142 if port
.get("binding:vif_details"):
3143 interface
["vlan"] = port
["binding:vif_details"].get("vlan")
3145 # Get vlan from network in case not present in port for those old openstacks and cases where
3146 # it is needed vlan at PT
3147 if not interface
["vlan"]:
3148 # if network is of type vlan and port is of type direct (sr-iov) then set vlan id
3149 network
= self
.neutron
.show_network(port
["network_id"])
3152 network
["network"].get("provider:network_type")
3155 # and port.get("binding:vnic_type") in ("direct", "direct-physical"):
3156 interface
["vlan"] = network
["network"].get(
3157 "provider:segmentation_id"
3161 # look for floating ip address
3163 floating_ip_dict
= self
.neutron
.list_floatingips(
3167 if floating_ip_dict
.get("floatingips"):
3169 floating_ip_dict
["floatingips"][0].get(
3170 "floating_ip_address"
3176 for subnet
in port
["fixed_ips"]:
3177 ips
.append(subnet
["ip_address"])
3179 interface
["ip_address"] = ";".join(ips
)
3180 vm
["interfaces"].append(interface
)
3181 except Exception as e
:
3183 "Error getting vm interface information {}: {}".format(
3188 except vimconn
.VimConnNotFoundException
as e
:
3189 self
.logger
.error("Exception getting vm status: %s", str(e
))
3190 vm
["status"] = "DELETED"
3191 vm
["error_msg"] = str(e
)
3192 except vimconn
.VimConnException
as e
:
3193 self
.logger
.error("Exception getting vm status: %s", str(e
))
3194 vm
["status"] = "VIM_ERROR"
3195 vm
["error_msg"] = str(e
)
3201 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
3202 """Send and action over a VM instance from VIM
3203 Returns None or the console dict if the action was successfully sent to the VIM"""
3204 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
3207 self
._reload
_connection
()
3208 server
= self
.nova
.servers
.find(id=vm_id
)
3210 if "start" in action_dict
:
3211 if action_dict
["start"] == "rebuild":
3214 if server
.status
== "PAUSED":
3216 elif server
.status
== "SUSPENDED":
3218 elif server
.status
== "SHUTOFF":
3222 "ERROR : Instance is not in SHUTOFF/PAUSE/SUSPEND state"
3224 raise vimconn
.VimConnException(
3225 "Cannot 'start' instance while it is in active state",
3226 http_code
=vimconn
.HTTP_Bad_Request
,
3229 elif "pause" in action_dict
:
3231 elif "resume" in action_dict
:
3233 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
3234 self
.logger
.debug("server status %s", server
.status
)
3235 if server
.status
== "ACTIVE":
3238 self
.logger
.debug("ERROR: VM is not in Active state")
3239 raise vimconn
.VimConnException(
3240 "VM is not in active state, stop operation is not allowed",
3241 http_code
=vimconn
.HTTP_Bad_Request
,
3243 elif "forceOff" in action_dict
:
3244 server
.stop() # TODO
3245 elif "terminate" in action_dict
:
3247 elif "createImage" in action_dict
:
3248 server
.create_image()
3249 # "path":path_schema,
3250 # "description":description_schema,
3251 # "name":name_schema,
3252 # "metadata":metadata_schema,
3253 # "imageRef": id_schema,
3254 # "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
3255 elif "rebuild" in action_dict
:
3256 server
.rebuild(server
.image
["id"])
3257 elif "reboot" in action_dict
:
3258 server
.reboot() # reboot_type="SOFT"
3259 elif "console" in action_dict
:
3260 console_type
= action_dict
["console"]
3262 if console_type
is None or console_type
== "novnc":
3263 console_dict
= server
.get_vnc_console("novnc")
3264 elif console_type
== "xvpvnc":
3265 console_dict
= server
.get_vnc_console(console_type
)
3266 elif console_type
== "rdp-html5":
3267 console_dict
= server
.get_rdp_console(console_type
)
3268 elif console_type
== "spice-html5":
3269 console_dict
= server
.get_spice_console(console_type
)
3271 raise vimconn
.VimConnException(
3272 "console type '{}' not allowed".format(console_type
),
3273 http_code
=vimconn
.HTTP_Bad_Request
,
3277 console_url
= console_dict
["console"]["url"]
3279 protocol_index
= console_url
.find("//")
3281 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
3284 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
3289 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
3290 raise vimconn
.VimConnException(
3291 "Unexpected response from VIM " + str(console_dict
)
3295 "protocol": console_url
[0:protocol_index
],
3296 "server": console_url
[protocol_index
+ 2 : port_index
],
3297 "port": int(console_url
[port_index
+ 1 : suffix_index
]),
3298 "suffix": console_url
[suffix_index
+ 1 :],
3301 return console_dict2
3303 raise vimconn
.VimConnException(
3304 "Unexpected response from VIM " + str(console_dict
)
3309 ksExceptions
.ClientException
,
3310 nvExceptions
.ClientException
,
3311 nvExceptions
.NotFound
,
3314 self
._format
_exception
(e
)
3315 # TODO insert exception vimconn.HTTP_Unauthorized
3317 # ###### VIO Specific Changes #########
3318 def _generate_vlanID(self
):
3320 Method to get unused vlanID
3328 networks
= self
.get_network_list()
3330 for net
in networks
:
3331 if net
.get("provider:segmentation_id"):
3332 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3334 used_vlanIDs
= set(usedVlanIDs
)
3336 # find unused VLAN ID
3337 for vlanID_range
in self
.config
.get("dataplane_net_vlan_range"):
3339 start_vlanid
, end_vlanid
= map(
3340 int, vlanID_range
.replace(" ", "").split("-")
3343 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3344 if vlanID
not in used_vlanIDs
:
3346 except Exception as exp
:
3347 raise vimconn
.VimConnException(
3348 "Exception {} occurred while generating VLAN ID.".format(exp
)
3351 raise vimconn
.VimConnConflictException(
3352 "Unable to create the SRIOV VLAN network. All given Vlan IDs {} are in use.".format(
3353 self
.config
.get("dataplane_net_vlan_range")
3357 def _generate_multisegment_vlanID(self
):
3359 Method to get unused vlanID
3367 networks
= self
.get_network_list()
3368 for net
in networks
:
3369 if net
.get("provider:network_type") == "vlan" and net
.get(
3370 "provider:segmentation_id"
3372 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3373 elif net
.get("segments"):
3374 for segment
in net
.get("segments"):
3375 if segment
.get("provider:network_type") == "vlan" and segment
.get(
3376 "provider:segmentation_id"
3378 usedVlanIDs
.append(segment
.get("provider:segmentation_id"))
3380 used_vlanIDs
= set(usedVlanIDs
)
3382 # find unused VLAN ID
3383 for vlanID_range
in self
.config
.get("multisegment_vlan_range"):
3385 start_vlanid
, end_vlanid
= map(
3386 int, vlanID_range
.replace(" ", "").split("-")
3389 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3390 if vlanID
not in used_vlanIDs
:
3392 except Exception as exp
:
3393 raise vimconn
.VimConnException(
3394 "Exception {} occurred while generating VLAN ID.".format(exp
)
3397 raise vimconn
.VimConnConflictException(
3398 "Unable to create the VLAN segment. All VLAN IDs {} are in use.".format(
3399 self
.config
.get("multisegment_vlan_range")
3403 def _validate_vlan_ranges(self
, input_vlan_range
, text_vlan_range
):
3405 Method to validate user given vlanID ranges
3409 for vlanID_range
in input_vlan_range
:
3410 vlan_range
= vlanID_range
.replace(" ", "")
3412 vlanID_pattern
= r
"(\d)*-(\d)*$"
3413 match_obj
= re
.match(vlanID_pattern
, vlan_range
)
3415 raise vimconn
.VimConnConflictException(
3416 "Invalid VLAN range for {}: {}.You must provide "
3417 "'{}' in format [start_ID - end_ID].".format(
3418 text_vlan_range
, vlanID_range
, text_vlan_range
3422 start_vlanid
, end_vlanid
= map(int, vlan_range
.split("-"))
3423 if start_vlanid
<= 0:
3424 raise vimconn
.VimConnConflictException(
3425 "Invalid VLAN range for {}: {}. Start ID can not be zero. For VLAN "
3426 "networks valid IDs are 1 to 4094 ".format(
3427 text_vlan_range
, vlanID_range
3431 if end_vlanid
> 4094:
3432 raise vimconn
.VimConnConflictException(
3433 "Invalid VLAN range for {}: {}. End VLAN ID can not be "
3434 "greater than 4094. For VLAN networks valid IDs are 1 to 4094 ".format(
3435 text_vlan_range
, vlanID_range
3439 if start_vlanid
> end_vlanid
:
3440 raise vimconn
.VimConnConflictException(
3441 "Invalid VLAN range for {}: {}. You must provide '{}'"
3442 " in format start_ID - end_ID and start_ID < end_ID ".format(
3443 text_vlan_range
, vlanID_range
, text_vlan_range
3447 def delete_user(self
, user_id
):
3448 """Delete a user from openstack VIM
3449 Returns the user identifier"""
3451 print("osconnector: Deleting a user from VIM")
3454 self
._reload
_connection
()
3455 self
.keystone
.users
.delete(user_id
)
3458 except ksExceptions
.ConnectionError
as e
:
3459 error_value
= -vimconn
.HTTP_Bad_Request
3463 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3465 except ksExceptions
.NotFound
as e
:
3466 error_value
= -vimconn
.HTTP_Not_Found
3470 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3472 except ksExceptions
.ClientException
as e
: # TODO remove
3473 error_value
= -vimconn
.HTTP_Bad_Request
3477 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3480 # TODO insert exception vimconn.HTTP_Unauthorized
3481 # if reaching here is because an exception
3482 self
.logger
.debug("delete_tenant " + error_text
)
3484 return error_value
, error_text
3486 def get_hosts_info(self
):
3487 """Get the information of deployed hosts
3488 Returns the hosts content"""
3490 print("osconnector: Getting Host info from VIM")
3494 self
._reload
_connection
()
3495 hypervisors
= self
.nova
.hypervisors
.list()
3497 for hype
in hypervisors
:
3498 h_list
.append(hype
.to_dict())
3500 return 1, {"hosts": h_list
}
3501 except nvExceptions
.NotFound
as e
:
3502 error_value
= -vimconn
.HTTP_Not_Found
3503 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3504 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
3505 error_value
= -vimconn
.HTTP_Bad_Request
3509 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3512 # TODO insert exception vimconn.HTTP_Unauthorized
3513 # if reaching here is because an exception
3514 self
.logger
.debug("get_hosts_info " + error_text
)
3516 return error_value
, error_text
3518 def get_hosts(self
, vim_tenant
):
3519 """Get the hosts and deployed instances
3520 Returns the hosts content"""
3521 r
, hype_dict
= self
.get_hosts_info()
3526 hypervisors
= hype_dict
["hosts"]
3529 servers
= self
.nova
.servers
.list()
3530 for hype
in hypervisors
:
3531 for server
in servers
:
3533 server
.to_dict()["OS-EXT-SRV-ATTR:hypervisor_hostname"]
3534 == hype
["hypervisor_hostname"]
3537 hype
["vm"].append(server
.id)
3539 hype
["vm"] = [server
.id]
3542 except nvExceptions
.NotFound
as e
:
3543 error_value
= -vimconn
.HTTP_Not_Found
3544 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3545 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
3546 error_value
= -vimconn
.HTTP_Bad_Request
3550 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3553 # TODO insert exception vimconn.HTTP_Unauthorized
3554 # if reaching here is because an exception
3555 self
.logger
.debug("get_hosts " + error_text
)
3557 return error_value
, error_text
3559 def new_classification(self
, name
, ctype
, definition
):
3561 "Adding a new (Traffic) Classification to VIM, named %s", name
3566 self
._reload
_connection
()
3568 if ctype
not in supportedClassificationTypes
:
3569 raise vimconn
.VimConnNotSupportedException(
3570 "OpenStack VIM connector does not support provided "
3571 "Classification Type {}, supported ones are: {}".format(
3572 ctype
, supportedClassificationTypes
3576 if not self
._validate
_classification
(ctype
, definition
):
3577 raise vimconn
.VimConnException(
3578 "Incorrect Classification definition for the type specified."
3581 classification_dict
= definition
3582 classification_dict
["name"] = name
3583 new_class
= self
.neutron
.create_sfc_flow_classifier(
3584 {"flow_classifier": classification_dict
}
3587 return new_class
["flow_classifier"]["id"]
3589 neExceptions
.ConnectionFailed
,
3590 ksExceptions
.ClientException
,
3591 neExceptions
.NeutronException
,
3594 self
.logger
.error("Creation of Classification failed.")
3595 self
._format
_exception
(e
)
3597 def get_classification(self
, class_id
):
3598 self
.logger
.debug(" Getting Classification %s from VIM", class_id
)
3599 filter_dict
= {"id": class_id
}
3600 class_list
= self
.get_classification_list(filter_dict
)
3602 if len(class_list
) == 0:
3603 raise vimconn
.VimConnNotFoundException(
3604 "Classification '{}' not found".format(class_id
)
3606 elif len(class_list
) > 1:
3607 raise vimconn
.VimConnConflictException(
3608 "Found more than one Classification with this criteria"
3611 classification
= class_list
[0]
3613 return classification
3615 def get_classification_list(self
, filter_dict
={}):
3617 "Getting Classifications from VIM filter: '%s'", str(filter_dict
)
3621 filter_dict_os
= filter_dict
.copy()
3622 self
._reload
_connection
()
3624 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3625 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3627 classification_dict
= self
.neutron
.list_sfc_flow_classifiers(
3630 classification_list
= classification_dict
["flow_classifiers"]
3631 self
.__classification
_os
2mano
(classification_list
)
3633 return classification_list
3635 neExceptions
.ConnectionFailed
,
3636 ksExceptions
.ClientException
,
3637 neExceptions
.NeutronException
,
3640 self
._format
_exception
(e
)
3642 def delete_classification(self
, class_id
):
3643 self
.logger
.debug("Deleting Classification '%s' from VIM", class_id
)
3646 self
._reload
_connection
()
3647 self
.neutron
.delete_sfc_flow_classifier(class_id
)
3651 neExceptions
.ConnectionFailed
,
3652 neExceptions
.NeutronException
,
3653 ksExceptions
.ClientException
,
3654 neExceptions
.NeutronException
,
3657 self
._format
_exception
(e
)
3659 def new_sfi(self
, name
, ingress_ports
, egress_ports
, sfc_encap
=True):
3661 "Adding a new Service Function Instance to VIM, named '%s'", name
3666 self
._reload
_connection
()
3672 if len(ingress_ports
) != 1:
3673 raise vimconn
.VimConnNotSupportedException(
3674 "OpenStack VIM connector can only have 1 ingress port per SFI"
3677 if len(egress_ports
) != 1:
3678 raise vimconn
.VimConnNotSupportedException(
3679 "OpenStack VIM connector can only have 1 egress port per SFI"
3684 "ingress": ingress_ports
[0],
3685 "egress": egress_ports
[0],
3686 "service_function_parameters": {"correlation": correlation
},
3688 new_sfi
= self
.neutron
.create_sfc_port_pair({"port_pair": sfi_dict
})
3690 return new_sfi
["port_pair"]["id"]
3692 neExceptions
.ConnectionFailed
,
3693 ksExceptions
.ClientException
,
3694 neExceptions
.NeutronException
,
3699 self
.neutron
.delete_sfc_port_pair(new_sfi
["port_pair"]["id"])
3702 "Creation of Service Function Instance failed, with "
3703 "subsequent deletion failure as well."
3706 self
._format
_exception
(e
)
3708 def get_sfi(self
, sfi_id
):
3709 self
.logger
.debug("Getting Service Function Instance %s from VIM", sfi_id
)
3710 filter_dict
= {"id": sfi_id
}
3711 sfi_list
= self
.get_sfi_list(filter_dict
)
3713 if len(sfi_list
) == 0:
3714 raise vimconn
.VimConnNotFoundException(
3715 "Service Function Instance '{}' not found".format(sfi_id
)
3717 elif len(sfi_list
) > 1:
3718 raise vimconn
.VimConnConflictException(
3719 "Found more than one Service Function Instance with this criteria"
3726 def get_sfi_list(self
, filter_dict
={}):
3728 "Getting Service Function Instances from VIM filter: '%s'", str(filter_dict
)
3732 self
._reload
_connection
()
3733 filter_dict_os
= filter_dict
.copy()
3735 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3736 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3738 sfi_dict
= self
.neutron
.list_sfc_port_pairs(**filter_dict_os
)
3739 sfi_list
= sfi_dict
["port_pairs"]
3740 self
.__sfi
_os
2mano
(sfi_list
)
3744 neExceptions
.ConnectionFailed
,
3745 ksExceptions
.ClientException
,
3746 neExceptions
.NeutronException
,
3749 self
._format
_exception
(e
)
3751 def delete_sfi(self
, sfi_id
):
3752 self
.logger
.debug("Deleting Service Function Instance '%s' from VIM", sfi_id
)
3755 self
._reload
_connection
()
3756 self
.neutron
.delete_sfc_port_pair(sfi_id
)
3760 neExceptions
.ConnectionFailed
,
3761 neExceptions
.NeutronException
,
3762 ksExceptions
.ClientException
,
3763 neExceptions
.NeutronException
,
3766 self
._format
_exception
(e
)
3768 def new_sf(self
, name
, sfis
, sfc_encap
=True):
3769 self
.logger
.debug("Adding a new Service Function to VIM, named '%s'", name
)
3773 self
._reload
_connection
()
3774 # correlation = None
3776 # correlation = "nsh"
3778 for instance
in sfis
:
3779 sfi
= self
.get_sfi(instance
)
3781 if sfi
.get("sfc_encap") != sfc_encap
:
3782 raise vimconn
.VimConnNotSupportedException(
3783 "OpenStack VIM connector requires all SFIs of the "
3784 "same SF to share the same SFC Encapsulation"
3787 sf_dict
= {"name": name
, "port_pairs": sfis
}
3788 new_sf
= self
.neutron
.create_sfc_port_pair_group(
3789 {"port_pair_group": sf_dict
}
3792 return new_sf
["port_pair_group"]["id"]
3794 neExceptions
.ConnectionFailed
,
3795 ksExceptions
.ClientException
,
3796 neExceptions
.NeutronException
,
3801 self
.neutron
.delete_sfc_port_pair_group(
3802 new_sf
["port_pair_group"]["id"]
3806 "Creation of Service Function failed, with "
3807 "subsequent deletion failure as well."
3810 self
._format
_exception
(e
)
3812 def get_sf(self
, sf_id
):
3813 self
.logger
.debug("Getting Service Function %s from VIM", sf_id
)
3814 filter_dict
= {"id": sf_id
}
3815 sf_list
= self
.get_sf_list(filter_dict
)
3817 if len(sf_list
) == 0:
3818 raise vimconn
.VimConnNotFoundException(
3819 "Service Function '{}' not found".format(sf_id
)
3821 elif len(sf_list
) > 1:
3822 raise vimconn
.VimConnConflictException(
3823 "Found more than one Service Function with this criteria"
3830 def get_sf_list(self
, filter_dict
={}):
3832 "Getting Service Function from VIM filter: '%s'", str(filter_dict
)
3836 self
._reload
_connection
()
3837 filter_dict_os
= filter_dict
.copy()
3839 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3840 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3842 sf_dict
= self
.neutron
.list_sfc_port_pair_groups(**filter_dict_os
)
3843 sf_list
= sf_dict
["port_pair_groups"]
3844 self
.__sf
_os
2mano
(sf_list
)
3848 neExceptions
.ConnectionFailed
,
3849 ksExceptions
.ClientException
,
3850 neExceptions
.NeutronException
,
3853 self
._format
_exception
(e
)
3855 def delete_sf(self
, sf_id
):
3856 self
.logger
.debug("Deleting Service Function '%s' from VIM", sf_id
)
3859 self
._reload
_connection
()
3860 self
.neutron
.delete_sfc_port_pair_group(sf_id
)
3864 neExceptions
.ConnectionFailed
,
3865 neExceptions
.NeutronException
,
3866 ksExceptions
.ClientException
,
3867 neExceptions
.NeutronException
,
3870 self
._format
_exception
(e
)
3872 def new_sfp(self
, name
, classifications
, sfs
, sfc_encap
=True, spi
=None):
3873 self
.logger
.debug("Adding a new Service Function Path to VIM, named '%s'", name
)
3877 self
._reload
_connection
()
3878 # In networking-sfc the MPLS encapsulation is legacy
3879 # should be used when no full SFC Encapsulation is intended
3880 correlation
= "mpls"
3887 "flow_classifiers": classifications
,
3888 "port_pair_groups": sfs
,
3889 "chain_parameters": {"correlation": correlation
},
3893 sfp_dict
["chain_id"] = spi
3895 new_sfp
= self
.neutron
.create_sfc_port_chain({"port_chain": sfp_dict
})
3897 return new_sfp
["port_chain"]["id"]
3899 neExceptions
.ConnectionFailed
,
3900 ksExceptions
.ClientException
,
3901 neExceptions
.NeutronException
,
3906 self
.neutron
.delete_sfc_port_chain(new_sfp
["port_chain"]["id"])
3909 "Creation of Service Function Path failed, with "
3910 "subsequent deletion failure as well."
3913 self
._format
_exception
(e
)
3915 def get_sfp(self
, sfp_id
):
3916 self
.logger
.debug(" Getting Service Function Path %s from VIM", sfp_id
)
3918 filter_dict
= {"id": sfp_id
}
3919 sfp_list
= self
.get_sfp_list(filter_dict
)
3921 if len(sfp_list
) == 0:
3922 raise vimconn
.VimConnNotFoundException(
3923 "Service Function Path '{}' not found".format(sfp_id
)
3925 elif len(sfp_list
) > 1:
3926 raise vimconn
.VimConnConflictException(
3927 "Found more than one Service Function Path with this criteria"
3934 def get_sfp_list(self
, filter_dict
={}):
3936 "Getting Service Function Paths from VIM filter: '%s'", str(filter_dict
)
3940 self
._reload
_connection
()
3941 filter_dict_os
= filter_dict
.copy()
3943 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3944 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3946 sfp_dict
= self
.neutron
.list_sfc_port_chains(**filter_dict_os
)
3947 sfp_list
= sfp_dict
["port_chains"]
3948 self
.__sfp
_os
2mano
(sfp_list
)
3952 neExceptions
.ConnectionFailed
,
3953 ksExceptions
.ClientException
,
3954 neExceptions
.NeutronException
,
3957 self
._format
_exception
(e
)
3959 def delete_sfp(self
, sfp_id
):
3960 self
.logger
.debug("Deleting Service Function Path '%s' from VIM", sfp_id
)
3963 self
._reload
_connection
()
3964 self
.neutron
.delete_sfc_port_chain(sfp_id
)
3968 neExceptions
.ConnectionFailed
,
3969 neExceptions
.NeutronException
,
3970 ksExceptions
.ClientException
,
3971 neExceptions
.NeutronException
,
3974 self
._format
_exception
(e
)
3976 def refresh_sfps_status(self
, sfp_list
):
3977 """Get the status of the service function path
3978 Params: the list of sfp identifiers
3979 Returns a dictionary with:
3980 vm_id: #VIM id of this service function path
3981 status: #Mandatory. Text with one of:
3982 # DELETED (not found at vim)
3983 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3984 # OTHER (Vim reported other status not understood)
3985 # ERROR (VIM indicates an ERROR status)
3987 # CREATING (on building process)
3988 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3989 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)F
3993 "refresh_sfps status: Getting tenant SFP information from VIM"
3996 for sfp_id
in sfp_list
:
4000 sfp_vim
= self
.get_sfp(sfp_id
)
4003 sfp
["status"] = vmStatus2manoFormat
["ACTIVE"]
4005 sfp
["status"] = "OTHER"
4006 sfp
["error_msg"] = "VIM status reported " + sfp
["status"]
4008 sfp
["vim_info"] = self
.serialize(sfp_vim
)
4010 if sfp_vim
.get("fault"):
4011 sfp
["error_msg"] = str(sfp_vim
["fault"])
4012 except vimconn
.VimConnNotFoundException
as e
:
4013 self
.logger
.error("Exception getting sfp status: %s", str(e
))
4014 sfp
["status"] = "DELETED"
4015 sfp
["error_msg"] = str(e
)
4016 except vimconn
.VimConnException
as e
:
4017 self
.logger
.error("Exception getting sfp status: %s", str(e
))
4018 sfp
["status"] = "VIM_ERROR"
4019 sfp
["error_msg"] = str(e
)
4021 sfp_dict
[sfp_id
] = sfp
4025 def refresh_sfis_status(self
, sfi_list
):
4026 """Get the status of the service function instances
4027 Params: the list of sfi identifiers
4028 Returns a dictionary with:
4029 vm_id: #VIM id of this service function instance
4030 status: #Mandatory. Text with one of:
4031 # DELETED (not found at vim)
4032 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4033 # OTHER (Vim reported other status not understood)
4034 # ERROR (VIM indicates an ERROR status)
4036 # CREATING (on building process)
4037 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4038 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4042 "refresh_sfis status: Getting tenant sfi information from VIM"
4045 for sfi_id
in sfi_list
:
4049 sfi_vim
= self
.get_sfi(sfi_id
)
4052 sfi
["status"] = vmStatus2manoFormat
["ACTIVE"]
4054 sfi
["status"] = "OTHER"
4055 sfi
["error_msg"] = "VIM status reported " + sfi
["status"]
4057 sfi
["vim_info"] = self
.serialize(sfi_vim
)
4059 if sfi_vim
.get("fault"):
4060 sfi
["error_msg"] = str(sfi_vim
["fault"])
4061 except vimconn
.VimConnNotFoundException
as e
:
4062 self
.logger
.error("Exception getting sfi status: %s", str(e
))
4063 sfi
["status"] = "DELETED"
4064 sfi
["error_msg"] = str(e
)
4065 except vimconn
.VimConnException
as e
:
4066 self
.logger
.error("Exception getting sfi status: %s", str(e
))
4067 sfi
["status"] = "VIM_ERROR"
4068 sfi
["error_msg"] = str(e
)
4070 sfi_dict
[sfi_id
] = sfi
4074 def refresh_sfs_status(self
, sf_list
):
4075 """Get the status of the service functions
4076 Params: the list of sf identifiers
4077 Returns a dictionary with:
4078 vm_id: #VIM id of this service function
4079 status: #Mandatory. Text with one of:
4080 # DELETED (not found at vim)
4081 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4082 # OTHER (Vim reported other status not understood)
4083 # ERROR (VIM indicates an ERROR status)
4085 # CREATING (on building process)
4086 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4087 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4090 self
.logger
.debug("refresh_sfs status: Getting tenant sf information from VIM")
4092 for sf_id
in sf_list
:
4096 sf_vim
= self
.get_sf(sf_id
)
4099 sf
["status"] = vmStatus2manoFormat
["ACTIVE"]
4101 sf
["status"] = "OTHER"
4102 sf
["error_msg"] = "VIM status reported " + sf_vim
["status"]
4104 sf
["vim_info"] = self
.serialize(sf_vim
)
4106 if sf_vim
.get("fault"):
4107 sf
["error_msg"] = str(sf_vim
["fault"])
4108 except vimconn
.VimConnNotFoundException
as e
:
4109 self
.logger
.error("Exception getting sf status: %s", str(e
))
4110 sf
["status"] = "DELETED"
4111 sf
["error_msg"] = str(e
)
4112 except vimconn
.VimConnException
as e
:
4113 self
.logger
.error("Exception getting sf status: %s", str(e
))
4114 sf
["status"] = "VIM_ERROR"
4115 sf
["error_msg"] = str(e
)
4121 def refresh_classifications_status(self
, classification_list
):
4122 """Get the status of the classifications
4123 Params: the list of classification identifiers
4124 Returns a dictionary with:
4125 vm_id: #VIM id of this classifier
4126 status: #Mandatory. Text with one of:
4127 # DELETED (not found at vim)
4128 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4129 # OTHER (Vim reported other status not understood)
4130 # ERROR (VIM indicates an ERROR status)
4132 # CREATING (on building process)
4133 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4134 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4136 classification_dict
= {}
4138 "refresh_classifications status: Getting tenant classification information from VIM"
4141 for classification_id
in classification_list
:
4145 classification_vim
= self
.get_classification(classification_id
)
4147 if classification_vim
:
4148 classification
["status"] = vmStatus2manoFormat
["ACTIVE"]
4150 classification
["status"] = "OTHER"
4151 classification
["error_msg"] = (
4152 "VIM status reported " + classification
["status"]
4155 classification
["vim_info"] = self
.serialize(classification_vim
)
4157 if classification_vim
.get("fault"):
4158 classification
["error_msg"] = str(classification_vim
["fault"])
4159 except vimconn
.VimConnNotFoundException
as e
:
4160 self
.logger
.error("Exception getting classification status: %s", str(e
))
4161 classification
["status"] = "DELETED"
4162 classification
["error_msg"] = str(e
)
4163 except vimconn
.VimConnException
as e
:
4164 self
.logger
.error("Exception getting classification status: %s", str(e
))
4165 classification
["status"] = "VIM_ERROR"
4166 classification
["error_msg"] = str(e
)
4168 classification_dict
[classification_id
] = classification
4170 return classification_dict
4172 def new_affinity_group(self
, affinity_group_data
):
4173 """Adds a server group to VIM
4174 affinity_group_data contains a dictionary with information, keys:
4175 name: name in VIM for the server group
4176 type: affinity or anti-affinity
4177 scope: Only nfvi-node allowed
4178 Returns the server group identifier"""
4179 self
.logger
.debug("Adding Server Group '%s'", str(affinity_group_data
))
4182 name
= affinity_group_data
["name"]
4183 policy
= affinity_group_data
["type"]
4185 self
._reload
_connection
()
4186 new_server_group
= self
.nova
.server_groups
.create(name
, policy
)
4188 return new_server_group
.id
4190 ksExceptions
.ClientException
,
4191 nvExceptions
.ClientException
,
4195 self
._format
_exception
(e
)
4197 def get_affinity_group(self
, affinity_group_id
):
4198 """Obtain server group details from the VIM. Returns the server group detais as a dict"""
4199 self
.logger
.debug("Getting flavor '%s'", affinity_group_id
)
4201 self
._reload
_connection
()
4202 server_group
= self
.nova
.server_groups
.find(id=affinity_group_id
)
4204 return server_group
.to_dict()
4206 nvExceptions
.NotFound
,
4207 nvExceptions
.ClientException
,
4208 ksExceptions
.ClientException
,
4211 self
._format
_exception
(e
)
4213 def delete_affinity_group(self
, affinity_group_id
):
4214 """Deletes a server group from the VIM. Returns the old affinity_group_id"""
4215 self
.logger
.debug("Getting server group '%s'", affinity_group_id
)
4217 self
._reload
_connection
()
4218 self
.nova
.server_groups
.delete(affinity_group_id
)
4220 return affinity_group_id
4222 nvExceptions
.NotFound
,
4223 ksExceptions
.ClientException
,
4224 nvExceptions
.ClientException
,
4227 self
._format
_exception
(e
)
4229 def get_vdu_state(self
, vm_id
):
4231 Getting the state of a vdu
4233 vm_id: ID of an instance
4235 self
.logger
.debug("Getting the status of VM")
4236 self
.logger
.debug("VIM VM ID %s", vm_id
)
4237 self
._reload
_connection
()
4238 server
= self
.nova
.servers
.find(id=vm_id
)
4239 server_dict
= server
.to_dict()
4241 server_dict
["status"],
4242 server_dict
["flavor"]["id"],
4243 server_dict
["OS-EXT-SRV-ATTR:host"],
4244 server_dict
["OS-EXT-AZ:availability_zone"],
4246 self
.logger
.debug("vdu_data %s", vdu_data
)
4249 def check_compute_availability(self
, host
, server_flavor_details
):
4250 self
._reload
_connection
()
4251 hypervisor_search
= self
.nova
.hypervisors
.search(
4252 hypervisor_match
=host
, servers
=True
4254 for hypervisor
in hypervisor_search
:
4255 hypervisor_id
= hypervisor
.to_dict()["id"]
4256 hypervisor_details
= self
.nova
.hypervisors
.get(hypervisor
=hypervisor_id
)
4257 hypervisor_dict
= hypervisor_details
.to_dict()
4258 hypervisor_temp
= json
.dumps(hypervisor_dict
)
4259 hypervisor_json
= json
.loads(hypervisor_temp
)
4260 resources_available
= [
4261 hypervisor_json
["free_ram_mb"],
4262 hypervisor_json
["disk_available_least"],
4263 hypervisor_json
["vcpus"] - hypervisor_json
["vcpus_used"],
4265 compute_available
= all(
4266 x
> y
for x
, y
in zip(resources_available
, server_flavor_details
)
4268 if compute_available
:
4271 def check_availability_zone(
4272 self
, old_az
, server_flavor_details
, old_host
, host
=None
4274 self
._reload
_connection
()
4275 az_check
= {"zone_check": False, "compute_availability": None}
4276 aggregates_list
= self
.nova
.aggregates
.list()
4277 for aggregate
in aggregates_list
:
4278 aggregate_details
= aggregate
.to_dict()
4279 aggregate_temp
= json
.dumps(aggregate_details
)
4280 aggregate_json
= json
.loads(aggregate_temp
)
4281 if aggregate_json
["availability_zone"] == old_az
:
4282 hosts_list
= aggregate_json
["hosts"]
4283 if host
is not None:
4284 if host
in hosts_list
:
4285 az_check
["zone_check"] = True
4286 available_compute_id
= self
.check_compute_availability(
4287 host
, server_flavor_details
4289 if available_compute_id
is not None:
4290 az_check
["compute_availability"] = available_compute_id
4292 for check_host
in hosts_list
:
4293 if check_host
!= old_host
:
4294 available_compute_id
= self
.check_compute_availability(
4295 check_host
, server_flavor_details
4297 if available_compute_id
is not None:
4298 az_check
["zone_check"] = True
4299 az_check
["compute_availability"] = available_compute_id
4302 az_check
["zone_check"] = True
4305 def migrate_instance(self
, vm_id
, compute_host
=None):
4309 vm_id: ID of an instance
4310 compute_host: Host to migrate the vdu to
4312 self
._reload
_connection
()
4314 instance_state
= self
.get_vdu_state(vm_id
)
4315 server_flavor_id
= instance_state
[1]
4316 server_hypervisor_name
= instance_state
[2]
4317 server_availability_zone
= instance_state
[3]
4319 server_flavor
= self
.nova
.flavors
.find(id=server_flavor_id
).to_dict()
4320 server_flavor_details
= [
4321 server_flavor
["ram"],
4322 server_flavor
["disk"],
4323 server_flavor
["vcpus"],
4325 if compute_host
== server_hypervisor_name
:
4326 raise vimconn
.VimConnException(
4327 "Unable to migrate instance '{}' to the same host '{}'".format(
4330 http_code
=vimconn
.HTTP_Bad_Request
,
4332 az_status
= self
.check_availability_zone(
4333 server_availability_zone
,
4334 server_flavor_details
,
4335 server_hypervisor_name
,
4338 availability_zone_check
= az_status
["zone_check"]
4339 available_compute_id
= az_status
.get("compute_availability")
4341 if availability_zone_check
is False:
4342 raise vimconn
.VimConnException(
4343 "Unable to migrate instance '{}' to a different availability zone".format(
4346 http_code
=vimconn
.HTTP_Bad_Request
,
4348 if available_compute_id
is not None:
4349 self
.nova
.servers
.live_migrate(
4351 host
=available_compute_id
,
4352 block_migration
=True,
4353 disk_over_commit
=False,
4356 changed_compute_host
= ""
4357 if state
== "MIGRATING":
4358 vm_state
= self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4359 changed_compute_host
= self
.get_vdu_state(vm_id
)[2]
4360 if vm_state
and changed_compute_host
== available_compute_id
:
4362 "Instance '{}' migrated to the new compute host '{}'".format(
4363 vm_id
, changed_compute_host
4366 return state
, available_compute_id
4368 raise vimconn
.VimConnException(
4369 "Migration Failed. Instance '{}' not moved to the new host {}".format(
4370 vm_id
, available_compute_id
4372 http_code
=vimconn
.HTTP_Bad_Request
,
4375 raise vimconn
.VimConnException(
4376 "Compute '{}' not available or does not have enough resources to migrate the instance".format(
4377 available_compute_id
4379 http_code
=vimconn
.HTTP_Bad_Request
,
4382 nvExceptions
.BadRequest
,
4383 nvExceptions
.ClientException
,
4384 nvExceptions
.NotFound
,
4386 self
._format
_exception
(e
)
4388 def resize_instance(self
, vm_id
, new_flavor_id
):
4390 For resizing the vm based on the given
4393 vm_id : ID of an instance
4394 new_flavor_id : Flavor id to be resized
4395 Return the status of a resized instance
4397 self
._reload
_connection
()
4398 self
.logger
.debug("resize the flavor of an instance")
4399 instance_status
, old_flavor_id
, compute_host
, az
= self
.get_vdu_state(vm_id
)
4400 old_flavor_disk
= self
.nova
.flavors
.find(id=old_flavor_id
).to_dict()["disk"]
4401 new_flavor_disk
= self
.nova
.flavors
.find(id=new_flavor_id
).to_dict()["disk"]
4403 if instance_status
== "ACTIVE" or instance_status
== "SHUTOFF":
4404 if old_flavor_disk
> new_flavor_disk
:
4405 raise nvExceptions
.BadRequest(
4407 message
="Server disk resize failed. Resize to lower disk flavor is not allowed",
4410 self
.nova
.servers
.resize(server
=vm_id
, flavor
=new_flavor_id
)
4411 vm_state
= self
.__wait
_for
_vm
(vm_id
, "VERIFY_RESIZE")
4413 instance_resized_status
= self
.confirm_resize(vm_id
)
4414 return instance_resized_status
4416 raise nvExceptions
.BadRequest(
4418 message
="Cannot 'resize' vm_state is in ERROR",
4422 self
.logger
.debug("ERROR : Instance is not in ACTIVE or SHUTOFF state")
4423 raise nvExceptions
.BadRequest(
4425 message
="Cannot 'resize' instance while it is in vm_state resized",
4428 nvExceptions
.BadRequest
,
4429 nvExceptions
.ClientException
,
4430 nvExceptions
.NotFound
,
4432 self
._format
_exception
(e
)
4434 def confirm_resize(self
, vm_id
):
4436 Confirm the resize of an instance
4438 vm_id: ID of an instance
4440 self
._reload
_connection
()
4441 self
.nova
.servers
.confirm_resize(server
=vm_id
)
4442 if self
.get_vdu_state(vm_id
)[0] == "VERIFY_RESIZE":
4443 self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4444 instance_status
= self
.get_vdu_state(vm_id
)[0]
4445 return instance_status