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
36 from pprint
import pformat
41 from cinderclient
import client
as cClient
42 from glanceclient
import client
as glClient
43 import glanceclient
.exc
as gl1Exceptions
44 from keystoneauth1
import session
45 from keystoneauth1
.identity
import v2
, v3
46 import keystoneclient
.exceptions
as ksExceptions
47 import keystoneclient
.v2_0
.client
as ksClient_v2
48 import keystoneclient
.v3
.client
as ksClient_v3
50 from neutronclient
.common
import exceptions
as neExceptions
51 from neutronclient
.neutron
import client
as neClient
52 from novaclient
import client
as nClient
, exceptions
as nvExceptions
53 from osm_ro_plugin
import vimconn
54 from requests
.exceptions
import ConnectionError
57 __author__
= "Alfonso Tierno, Gerardo Garcia, Pablo Montes, xFlow Research, Igor D.C., Eduardo Sousa"
58 __date__
= "$22-sep-2017 23:59:59$"
60 """contain the openstack virtual machine status to openmano status"""
61 vmStatus2manoFormat
= {
64 "SUSPENDED": "SUSPENDED",
65 "SHUTOFF": "INACTIVE",
70 netStatus2manoFormat
= {
73 "INACTIVE": "INACTIVE",
79 supportedClassificationTypes
= ["legacy_flow_classifier"]
81 # global var to have a timeout creating and deleting volumes
86 class SafeDumper(yaml
.SafeDumper
):
87 def represent_data(self
, data
):
88 # Openstack APIs use custom subclasses of dict and YAML safe dumper
89 # is designed to not handle that (reference issue 142 of pyyaml)
90 if isinstance(data
, dict) and data
.__class
__ != dict:
91 # A simple solution is to convert those items back to dicts
92 data
= dict(data
.items())
94 return super(SafeDumper
, self
).represent_data(data
)
97 class vimconnector(vimconn
.VimConnector
):
112 """using common constructor parameters. In this case
113 'url' is the keystone authorization url,
114 'url_admin' is not use
116 api_version
= config
.get("APIversion")
118 if api_version
and api_version
not in ("v3.3", "v2.0", "2", "3"):
119 raise vimconn
.VimConnException(
120 "Invalid value '{}' for config:APIversion. "
121 "Allowed values are 'v3.3', 'v2.0', '2' or '3'".format(api_version
)
124 vim_type
= config
.get("vim_type")
126 if vim_type
and vim_type
not in ("vio", "VIO"):
127 raise vimconn
.VimConnException(
128 "Invalid value '{}' for config:vim_type."
129 "Allowed values are 'vio' or 'VIO'".format(vim_type
)
132 if config
.get("dataplane_net_vlan_range") is not None:
133 # validate vlan ranges provided by user
134 self
._validate
_vlan
_ranges
(
135 config
.get("dataplane_net_vlan_range"), "dataplane_net_vlan_range"
138 if config
.get("multisegment_vlan_range") is not None:
139 # validate vlan ranges provided by user
140 self
._validate
_vlan
_ranges
(
141 config
.get("multisegment_vlan_range"), "multisegment_vlan_range"
144 vimconn
.VimConnector
.__init
__(
158 if self
.config
.get("insecure") and self
.config
.get("ca_cert"):
159 raise vimconn
.VimConnException(
160 "options insecure and ca_cert are mutually exclusive"
165 if self
.config
.get("insecure"):
168 if self
.config
.get("ca_cert"):
169 self
.verify
= self
.config
.get("ca_cert")
172 raise TypeError("url param can not be NoneType")
174 self
.persistent_info
= persistent_info
175 self
.availability_zone
= persistent_info
.get("availability_zone", None)
176 self
.session
= persistent_info
.get("session", {"reload_client": True})
177 self
.my_tenant_id
= self
.session
.get("my_tenant_id")
178 self
.nova
= self
.session
.get("nova")
179 self
.neutron
= self
.session
.get("neutron")
180 self
.cinder
= self
.session
.get("cinder")
181 self
.glance
= self
.session
.get("glance")
182 # self.glancev1 = self.session.get("glancev1")
183 self
.keystone
= self
.session
.get("keystone")
184 self
.api_version3
= self
.session
.get("api_version3")
185 self
.vim_type
= self
.config
.get("vim_type")
188 self
.vim_type
= self
.vim_type
.upper()
190 if self
.config
.get("use_internal_endpoint"):
191 self
.endpoint_type
= "internalURL"
193 self
.endpoint_type
= None
195 logging
.getLogger("urllib3").setLevel(logging
.WARNING
)
196 logging
.getLogger("keystoneauth").setLevel(logging
.WARNING
)
197 logging
.getLogger("novaclient").setLevel(logging
.WARNING
)
198 self
.logger
= logging
.getLogger("ro.vim.openstack")
200 # allow security_groups to be a list or a single string
201 if isinstance(self
.config
.get("security_groups"), str):
202 self
.config
["security_groups"] = [self
.config
["security_groups"]]
204 self
.security_groups_id
= None
206 # ###### VIO Specific Changes #########
207 if self
.vim_type
== "VIO":
208 self
.logger
= logging
.getLogger("ro.vim.vio")
211 self
.logger
.setLevel(getattr(logging
, log_level
))
213 def __getitem__(self
, index
):
214 """Get individuals parameters.
216 if index
== "project_domain_id":
217 return self
.config
.get("project_domain_id")
218 elif index
== "user_domain_id":
219 return self
.config
.get("user_domain_id")
221 return vimconn
.VimConnector
.__getitem
__(self
, index
)
223 def __setitem__(self
, index
, value
):
224 """Set individuals parameters and it is marked as dirty so to force connection reload.
226 if index
== "project_domain_id":
227 self
.config
["project_domain_id"] = value
228 elif index
== "user_domain_id":
229 self
.config
["user_domain_id"] = value
231 vimconn
.VimConnector
.__setitem
__(self
, index
, value
)
233 self
.session
["reload_client"] = True
235 def serialize(self
, value
):
236 """Serialization of python basic types.
238 In the case value is not serializable a message will be logged and a
239 simple representation of the data that cannot be converted back to
242 if isinstance(value
, str):
247 value
, Dumper
=SafeDumper
, default_flow_style
=True, width
=256
249 except yaml
.representer
.RepresenterError
:
251 "The following entity cannot be serialized in YAML:\n\n%s\n\n",
258 def _reload_connection(self
):
259 """Called before any operation, it check if credentials has changed
260 Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
262 # TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
263 if self
.session
["reload_client"]:
264 if self
.config
.get("APIversion"):
265 self
.api_version3
= (
266 self
.config
["APIversion"] == "v3.3"
267 or self
.config
["APIversion"] == "3"
269 else: # get from ending auth_url that end with v3 or with v2.0
270 self
.api_version3
= self
.url
.endswith("/v3") or self
.url
.endswith(
274 self
.session
["api_version3"] = self
.api_version3
276 if self
.api_version3
:
277 if self
.config
.get("project_domain_id") or self
.config
.get(
278 "project_domain_name"
280 project_domain_id_default
= None
282 project_domain_id_default
= "default"
284 if self
.config
.get("user_domain_id") or self
.config
.get(
287 user_domain_id_default
= None
289 user_domain_id_default
= "default"
293 password
=self
.passwd
,
294 project_name
=self
.tenant_name
,
295 project_id
=self
.tenant_id
,
296 project_domain_id
=self
.config
.get(
297 "project_domain_id", project_domain_id_default
299 user_domain_id
=self
.config
.get(
300 "user_domain_id", user_domain_id_default
302 project_domain_name
=self
.config
.get("project_domain_name"),
303 user_domain_name
=self
.config
.get("user_domain_name"),
309 password
=self
.passwd
,
310 tenant_name
=self
.tenant_name
,
311 tenant_id
=self
.tenant_id
,
314 sess
= session
.Session(auth
=auth
, verify
=self
.verify
)
315 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
316 # Titanium cloud and StarlingX
317 region_name
= self
.config
.get("region_name")
319 if self
.api_version3
:
320 self
.keystone
= ksClient_v3
.Client(
322 endpoint_type
=self
.endpoint_type
,
323 region_name
=region_name
,
326 self
.keystone
= ksClient_v2
.Client(
327 session
=sess
, endpoint_type
=self
.endpoint_type
330 self
.session
["keystone"] = self
.keystone
331 # In order to enable microversion functionality an explicit microversion must be specified in "config".
332 # This implementation approach is due to the warning message in
333 # https://developer.openstack.org/api-guide/compute/microversions.html
334 # where it is stated that microversion backwards compatibility is not guaranteed and clients should
335 # always require an specific microversion.
336 # To be able to use "device role tagging" functionality define "microversion: 2.32" in datacenter config
337 version
= self
.config
.get("microversion")
342 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
343 # Titanium cloud and StarlingX
344 self
.nova
= self
.session
["nova"] = nClient
.Client(
347 endpoint_type
=self
.endpoint_type
,
348 region_name
=region_name
,
350 self
.neutron
= self
.session
["neutron"] = neClient
.Client(
353 endpoint_type
=self
.endpoint_type
,
354 region_name
=region_name
,
356 self
.cinder
= self
.session
["cinder"] = cClient
.Client(
359 endpoint_type
=self
.endpoint_type
,
360 region_name
=region_name
,
364 self
.my_tenant_id
= self
.session
["my_tenant_id"] = sess
.get_project_id()
366 self
.logger
.error("Cannot get project_id from session", exc_info
=True)
368 if self
.endpoint_type
== "internalURL":
369 glance_service_id
= self
.keystone
.services
.list(name
="glance")[0].id
370 glance_endpoint
= self
.keystone
.endpoints
.list(
371 glance_service_id
, interface
="internal"
374 glance_endpoint
= None
376 self
.glance
= self
.session
["glance"] = glClient
.Client(
377 2, session
=sess
, endpoint
=glance_endpoint
379 # using version 1 of glance client in new_image()
380 # self.glancev1 = self.session["glancev1"] = glClient.Client("1", session=sess,
381 # endpoint=glance_endpoint)
382 self
.session
["reload_client"] = False
383 self
.persistent_info
["session"] = self
.session
384 # add availablity zone info inside self.persistent_info
385 self
._set
_availablity
_zones
()
386 self
.persistent_info
["availability_zone"] = self
.availability_zone
387 # force to get again security_groups_ids next time they are needed
388 self
.security_groups_id
= None
390 def __net_os2mano(self
, net_list_dict
):
391 """Transform the net openstack format to mano format
392 net_list_dict can be a list of dict or a single dict"""
393 if type(net_list_dict
) is dict:
394 net_list_
= (net_list_dict
,)
395 elif type(net_list_dict
) is list:
396 net_list_
= net_list_dict
398 raise TypeError("param net_list_dict must be a list or a dictionary")
399 for net
in net_list_
:
400 if net
.get("provider:network_type") == "vlan":
403 net
["type"] = "bridge"
405 def __classification_os2mano(self
, class_list_dict
):
406 """Transform the openstack format (Flow Classifier) to mano format
407 (Classification) class_list_dict can be a list of dict or a single dict
409 if isinstance(class_list_dict
, dict):
410 class_list_
= [class_list_dict
]
411 elif isinstance(class_list_dict
, list):
412 class_list_
= class_list_dict
414 raise TypeError("param class_list_dict must be a list or a dictionary")
415 for classification
in class_list_
:
416 id = classification
.pop("id")
417 name
= classification
.pop("name")
418 description
= classification
.pop("description")
419 project_id
= classification
.pop("project_id")
420 tenant_id
= classification
.pop("tenant_id")
421 original_classification
= copy
.deepcopy(classification
)
422 classification
.clear()
423 classification
["ctype"] = "legacy_flow_classifier"
424 classification
["definition"] = original_classification
425 classification
["id"] = id
426 classification
["name"] = name
427 classification
["description"] = description
428 classification
["project_id"] = project_id
429 classification
["tenant_id"] = tenant_id
431 def __sfi_os2mano(self
, sfi_list_dict
):
432 """Transform the openstack format (Port Pair) to mano format (SFI)
433 sfi_list_dict can be a list of dict or a single dict
435 if isinstance(sfi_list_dict
, dict):
436 sfi_list_
= [sfi_list_dict
]
437 elif isinstance(sfi_list_dict
, list):
438 sfi_list_
= sfi_list_dict
440 raise TypeError("param sfi_list_dict must be a list or a dictionary")
442 for sfi
in sfi_list_
:
443 sfi
["ingress_ports"] = []
444 sfi
["egress_ports"] = []
446 if sfi
.get("ingress"):
447 sfi
["ingress_ports"].append(sfi
["ingress"])
449 if sfi
.get("egress"):
450 sfi
["egress_ports"].append(sfi
["egress"])
454 params
= sfi
.get("service_function_parameters")
458 correlation
= params
.get("correlation")
463 sfi
["sfc_encap"] = sfc_encap
464 del sfi
["service_function_parameters"]
466 def __sf_os2mano(self
, sf_list_dict
):
467 """Transform the openstack format (Port Pair Group) to mano format (SF)
468 sf_list_dict can be a list of dict or a single dict
470 if isinstance(sf_list_dict
, dict):
471 sf_list_
= [sf_list_dict
]
472 elif isinstance(sf_list_dict
, list):
473 sf_list_
= sf_list_dict
475 raise TypeError("param sf_list_dict must be a list or a dictionary")
478 del sf
["port_pair_group_parameters"]
479 sf
["sfis"] = sf
["port_pairs"]
482 def __sfp_os2mano(self
, sfp_list_dict
):
483 """Transform the openstack format (Port Chain) to mano format (SFP)
484 sfp_list_dict can be a list of dict or a single dict
486 if isinstance(sfp_list_dict
, dict):
487 sfp_list_
= [sfp_list_dict
]
488 elif isinstance(sfp_list_dict
, list):
489 sfp_list_
= sfp_list_dict
491 raise TypeError("param sfp_list_dict must be a list or a dictionary")
493 for sfp
in sfp_list_
:
494 params
= sfp
.pop("chain_parameters")
498 correlation
= params
.get("correlation")
503 sfp
["sfc_encap"] = sfc_encap
504 sfp
["spi"] = sfp
.pop("chain_id")
505 sfp
["classifications"] = sfp
.pop("flow_classifiers")
506 sfp
["service_functions"] = sfp
.pop("port_pair_groups")
508 # placeholder for now; read TODO note below
509 def _validate_classification(self
, type, definition
):
510 # only legacy_flow_classifier Type is supported at this point
512 # TODO(igordcard): this method should be an abstract method of an
513 # abstract Classification class to be implemented by the specific
514 # Types. Also, abstract vimconnector should call the validation
515 # method before the implemented VIM connectors are called.
517 def _format_exception(self
, exception
):
518 """Transform a keystone, nova, neutron exception into a vimconn exception discovering the cause"""
519 message_error
= str(exception
)
525 neExceptions
.NetworkNotFoundClient
,
526 nvExceptions
.NotFound
,
527 ksExceptions
.NotFound
,
528 gl1Exceptions
.HTTPNotFound
,
531 raise vimconn
.VimConnNotFoundException(
532 type(exception
).__name
__ + ": " + message_error
538 gl1Exceptions
.HTTPException
,
539 gl1Exceptions
.CommunicationError
,
541 ksExceptions
.ConnectionError
,
542 neExceptions
.ConnectionFailed
,
545 if type(exception
).__name
__ == "SSLError":
546 tip
= " (maybe option 'insecure' must be added to the VIM)"
548 raise vimconn
.VimConnConnectionException(
549 "Invalid URL or credentials{}: {}".format(tip
, message_error
)
555 nvExceptions
.BadRequest
,
556 ksExceptions
.BadRequest
,
559 raise vimconn
.VimConnException(
560 type(exception
).__name
__ + ": " + message_error
565 nvExceptions
.ClientException
,
566 ksExceptions
.ClientException
,
567 neExceptions
.NeutronException
,
570 raise vimconn
.VimConnUnexpectedResponse(
571 type(exception
).__name
__ + ": " + message_error
573 elif isinstance(exception
, nvExceptions
.Conflict
):
574 raise vimconn
.VimConnConflictException(
575 type(exception
).__name
__ + ": " + message_error
577 elif isinstance(exception
, vimconn
.VimConnException
):
580 self
.logger
.error("General Exception " + message_error
, exc_info
=True)
582 raise vimconn
.VimConnConnectionException(
583 type(exception
).__name
__ + ": " + message_error
586 def _get_ids_from_name(self
):
588 Obtain ids from name of tenant and security_groups. Store at self .security_groups_id"
591 # get tenant_id if only tenant_name is supplied
592 self
._reload
_connection
()
594 if not self
.my_tenant_id
:
595 raise vimconn
.VimConnConnectionException(
596 "Error getting tenant information from name={} id={}".format(
597 self
.tenant_name
, self
.tenant_id
601 if self
.config
.get("security_groups") and not self
.security_groups_id
:
602 # convert from name to id
603 neutron_sg_list
= self
.neutron
.list_security_groups(
604 tenant_id
=self
.my_tenant_id
607 self
.security_groups_id
= []
608 for sg
in self
.config
.get("security_groups"):
609 for neutron_sg
in neutron_sg_list
:
610 if sg
in (neutron_sg
["id"], neutron_sg
["name"]):
611 self
.security_groups_id
.append(neutron_sg
["id"])
614 self
.security_groups_id
= None
616 raise vimconn
.VimConnConnectionException(
617 "Not found security group {} for this tenant".format(sg
)
620 def check_vim_connectivity(self
):
621 # just get network list to check connectivity and credentials
622 self
.get_network_list(filter_dict
={})
624 def get_tenant_list(self
, filter_dict
={}):
625 """Obtain tenants of VIM
626 filter_dict can contain the following keys:
627 name: filter by tenant name
628 id: filter by tenant uuid/id
630 Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
632 self
.logger
.debug("Getting tenants from VIM filter: '%s'", str(filter_dict
))
635 self
._reload
_connection
()
637 if self
.api_version3
:
638 project_class_list
= self
.keystone
.projects
.list(
639 name
=filter_dict
.get("name")
642 project_class_list
= self
.keystone
.tenants
.findall(**filter_dict
)
646 for project
in project_class_list
:
647 if filter_dict
.get("id") and filter_dict
["id"] != project
.id:
650 project_list
.append(project
.to_dict())
654 ksExceptions
.ConnectionError
,
655 ksExceptions
.ClientException
,
658 self
._format
_exception
(e
)
660 def new_tenant(self
, tenant_name
, tenant_description
):
661 """Adds a new tenant to openstack VIM. Returns the tenant identifier"""
662 self
.logger
.debug("Adding a new tenant name: %s", tenant_name
)
665 self
._reload
_connection
()
667 if self
.api_version3
:
668 project
= self
.keystone
.projects
.create(
670 self
.config
.get("project_domain_id", "default"),
671 description
=tenant_description
,
675 project
= self
.keystone
.tenants
.create(tenant_name
, tenant_description
)
679 ksExceptions
.ConnectionError
,
680 ksExceptions
.ClientException
,
681 ksExceptions
.BadRequest
,
684 self
._format
_exception
(e
)
686 def delete_tenant(self
, tenant_id
):
687 """Delete a tenant from openstack VIM. Returns the old tenant identifier"""
688 self
.logger
.debug("Deleting tenant %s from VIM", tenant_id
)
691 self
._reload
_connection
()
693 if self
.api_version3
:
694 self
.keystone
.projects
.delete(tenant_id
)
696 self
.keystone
.tenants
.delete(tenant_id
)
700 ksExceptions
.ConnectionError
,
701 ksExceptions
.ClientException
,
702 ksExceptions
.NotFound
,
705 self
._format
_exception
(e
)
713 provider_network_profile
=None,
715 """Adds a tenant network to VIM
717 'net_name': name of the network
719 'bridge': overlay isolated network
720 'data': underlay E-LAN network for Passthrough and SRIOV interfaces
721 'ptp': underlay E-LINE network for Passthrough and SRIOV interfaces.
722 'ip_profile': is a dict containing the IP parameters of the network
723 'ip_version': can be "IPv4" or "IPv6" (Currently only IPv4 is implemented)
724 'subnet_address': ip_prefix_schema, that is X.X.X.X/Y
725 'gateway_address': (Optional) ip_schema, that is X.X.X.X
726 'dns_address': (Optional) comma separated list of ip_schema, e.g. X.X.X.X[,X,X,X,X]
727 'dhcp_enabled': True or False
728 'dhcp_start_address': ip_schema, first IP to grant
729 'dhcp_count': number of IPs to grant.
730 'shared': if this network can be seen/use by other tenants/organization
731 'provider_network_profile': (optional) contains {segmentation-id: vlan, network-type: vlan|vxlan,
732 physical-network: physnet-label}
733 Returns a tuple with the network identifier and created_items, or raises an exception on error
734 created_items can be None or a dictionary where this method can include key-values that will be passed to
735 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
736 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
740 "Adding a new network to VIM name '%s', type '%s'", net_name
, net_type
742 # self.logger.debug(">>>>>>>>>>>>>>>>>> IP profile %s", str(ip_profile))
747 if provider_network_profile
:
748 vlan
= provider_network_profile
.get("segmentation-id")
752 self
._reload
_connection
()
753 network_dict
= {"name": net_name
, "admin_state_up": True}
755 if net_type
in ("data", "ptp"):
756 provider_physical_network
= None
758 if provider_network_profile
and provider_network_profile
.get(
761 provider_physical_network
= provider_network_profile
.get(
765 # provider-network must be one of the dataplane_physcial_netowrk if this is a list. If it is string
766 # or not declared, just ignore the checking
769 self
.config
.get("dataplane_physical_net"), (tuple, list)
771 and provider_physical_network
772 not in self
.config
["dataplane_physical_net"]
774 raise vimconn
.VimConnConflictException(
775 "Invalid parameter 'provider-network:physical-network' "
776 "for network creation. '{}' is not one of the declared "
777 "list at VIM_config:dataplane_physical_net".format(
778 provider_physical_network
782 # use the default dataplane_physical_net
783 if not provider_physical_network
:
784 provider_physical_network
= self
.config
.get(
785 "dataplane_physical_net"
788 # if it is non empty list, use the first value. If it is a string use the value directly
790 isinstance(provider_physical_network
, (tuple, list))
791 and provider_physical_network
793 provider_physical_network
= provider_physical_network
[0]
795 if not provider_physical_network
:
796 raise vimconn
.VimConnConflictException(
797 "missing information needed for underlay networks. Provide "
798 "'dataplane_physical_net' configuration at VIM or use the NS "
799 "instantiation parameter 'provider-network.physical-network'"
803 if not self
.config
.get("multisegment_support"):
805 "provider:physical_network"
806 ] = provider_physical_network
809 provider_network_profile
810 and "network-type" in provider_network_profile
813 "provider:network_type"
814 ] = provider_network_profile
["network-type"]
816 network_dict
["provider:network_type"] = self
.config
.get(
817 "dataplane_network_type", "vlan"
821 network_dict
["provider:segmentation_id"] = vlan
826 "provider:physical_network": "",
827 "provider:network_type": "vxlan",
829 segment_list
.append(segment1_dict
)
831 "provider:physical_network": provider_physical_network
,
832 "provider:network_type": "vlan",
836 segment2_dict
["provider:segmentation_id"] = vlan
837 elif self
.config
.get("multisegment_vlan_range"):
838 vlanID
= self
._generate
_multisegment
_vlanID
()
839 segment2_dict
["provider:segmentation_id"] = vlanID
842 # raise vimconn.VimConnConflictException(
843 # "You must provide "multisegment_vlan_range" at config dict before creating a multisegment
845 segment_list
.append(segment2_dict
)
846 network_dict
["segments"] = segment_list
848 # VIO Specific Changes. It needs a concrete VLAN
849 if self
.vim_type
== "VIO" and vlan
is None:
850 if self
.config
.get("dataplane_net_vlan_range") is None:
851 raise vimconn
.VimConnConflictException(
852 "You must provide 'dataplane_net_vlan_range' in format "
853 "[start_ID - end_ID] at VIM_config for creating underlay "
857 network_dict
["provider:segmentation_id"] = self
._generate
_vlanID
()
859 network_dict
["shared"] = shared
861 if self
.config
.get("disable_network_port_security"):
862 network_dict
["port_security_enabled"] = False
864 if self
.config
.get("neutron_availability_zone_hints"):
865 hints
= self
.config
.get("neutron_availability_zone_hints")
867 if isinstance(hints
, str):
870 network_dict
["availability_zone_hints"] = hints
872 new_net
= self
.neutron
.create_network({"network": network_dict
})
874 # create subnetwork, even if there is no profile
879 if not ip_profile
.get("subnet_address"):
880 # Fake subnet is required
881 subnet_rand
= random
.randint(0, 255)
882 ip_profile
["subnet_address"] = "192.168.{}.0/24".format(subnet_rand
)
884 if "ip_version" not in ip_profile
:
885 ip_profile
["ip_version"] = "IPv4"
888 "name": net_name
+ "-subnet",
889 "network_id": new_net
["network"]["id"],
890 "ip_version": 4 if ip_profile
["ip_version"] == "IPv4" else 6,
891 "cidr": ip_profile
["subnet_address"],
894 # Gateway should be set to None if not needed. Otherwise openstack assigns one by default
895 if ip_profile
.get("gateway_address"):
896 subnet
["gateway_ip"] = ip_profile
["gateway_address"]
898 subnet
["gateway_ip"] = None
900 if ip_profile
.get("dns_address"):
901 subnet
["dns_nameservers"] = ip_profile
["dns_address"].split(";")
903 if "dhcp_enabled" in ip_profile
:
904 subnet
["enable_dhcp"] = (
906 if ip_profile
["dhcp_enabled"] == "false"
907 or ip_profile
["dhcp_enabled"] is False
911 if ip_profile
.get("dhcp_start_address"):
912 subnet
["allocation_pools"] = []
913 subnet
["allocation_pools"].append(dict())
914 subnet
["allocation_pools"][0]["start"] = ip_profile
[
918 if ip_profile
.get("dhcp_count"):
919 # parts = ip_profile["dhcp_start_address"].split(".")
920 # ip_int = (int(parts[0]) << 24) + (int(parts[1]) << 16) + (int(parts[2]) << 8) + int(parts[3])
921 ip_int
= int(netaddr
.IPAddress(ip_profile
["dhcp_start_address"]))
922 ip_int
+= ip_profile
["dhcp_count"] - 1
923 ip_str
= str(netaddr
.IPAddress(ip_int
))
924 subnet
["allocation_pools"][0]["end"] = ip_str
926 # self.logger.debug(">>>>>>>>>>>>>>>>>> Subnet: %s", str(subnet))
927 self
.neutron
.create_subnet({"subnet": subnet
})
929 if net_type
== "data" and self
.config
.get("multisegment_support"):
930 if self
.config
.get("l2gw_support"):
931 l2gw_list
= self
.neutron
.list_l2_gateways().get("l2_gateways", ())
932 for l2gw
in l2gw_list
:
934 "l2_gateway_id": l2gw
["id"],
935 "network_id": new_net
["network"]["id"],
936 "segmentation_id": str(vlanID
),
938 new_l2gw_conn
= self
.neutron
.create_l2_gateway_connection(
939 {"l2_gateway_connection": l2gw_conn
}
943 + str(new_l2gw_conn
["l2_gateway_connection"]["id"])
946 return new_net
["network"]["id"], created_items
947 except Exception as e
:
948 # delete l2gw connections (if any) before deleting the network
949 for k
, v
in created_items
.items():
950 if not v
: # skip already deleted
954 k_item
, _
, k_id
= k
.partition(":")
956 if k_item
== "l2gwconn":
957 self
.neutron
.delete_l2_gateway_connection(k_id
)
958 except Exception as e2
:
960 "Error deleting l2 gateway connection: {}: {}".format(
961 type(e2
).__name
__, e2
966 self
.neutron
.delete_network(new_net
["network"]["id"])
968 self
._format
_exception
(e
)
970 def get_network_list(self
, filter_dict
={}):
971 """Obtain tenant networks of VIM
977 admin_state_up: boolean
979 Returns the network list of dictionaries
981 self
.logger
.debug("Getting network from VIM filter: '%s'", str(filter_dict
))
984 self
._reload
_connection
()
985 filter_dict_os
= filter_dict
.copy()
987 if self
.api_version3
and "tenant_id" in filter_dict_os
:
989 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
991 net_dict
= self
.neutron
.list_networks(**filter_dict_os
)
992 net_list
= net_dict
["networks"]
993 self
.__net
_os
2mano
(net_list
)
997 neExceptions
.ConnectionFailed
,
998 ksExceptions
.ClientException
,
999 neExceptions
.NeutronException
,
1002 self
._format
_exception
(e
)
1004 def get_network(self
, net_id
):
1005 """Obtain details of network from VIM
1006 Returns the network information from a network id"""
1007 self
.logger
.debug(" Getting tenant network %s from VIM", net_id
)
1008 filter_dict
= {"id": net_id
}
1009 net_list
= self
.get_network_list(filter_dict
)
1011 if len(net_list
) == 0:
1012 raise vimconn
.VimConnNotFoundException(
1013 "Network '{}' not found".format(net_id
)
1015 elif len(net_list
) > 1:
1016 raise vimconn
.VimConnConflictException(
1017 "Found more than one network with this criteria"
1022 for subnet_id
in net
.get("subnets", ()):
1024 subnet
= self
.neutron
.show_subnet(subnet_id
)
1025 except Exception as e
:
1027 "osconnector.get_network(): Error getting subnet %s %s"
1030 subnet
= {"id": subnet_id
, "fault": str(e
)}
1032 subnets
.append(subnet
)
1034 net
["subnets"] = subnets
1035 net
["encapsulation"] = net
.get("provider:network_type")
1036 net
["encapsulation_type"] = net
.get("provider:network_type")
1037 net
["segmentation_id"] = net
.get("provider:segmentation_id")
1038 net
["encapsulation_id"] = net
.get("provider:segmentation_id")
1042 def delete_network(self
, net_id
, created_items
=None):
1044 Removes a tenant network from VIM and its associated elements
1045 :param net_id: VIM identifier of the network, provided by method new_network
1046 :param created_items: dictionary with extra items to be deleted. provided by method new_network
1047 Returns the network identifier or raises an exception upon error or when network is not found
1049 self
.logger
.debug("Deleting network '%s' from VIM", net_id
)
1051 if created_items
is None:
1055 self
._reload
_connection
()
1056 # delete l2gw connections (if any) before deleting the network
1057 for k
, v
in created_items
.items():
1058 if not v
: # skip already deleted
1062 k_item
, _
, k_id
= k
.partition(":")
1063 if k_item
== "l2gwconn":
1064 self
.neutron
.delete_l2_gateway_connection(k_id
)
1065 except Exception as e
:
1067 "Error deleting l2 gateway connection: {}: {}".format(
1072 # delete VM ports attached to this networks before the network
1073 ports
= self
.neutron
.list_ports(network_id
=net_id
)
1074 for p
in ports
["ports"]:
1076 self
.neutron
.delete_port(p
["id"])
1077 except Exception as e
:
1078 self
.logger
.error("Error deleting port %s: %s", p
["id"], str(e
))
1080 self
.neutron
.delete_network(net_id
)
1084 neExceptions
.ConnectionFailed
,
1085 neExceptions
.NetworkNotFoundClient
,
1086 neExceptions
.NeutronException
,
1087 ksExceptions
.ClientException
,
1088 neExceptions
.NeutronException
,
1091 self
._format
_exception
(e
)
1093 def refresh_nets_status(self
, net_list
):
1094 """Get the status of the networks
1095 Params: the list of network identifiers
1096 Returns a dictionary with:
1097 net_id: #VIM id of this network
1098 status: #Mandatory. Text with one of:
1099 # DELETED (not found at vim)
1100 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1101 # OTHER (Vim reported other status not understood)
1102 # ERROR (VIM indicates an ERROR status)
1103 # ACTIVE, INACTIVE, DOWN (admin down),
1104 # BUILD (on building process)
1106 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
1107 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1111 for net_id
in net_list
:
1115 net_vim
= self
.get_network(net_id
)
1117 if net_vim
["status"] in netStatus2manoFormat
:
1118 net
["status"] = netStatus2manoFormat
[net_vim
["status"]]
1120 net
["status"] = "OTHER"
1121 net
["error_msg"] = "VIM status reported " + net_vim
["status"]
1123 if net
["status"] == "ACTIVE" and not net_vim
["admin_state_up"]:
1124 net
["status"] = "DOWN"
1126 net
["vim_info"] = self
.serialize(net_vim
)
1128 if net_vim
.get("fault"): # TODO
1129 net
["error_msg"] = str(net_vim
["fault"])
1130 except vimconn
.VimConnNotFoundException
as e
:
1131 self
.logger
.error("Exception getting net status: %s", str(e
))
1132 net
["status"] = "DELETED"
1133 net
["error_msg"] = str(e
)
1134 except vimconn
.VimConnException
as e
:
1135 self
.logger
.error("Exception getting net status: %s", str(e
))
1136 net
["status"] = "VIM_ERROR"
1137 net
["error_msg"] = str(e
)
1138 net_dict
[net_id
] = net
1141 def get_flavor(self
, flavor_id
):
1142 """Obtain flavor details from the VIM. Returns the flavor dict details"""
1143 self
.logger
.debug("Getting flavor '%s'", flavor_id
)
1146 self
._reload
_connection
()
1147 flavor
= self
.nova
.flavors
.find(id=flavor_id
)
1148 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
1150 return flavor
.to_dict()
1152 nvExceptions
.NotFound
,
1153 nvExceptions
.ClientException
,
1154 ksExceptions
.ClientException
,
1157 self
._format
_exception
(e
)
1159 def get_flavor_id_from_data(self
, flavor_dict
):
1160 """Obtain flavor id that match the flavor description
1161 Returns the flavor_id or raises a vimconnNotFoundException
1162 flavor_dict: contains the required ram, vcpus, disk
1163 If 'use_existing_flavors' is set to True at config, the closer flavor that provides same or more ram, vcpus
1164 and disk is returned. Otherwise a flavor with exactly same ram, vcpus and disk is returned or a
1165 vimconnNotFoundException is raised
1167 exact_match
= False if self
.config
.get("use_existing_flavors") else True
1170 self
._reload
_connection
()
1171 flavor_candidate_id
= None
1172 flavor_candidate_data
= (10000, 10000, 10000)
1175 flavor_dict
["vcpus"],
1176 flavor_dict
["disk"],
1177 flavor_dict
.get("ephemeral", 0),
1178 flavor_dict
.get("swap", 0),
1181 extended
= flavor_dict
.get("extended", {})
1184 raise vimconn
.VimConnNotFoundException(
1185 "Flavor with EPA still not implemented"
1187 # if len(numas) > 1:
1188 # raise vimconn.VimConnNotFoundException("Cannot find any flavor with more than one numa")
1190 # numas = extended.get("numas")
1191 for flavor
in self
.nova
.flavors
.list():
1192 epa
= flavor
.get_keys()
1203 flavor
.swap
if isinstance(flavor
.swap
, int) else 0,
1205 if flavor_data
== flavor_target
:
1209 and flavor_target
< flavor_data
< flavor_candidate_data
1211 flavor_candidate_id
= flavor
.id
1212 flavor_candidate_data
= flavor_data
1214 if not exact_match
and flavor_candidate_id
:
1215 return flavor_candidate_id
1217 raise vimconn
.VimConnNotFoundException(
1218 "Cannot find any flavor matching '{}'".format(flavor_dict
)
1221 nvExceptions
.NotFound
,
1222 nvExceptions
.ClientException
,
1223 ksExceptions
.ClientException
,
1226 self
._format
_exception
(e
)
1228 def process_resource_quota(self
, quota
, prefix
, extra_specs
):
1234 if "limit" in quota
:
1235 extra_specs
["quota:" + prefix
+ "_limit"] = quota
["limit"]
1237 if "reserve" in quota
:
1238 extra_specs
["quota:" + prefix
+ "_reservation"] = quota
["reserve"]
1240 if "shares" in quota
:
1241 extra_specs
["quota:" + prefix
+ "_shares_level"] = "custom"
1242 extra_specs
["quota:" + prefix
+ "_shares_share"] = quota
["shares"]
1244 def new_flavor(self
, flavor_data
, change_name_if_used
=True):
1245 """Adds a tenant flavor to openstack VIM
1246 if change_name_if_used is True, it will change name in case of conflict, because it is not supported name
1248 Returns the flavor identifier
1250 self
.logger
.debug("Adding flavor '%s'", str(flavor_data
))
1256 name
= flavor_data
["name"]
1257 while retry
< max_retries
:
1260 self
._reload
_connection
()
1262 if change_name_if_used
:
1265 fl
= self
.nova
.flavors
.list()
1268 fl_names
.append(f
.name
)
1270 while name
in fl_names
:
1272 name
= flavor_data
["name"] + "-" + str(name_suffix
)
1274 ram
= flavor_data
.get("ram", 64)
1275 vcpus
= flavor_data
.get("vcpus", 1)
1278 extended
= flavor_data
.get("extended")
1280 numas
= extended
.get("numas")
1283 numa_nodes
= len(numas
)
1286 return -1, "Can not add flavor with more than one numa"
1288 extra_specs
["hw:numa_nodes"] = str(numa_nodes
)
1289 extra_specs
["hw:mem_page_size"] = "large"
1290 extra_specs
["hw:cpu_policy"] = "dedicated"
1291 extra_specs
["hw:numa_mempolicy"] = "strict"
1293 if self
.vim_type
== "VIO":
1295 "vmware:extra_config"
1296 ] = '{"numa.nodeAffinity":"0"}'
1297 extra_specs
["vmware:latency_sensitivity_level"] = "high"
1300 # overwrite ram and vcpus
1301 # check if key "memory" is present in numa else use ram value at flavor
1302 if "memory" in numa
:
1303 ram
= numa
["memory"] * 1024
1304 # See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/
1305 # implemented/virt-driver-cpu-thread-pinning.html
1306 extra_specs
["hw:cpu_sockets"] = 1
1308 if "paired-threads" in numa
:
1309 vcpus
= numa
["paired-threads"] * 2
1310 # cpu_thread_policy "require" implies that the compute node must have an
1312 extra_specs
["hw:cpu_thread_policy"] = "require"
1313 extra_specs
["hw:cpu_policy"] = "dedicated"
1314 elif "cores" in numa
:
1315 vcpus
= numa
["cores"]
1316 # cpu_thread_policy "prefer" implies that the host must not have an SMT
1317 # architecture, or a non-SMT architecture will be emulated
1318 extra_specs
["hw:cpu_thread_policy"] = "isolate"
1319 extra_specs
["hw:cpu_policy"] = "dedicated"
1320 elif "threads" in numa
:
1321 vcpus
= numa
["threads"]
1322 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT
1324 extra_specs
["hw:cpu_thread_policy"] = "prefer"
1325 extra_specs
["hw:cpu_policy"] = "dedicated"
1326 # for interface in numa.get("interfaces",() ):
1327 # if interface["dedicated"]=="yes":
1328 # raise vimconn.VimConnException("Passthrough interfaces are not supported
1329 # for the openstack connector", http_code=vimconn.HTTP_Service_Unavailable)
1330 # #TODO, add the key 'pci_passthrough:alias"="<label at config>:<number ifaces>"'
1331 # when a way to connect it is available
1332 elif extended
.get("cpu-quota"):
1333 self
.process_resource_quota(
1334 extended
.get("cpu-quota"), "cpu", extra_specs
1337 if extended
.get("mem-quota"):
1338 self
.process_resource_quota(
1339 extended
.get("mem-quota"), "memory", extra_specs
1342 if extended
.get("vif-quota"):
1343 self
.process_resource_quota(
1344 extended
.get("vif-quota"), "vif", extra_specs
1347 if extended
.get("disk-io-quota"):
1348 self
.process_resource_quota(
1349 extended
.get("disk-io-quota"), "disk_io", extra_specs
1352 # Set the mempage size as specified in the descriptor
1353 if extended
.get("mempage-size"):
1354 if extended
.get("mempage-size") == "LARGE":
1355 extra_specs
["hw:mem_page_size"] = "large"
1356 elif extended
.get("mempage-size") == "SMALL":
1357 extra_specs
["hw:mem_page_size"] = "small"
1358 elif extended
.get("mempage-size") == "SIZE_2MB":
1359 extra_specs
["hw:mem_page_size"] = "2MB"
1360 elif extended
.get("mempage-size") == "SIZE_1GB":
1361 extra_specs
["hw:mem_page_size"] = "1GB"
1362 elif extended
.get("mempage-size") == "PREFER_LARGE":
1363 extra_specs
["hw:mem_page_size"] = "any"
1365 # The validations in NBI should make reaching here not possible.
1366 # If this message is shown, check validations
1368 "Invalid mempage-size %s. Will be ignored",
1369 extended
.get("mempage-size"),
1373 new_flavor
= self
.nova
.flavors
.create(
1377 disk
=flavor_data
.get("disk", 0),
1378 ephemeral
=flavor_data
.get("ephemeral", 0),
1379 swap
=flavor_data
.get("swap", 0),
1380 is_public
=flavor_data
.get("is_public", True),
1384 new_flavor
.set_keys(extra_specs
)
1386 return new_flavor
.id
1387 except nvExceptions
.Conflict
as e
:
1388 if change_name_if_used
and retry
< max_retries
:
1391 self
._format
_exception
(e
)
1392 # except nvExceptions.BadRequest as e:
1394 ksExceptions
.ClientException
,
1395 nvExceptions
.ClientException
,
1399 self
._format
_exception
(e
)
1401 def delete_flavor(self
, flavor_id
):
1402 """Deletes a tenant flavor from openstack VIM. Returns the old flavor_id"""
1404 self
._reload
_connection
()
1405 self
.nova
.flavors
.delete(flavor_id
)
1408 # except nvExceptions.BadRequest as e:
1410 nvExceptions
.NotFound
,
1411 ksExceptions
.ClientException
,
1412 nvExceptions
.ClientException
,
1415 self
._format
_exception
(e
)
1417 def new_image(self
, image_dict
):
1419 Adds a tenant image to VIM. imge_dict is a dictionary with:
1421 disk_format: qcow2, vhd, vmdk, raw (by default), ...
1422 location: path or URI
1423 public: "yes" or "no"
1424 metadata: metadata of the image
1425 Returns the image_id
1430 while retry
< max_retries
:
1433 self
._reload
_connection
()
1435 # determine format http://docs.openstack.org/developer/glance/formats.html
1436 if "disk_format" in image_dict
:
1437 disk_format
= image_dict
["disk_format"]
1438 else: # autodiscover based on extension
1439 if image_dict
["location"].endswith(".qcow2"):
1440 disk_format
= "qcow2"
1441 elif image_dict
["location"].endswith(".vhd"):
1443 elif image_dict
["location"].endswith(".vmdk"):
1444 disk_format
= "vmdk"
1445 elif image_dict
["location"].endswith(".vdi"):
1447 elif image_dict
["location"].endswith(".iso"):
1449 elif image_dict
["location"].endswith(".aki"):
1451 elif image_dict
["location"].endswith(".ari"):
1453 elif image_dict
["location"].endswith(".ami"):
1459 "new_image: '%s' loading from '%s'",
1461 image_dict
["location"],
1463 if self
.vim_type
== "VIO":
1464 container_format
= "bare"
1465 if "container_format" in image_dict
:
1466 container_format
= image_dict
["container_format"]
1468 new_image
= self
.glance
.images
.create(
1469 name
=image_dict
["name"],
1470 container_format
=container_format
,
1471 disk_format
=disk_format
,
1474 new_image
= self
.glance
.images
.create(name
=image_dict
["name"])
1476 if image_dict
["location"].startswith("http"):
1477 # TODO there is not a method to direct download. It must be downloaded locally with requests
1478 raise vimconn
.VimConnNotImplemented("Cannot create image from URL")
1480 with
open(image_dict
["location"]) as fimage
:
1481 self
.glance
.images
.upload(new_image
.id, fimage
)
1482 # new_image = self.glancev1.images.create(name=image_dict["name"], is_public=
1483 # image_dict.get("public","yes")=="yes",
1484 # container_format="bare", data=fimage, disk_format=disk_format)
1486 metadata_to_load
= image_dict
.get("metadata")
1488 # TODO location is a reserved word for current openstack versions. fixed for VIO please check
1490 if self
.vim_type
== "VIO":
1491 metadata_to_load
["upload_location"] = image_dict
["location"]
1493 metadata_to_load
["location"] = image_dict
["location"]
1495 self
.glance
.images
.update(new_image
.id, **metadata_to_load
)
1499 nvExceptions
.Conflict
,
1500 ksExceptions
.ClientException
,
1501 nvExceptions
.ClientException
,
1503 self
._format
_exception
(e
)
1506 gl1Exceptions
.HTTPException
,
1507 gl1Exceptions
.CommunicationError
,
1510 if retry
== max_retries
:
1513 self
._format
_exception
(e
)
1514 except IOError as e
: # can not open the file
1515 raise vimconn
.VimConnConnectionException(
1516 "{}: {} for {}".format(type(e
).__name
__, e
, image_dict
["location"]),
1517 http_code
=vimconn
.HTTP_Bad_Request
,
1520 def delete_image(self
, image_id
):
1521 """Deletes a tenant image from openstack VIM. Returns the old id"""
1523 self
._reload
_connection
()
1524 self
.glance
.images
.delete(image_id
)
1528 nvExceptions
.NotFound
,
1529 ksExceptions
.ClientException
,
1530 nvExceptions
.ClientException
,
1531 gl1Exceptions
.CommunicationError
,
1532 gl1Exceptions
.HTTPNotFound
,
1534 ) as e
: # TODO remove
1535 self
._format
_exception
(e
)
1537 def get_image_id_from_path(self
, path
):
1538 """Get the image id from image path in the VIM database. Returns the image_id"""
1540 self
._reload
_connection
()
1541 images
= self
.glance
.images
.list()
1543 for image
in images
:
1544 if image
.metadata
.get("location") == path
:
1547 raise vimconn
.VimConnNotFoundException(
1548 "image with location '{}' not found".format(path
)
1551 ksExceptions
.ClientException
,
1552 nvExceptions
.ClientException
,
1553 gl1Exceptions
.CommunicationError
,
1556 self
._format
_exception
(e
)
1558 def get_image_list(self
, filter_dict
={}):
1559 """Obtain tenant images from VIM
1563 checksum: image checksum
1564 Returns the image list of dictionaries:
1565 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1568 self
.logger
.debug("Getting image list from VIM filter: '%s'", str(filter_dict
))
1571 self
._reload
_connection
()
1572 # filter_dict_os = filter_dict.copy()
1573 # First we filter by the available filter fields: name, id. The others are removed.
1574 image_list
= self
.glance
.images
.list()
1577 for image
in image_list
:
1579 if filter_dict
.get("name") and image
["name"] != filter_dict
["name"]:
1582 if filter_dict
.get("id") and image
["id"] != filter_dict
["id"]:
1586 filter_dict
.get("checksum")
1587 and image
["checksum"] != filter_dict
["checksum"]
1591 filtered_list
.append(image
.copy())
1592 except gl1Exceptions
.HTTPNotFound
:
1595 return filtered_list
1597 ksExceptions
.ClientException
,
1598 nvExceptions
.ClientException
,
1599 gl1Exceptions
.CommunicationError
,
1602 self
._format
_exception
(e
)
1604 def __wait_for_vm(self
, vm_id
, status
):
1605 """wait until vm is in the desired status and return True.
1606 If the VM gets in ERROR status, return false.
1607 If the timeout is reached generate an exception"""
1609 while elapsed_time
< server_timeout
:
1610 vm_status
= self
.nova
.servers
.get(vm_id
).status
1612 if vm_status
== status
:
1615 if vm_status
== "ERROR":
1621 # if we exceeded the timeout rollback
1622 if elapsed_time
>= server_timeout
:
1623 raise vimconn
.VimConnException(
1624 "Timeout waiting for instance " + vm_id
+ " to get " + status
,
1625 http_code
=vimconn
.HTTP_Request_Timeout
,
1628 def _get_openstack_availablity_zones(self
):
1630 Get from openstack availability zones available
1634 openstack_availability_zone
= self
.nova
.availability_zones
.list()
1635 openstack_availability_zone
= [
1637 for zone
in openstack_availability_zone
1638 if zone
.zoneName
!= "internal"
1641 return openstack_availability_zone
1645 def _set_availablity_zones(self
):
1647 Set vim availablity zone
1650 if "availability_zone" in self
.config
:
1651 vim_availability_zones
= self
.config
.get("availability_zone")
1653 if isinstance(vim_availability_zones
, str):
1654 self
.availability_zone
= [vim_availability_zones
]
1655 elif isinstance(vim_availability_zones
, list):
1656 self
.availability_zone
= vim_availability_zones
1658 self
.availability_zone
= self
._get
_openstack
_availablity
_zones
()
1660 def _get_vm_availability_zone(
1661 self
, availability_zone_index
, availability_zone_list
1664 Return thge availability zone to be used by the created VM.
1665 :return: The VIM availability zone to be used or None
1667 if availability_zone_index
is None:
1668 if not self
.config
.get("availability_zone"):
1670 elif isinstance(self
.config
.get("availability_zone"), str):
1671 return self
.config
["availability_zone"]
1673 # TODO consider using a different parameter at config for default AV and AV list match
1674 return self
.config
["availability_zone"][0]
1676 vim_availability_zones
= self
.availability_zone
1677 # check if VIM offer enough availability zones describe in the VNFD
1678 if vim_availability_zones
and len(availability_zone_list
) <= len(
1679 vim_availability_zones
1681 # check if all the names of NFV AV match VIM AV names
1682 match_by_index
= False
1683 for av
in availability_zone_list
:
1684 if av
not in vim_availability_zones
:
1685 match_by_index
= True
1689 return vim_availability_zones
[availability_zone_index
]
1691 return availability_zone_list
[availability_zone_index
]
1693 raise vimconn
.VimConnConflictException(
1694 "No enough availability zones at VIM for this deployment"
1704 affinity_group_list
,
1708 availability_zone_index
=None,
1709 availability_zone_list
=None,
1711 """Adds a VM instance to VIM
1713 start: indicates if VM must start or boot in pause mode. Ignored
1714 image_id,flavor_id: image and flavor uuid
1715 affinity_group_list: list of affinity groups, each one is a dictionary.
1717 net_list: list of interfaces, each one is a dictionary with:
1719 net_id: network uuid to connect
1720 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
1721 model: interface model, ignored #TODO
1722 mac_address: used for SR-IOV ifaces #TODO for other types
1723 use: 'data', 'bridge', 'mgmt'
1724 type: 'virtual', 'PCI-PASSTHROUGH'('PF'), 'SR-IOV'('VF'), 'VFnotShared'
1725 vim_id: filled/added by this function
1726 floating_ip: True/False (or it can be None)
1727 port_security: True/False
1728 'cloud_config': (optional) dictionary with:
1729 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
1730 'users': (optional) list of users to be inserted, each item is a dict with:
1731 'name': (mandatory) user name,
1732 'key-pairs': (optional) list of strings with the public key to be inserted to the user
1733 'user-data': (optional) string is a text script to be passed directly to cloud-init
1734 'config-files': (optional). List of files to be transferred. Each item is a dict with:
1735 'dest': (mandatory) string with the destination absolute path
1736 'encoding': (optional, by default text). Can be one of:
1737 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
1738 'content' (mandatory): string with the content of the file
1739 'permissions': (optional) string with file permissions, typically octal notation '0644'
1740 'owner': (optional) file owner, string with the format 'owner:group'
1741 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
1742 'disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
1743 'image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
1744 'size': (mandatory) string with the size of the disk in GB
1745 'vim_id' (optional) should use this existing volume id
1746 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
1747 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
1748 availability_zone_index is None
1749 #TODO ip, security groups
1750 Returns a tuple with the instance identifier and created_items or raises an exception on error
1751 created_items can be None or a dictionary where this method can include key-values that will be passed to
1752 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
1753 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
1757 "new_vminstance input: image='%s' flavor='%s' nics='%s'",
1768 external_network
= []
1769 # ^list of external networks to be connected to instance, later on used to create floating_ip
1770 no_secured_ports
= [] # List of port-is with port-security disabled
1771 self
._reload
_connection
()
1772 # metadata_vpci = {} # For a specific neutron plugin
1773 block_device_mapping
= None
1775 for net
in net_list
:
1776 if not net
.get("net_id"): # skip non connected iface
1780 "network_id": net
["net_id"],
1781 "name": net
.get("name"),
1782 "admin_state_up": True,
1786 self
.config
.get("security_groups")
1787 and net
.get("port_security") is not False
1788 and not self
.config
.get("no_port_security_extension")
1790 if not self
.security_groups_id
:
1791 self
._get
_ids
_from
_name
()
1793 port_dict
["security_groups"] = self
.security_groups_id
1795 if net
["type"] == "virtual":
1798 # metadata_vpci[ net["net_id"] ] = [[ net["vpci"], "" ]]
1799 elif net
["type"] == "VF" or net
["type"] == "SR-IOV": # for VF
1801 # if "VF" not in metadata_vpci:
1802 # metadata_vpci["VF"]=[]
1803 # metadata_vpci["VF"].append([ net["vpci"], "" ])
1804 port_dict
["binding:vnic_type"] = "direct"
1806 # VIO specific Changes
1807 if self
.vim_type
== "VIO":
1808 # Need to create port with port_security_enabled = False and no-security-groups
1809 port_dict
["port_security_enabled"] = False
1810 port_dict
["provider_security_groups"] = []
1811 port_dict
["security_groups"] = []
1812 else: # For PT PCI-PASSTHROUGH
1814 # if "PF" not in metadata_vpci:
1815 # metadata_vpci["PF"]=[]
1816 # metadata_vpci["PF"].append([ net["vpci"], "" ])
1817 port_dict
["binding:vnic_type"] = "direct-physical"
1819 if not port_dict
["name"]:
1820 port_dict
["name"] = name
1822 if net
.get("mac_address"):
1823 port_dict
["mac_address"] = net
["mac_address"]
1825 if net
.get("ip_address"):
1826 port_dict
["fixed_ips"] = [{"ip_address": net
["ip_address"]}]
1827 # TODO add "subnet_id": <subnet_id>
1829 new_port
= self
.neutron
.create_port({"port": port_dict
})
1830 created_items
["port:" + str(new_port
["port"]["id"])] = True
1831 net
["mac_adress"] = new_port
["port"]["mac_address"]
1832 net
["vim_id"] = new_port
["port"]["id"]
1833 # if try to use a network without subnetwork, it will return a emtpy list
1834 fixed_ips
= new_port
["port"].get("fixed_ips")
1837 net
["ip"] = fixed_ips
[0].get("ip_address")
1841 port
= {"port-id": new_port
["port"]["id"]}
1842 if float(self
.nova
.api_version
.get_string()) >= 2.32:
1843 port
["tag"] = new_port
["port"]["name"]
1845 net_list_vim
.append(port
)
1847 if net
.get("floating_ip", False):
1848 net
["exit_on_floating_ip_error"] = True
1849 external_network
.append(net
)
1850 elif net
["use"] == "mgmt" and self
.config
.get("use_floating_ip"):
1851 net
["exit_on_floating_ip_error"] = False
1852 external_network
.append(net
)
1853 net
["floating_ip"] = self
.config
.get("use_floating_ip")
1855 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic
1857 # As a workaround we wait until the VM is active and then disable the port-security
1858 if net
.get("port_security") is False and not self
.config
.get(
1859 "no_port_security_extension"
1861 no_secured_ports
.append(
1863 new_port
["port"]["id"],
1864 net
.get("port_security_disable_strategy"),
1869 # metadata = {"pci_assignement": json.dumps(metadata_vpci)}
1870 # if len(metadata["pci_assignement"]) >255:
1871 # #limit the metadata size
1872 # #metadata["pci_assignement"] = metadata["pci_assignement"][0:255]
1873 # self.logger.warn("Metadata deleted since it exceeds the expected length (255) ")
1877 "name '%s' image_id '%s'flavor_id '%s' net_list_vim '%s' description '%s'",
1886 config_drive
, userdata
= self
._create
_user
_data
(cloud_config
)
1888 # get availability Zone
1889 vm_av_zone
= self
._get
_vm
_availability
_zone
(
1890 availability_zone_index
, availability_zone_list
1893 # Create additional volumes in case these are present in disk_list
1894 base_disk_index
= ord("b")
1895 boot_volume_id
= None
1897 block_device_mapping
= {}
1898 for disk
in disk_list
:
1899 if disk
.get("vim_id"):
1900 block_device_mapping
["_vd" + chr(base_disk_index
)] = disk
[
1904 if "image_id" in disk
:
1905 base_disk_index
= ord("a")
1906 volume
= self
.cinder
.volumes
.create(
1908 name
=name
+ "_vd" + chr(base_disk_index
),
1909 imageRef
=disk
["image_id"],
1910 # Make sure volume is in the same AZ as the VM to be attached to
1911 availability_zone
=vm_av_zone
,
1913 boot_volume_id
= volume
.id
1915 volume
= self
.cinder
.volumes
.create(
1917 name
=name
+ "_vd" + chr(base_disk_index
),
1918 # Make sure volume is in the same AZ as the VM to be attached to
1919 availability_zone
=vm_av_zone
,
1922 created_items
["volume:" + str(volume
.id)] = True
1923 block_device_mapping
["_vd" + chr(base_disk_index
)] = volume
.id
1925 base_disk_index
+= 1
1927 # Wait until created volumes are with status available
1929 while elapsed_time
< volume_timeout
:
1930 for created_item
in created_items
:
1931 v
, _
, volume_id
= created_item
.partition(":")
1933 if self
.cinder
.volumes
.get(volume_id
).status
!= "available":
1935 else: # all ready: break from while
1941 # If we exceeded the timeout rollback
1942 if elapsed_time
>= volume_timeout
:
1943 raise vimconn
.VimConnException(
1944 "Timeout creating volumes for instance " + name
,
1945 http_code
=vimconn
.HTTP_Request_Timeout
,
1948 self
.cinder
.volumes
.set_bootable(boot_volume_id
, True)
1950 # Manage affinity groups/server groups
1951 server_group_id
= None
1952 scheduller_hints
= {}
1954 if affinity_group_list
:
1955 # Only first id on the list will be used. Openstack restriction
1956 server_group_id
= affinity_group_list
[0]["affinity_group_id"]
1957 scheduller_hints
["group"] = server_group_id
1960 "nova.servers.create({}, {}, {}, nics={}, security_groups={}, "
1961 "availability_zone={}, key_name={}, userdata={}, config_drive={}, "
1962 "block_device_mapping={}, server_group={})".format(
1967 self
.config
.get("security_groups"),
1969 self
.config
.get("keypair"),
1972 block_device_mapping
,
1976 server
= self
.nova
.servers
.create(
1981 security_groups
=self
.config
.get("security_groups"),
1982 # TODO remove security_groups in future versions. Already at neutron port
1983 availability_zone
=vm_av_zone
,
1984 key_name
=self
.config
.get("keypair"),
1986 config_drive
=config_drive
,
1987 block_device_mapping
=block_device_mapping
,
1988 scheduler_hints
=scheduller_hints
,
1989 ) # , description=description)
1991 vm_start_time
= time
.time()
1992 # Previously mentioned workaround to wait until the VM is active and then disable the port-security
1993 if no_secured_ports
:
1994 self
.__wait
_for
_vm
(server
.id, "ACTIVE")
1996 for port
in no_secured_ports
:
1998 "port": {"port_security_enabled": False, "security_groups": None}
2001 if port
[1] == "allow-address-pairs":
2003 "port": {"allowed_address_pairs": [{"ip_address": "0.0.0.0/0"}]}
2007 self
.neutron
.update_port(port
[0], port_update
)
2009 raise vimconn
.VimConnException(
2010 "It was not possible to disable port security for port {}".format(
2015 # print "DONE :-)", server
2018 for floating_network
in external_network
:
2021 floating_ip_retries
= 3
2022 # In case of RO in HA there can be conflicts, two RO trying to assign same floating IP, so retry
2025 floating_ips
= self
.neutron
.list_floatingips().get(
2028 random
.shuffle(floating_ips
) # randomize
2029 for fip
in floating_ips
:
2032 or fip
.get("tenant_id") != server
.tenant_id
2036 if isinstance(floating_network
["floating_ip"], str):
2038 fip
.get("floating_network_id")
2039 != floating_network
["floating_ip"]
2043 free_floating_ip
= fip
["id"]
2047 isinstance(floating_network
["floating_ip"], str)
2048 and floating_network
["floating_ip"].lower() != "true"
2050 pool_id
= floating_network
["floating_ip"]
2052 # Find the external network
2053 external_nets
= list()
2055 for net
in self
.neutron
.list_networks()["networks"]:
2056 if net
["router:external"]:
2057 external_nets
.append(net
)
2059 if len(external_nets
) == 0:
2060 raise vimconn
.VimConnException(
2061 "Cannot create floating_ip automatically since "
2062 "no external network is present",
2063 http_code
=vimconn
.HTTP_Conflict
,
2066 if len(external_nets
) > 1:
2067 raise vimconn
.VimConnException(
2068 "Cannot create floating_ip automatically since "
2069 "multiple external networks are present",
2070 http_code
=vimconn
.HTTP_Conflict
,
2073 pool_id
= external_nets
[0].get("id")
2077 "floating_network_id": pool_id
,
2078 "tenant_id": server
.tenant_id
,
2083 # self.logger.debug("Creating floating IP")
2084 new_floating_ip
= self
.neutron
.create_floatingip(param
)
2085 free_floating_ip
= new_floating_ip
["floatingip"]["id"]
2087 "floating_ip:" + str(free_floating_ip
)
2089 except Exception as e
:
2090 raise vimconn
.VimConnException(
2092 + ": Cannot create new floating_ip "
2094 http_code
=vimconn
.HTTP_Conflict
,
2098 # for race condition ensure not already assigned
2099 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2101 if fip
["floatingip"]["port_id"]:
2104 # the vim_id key contains the neutron.port_id
2105 self
.neutron
.update_floatingip(
2107 {"floatingip": {"port_id": floating_network
["vim_id"]}},
2109 # for race condition ensure not re-assigned to other VM after 5 seconds
2111 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2114 fip
["floatingip"]["port_id"]
2115 != floating_network
["vim_id"]
2118 "floating_ip {} re-assigned to other port".format(
2125 "Assigned floating_ip {} to VM {}".format(
2126 free_floating_ip
, server
.id
2130 except Exception as e
:
2131 # openstack need some time after VM creation to assign an IP. So retry if fails
2132 vm_status
= self
.nova
.servers
.get(server
.id).status
2134 if vm_status
not in ("ACTIVE", "ERROR"):
2135 if time
.time() - vm_start_time
< server_timeout
:
2138 elif floating_ip_retries
> 0:
2139 floating_ip_retries
-= 1
2142 raise vimconn
.VimConnException(
2143 "Cannot create floating_ip: {} {}".format(
2146 http_code
=vimconn
.HTTP_Conflict
,
2149 except Exception as e
:
2150 if not floating_network
["exit_on_floating_ip_error"]:
2151 self
.logger
.error("Cannot create floating_ip. %s", str(e
))
2156 return server
.id, created_items
2157 # except nvExceptions.NotFound as e:
2158 # error_value=-vimconn.HTTP_Not_Found
2159 # error_text= "vm instance %s not found" % vm_id
2160 # except TypeError as e:
2161 # raise vimconn.VimConnException(type(e).__name__ + ": "+ str(e), http_code=vimconn.HTTP_Bad_Request)
2163 except Exception as e
:
2166 server_id
= server
.id
2169 self
.delete_vminstance(server_id
, created_items
)
2170 except Exception as e2
:
2171 self
.logger
.error("new_vminstance rollback fail {}".format(e2
))
2173 self
._format
_exception
(e
)
2175 def get_vminstance(self
, vm_id
):
2176 """Returns the VM instance information from VIM"""
2177 # self.logger.debug("Getting VM from VIM")
2179 self
._reload
_connection
()
2180 server
= self
.nova
.servers
.find(id=vm_id
)
2181 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
2183 return server
.to_dict()
2185 ksExceptions
.ClientException
,
2186 nvExceptions
.ClientException
,
2187 nvExceptions
.NotFound
,
2190 self
._format
_exception
(e
)
2192 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
2194 Get a console for the virtual machine
2196 vm_id: uuid of the VM
2197 console_type, can be:
2198 "novnc" (by default), "xvpvnc" for VNC types,
2199 "rdp-html5" for RDP types, "spice-html5" for SPICE types
2200 Returns dict with the console parameters:
2201 protocol: ssh, ftp, http, https, ...
2202 server: usually ip address
2203 port: the http, ssh, ... port
2204 suffix: extra text, e.g. the http path and query string
2206 self
.logger
.debug("Getting VM CONSOLE from VIM")
2209 self
._reload
_connection
()
2210 server
= self
.nova
.servers
.find(id=vm_id
)
2212 if console_type
is None or console_type
== "novnc":
2213 console_dict
= server
.get_vnc_console("novnc")
2214 elif console_type
== "xvpvnc":
2215 console_dict
= server
.get_vnc_console(console_type
)
2216 elif console_type
== "rdp-html5":
2217 console_dict
= server
.get_rdp_console(console_type
)
2218 elif console_type
== "spice-html5":
2219 console_dict
= server
.get_spice_console(console_type
)
2221 raise vimconn
.VimConnException(
2222 "console type '{}' not allowed".format(console_type
),
2223 http_code
=vimconn
.HTTP_Bad_Request
,
2226 console_dict1
= console_dict
.get("console")
2229 console_url
= console_dict1
.get("url")
2233 protocol_index
= console_url
.find("//")
2235 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2238 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2243 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2245 -vimconn
.HTTP_Internal_Server_Error
,
2246 "Unexpected response from VIM",
2250 "protocol": console_url
[0:protocol_index
],
2251 "server": console_url
[protocol_index
+ 2 : port_index
],
2252 "port": console_url
[port_index
:suffix_index
],
2253 "suffix": console_url
[suffix_index
+ 1 :],
2258 raise vimconn
.VimConnUnexpectedResponse("Unexpected response from VIM")
2260 nvExceptions
.NotFound
,
2261 ksExceptions
.ClientException
,
2262 nvExceptions
.ClientException
,
2263 nvExceptions
.BadRequest
,
2266 self
._format
_exception
(e
)
2268 def delete_vminstance(self
, vm_id
, created_items
=None):
2269 """Removes a VM instance from VIM. Returns the old identifier"""
2270 # print "osconnector: Getting VM from VIM"
2271 if created_items
is None:
2275 self
._reload
_connection
()
2276 # delete VM ports attached to this networks before the virtual machine
2277 for k
, v
in created_items
.items():
2278 if not v
: # skip already deleted
2282 k_item
, _
, k_id
= k
.partition(":")
2283 if k_item
== "port":
2284 self
.neutron
.delete_port(k_id
)
2285 except Exception as e
:
2287 "Error deleting port: {}: {}".format(type(e
).__name
__, e
)
2290 # #commented because detaching the volumes makes the servers.delete not work properly ?!?
2291 # #dettach volumes attached
2292 # server = self.nova.servers.get(vm_id)
2293 # volumes_attached_dict = server._info["os-extended-volumes:volumes_attached"] #volume["id"]
2294 # #for volume in volumes_attached_dict:
2295 # # self.cinder.volumes.detach(volume["id"])
2298 self
.nova
.servers
.delete(vm_id
)
2300 # delete volumes. Although having detached, they should have in active status before deleting
2301 # we ensure in this loop
2305 while keep_waiting
and elapsed_time
< volume_timeout
:
2306 keep_waiting
= False
2308 for k
, v
in created_items
.items():
2309 if not v
: # skip already deleted
2313 k_item
, _
, k_id
= k
.partition(":")
2314 if k_item
== "volume":
2315 if self
.cinder
.volumes
.get(k_id
).status
!= "available":
2318 self
.cinder
.volumes
.delete(k_id
)
2319 created_items
[k
] = None
2320 elif k_item
== "floating_ip": # floating ip
2321 self
.neutron
.delete_floatingip(k_id
)
2322 created_items
[k
] = None
2324 except Exception as e
:
2325 self
.logger
.error("Error deleting {}: {}".format(k
, e
))
2333 nvExceptions
.NotFound
,
2334 ksExceptions
.ClientException
,
2335 nvExceptions
.ClientException
,
2338 self
._format
_exception
(e
)
2340 def refresh_vms_status(self
, vm_list
):
2341 """Get the status of the virtual machines and their interfaces/ports
2342 Params: the list of VM identifiers
2343 Returns a dictionary with:
2344 vm_id: #VIM id of this Virtual Machine
2345 status: #Mandatory. Text with one of:
2346 # DELETED (not found at vim)
2347 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2348 # OTHER (Vim reported other status not understood)
2349 # ERROR (VIM indicates an ERROR status)
2350 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
2351 # CREATING (on building process), ERROR
2352 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
2354 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2355 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2357 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2358 mac_address: #Text format XX:XX:XX:XX:XX:XX
2359 vim_net_id: #network id where this interface is connected
2360 vim_interface_id: #interface/port VIM id
2361 ip_address: #null, or text with IPv4, IPv6 address
2362 compute_node: #identification of compute node where PF,VF interface is allocated
2363 pci: #PCI address of the NIC that hosts the PF,VF
2364 vlan: #physical VLAN used for VF
2368 "refresh_vms status: Getting tenant VM instance information from VIM"
2371 for vm_id
in vm_list
:
2375 vm_vim
= self
.get_vminstance(vm_id
)
2377 if vm_vim
["status"] in vmStatus2manoFormat
:
2378 vm
["status"] = vmStatus2manoFormat
[vm_vim
["status"]]
2380 vm
["status"] = "OTHER"
2381 vm
["error_msg"] = "VIM status reported " + vm_vim
["status"]
2383 vm_vim
.pop("OS-EXT-SRV-ATTR:user_data", None)
2384 vm_vim
.pop("user_data", None)
2385 vm
["vim_info"] = self
.serialize(vm_vim
)
2387 vm
["interfaces"] = []
2388 if vm_vim
.get("fault"):
2389 vm
["error_msg"] = str(vm_vim
["fault"])
2393 self
._reload
_connection
()
2394 port_dict
= self
.neutron
.list_ports(device_id
=vm_id
)
2396 for port
in port_dict
["ports"]:
2398 interface
["vim_info"] = self
.serialize(port
)
2399 interface
["mac_address"] = port
.get("mac_address")
2400 interface
["vim_net_id"] = port
["network_id"]
2401 interface
["vim_interface_id"] = port
["id"]
2402 # check if OS-EXT-SRV-ATTR:host is there,
2403 # in case of non-admin credentials, it will be missing
2405 if vm_vim
.get("OS-EXT-SRV-ATTR:host"):
2406 interface
["compute_node"] = vm_vim
["OS-EXT-SRV-ATTR:host"]
2408 interface
["pci"] = None
2410 # check if binding:profile is there,
2411 # in case of non-admin credentials, it will be missing
2412 if port
.get("binding:profile"):
2413 if port
["binding:profile"].get("pci_slot"):
2414 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting
2416 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
2417 # CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2) assuming there are 2 ports per nic
2418 pci
= port
["binding:profile"]["pci_slot"]
2419 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
2420 interface
["pci"] = pci
2422 interface
["vlan"] = None
2424 if port
.get("binding:vif_details"):
2425 interface
["vlan"] = port
["binding:vif_details"].get("vlan")
2427 # Get vlan from network in case not present in port for those old openstacks and cases where
2428 # it is needed vlan at PT
2429 if not interface
["vlan"]:
2430 # if network is of type vlan and port is of type direct (sr-iov) then set vlan id
2431 network
= self
.neutron
.show_network(port
["network_id"])
2434 network
["network"].get("provider:network_type")
2437 # and port.get("binding:vnic_type") in ("direct", "direct-physical"):
2438 interface
["vlan"] = network
["network"].get(
2439 "provider:segmentation_id"
2443 # look for floating ip address
2445 floating_ip_dict
= self
.neutron
.list_floatingips(
2449 if floating_ip_dict
.get("floatingips"):
2451 floating_ip_dict
["floatingips"][0].get(
2452 "floating_ip_address"
2458 for subnet
in port
["fixed_ips"]:
2459 ips
.append(subnet
["ip_address"])
2461 interface
["ip_address"] = ";".join(ips
)
2462 vm
["interfaces"].append(interface
)
2463 except Exception as e
:
2465 "Error getting vm interface information {}: {}".format(
2470 except vimconn
.VimConnNotFoundException
as e
:
2471 self
.logger
.error("Exception getting vm status: %s", str(e
))
2472 vm
["status"] = "DELETED"
2473 vm
["error_msg"] = str(e
)
2474 except vimconn
.VimConnException
as e
:
2475 self
.logger
.error("Exception getting vm status: %s", str(e
))
2476 vm
["status"] = "VIM_ERROR"
2477 vm
["error_msg"] = str(e
)
2483 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
2484 """Send and action over a VM instance from VIM
2485 Returns None or the console dict if the action was successfully sent to the VIM"""
2486 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
2489 self
._reload
_connection
()
2490 server
= self
.nova
.servers
.find(id=vm_id
)
2492 if "start" in action_dict
:
2493 if action_dict
["start"] == "rebuild":
2496 if server
.status
== "PAUSED":
2498 elif server
.status
== "SUSPENDED":
2500 elif server
.status
== "SHUTOFF":
2502 elif "pause" in action_dict
:
2504 elif "resume" in action_dict
:
2506 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
2508 elif "forceOff" in action_dict
:
2509 server
.stop() # TODO
2510 elif "terminate" in action_dict
:
2512 elif "createImage" in action_dict
:
2513 server
.create_image()
2514 # "path":path_schema,
2515 # "description":description_schema,
2516 # "name":name_schema,
2517 # "metadata":metadata_schema,
2518 # "imageRef": id_schema,
2519 # "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
2520 elif "rebuild" in action_dict
:
2521 server
.rebuild(server
.image
["id"])
2522 elif "reboot" in action_dict
:
2523 server
.reboot() # reboot_type="SOFT"
2524 elif "console" in action_dict
:
2525 console_type
= action_dict
["console"]
2527 if console_type
is None or console_type
== "novnc":
2528 console_dict
= server
.get_vnc_console("novnc")
2529 elif console_type
== "xvpvnc":
2530 console_dict
= server
.get_vnc_console(console_type
)
2531 elif console_type
== "rdp-html5":
2532 console_dict
= server
.get_rdp_console(console_type
)
2533 elif console_type
== "spice-html5":
2534 console_dict
= server
.get_spice_console(console_type
)
2536 raise vimconn
.VimConnException(
2537 "console type '{}' not allowed".format(console_type
),
2538 http_code
=vimconn
.HTTP_Bad_Request
,
2542 console_url
= console_dict
["console"]["url"]
2544 protocol_index
= console_url
.find("//")
2546 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2549 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2554 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2555 raise vimconn
.VimConnException(
2556 "Unexpected response from VIM " + str(console_dict
)
2560 "protocol": console_url
[0:protocol_index
],
2561 "server": console_url
[protocol_index
+ 2 : port_index
],
2562 "port": int(console_url
[port_index
+ 1 : suffix_index
]),
2563 "suffix": console_url
[suffix_index
+ 1 :],
2566 return console_dict2
2568 raise vimconn
.VimConnException(
2569 "Unexpected response from VIM " + str(console_dict
)
2574 ksExceptions
.ClientException
,
2575 nvExceptions
.ClientException
,
2576 nvExceptions
.NotFound
,
2579 self
._format
_exception
(e
)
2580 # TODO insert exception vimconn.HTTP_Unauthorized
2582 # ###### VIO Specific Changes #########
2583 def _generate_vlanID(self
):
2585 Method to get unused vlanID
2593 networks
= self
.get_network_list()
2595 for net
in networks
:
2596 if net
.get("provider:segmentation_id"):
2597 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
2599 used_vlanIDs
= set(usedVlanIDs
)
2601 # find unused VLAN ID
2602 for vlanID_range
in self
.config
.get("dataplane_net_vlan_range"):
2604 start_vlanid
, end_vlanid
= map(
2605 int, vlanID_range
.replace(" ", "").split("-")
2608 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
2609 if vlanID
not in used_vlanIDs
:
2611 except Exception as exp
:
2612 raise vimconn
.VimConnException(
2613 "Exception {} occurred while generating VLAN ID.".format(exp
)
2616 raise vimconn
.VimConnConflictException(
2617 "Unable to create the SRIOV VLAN network. All given Vlan IDs {} are in use.".format(
2618 self
.config
.get("dataplane_net_vlan_range")
2622 def _generate_multisegment_vlanID(self
):
2624 Method to get unused vlanID
2632 networks
= self
.get_network_list()
2633 for net
in networks
:
2634 if net
.get("provider:network_type") == "vlan" and net
.get(
2635 "provider:segmentation_id"
2637 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
2638 elif net
.get("segments"):
2639 for segment
in net
.get("segments"):
2640 if segment
.get("provider:network_type") == "vlan" and segment
.get(
2641 "provider:segmentation_id"
2643 usedVlanIDs
.append(segment
.get("provider:segmentation_id"))
2645 used_vlanIDs
= set(usedVlanIDs
)
2647 # find unused VLAN ID
2648 for vlanID_range
in self
.config
.get("multisegment_vlan_range"):
2650 start_vlanid
, end_vlanid
= map(
2651 int, vlanID_range
.replace(" ", "").split("-")
2654 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
2655 if vlanID
not in used_vlanIDs
:
2657 except Exception as exp
:
2658 raise vimconn
.VimConnException(
2659 "Exception {} occurred while generating VLAN ID.".format(exp
)
2662 raise vimconn
.VimConnConflictException(
2663 "Unable to create the VLAN segment. All VLAN IDs {} are in use.".format(
2664 self
.config
.get("multisegment_vlan_range")
2668 def _validate_vlan_ranges(self
, input_vlan_range
, text_vlan_range
):
2670 Method to validate user given vlanID ranges
2674 for vlanID_range
in input_vlan_range
:
2675 vlan_range
= vlanID_range
.replace(" ", "")
2677 vlanID_pattern
= r
"(\d)*-(\d)*$"
2678 match_obj
= re
.match(vlanID_pattern
, vlan_range
)
2680 raise vimconn
.VimConnConflictException(
2681 "Invalid VLAN range for {}: {}.You must provide "
2682 "'{}' in format [start_ID - end_ID].".format(
2683 text_vlan_range
, vlanID_range
, text_vlan_range
2687 start_vlanid
, end_vlanid
= map(int, vlan_range
.split("-"))
2688 if start_vlanid
<= 0:
2689 raise vimconn
.VimConnConflictException(
2690 "Invalid VLAN range for {}: {}. Start ID can not be zero. For VLAN "
2691 "networks valid IDs are 1 to 4094 ".format(
2692 text_vlan_range
, vlanID_range
2696 if end_vlanid
> 4094:
2697 raise vimconn
.VimConnConflictException(
2698 "Invalid VLAN range for {}: {}. End VLAN ID can not be "
2699 "greater than 4094. For VLAN networks valid IDs are 1 to 4094 ".format(
2700 text_vlan_range
, vlanID_range
2704 if start_vlanid
> end_vlanid
:
2705 raise vimconn
.VimConnConflictException(
2706 "Invalid VLAN range for {}: {}. You must provide '{}'"
2707 " in format start_ID - end_ID and start_ID < end_ID ".format(
2708 text_vlan_range
, vlanID_range
, text_vlan_range
2712 # NOT USED FUNCTIONS
2714 def new_external_port(self
, port_data
):
2715 """Adds a external port to VIM
2716 Returns the port identifier"""
2717 # TODO openstack if needed
2719 -vimconn
.HTTP_Internal_Server_Error
,
2720 "osconnector.new_external_port() not implemented",
2723 def connect_port_network(self
, port_id
, network_id
, admin
=False):
2724 """Connects a external port to a network
2725 Returns status code of the VIM response"""
2726 # TODO openstack if needed
2728 -vimconn
.HTTP_Internal_Server_Error
,
2729 "osconnector.connect_port_network() not implemented",
2732 def new_user(self
, user_name
, user_passwd
, tenant_id
=None):
2733 """Adds a new user to openstack VIM
2734 Returns the user identifier"""
2735 self
.logger
.debug("osconnector: Adding a new user to VIM")
2738 self
._reload
_connection
()
2739 user
= self
.keystone
.users
.create(
2740 user_name
, password
=user_passwd
, default_project
=tenant_id
2742 # self.keystone.tenants.add_user(self.k_creds["username"], #role)
2745 except ksExceptions
.ConnectionError
as e
:
2746 error_value
= -vimconn
.HTTP_Bad_Request
2750 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2752 except ksExceptions
.ClientException
as e
: # TODO remove
2753 error_value
= -vimconn
.HTTP_Bad_Request
2757 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2760 # TODO insert exception vimconn.HTTP_Unauthorized
2761 # if reaching here is because an exception
2762 self
.logger
.debug("new_user " + error_text
)
2764 return error_value
, error_text
2766 def delete_user(self
, user_id
):
2767 """Delete a user from openstack VIM
2768 Returns the user identifier"""
2770 print("osconnector: Deleting a user from VIM")
2773 self
._reload
_connection
()
2774 self
.keystone
.users
.delete(user_id
)
2777 except ksExceptions
.ConnectionError
as e
:
2778 error_value
= -vimconn
.HTTP_Bad_Request
2782 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2784 except ksExceptions
.NotFound
as e
:
2785 error_value
= -vimconn
.HTTP_Not_Found
2789 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2791 except ksExceptions
.ClientException
as e
: # TODO remove
2792 error_value
= -vimconn
.HTTP_Bad_Request
2796 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2799 # TODO insert exception vimconn.HTTP_Unauthorized
2800 # if reaching here is because an exception
2801 self
.logger
.debug("delete_tenant " + error_text
)
2803 return error_value
, error_text
2805 def get_hosts_info(self
):
2806 """Get the information of deployed hosts
2807 Returns the hosts content"""
2809 print("osconnector: Getting Host info from VIM")
2813 self
._reload
_connection
()
2814 hypervisors
= self
.nova
.hypervisors
.list()
2816 for hype
in hypervisors
:
2817 h_list
.append(hype
.to_dict())
2819 return 1, {"hosts": h_list
}
2820 except nvExceptions
.NotFound
as e
:
2821 error_value
= -vimconn
.HTTP_Not_Found
2822 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
2823 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
2824 error_value
= -vimconn
.HTTP_Bad_Request
2828 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2831 # TODO insert exception vimconn.HTTP_Unauthorized
2832 # if reaching here is because an exception
2833 self
.logger
.debug("get_hosts_info " + error_text
)
2835 return error_value
, error_text
2837 def get_hosts(self
, vim_tenant
):
2838 """Get the hosts and deployed instances
2839 Returns the hosts content"""
2840 r
, hype_dict
= self
.get_hosts_info()
2845 hypervisors
= hype_dict
["hosts"]
2848 servers
= self
.nova
.servers
.list()
2849 for hype
in hypervisors
:
2850 for server
in servers
:
2852 server
.to_dict()["OS-EXT-SRV-ATTR:hypervisor_hostname"]
2853 == hype
["hypervisor_hostname"]
2856 hype
["vm"].append(server
.id)
2858 hype
["vm"] = [server
.id]
2861 except nvExceptions
.NotFound
as e
:
2862 error_value
= -vimconn
.HTTP_Not_Found
2863 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
2864 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
2865 error_value
= -vimconn
.HTTP_Bad_Request
2869 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2872 # TODO insert exception vimconn.HTTP_Unauthorized
2873 # if reaching here is because an exception
2874 self
.logger
.debug("get_hosts " + error_text
)
2876 return error_value
, error_text
2878 def new_classification(self
, name
, ctype
, definition
):
2880 "Adding a new (Traffic) Classification to VIM, named %s", name
2885 self
._reload
_connection
()
2887 if ctype
not in supportedClassificationTypes
:
2888 raise vimconn
.VimConnNotSupportedException(
2889 "OpenStack VIM connector does not support provided "
2890 "Classification Type {}, supported ones are: {}".format(
2891 ctype
, supportedClassificationTypes
2895 if not self
._validate
_classification
(ctype
, definition
):
2896 raise vimconn
.VimConnException(
2897 "Incorrect Classification definition for the type specified."
2900 classification_dict
= definition
2901 classification_dict
["name"] = name
2902 new_class
= self
.neutron
.create_sfc_flow_classifier(
2903 {"flow_classifier": classification_dict
}
2906 return new_class
["flow_classifier"]["id"]
2908 neExceptions
.ConnectionFailed
,
2909 ksExceptions
.ClientException
,
2910 neExceptions
.NeutronException
,
2913 self
.logger
.error("Creation of Classification failed.")
2914 self
._format
_exception
(e
)
2916 def get_classification(self
, class_id
):
2917 self
.logger
.debug(" Getting Classification %s from VIM", class_id
)
2918 filter_dict
= {"id": class_id
}
2919 class_list
= self
.get_classification_list(filter_dict
)
2921 if len(class_list
) == 0:
2922 raise vimconn
.VimConnNotFoundException(
2923 "Classification '{}' not found".format(class_id
)
2925 elif len(class_list
) > 1:
2926 raise vimconn
.VimConnConflictException(
2927 "Found more than one Classification with this criteria"
2930 classification
= class_list
[0]
2932 return classification
2934 def get_classification_list(self
, filter_dict
={}):
2936 "Getting Classifications from VIM filter: '%s'", str(filter_dict
)
2940 filter_dict_os
= filter_dict
.copy()
2941 self
._reload
_connection
()
2943 if self
.api_version3
and "tenant_id" in filter_dict_os
:
2944 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
2946 classification_dict
= self
.neutron
.list_sfc_flow_classifiers(
2949 classification_list
= classification_dict
["flow_classifiers"]
2950 self
.__classification
_os
2mano
(classification_list
)
2952 return classification_list
2954 neExceptions
.ConnectionFailed
,
2955 ksExceptions
.ClientException
,
2956 neExceptions
.NeutronException
,
2959 self
._format
_exception
(e
)
2961 def delete_classification(self
, class_id
):
2962 self
.logger
.debug("Deleting Classification '%s' from VIM", class_id
)
2965 self
._reload
_connection
()
2966 self
.neutron
.delete_sfc_flow_classifier(class_id
)
2970 neExceptions
.ConnectionFailed
,
2971 neExceptions
.NeutronException
,
2972 ksExceptions
.ClientException
,
2973 neExceptions
.NeutronException
,
2976 self
._format
_exception
(e
)
2978 def new_sfi(self
, name
, ingress_ports
, egress_ports
, sfc_encap
=True):
2980 "Adding a new Service Function Instance to VIM, named '%s'", name
2985 self
._reload
_connection
()
2991 if len(ingress_ports
) != 1:
2992 raise vimconn
.VimConnNotSupportedException(
2993 "OpenStack VIM connector can only have 1 ingress port per SFI"
2996 if len(egress_ports
) != 1:
2997 raise vimconn
.VimConnNotSupportedException(
2998 "OpenStack VIM connector can only have 1 egress port per SFI"
3003 "ingress": ingress_ports
[0],
3004 "egress": egress_ports
[0],
3005 "service_function_parameters": {"correlation": correlation
},
3007 new_sfi
= self
.neutron
.create_sfc_port_pair({"port_pair": sfi_dict
})
3009 return new_sfi
["port_pair"]["id"]
3011 neExceptions
.ConnectionFailed
,
3012 ksExceptions
.ClientException
,
3013 neExceptions
.NeutronException
,
3018 self
.neutron
.delete_sfc_port_pair(new_sfi
["port_pair"]["id"])
3021 "Creation of Service Function Instance failed, with "
3022 "subsequent deletion failure as well."
3025 self
._format
_exception
(e
)
3027 def get_sfi(self
, sfi_id
):
3028 self
.logger
.debug("Getting Service Function Instance %s from VIM", sfi_id
)
3029 filter_dict
= {"id": sfi_id
}
3030 sfi_list
= self
.get_sfi_list(filter_dict
)
3032 if len(sfi_list
) == 0:
3033 raise vimconn
.VimConnNotFoundException(
3034 "Service Function Instance '{}' not found".format(sfi_id
)
3036 elif len(sfi_list
) > 1:
3037 raise vimconn
.VimConnConflictException(
3038 "Found more than one Service Function Instance with this criteria"
3045 def get_sfi_list(self
, filter_dict
={}):
3047 "Getting Service Function Instances from VIM filter: '%s'", str(filter_dict
)
3051 self
._reload
_connection
()
3052 filter_dict_os
= filter_dict
.copy()
3054 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3055 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3057 sfi_dict
= self
.neutron
.list_sfc_port_pairs(**filter_dict_os
)
3058 sfi_list
= sfi_dict
["port_pairs"]
3059 self
.__sfi
_os
2mano
(sfi_list
)
3063 neExceptions
.ConnectionFailed
,
3064 ksExceptions
.ClientException
,
3065 neExceptions
.NeutronException
,
3068 self
._format
_exception
(e
)
3070 def delete_sfi(self
, sfi_id
):
3071 self
.logger
.debug("Deleting Service Function Instance '%s' from VIM", sfi_id
)
3074 self
._reload
_connection
()
3075 self
.neutron
.delete_sfc_port_pair(sfi_id
)
3079 neExceptions
.ConnectionFailed
,
3080 neExceptions
.NeutronException
,
3081 ksExceptions
.ClientException
,
3082 neExceptions
.NeutronException
,
3085 self
._format
_exception
(e
)
3087 def new_sf(self
, name
, sfis
, sfc_encap
=True):
3088 self
.logger
.debug("Adding a new Service Function to VIM, named '%s'", name
)
3092 self
._reload
_connection
()
3093 # correlation = None
3095 # correlation = "nsh"
3097 for instance
in sfis
:
3098 sfi
= self
.get_sfi(instance
)
3100 if sfi
.get("sfc_encap") != sfc_encap
:
3101 raise vimconn
.VimConnNotSupportedException(
3102 "OpenStack VIM connector requires all SFIs of the "
3103 "same SF to share the same SFC Encapsulation"
3106 sf_dict
= {"name": name
, "port_pairs": sfis
}
3107 new_sf
= self
.neutron
.create_sfc_port_pair_group(
3108 {"port_pair_group": sf_dict
}
3111 return new_sf
["port_pair_group"]["id"]
3113 neExceptions
.ConnectionFailed
,
3114 ksExceptions
.ClientException
,
3115 neExceptions
.NeutronException
,
3120 self
.neutron
.delete_sfc_port_pair_group(
3121 new_sf
["port_pair_group"]["id"]
3125 "Creation of Service Function failed, with "
3126 "subsequent deletion failure as well."
3129 self
._format
_exception
(e
)
3131 def get_sf(self
, sf_id
):
3132 self
.logger
.debug("Getting Service Function %s from VIM", sf_id
)
3133 filter_dict
= {"id": sf_id
}
3134 sf_list
= self
.get_sf_list(filter_dict
)
3136 if len(sf_list
) == 0:
3137 raise vimconn
.VimConnNotFoundException(
3138 "Service Function '{}' not found".format(sf_id
)
3140 elif len(sf_list
) > 1:
3141 raise vimconn
.VimConnConflictException(
3142 "Found more than one Service Function with this criteria"
3149 def get_sf_list(self
, filter_dict
={}):
3151 "Getting Service Function from VIM filter: '%s'", str(filter_dict
)
3155 self
._reload
_connection
()
3156 filter_dict_os
= filter_dict
.copy()
3158 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3159 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3161 sf_dict
= self
.neutron
.list_sfc_port_pair_groups(**filter_dict_os
)
3162 sf_list
= sf_dict
["port_pair_groups"]
3163 self
.__sf
_os
2mano
(sf_list
)
3167 neExceptions
.ConnectionFailed
,
3168 ksExceptions
.ClientException
,
3169 neExceptions
.NeutronException
,
3172 self
._format
_exception
(e
)
3174 def delete_sf(self
, sf_id
):
3175 self
.logger
.debug("Deleting Service Function '%s' from VIM", sf_id
)
3178 self
._reload
_connection
()
3179 self
.neutron
.delete_sfc_port_pair_group(sf_id
)
3183 neExceptions
.ConnectionFailed
,
3184 neExceptions
.NeutronException
,
3185 ksExceptions
.ClientException
,
3186 neExceptions
.NeutronException
,
3189 self
._format
_exception
(e
)
3191 def new_sfp(self
, name
, classifications
, sfs
, sfc_encap
=True, spi
=None):
3192 self
.logger
.debug("Adding a new Service Function Path to VIM, named '%s'", name
)
3196 self
._reload
_connection
()
3197 # In networking-sfc the MPLS encapsulation is legacy
3198 # should be used when no full SFC Encapsulation is intended
3199 correlation
= "mpls"
3206 "flow_classifiers": classifications
,
3207 "port_pair_groups": sfs
,
3208 "chain_parameters": {"correlation": correlation
},
3212 sfp_dict
["chain_id"] = spi
3214 new_sfp
= self
.neutron
.create_sfc_port_chain({"port_chain": sfp_dict
})
3216 return new_sfp
["port_chain"]["id"]
3218 neExceptions
.ConnectionFailed
,
3219 ksExceptions
.ClientException
,
3220 neExceptions
.NeutronException
,
3225 self
.neutron
.delete_sfc_port_chain(new_sfp
["port_chain"]["id"])
3228 "Creation of Service Function Path failed, with "
3229 "subsequent deletion failure as well."
3232 self
._format
_exception
(e
)
3234 def get_sfp(self
, sfp_id
):
3235 self
.logger
.debug(" Getting Service Function Path %s from VIM", sfp_id
)
3237 filter_dict
= {"id": sfp_id
}
3238 sfp_list
= self
.get_sfp_list(filter_dict
)
3240 if len(sfp_list
) == 0:
3241 raise vimconn
.VimConnNotFoundException(
3242 "Service Function Path '{}' not found".format(sfp_id
)
3244 elif len(sfp_list
) > 1:
3245 raise vimconn
.VimConnConflictException(
3246 "Found more than one Service Function Path with this criteria"
3253 def get_sfp_list(self
, filter_dict
={}):
3255 "Getting Service Function Paths from VIM filter: '%s'", str(filter_dict
)
3259 self
._reload
_connection
()
3260 filter_dict_os
= filter_dict
.copy()
3262 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3263 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3265 sfp_dict
= self
.neutron
.list_sfc_port_chains(**filter_dict_os
)
3266 sfp_list
= sfp_dict
["port_chains"]
3267 self
.__sfp
_os
2mano
(sfp_list
)
3271 neExceptions
.ConnectionFailed
,
3272 ksExceptions
.ClientException
,
3273 neExceptions
.NeutronException
,
3276 self
._format
_exception
(e
)
3278 def delete_sfp(self
, sfp_id
):
3279 self
.logger
.debug("Deleting Service Function Path '%s' from VIM", sfp_id
)
3282 self
._reload
_connection
()
3283 self
.neutron
.delete_sfc_port_chain(sfp_id
)
3287 neExceptions
.ConnectionFailed
,
3288 neExceptions
.NeutronException
,
3289 ksExceptions
.ClientException
,
3290 neExceptions
.NeutronException
,
3293 self
._format
_exception
(e
)
3295 def refresh_sfps_status(self
, sfp_list
):
3296 """Get the status of the service function path
3297 Params: the list of sfp identifiers
3298 Returns a dictionary with:
3299 vm_id: #VIM id of this service function path
3300 status: #Mandatory. Text with one of:
3301 # DELETED (not found at vim)
3302 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3303 # OTHER (Vim reported other status not understood)
3304 # ERROR (VIM indicates an ERROR status)
3306 # CREATING (on building process)
3307 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3308 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)F
3312 "refresh_sfps status: Getting tenant SFP information from VIM"
3315 for sfp_id
in sfp_list
:
3319 sfp_vim
= self
.get_sfp(sfp_id
)
3322 sfp
["status"] = vmStatus2manoFormat
["ACTIVE"]
3324 sfp
["status"] = "OTHER"
3325 sfp
["error_msg"] = "VIM status reported " + sfp
["status"]
3327 sfp
["vim_info"] = self
.serialize(sfp_vim
)
3329 if sfp_vim
.get("fault"):
3330 sfp
["error_msg"] = str(sfp_vim
["fault"])
3331 except vimconn
.VimConnNotFoundException
as e
:
3332 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3333 sfp
["status"] = "DELETED"
3334 sfp
["error_msg"] = str(e
)
3335 except vimconn
.VimConnException
as e
:
3336 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3337 sfp
["status"] = "VIM_ERROR"
3338 sfp
["error_msg"] = str(e
)
3340 sfp_dict
[sfp_id
] = sfp
3344 def refresh_sfis_status(self
, sfi_list
):
3345 """Get the status of the service function instances
3346 Params: the list of sfi identifiers
3347 Returns a dictionary with:
3348 vm_id: #VIM id of this service function instance
3349 status: #Mandatory. Text with one of:
3350 # DELETED (not found at vim)
3351 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3352 # OTHER (Vim reported other status not understood)
3353 # ERROR (VIM indicates an ERROR status)
3355 # CREATING (on building process)
3356 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3357 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3361 "refresh_sfis status: Getting tenant sfi information from VIM"
3364 for sfi_id
in sfi_list
:
3368 sfi_vim
= self
.get_sfi(sfi_id
)
3371 sfi
["status"] = vmStatus2manoFormat
["ACTIVE"]
3373 sfi
["status"] = "OTHER"
3374 sfi
["error_msg"] = "VIM status reported " + sfi
["status"]
3376 sfi
["vim_info"] = self
.serialize(sfi_vim
)
3378 if sfi_vim
.get("fault"):
3379 sfi
["error_msg"] = str(sfi_vim
["fault"])
3380 except vimconn
.VimConnNotFoundException
as e
:
3381 self
.logger
.error("Exception getting sfi status: %s", str(e
))
3382 sfi
["status"] = "DELETED"
3383 sfi
["error_msg"] = str(e
)
3384 except vimconn
.VimConnException
as e
:
3385 self
.logger
.error("Exception getting sfi status: %s", str(e
))
3386 sfi
["status"] = "VIM_ERROR"
3387 sfi
["error_msg"] = str(e
)
3389 sfi_dict
[sfi_id
] = sfi
3393 def refresh_sfs_status(self
, sf_list
):
3394 """Get the status of the service functions
3395 Params: the list of sf identifiers
3396 Returns a dictionary with:
3397 vm_id: #VIM id of this service function
3398 status: #Mandatory. Text with one of:
3399 # DELETED (not found at vim)
3400 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3401 # OTHER (Vim reported other status not understood)
3402 # ERROR (VIM indicates an ERROR status)
3404 # CREATING (on building process)
3405 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3406 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3409 self
.logger
.debug("refresh_sfs status: Getting tenant sf information from VIM")
3411 for sf_id
in sf_list
:
3415 sf_vim
= self
.get_sf(sf_id
)
3418 sf
["status"] = vmStatus2manoFormat
["ACTIVE"]
3420 sf
["status"] = "OTHER"
3421 sf
["error_msg"] = "VIM status reported " + sf_vim
["status"]
3423 sf
["vim_info"] = self
.serialize(sf_vim
)
3425 if sf_vim
.get("fault"):
3426 sf
["error_msg"] = str(sf_vim
["fault"])
3427 except vimconn
.VimConnNotFoundException
as e
:
3428 self
.logger
.error("Exception getting sf status: %s", str(e
))
3429 sf
["status"] = "DELETED"
3430 sf
["error_msg"] = str(e
)
3431 except vimconn
.VimConnException
as e
:
3432 self
.logger
.error("Exception getting sf status: %s", str(e
))
3433 sf
["status"] = "VIM_ERROR"
3434 sf
["error_msg"] = str(e
)
3440 def refresh_classifications_status(self
, classification_list
):
3441 """Get the status of the classifications
3442 Params: the list of classification identifiers
3443 Returns a dictionary with:
3444 vm_id: #VIM id of this classifier
3445 status: #Mandatory. Text with one of:
3446 # DELETED (not found at vim)
3447 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3448 # OTHER (Vim reported other status not understood)
3449 # ERROR (VIM indicates an ERROR status)
3451 # CREATING (on building process)
3452 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3453 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3455 classification_dict
= {}
3457 "refresh_classifications status: Getting tenant classification information from VIM"
3460 for classification_id
in classification_list
:
3464 classification_vim
= self
.get_classification(classification_id
)
3466 if classification_vim
:
3467 classification
["status"] = vmStatus2manoFormat
["ACTIVE"]
3469 classification
["status"] = "OTHER"
3470 classification
["error_msg"] = (
3471 "VIM status reported " + classification
["status"]
3474 classification
["vim_info"] = self
.serialize(classification_vim
)
3476 if classification_vim
.get("fault"):
3477 classification
["error_msg"] = str(classification_vim
["fault"])
3478 except vimconn
.VimConnNotFoundException
as e
:
3479 self
.logger
.error("Exception getting classification status: %s", str(e
))
3480 classification
["status"] = "DELETED"
3481 classification
["error_msg"] = str(e
)
3482 except vimconn
.VimConnException
as e
:
3483 self
.logger
.error("Exception getting classification status: %s", str(e
))
3484 classification
["status"] = "VIM_ERROR"
3485 classification
["error_msg"] = str(e
)
3487 classification_dict
[classification_id
] = classification
3489 return classification_dict
3491 def new_affinity_group(self
, affinity_group_data
):
3492 """Adds a server group to VIM
3493 affinity_group_data contains a dictionary with information, keys:
3494 name: name in VIM for the server group
3495 type: affinity or anti-affinity
3496 scope: Only nfvi-node allowed
3497 Returns the server group identifier"""
3498 self
.logger
.debug("Adding Server Group '%s'", str(affinity_group_data
))
3501 name
= affinity_group_data
["name"]
3502 policy
= affinity_group_data
["type"]
3504 self
._reload
_connection
()
3505 new_server_group
= self
.nova
.server_groups
.create(name
, policy
)
3507 return new_server_group
.id
3509 ksExceptions
.ClientException
,
3510 nvExceptions
.ClientException
,
3514 self
._format
_exception
(e
)
3516 def get_affinity_group(self
, affinity_group_id
):
3517 """Obtain server group details from the VIM. Returns the server group detais as a dict"""
3518 self
.logger
.debug("Getting flavor '%s'", affinity_group_id
)
3520 self
._reload
_connection
()
3521 server_group
= self
.nova
.server_groups
.find(id=affinity_group_id
)
3523 return server_group
.to_dict()
3525 nvExceptions
.NotFound
,
3526 nvExceptions
.ClientException
,
3527 ksExceptions
.ClientException
,
3530 self
._format
_exception
(e
)
3532 def delete_affinity_group(self
, affinity_group_id
):
3533 """Deletes a server group from the VIM. Returns the old affinity_group_id"""
3534 self
.logger
.debug("Getting server group '%s'", affinity_group_id
)
3536 self
._reload
_connection
()
3537 self
.nova
.server_groups
.delete(affinity_group_id
)
3539 return affinity_group_id
3541 nvExceptions
.NotFound
,
3542 ksExceptions
.ClientException
,
3543 nvExceptions
.ClientException
,
3546 self
._format
_exception
(e
)