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
1353 new_flavor
= self
.nova
.flavors
.create(
1357 disk
=flavor_data
.get("disk", 0),
1358 ephemeral
=flavor_data
.get("ephemeral", 0),
1359 swap
=flavor_data
.get("swap", 0),
1360 is_public
=flavor_data
.get("is_public", True),
1364 new_flavor
.set_keys(extra_specs
)
1366 return new_flavor
.id
1367 except nvExceptions
.Conflict
as e
:
1368 if change_name_if_used
and retry
< max_retries
:
1371 self
._format
_exception
(e
)
1372 # except nvExceptions.BadRequest as e:
1374 ksExceptions
.ClientException
,
1375 nvExceptions
.ClientException
,
1379 self
._format
_exception
(e
)
1381 def delete_flavor(self
, flavor_id
):
1382 """Deletes a tenant flavor from openstack VIM. Returns the old flavor_id"""
1384 self
._reload
_connection
()
1385 self
.nova
.flavors
.delete(flavor_id
)
1388 # except nvExceptions.BadRequest as e:
1390 nvExceptions
.NotFound
,
1391 ksExceptions
.ClientException
,
1392 nvExceptions
.ClientException
,
1395 self
._format
_exception
(e
)
1397 def new_image(self
, image_dict
):
1399 Adds a tenant image to VIM. imge_dict is a dictionary with:
1401 disk_format: qcow2, vhd, vmdk, raw (by default), ...
1402 location: path or URI
1403 public: "yes" or "no"
1404 metadata: metadata of the image
1405 Returns the image_id
1410 while retry
< max_retries
:
1413 self
._reload
_connection
()
1415 # determine format http://docs.openstack.org/developer/glance/formats.html
1416 if "disk_format" in image_dict
:
1417 disk_format
= image_dict
["disk_format"]
1418 else: # autodiscover based on extension
1419 if image_dict
["location"].endswith(".qcow2"):
1420 disk_format
= "qcow2"
1421 elif image_dict
["location"].endswith(".vhd"):
1423 elif image_dict
["location"].endswith(".vmdk"):
1424 disk_format
= "vmdk"
1425 elif image_dict
["location"].endswith(".vdi"):
1427 elif image_dict
["location"].endswith(".iso"):
1429 elif image_dict
["location"].endswith(".aki"):
1431 elif image_dict
["location"].endswith(".ari"):
1433 elif image_dict
["location"].endswith(".ami"):
1439 "new_image: '%s' loading from '%s'",
1441 image_dict
["location"],
1443 if self
.vim_type
== "VIO":
1444 container_format
= "bare"
1445 if "container_format" in image_dict
:
1446 container_format
= image_dict
["container_format"]
1448 new_image
= self
.glance
.images
.create(
1449 name
=image_dict
["name"],
1450 container_format
=container_format
,
1451 disk_format
=disk_format
,
1454 new_image
= self
.glance
.images
.create(name
=image_dict
["name"])
1456 if image_dict
["location"].startswith("http"):
1457 # TODO there is not a method to direct download. It must be downloaded locally with requests
1458 raise vimconn
.VimConnNotImplemented("Cannot create image from URL")
1460 with
open(image_dict
["location"]) as fimage
:
1461 self
.glance
.images
.upload(new_image
.id, fimage
)
1462 # new_image = self.glancev1.images.create(name=image_dict["name"], is_public=
1463 # image_dict.get("public","yes")=="yes",
1464 # container_format="bare", data=fimage, disk_format=disk_format)
1466 metadata_to_load
= image_dict
.get("metadata")
1468 # TODO location is a reserved word for current openstack versions. fixed for VIO please check
1470 if self
.vim_type
== "VIO":
1471 metadata_to_load
["upload_location"] = image_dict
["location"]
1473 metadata_to_load
["location"] = image_dict
["location"]
1475 self
.glance
.images
.update(new_image
.id, **metadata_to_load
)
1479 nvExceptions
.Conflict
,
1480 ksExceptions
.ClientException
,
1481 nvExceptions
.ClientException
,
1483 self
._format
_exception
(e
)
1486 gl1Exceptions
.HTTPException
,
1487 gl1Exceptions
.CommunicationError
,
1490 if retry
== max_retries
:
1493 self
._format
_exception
(e
)
1494 except IOError as e
: # can not open the file
1495 raise vimconn
.VimConnConnectionException(
1496 "{}: {} for {}".format(type(e
).__name
__, e
, image_dict
["location"]),
1497 http_code
=vimconn
.HTTP_Bad_Request
,
1500 def delete_image(self
, image_id
):
1501 """Deletes a tenant image from openstack VIM. Returns the old id"""
1503 self
._reload
_connection
()
1504 self
.glance
.images
.delete(image_id
)
1508 nvExceptions
.NotFound
,
1509 ksExceptions
.ClientException
,
1510 nvExceptions
.ClientException
,
1511 gl1Exceptions
.CommunicationError
,
1512 gl1Exceptions
.HTTPNotFound
,
1514 ) as e
: # TODO remove
1515 self
._format
_exception
(e
)
1517 def get_image_id_from_path(self
, path
):
1518 """Get the image id from image path in the VIM database. Returns the image_id"""
1520 self
._reload
_connection
()
1521 images
= self
.glance
.images
.list()
1523 for image
in images
:
1524 if image
.metadata
.get("location") == path
:
1527 raise vimconn
.VimConnNotFoundException(
1528 "image with location '{}' not found".format(path
)
1531 ksExceptions
.ClientException
,
1532 nvExceptions
.ClientException
,
1533 gl1Exceptions
.CommunicationError
,
1536 self
._format
_exception
(e
)
1538 def get_image_list(self
, filter_dict
={}):
1539 """Obtain tenant images from VIM
1543 checksum: image checksum
1544 Returns the image list of dictionaries:
1545 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1548 self
.logger
.debug("Getting image list from VIM filter: '%s'", str(filter_dict
))
1551 self
._reload
_connection
()
1552 # filter_dict_os = filter_dict.copy()
1553 # First we filter by the available filter fields: name, id. The others are removed.
1554 image_list
= self
.glance
.images
.list()
1557 for image
in image_list
:
1559 if filter_dict
.get("name") and image
["name"] != filter_dict
["name"]:
1562 if filter_dict
.get("id") and image
["id"] != filter_dict
["id"]:
1566 filter_dict
.get("checksum")
1567 and image
["checksum"] != filter_dict
["checksum"]
1571 filtered_list
.append(image
.copy())
1572 except gl1Exceptions
.HTTPNotFound
:
1575 return filtered_list
1577 ksExceptions
.ClientException
,
1578 nvExceptions
.ClientException
,
1579 gl1Exceptions
.CommunicationError
,
1582 self
._format
_exception
(e
)
1584 def __wait_for_vm(self
, vm_id
, status
):
1585 """wait until vm is in the desired status and return True.
1586 If the VM gets in ERROR status, return false.
1587 If the timeout is reached generate an exception"""
1589 while elapsed_time
< server_timeout
:
1590 vm_status
= self
.nova
.servers
.get(vm_id
).status
1592 if vm_status
== status
:
1595 if vm_status
== "ERROR":
1601 # if we exceeded the timeout rollback
1602 if elapsed_time
>= server_timeout
:
1603 raise vimconn
.VimConnException(
1604 "Timeout waiting for instance " + vm_id
+ " to get " + status
,
1605 http_code
=vimconn
.HTTP_Request_Timeout
,
1608 def _get_openstack_availablity_zones(self
):
1610 Get from openstack availability zones available
1614 openstack_availability_zone
= self
.nova
.availability_zones
.list()
1615 openstack_availability_zone
= [
1617 for zone
in openstack_availability_zone
1618 if zone
.zoneName
!= "internal"
1621 return openstack_availability_zone
1625 def _set_availablity_zones(self
):
1627 Set vim availablity zone
1630 if "availability_zone" in self
.config
:
1631 vim_availability_zones
= self
.config
.get("availability_zone")
1633 if isinstance(vim_availability_zones
, str):
1634 self
.availability_zone
= [vim_availability_zones
]
1635 elif isinstance(vim_availability_zones
, list):
1636 self
.availability_zone
= vim_availability_zones
1638 self
.availability_zone
= self
._get
_openstack
_availablity
_zones
()
1640 def _get_vm_availability_zone(
1641 self
, availability_zone_index
, availability_zone_list
1644 Return thge availability zone to be used by the created VM.
1645 :return: The VIM availability zone to be used or None
1647 if availability_zone_index
is None:
1648 if not self
.config
.get("availability_zone"):
1650 elif isinstance(self
.config
.get("availability_zone"), str):
1651 return self
.config
["availability_zone"]
1653 # TODO consider using a different parameter at config for default AV and AV list match
1654 return self
.config
["availability_zone"][0]
1656 vim_availability_zones
= self
.availability_zone
1657 # check if VIM offer enough availability zones describe in the VNFD
1658 if vim_availability_zones
and len(availability_zone_list
) <= len(
1659 vim_availability_zones
1661 # check if all the names of NFV AV match VIM AV names
1662 match_by_index
= False
1663 for av
in availability_zone_list
:
1664 if av
not in vim_availability_zones
:
1665 match_by_index
= True
1669 return vim_availability_zones
[availability_zone_index
]
1671 return availability_zone_list
[availability_zone_index
]
1673 raise vimconn
.VimConnConflictException(
1674 "No enough availability zones at VIM for this deployment"
1684 affinity_group_list
,
1688 availability_zone_index
=None,
1689 availability_zone_list
=None,
1691 """Adds a VM instance to VIM
1693 start: indicates if VM must start or boot in pause mode. Ignored
1694 image_id,flavor_id: image and flavor uuid
1695 affinity_group_list: list of affinity groups, each one is a dictionary.
1697 net_list: list of interfaces, each one is a dictionary with:
1699 net_id: network uuid to connect
1700 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
1701 model: interface model, ignored #TODO
1702 mac_address: used for SR-IOV ifaces #TODO for other types
1703 use: 'data', 'bridge', 'mgmt'
1704 type: 'virtual', 'PCI-PASSTHROUGH'('PF'), 'SR-IOV'('VF'), 'VFnotShared'
1705 vim_id: filled/added by this function
1706 floating_ip: True/False (or it can be None)
1707 port_security: True/False
1708 'cloud_config': (optional) dictionary with:
1709 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
1710 'users': (optional) list of users to be inserted, each item is a dict with:
1711 'name': (mandatory) user name,
1712 'key-pairs': (optional) list of strings with the public key to be inserted to the user
1713 'user-data': (optional) string is a text script to be passed directly to cloud-init
1714 'config-files': (optional). List of files to be transferred. Each item is a dict with:
1715 'dest': (mandatory) string with the destination absolute path
1716 'encoding': (optional, by default text). Can be one of:
1717 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
1718 'content' (mandatory): string with the content of the file
1719 'permissions': (optional) string with file permissions, typically octal notation '0644'
1720 'owner': (optional) file owner, string with the format 'owner:group'
1721 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
1722 'disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
1723 'image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
1724 'size': (mandatory) string with the size of the disk in GB
1725 'vim_id' (optional) should use this existing volume id
1726 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
1727 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
1728 availability_zone_index is None
1729 #TODO ip, security groups
1730 Returns a tuple with the instance identifier and created_items or raises an exception on error
1731 created_items can be None or a dictionary where this method can include key-values that will be passed to
1732 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
1733 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
1737 "new_vminstance input: image='%s' flavor='%s' nics='%s'",
1748 external_network
= []
1749 # ^list of external networks to be connected to instance, later on used to create floating_ip
1750 no_secured_ports
= [] # List of port-is with port-security disabled
1751 self
._reload
_connection
()
1752 # metadata_vpci = {} # For a specific neutron plugin
1753 block_device_mapping
= None
1755 for net
in net_list
:
1756 if not net
.get("net_id"): # skip non connected iface
1760 "network_id": net
["net_id"],
1761 "name": net
.get("name"),
1762 "admin_state_up": True,
1766 self
.config
.get("security_groups")
1767 and net
.get("port_security") is not False
1768 and not self
.config
.get("no_port_security_extension")
1770 if not self
.security_groups_id
:
1771 self
._get
_ids
_from
_name
()
1773 port_dict
["security_groups"] = self
.security_groups_id
1775 if net
["type"] == "virtual":
1778 # metadata_vpci[ net["net_id"] ] = [[ net["vpci"], "" ]]
1779 elif net
["type"] == "VF" or net
["type"] == "SR-IOV": # for VF
1781 # if "VF" not in metadata_vpci:
1782 # metadata_vpci["VF"]=[]
1783 # metadata_vpci["VF"].append([ net["vpci"], "" ])
1784 port_dict
["binding:vnic_type"] = "direct"
1786 # VIO specific Changes
1787 if self
.vim_type
== "VIO":
1788 # Need to create port with port_security_enabled = False and no-security-groups
1789 port_dict
["port_security_enabled"] = False
1790 port_dict
["provider_security_groups"] = []
1791 port_dict
["security_groups"] = []
1792 else: # For PT PCI-PASSTHROUGH
1794 # if "PF" not in metadata_vpci:
1795 # metadata_vpci["PF"]=[]
1796 # metadata_vpci["PF"].append([ net["vpci"], "" ])
1797 port_dict
["binding:vnic_type"] = "direct-physical"
1799 if not port_dict
["name"]:
1800 port_dict
["name"] = name
1802 if net
.get("mac_address"):
1803 port_dict
["mac_address"] = net
["mac_address"]
1805 if net
.get("ip_address"):
1806 port_dict
["fixed_ips"] = [{"ip_address": net
["ip_address"]}]
1807 # TODO add "subnet_id": <subnet_id>
1809 new_port
= self
.neutron
.create_port({"port": port_dict
})
1810 created_items
["port:" + str(new_port
["port"]["id"])] = True
1811 net
["mac_adress"] = new_port
["port"]["mac_address"]
1812 net
["vim_id"] = new_port
["port"]["id"]
1813 # if try to use a network without subnetwork, it will return a emtpy list
1814 fixed_ips
= new_port
["port"].get("fixed_ips")
1817 net
["ip"] = fixed_ips
[0].get("ip_address")
1821 port
= {"port-id": new_port
["port"]["id"]}
1822 if float(self
.nova
.api_version
.get_string()) >= 2.32:
1823 port
["tag"] = new_port
["port"]["name"]
1825 net_list_vim
.append(port
)
1827 if net
.get("floating_ip", False):
1828 net
["exit_on_floating_ip_error"] = True
1829 external_network
.append(net
)
1830 elif net
["use"] == "mgmt" and self
.config
.get("use_floating_ip"):
1831 net
["exit_on_floating_ip_error"] = False
1832 external_network
.append(net
)
1833 net
["floating_ip"] = self
.config
.get("use_floating_ip")
1835 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic
1837 # As a workaround we wait until the VM is active and then disable the port-security
1838 if net
.get("port_security") is False and not self
.config
.get(
1839 "no_port_security_extension"
1841 no_secured_ports
.append(
1843 new_port
["port"]["id"],
1844 net
.get("port_security_disable_strategy"),
1849 # metadata = {"pci_assignement": json.dumps(metadata_vpci)}
1850 # if len(metadata["pci_assignement"]) >255:
1851 # #limit the metadata size
1852 # #metadata["pci_assignement"] = metadata["pci_assignement"][0:255]
1853 # self.logger.warn("Metadata deleted since it exceeds the expected length (255) ")
1857 "name '%s' image_id '%s'flavor_id '%s' net_list_vim '%s' description '%s'",
1866 config_drive
, userdata
= self
._create
_user
_data
(cloud_config
)
1868 # get availability Zone
1869 vm_av_zone
= self
._get
_vm
_availability
_zone
(
1870 availability_zone_index
, availability_zone_list
1873 # Create additional volumes in case these are present in disk_list
1874 base_disk_index
= ord("b")
1875 boot_volume_id
= None
1877 block_device_mapping
= {}
1878 for disk
in disk_list
:
1879 if disk
.get("vim_id"):
1880 block_device_mapping
["_vd" + chr(base_disk_index
)] = disk
[
1884 if "image_id" in disk
:
1885 base_disk_index
= ord("a")
1886 volume
= self
.cinder
.volumes
.create(
1888 name
=name
+ "_vd" + chr(base_disk_index
),
1889 imageRef
=disk
["image_id"],
1890 # Make sure volume is in the same AZ as the VM to be attached to
1891 availability_zone
=vm_av_zone
,
1893 boot_volume_id
= volume
.id
1895 volume
= self
.cinder
.volumes
.create(
1897 name
=name
+ "_vd" + chr(base_disk_index
),
1898 # Make sure volume is in the same AZ as the VM to be attached to
1899 availability_zone
=vm_av_zone
,
1902 created_items
["volume:" + str(volume
.id)] = True
1903 block_device_mapping
["_vd" + chr(base_disk_index
)] = volume
.id
1905 base_disk_index
+= 1
1907 # Wait until created volumes are with status available
1909 while elapsed_time
< volume_timeout
:
1910 for created_item
in created_items
:
1911 v
, _
, volume_id
= created_item
.partition(":")
1913 if self
.cinder
.volumes
.get(volume_id
).status
!= "available":
1915 else: # all ready: break from while
1921 # If we exceeded the timeout rollback
1922 if elapsed_time
>= volume_timeout
:
1923 raise vimconn
.VimConnException(
1924 "Timeout creating volumes for instance " + name
,
1925 http_code
=vimconn
.HTTP_Request_Timeout
,
1928 self
.cinder
.volumes
.set_bootable(boot_volume_id
, True)
1930 # Manage affinity groups/server groups
1931 server_group_id
= None
1932 scheduller_hints
= {}
1934 if affinity_group_list
:
1935 # Only first id on the list will be used. Openstack restriction
1936 server_group_id
= affinity_group_list
[0]["affinity_group_id"]
1937 scheduller_hints
["group"] = server_group_id
1940 "nova.servers.create({}, {}, {}, nics={}, security_groups={}, "
1941 "availability_zone={}, key_name={}, userdata={}, config_drive={}, "
1942 "block_device_mapping={}, server_group={})".format(
1947 self
.config
.get("security_groups"),
1949 self
.config
.get("keypair"),
1952 block_device_mapping
,
1956 server
= self
.nova
.servers
.create(
1961 security_groups
=self
.config
.get("security_groups"),
1962 # TODO remove security_groups in future versions. Already at neutron port
1963 availability_zone
=vm_av_zone
,
1964 key_name
=self
.config
.get("keypair"),
1966 config_drive
=config_drive
,
1967 block_device_mapping
=block_device_mapping
,
1968 scheduler_hints
=scheduller_hints
,
1969 ) # , description=description)
1971 vm_start_time
= time
.time()
1972 # Previously mentioned workaround to wait until the VM is active and then disable the port-security
1973 if no_secured_ports
:
1974 self
.__wait
_for
_vm
(server
.id, "ACTIVE")
1976 for port
in no_secured_ports
:
1978 "port": {"port_security_enabled": False, "security_groups": None}
1981 if port
[1] == "allow-address-pairs":
1983 "port": {"allowed_address_pairs": [{"ip_address": "0.0.0.0/0"}]}
1987 self
.neutron
.update_port(port
[0], port_update
)
1989 raise vimconn
.VimConnException(
1990 "It was not possible to disable port security for port {}".format(
1995 # print "DONE :-)", server
1998 for floating_network
in external_network
:
2001 floating_ip_retries
= 3
2002 # In case of RO in HA there can be conflicts, two RO trying to assign same floating IP, so retry
2005 floating_ips
= self
.neutron
.list_floatingips().get(
2008 random
.shuffle(floating_ips
) # randomize
2009 for fip
in floating_ips
:
2012 or fip
.get("tenant_id") != server
.tenant_id
2016 if isinstance(floating_network
["floating_ip"], str):
2018 fip
.get("floating_network_id")
2019 != floating_network
["floating_ip"]
2023 free_floating_ip
= fip
["id"]
2027 isinstance(floating_network
["floating_ip"], str)
2028 and floating_network
["floating_ip"].lower() != "true"
2030 pool_id
= floating_network
["floating_ip"]
2032 # Find the external network
2033 external_nets
= list()
2035 for net
in self
.neutron
.list_networks()["networks"]:
2036 if net
["router:external"]:
2037 external_nets
.append(net
)
2039 if len(external_nets
) == 0:
2040 raise vimconn
.VimConnException(
2041 "Cannot create floating_ip automatically since "
2042 "no external network is present",
2043 http_code
=vimconn
.HTTP_Conflict
,
2046 if len(external_nets
) > 1:
2047 raise vimconn
.VimConnException(
2048 "Cannot create floating_ip automatically since "
2049 "multiple external networks are present",
2050 http_code
=vimconn
.HTTP_Conflict
,
2053 pool_id
= external_nets
[0].get("id")
2057 "floating_network_id": pool_id
,
2058 "tenant_id": server
.tenant_id
,
2063 # self.logger.debug("Creating floating IP")
2064 new_floating_ip
= self
.neutron
.create_floatingip(param
)
2065 free_floating_ip
= new_floating_ip
["floatingip"]["id"]
2067 "floating_ip:" + str(free_floating_ip
)
2069 except Exception as e
:
2070 raise vimconn
.VimConnException(
2072 + ": Cannot create new floating_ip "
2074 http_code
=vimconn
.HTTP_Conflict
,
2078 # for race condition ensure not already assigned
2079 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2081 if fip
["floatingip"]["port_id"]:
2084 # the vim_id key contains the neutron.port_id
2085 self
.neutron
.update_floatingip(
2087 {"floatingip": {"port_id": floating_network
["vim_id"]}},
2089 # for race condition ensure not re-assigned to other VM after 5 seconds
2091 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2094 fip
["floatingip"]["port_id"]
2095 != floating_network
["vim_id"]
2098 "floating_ip {} re-assigned to other port".format(
2105 "Assigned floating_ip {} to VM {}".format(
2106 free_floating_ip
, server
.id
2110 except Exception as e
:
2111 # openstack need some time after VM creation to assign an IP. So retry if fails
2112 vm_status
= self
.nova
.servers
.get(server
.id).status
2114 if vm_status
not in ("ACTIVE", "ERROR"):
2115 if time
.time() - vm_start_time
< server_timeout
:
2118 elif floating_ip_retries
> 0:
2119 floating_ip_retries
-= 1
2122 raise vimconn
.VimConnException(
2123 "Cannot create floating_ip: {} {}".format(
2126 http_code
=vimconn
.HTTP_Conflict
,
2129 except Exception as e
:
2130 if not floating_network
["exit_on_floating_ip_error"]:
2131 self
.logger
.error("Cannot create floating_ip. %s", str(e
))
2136 return server
.id, created_items
2137 # except nvExceptions.NotFound as e:
2138 # error_value=-vimconn.HTTP_Not_Found
2139 # error_text= "vm instance %s not found" % vm_id
2140 # except TypeError as e:
2141 # raise vimconn.VimConnException(type(e).__name__ + ": "+ str(e), http_code=vimconn.HTTP_Bad_Request)
2143 except Exception as e
:
2146 server_id
= server
.id
2149 self
.delete_vminstance(server_id
, created_items
)
2150 except Exception as e2
:
2151 self
.logger
.error("new_vminstance rollback fail {}".format(e2
))
2153 self
._format
_exception
(e
)
2155 def get_vminstance(self
, vm_id
):
2156 """Returns the VM instance information from VIM"""
2157 # self.logger.debug("Getting VM from VIM")
2159 self
._reload
_connection
()
2160 server
= self
.nova
.servers
.find(id=vm_id
)
2161 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
2163 return server
.to_dict()
2165 ksExceptions
.ClientException
,
2166 nvExceptions
.ClientException
,
2167 nvExceptions
.NotFound
,
2170 self
._format
_exception
(e
)
2172 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
2174 Get a console for the virtual machine
2176 vm_id: uuid of the VM
2177 console_type, can be:
2178 "novnc" (by default), "xvpvnc" for VNC types,
2179 "rdp-html5" for RDP types, "spice-html5" for SPICE types
2180 Returns dict with the console parameters:
2181 protocol: ssh, ftp, http, https, ...
2182 server: usually ip address
2183 port: the http, ssh, ... port
2184 suffix: extra text, e.g. the http path and query string
2186 self
.logger
.debug("Getting VM CONSOLE from VIM")
2189 self
._reload
_connection
()
2190 server
= self
.nova
.servers
.find(id=vm_id
)
2192 if console_type
is None or console_type
== "novnc":
2193 console_dict
= server
.get_vnc_console("novnc")
2194 elif console_type
== "xvpvnc":
2195 console_dict
= server
.get_vnc_console(console_type
)
2196 elif console_type
== "rdp-html5":
2197 console_dict
= server
.get_rdp_console(console_type
)
2198 elif console_type
== "spice-html5":
2199 console_dict
= server
.get_spice_console(console_type
)
2201 raise vimconn
.VimConnException(
2202 "console type '{}' not allowed".format(console_type
),
2203 http_code
=vimconn
.HTTP_Bad_Request
,
2206 console_dict1
= console_dict
.get("console")
2209 console_url
= console_dict1
.get("url")
2213 protocol_index
= console_url
.find("//")
2215 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2218 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2223 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2225 -vimconn
.HTTP_Internal_Server_Error
,
2226 "Unexpected response from VIM",
2230 "protocol": console_url
[0:protocol_index
],
2231 "server": console_url
[protocol_index
+ 2 : port_index
],
2232 "port": console_url
[port_index
:suffix_index
],
2233 "suffix": console_url
[suffix_index
+ 1 :],
2238 raise vimconn
.VimConnUnexpectedResponse("Unexpected response from VIM")
2240 nvExceptions
.NotFound
,
2241 ksExceptions
.ClientException
,
2242 nvExceptions
.ClientException
,
2243 nvExceptions
.BadRequest
,
2246 self
._format
_exception
(e
)
2248 def delete_vminstance(self
, vm_id
, created_items
=None):
2249 """Removes a VM instance from VIM. Returns the old identifier"""
2250 # print "osconnector: Getting VM from VIM"
2251 if created_items
is None:
2255 self
._reload
_connection
()
2256 # delete VM ports attached to this networks before the virtual machine
2257 for k
, v
in created_items
.items():
2258 if not v
: # skip already deleted
2262 k_item
, _
, k_id
= k
.partition(":")
2263 if k_item
== "port":
2264 self
.neutron
.delete_port(k_id
)
2265 except Exception as e
:
2267 "Error deleting port: {}: {}".format(type(e
).__name
__, e
)
2270 # #commented because detaching the volumes makes the servers.delete not work properly ?!?
2271 # #dettach volumes attached
2272 # server = self.nova.servers.get(vm_id)
2273 # volumes_attached_dict = server._info["os-extended-volumes:volumes_attached"] #volume["id"]
2274 # #for volume in volumes_attached_dict:
2275 # # self.cinder.volumes.detach(volume["id"])
2278 self
.nova
.servers
.delete(vm_id
)
2280 # delete volumes. Although having detached, they should have in active status before deleting
2281 # we ensure in this loop
2285 while keep_waiting
and elapsed_time
< volume_timeout
:
2286 keep_waiting
= False
2288 for k
, v
in created_items
.items():
2289 if not v
: # skip already deleted
2293 k_item
, _
, k_id
= k
.partition(":")
2294 if k_item
== "volume":
2295 if self
.cinder
.volumes
.get(k_id
).status
!= "available":
2298 self
.cinder
.volumes
.delete(k_id
)
2299 created_items
[k
] = None
2300 elif k_item
== "floating_ip": # floating ip
2301 self
.neutron
.delete_floatingip(k_id
)
2302 created_items
[k
] = None
2304 except Exception as e
:
2305 self
.logger
.error("Error deleting {}: {}".format(k
, e
))
2313 nvExceptions
.NotFound
,
2314 ksExceptions
.ClientException
,
2315 nvExceptions
.ClientException
,
2318 self
._format
_exception
(e
)
2320 def refresh_vms_status(self
, vm_list
):
2321 """Get the status of the virtual machines and their interfaces/ports
2322 Params: the list of VM identifiers
2323 Returns a dictionary with:
2324 vm_id: #VIM id of this Virtual Machine
2325 status: #Mandatory. Text with one of:
2326 # DELETED (not found at vim)
2327 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2328 # OTHER (Vim reported other status not understood)
2329 # ERROR (VIM indicates an ERROR status)
2330 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
2331 # CREATING (on building process), ERROR
2332 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
2334 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2335 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2337 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2338 mac_address: #Text format XX:XX:XX:XX:XX:XX
2339 vim_net_id: #network id where this interface is connected
2340 vim_interface_id: #interface/port VIM id
2341 ip_address: #null, or text with IPv4, IPv6 address
2342 compute_node: #identification of compute node where PF,VF interface is allocated
2343 pci: #PCI address of the NIC that hosts the PF,VF
2344 vlan: #physical VLAN used for VF
2348 "refresh_vms status: Getting tenant VM instance information from VIM"
2351 for vm_id
in vm_list
:
2355 vm_vim
= self
.get_vminstance(vm_id
)
2357 if vm_vim
["status"] in vmStatus2manoFormat
:
2358 vm
["status"] = vmStatus2manoFormat
[vm_vim
["status"]]
2360 vm
["status"] = "OTHER"
2361 vm
["error_msg"] = "VIM status reported " + vm_vim
["status"]
2363 vm_vim
.pop("OS-EXT-SRV-ATTR:user_data", None)
2364 vm_vim
.pop("user_data", None)
2365 vm
["vim_info"] = self
.serialize(vm_vim
)
2367 vm
["interfaces"] = []
2368 if vm_vim
.get("fault"):
2369 vm
["error_msg"] = str(vm_vim
["fault"])
2373 self
._reload
_connection
()
2374 port_dict
= self
.neutron
.list_ports(device_id
=vm_id
)
2376 for port
in port_dict
["ports"]:
2378 interface
["vim_info"] = self
.serialize(port
)
2379 interface
["mac_address"] = port
.get("mac_address")
2380 interface
["vim_net_id"] = port
["network_id"]
2381 interface
["vim_interface_id"] = port
["id"]
2382 # check if OS-EXT-SRV-ATTR:host is there,
2383 # in case of non-admin credentials, it will be missing
2385 if vm_vim
.get("OS-EXT-SRV-ATTR:host"):
2386 interface
["compute_node"] = vm_vim
["OS-EXT-SRV-ATTR:host"]
2388 interface
["pci"] = None
2390 # check if binding:profile is there,
2391 # in case of non-admin credentials, it will be missing
2392 if port
.get("binding:profile"):
2393 if port
["binding:profile"].get("pci_slot"):
2394 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting
2396 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
2397 # CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2) assuming there are 2 ports per nic
2398 pci
= port
["binding:profile"]["pci_slot"]
2399 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
2400 interface
["pci"] = pci
2402 interface
["vlan"] = None
2404 if port
.get("binding:vif_details"):
2405 interface
["vlan"] = port
["binding:vif_details"].get("vlan")
2407 # Get vlan from network in case not present in port for those old openstacks and cases where
2408 # it is needed vlan at PT
2409 if not interface
["vlan"]:
2410 # if network is of type vlan and port is of type direct (sr-iov) then set vlan id
2411 network
= self
.neutron
.show_network(port
["network_id"])
2414 network
["network"].get("provider:network_type")
2417 # and port.get("binding:vnic_type") in ("direct", "direct-physical"):
2418 interface
["vlan"] = network
["network"].get(
2419 "provider:segmentation_id"
2423 # look for floating ip address
2425 floating_ip_dict
= self
.neutron
.list_floatingips(
2429 if floating_ip_dict
.get("floatingips"):
2431 floating_ip_dict
["floatingips"][0].get(
2432 "floating_ip_address"
2438 for subnet
in port
["fixed_ips"]:
2439 ips
.append(subnet
["ip_address"])
2441 interface
["ip_address"] = ";".join(ips
)
2442 vm
["interfaces"].append(interface
)
2443 except Exception as e
:
2445 "Error getting vm interface information {}: {}".format(
2450 except vimconn
.VimConnNotFoundException
as e
:
2451 self
.logger
.error("Exception getting vm status: %s", str(e
))
2452 vm
["status"] = "DELETED"
2453 vm
["error_msg"] = str(e
)
2454 except vimconn
.VimConnException
as e
:
2455 self
.logger
.error("Exception getting vm status: %s", str(e
))
2456 vm
["status"] = "VIM_ERROR"
2457 vm
["error_msg"] = str(e
)
2463 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
2464 """Send and action over a VM instance from VIM
2465 Returns None or the console dict if the action was successfully sent to the VIM"""
2466 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
2469 self
._reload
_connection
()
2470 server
= self
.nova
.servers
.find(id=vm_id
)
2472 if "start" in action_dict
:
2473 if action_dict
["start"] == "rebuild":
2476 if server
.status
== "PAUSED":
2478 elif server
.status
== "SUSPENDED":
2480 elif server
.status
== "SHUTOFF":
2482 elif "pause" in action_dict
:
2484 elif "resume" in action_dict
:
2486 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
2488 elif "forceOff" in action_dict
:
2489 server
.stop() # TODO
2490 elif "terminate" in action_dict
:
2492 elif "createImage" in action_dict
:
2493 server
.create_image()
2494 # "path":path_schema,
2495 # "description":description_schema,
2496 # "name":name_schema,
2497 # "metadata":metadata_schema,
2498 # "imageRef": id_schema,
2499 # "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
2500 elif "rebuild" in action_dict
:
2501 server
.rebuild(server
.image
["id"])
2502 elif "reboot" in action_dict
:
2503 server
.reboot() # reboot_type="SOFT"
2504 elif "console" in action_dict
:
2505 console_type
= action_dict
["console"]
2507 if console_type
is None or console_type
== "novnc":
2508 console_dict
= server
.get_vnc_console("novnc")
2509 elif console_type
== "xvpvnc":
2510 console_dict
= server
.get_vnc_console(console_type
)
2511 elif console_type
== "rdp-html5":
2512 console_dict
= server
.get_rdp_console(console_type
)
2513 elif console_type
== "spice-html5":
2514 console_dict
= server
.get_spice_console(console_type
)
2516 raise vimconn
.VimConnException(
2517 "console type '{}' not allowed".format(console_type
),
2518 http_code
=vimconn
.HTTP_Bad_Request
,
2522 console_url
= console_dict
["console"]["url"]
2524 protocol_index
= console_url
.find("//")
2526 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2529 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2534 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2535 raise vimconn
.VimConnException(
2536 "Unexpected response from VIM " + str(console_dict
)
2540 "protocol": console_url
[0:protocol_index
],
2541 "server": console_url
[protocol_index
+ 2 : port_index
],
2542 "port": int(console_url
[port_index
+ 1 : suffix_index
]),
2543 "suffix": console_url
[suffix_index
+ 1 :],
2546 return console_dict2
2548 raise vimconn
.VimConnException(
2549 "Unexpected response from VIM " + str(console_dict
)
2554 ksExceptions
.ClientException
,
2555 nvExceptions
.ClientException
,
2556 nvExceptions
.NotFound
,
2559 self
._format
_exception
(e
)
2560 # TODO insert exception vimconn.HTTP_Unauthorized
2562 # ###### VIO Specific Changes #########
2563 def _generate_vlanID(self
):
2565 Method to get unused vlanID
2573 networks
= self
.get_network_list()
2575 for net
in networks
:
2576 if net
.get("provider:segmentation_id"):
2577 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
2579 used_vlanIDs
= set(usedVlanIDs
)
2581 # find unused VLAN ID
2582 for vlanID_range
in self
.config
.get("dataplane_net_vlan_range"):
2584 start_vlanid
, end_vlanid
= map(
2585 int, vlanID_range
.replace(" ", "").split("-")
2588 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
2589 if vlanID
not in used_vlanIDs
:
2591 except Exception as exp
:
2592 raise vimconn
.VimConnException(
2593 "Exception {} occurred while generating VLAN ID.".format(exp
)
2596 raise vimconn
.VimConnConflictException(
2597 "Unable to create the SRIOV VLAN network. All given Vlan IDs {} are in use.".format(
2598 self
.config
.get("dataplane_net_vlan_range")
2602 def _generate_multisegment_vlanID(self
):
2604 Method to get unused vlanID
2612 networks
= self
.get_network_list()
2613 for net
in networks
:
2614 if net
.get("provider:network_type") == "vlan" and net
.get(
2615 "provider:segmentation_id"
2617 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
2618 elif net
.get("segments"):
2619 for segment
in net
.get("segments"):
2620 if segment
.get("provider:network_type") == "vlan" and segment
.get(
2621 "provider:segmentation_id"
2623 usedVlanIDs
.append(segment
.get("provider:segmentation_id"))
2625 used_vlanIDs
= set(usedVlanIDs
)
2627 # find unused VLAN ID
2628 for vlanID_range
in self
.config
.get("multisegment_vlan_range"):
2630 start_vlanid
, end_vlanid
= map(
2631 int, vlanID_range
.replace(" ", "").split("-")
2634 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
2635 if vlanID
not in used_vlanIDs
:
2637 except Exception as exp
:
2638 raise vimconn
.VimConnException(
2639 "Exception {} occurred while generating VLAN ID.".format(exp
)
2642 raise vimconn
.VimConnConflictException(
2643 "Unable to create the VLAN segment. All VLAN IDs {} are in use.".format(
2644 self
.config
.get("multisegment_vlan_range")
2648 def _validate_vlan_ranges(self
, input_vlan_range
, text_vlan_range
):
2650 Method to validate user given vlanID ranges
2654 for vlanID_range
in input_vlan_range
:
2655 vlan_range
= vlanID_range
.replace(" ", "")
2657 vlanID_pattern
= r
"(\d)*-(\d)*$"
2658 match_obj
= re
.match(vlanID_pattern
, vlan_range
)
2660 raise vimconn
.VimConnConflictException(
2661 "Invalid VLAN range for {}: {}.You must provide "
2662 "'{}' in format [start_ID - end_ID].".format(
2663 text_vlan_range
, vlanID_range
, text_vlan_range
2667 start_vlanid
, end_vlanid
= map(int, vlan_range
.split("-"))
2668 if start_vlanid
<= 0:
2669 raise vimconn
.VimConnConflictException(
2670 "Invalid VLAN range for {}: {}. Start ID can not be zero. For VLAN "
2671 "networks valid IDs are 1 to 4094 ".format(
2672 text_vlan_range
, vlanID_range
2676 if end_vlanid
> 4094:
2677 raise vimconn
.VimConnConflictException(
2678 "Invalid VLAN range for {}: {}. End VLAN ID can not be "
2679 "greater than 4094. For VLAN networks valid IDs are 1 to 4094 ".format(
2680 text_vlan_range
, vlanID_range
2684 if start_vlanid
> end_vlanid
:
2685 raise vimconn
.VimConnConflictException(
2686 "Invalid VLAN range for {}: {}. You must provide '{}'"
2687 " in format start_ID - end_ID and start_ID < end_ID ".format(
2688 text_vlan_range
, vlanID_range
, text_vlan_range
2692 # NOT USED FUNCTIONS
2694 def new_external_port(self
, port_data
):
2695 """Adds a external port to VIM
2696 Returns the port identifier"""
2697 # TODO openstack if needed
2699 -vimconn
.HTTP_Internal_Server_Error
,
2700 "osconnector.new_external_port() not implemented",
2703 def connect_port_network(self
, port_id
, network_id
, admin
=False):
2704 """Connects a external port to a network
2705 Returns status code of the VIM response"""
2706 # TODO openstack if needed
2708 -vimconn
.HTTP_Internal_Server_Error
,
2709 "osconnector.connect_port_network() not implemented",
2712 def new_user(self
, user_name
, user_passwd
, tenant_id
=None):
2713 """Adds a new user to openstack VIM
2714 Returns the user identifier"""
2715 self
.logger
.debug("osconnector: Adding a new user to VIM")
2718 self
._reload
_connection
()
2719 user
= self
.keystone
.users
.create(
2720 user_name
, password
=user_passwd
, default_project
=tenant_id
2722 # self.keystone.tenants.add_user(self.k_creds["username"], #role)
2725 except ksExceptions
.ConnectionError
as e
:
2726 error_value
= -vimconn
.HTTP_Bad_Request
2730 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2732 except ksExceptions
.ClientException
as e
: # TODO remove
2733 error_value
= -vimconn
.HTTP_Bad_Request
2737 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2740 # TODO insert exception vimconn.HTTP_Unauthorized
2741 # if reaching here is because an exception
2742 self
.logger
.debug("new_user " + error_text
)
2744 return error_value
, error_text
2746 def delete_user(self
, user_id
):
2747 """Delete a user from openstack VIM
2748 Returns the user identifier"""
2750 print("osconnector: Deleting a user from VIM")
2753 self
._reload
_connection
()
2754 self
.keystone
.users
.delete(user_id
)
2757 except ksExceptions
.ConnectionError
as e
:
2758 error_value
= -vimconn
.HTTP_Bad_Request
2762 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2764 except ksExceptions
.NotFound
as e
:
2765 error_value
= -vimconn
.HTTP_Not_Found
2769 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2771 except ksExceptions
.ClientException
as e
: # TODO remove
2772 error_value
= -vimconn
.HTTP_Bad_Request
2776 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2779 # TODO insert exception vimconn.HTTP_Unauthorized
2780 # if reaching here is because an exception
2781 self
.logger
.debug("delete_tenant " + error_text
)
2783 return error_value
, error_text
2785 def get_hosts_info(self
):
2786 """Get the information of deployed hosts
2787 Returns the hosts content"""
2789 print("osconnector: Getting Host info from VIM")
2793 self
._reload
_connection
()
2794 hypervisors
= self
.nova
.hypervisors
.list()
2796 for hype
in hypervisors
:
2797 h_list
.append(hype
.to_dict())
2799 return 1, {"hosts": h_list
}
2800 except nvExceptions
.NotFound
as e
:
2801 error_value
= -vimconn
.HTTP_Not_Found
2802 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
2803 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
2804 error_value
= -vimconn
.HTTP_Bad_Request
2808 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2811 # TODO insert exception vimconn.HTTP_Unauthorized
2812 # if reaching here is because an exception
2813 self
.logger
.debug("get_hosts_info " + error_text
)
2815 return error_value
, error_text
2817 def get_hosts(self
, vim_tenant
):
2818 """Get the hosts and deployed instances
2819 Returns the hosts content"""
2820 r
, hype_dict
= self
.get_hosts_info()
2825 hypervisors
= hype_dict
["hosts"]
2828 servers
= self
.nova
.servers
.list()
2829 for hype
in hypervisors
:
2830 for server
in servers
:
2832 server
.to_dict()["OS-EXT-SRV-ATTR:hypervisor_hostname"]
2833 == hype
["hypervisor_hostname"]
2836 hype
["vm"].append(server
.id)
2838 hype
["vm"] = [server
.id]
2841 except nvExceptions
.NotFound
as e
:
2842 error_value
= -vimconn
.HTTP_Not_Found
2843 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
2844 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
2845 error_value
= -vimconn
.HTTP_Bad_Request
2849 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
2852 # TODO insert exception vimconn.HTTP_Unauthorized
2853 # if reaching here is because an exception
2854 self
.logger
.debug("get_hosts " + error_text
)
2856 return error_value
, error_text
2858 def new_classification(self
, name
, ctype
, definition
):
2860 "Adding a new (Traffic) Classification to VIM, named %s", name
2865 self
._reload
_connection
()
2867 if ctype
not in supportedClassificationTypes
:
2868 raise vimconn
.VimConnNotSupportedException(
2869 "OpenStack VIM connector does not support provided "
2870 "Classification Type {}, supported ones are: {}".format(
2871 ctype
, supportedClassificationTypes
2875 if not self
._validate
_classification
(ctype
, definition
):
2876 raise vimconn
.VimConnException(
2877 "Incorrect Classification definition for the type specified."
2880 classification_dict
= definition
2881 classification_dict
["name"] = name
2882 new_class
= self
.neutron
.create_sfc_flow_classifier(
2883 {"flow_classifier": classification_dict
}
2886 return new_class
["flow_classifier"]["id"]
2888 neExceptions
.ConnectionFailed
,
2889 ksExceptions
.ClientException
,
2890 neExceptions
.NeutronException
,
2893 self
.logger
.error("Creation of Classification failed.")
2894 self
._format
_exception
(e
)
2896 def get_classification(self
, class_id
):
2897 self
.logger
.debug(" Getting Classification %s from VIM", class_id
)
2898 filter_dict
= {"id": class_id
}
2899 class_list
= self
.get_classification_list(filter_dict
)
2901 if len(class_list
) == 0:
2902 raise vimconn
.VimConnNotFoundException(
2903 "Classification '{}' not found".format(class_id
)
2905 elif len(class_list
) > 1:
2906 raise vimconn
.VimConnConflictException(
2907 "Found more than one Classification with this criteria"
2910 classification
= class_list
[0]
2912 return classification
2914 def get_classification_list(self
, filter_dict
={}):
2916 "Getting Classifications from VIM filter: '%s'", str(filter_dict
)
2920 filter_dict_os
= filter_dict
.copy()
2921 self
._reload
_connection
()
2923 if self
.api_version3
and "tenant_id" in filter_dict_os
:
2924 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
2926 classification_dict
= self
.neutron
.list_sfc_flow_classifiers(
2929 classification_list
= classification_dict
["flow_classifiers"]
2930 self
.__classification
_os
2mano
(classification_list
)
2932 return classification_list
2934 neExceptions
.ConnectionFailed
,
2935 ksExceptions
.ClientException
,
2936 neExceptions
.NeutronException
,
2939 self
._format
_exception
(e
)
2941 def delete_classification(self
, class_id
):
2942 self
.logger
.debug("Deleting Classification '%s' from VIM", class_id
)
2945 self
._reload
_connection
()
2946 self
.neutron
.delete_sfc_flow_classifier(class_id
)
2950 neExceptions
.ConnectionFailed
,
2951 neExceptions
.NeutronException
,
2952 ksExceptions
.ClientException
,
2953 neExceptions
.NeutronException
,
2956 self
._format
_exception
(e
)
2958 def new_sfi(self
, name
, ingress_ports
, egress_ports
, sfc_encap
=True):
2960 "Adding a new Service Function Instance to VIM, named '%s'", name
2965 self
._reload
_connection
()
2971 if len(ingress_ports
) != 1:
2972 raise vimconn
.VimConnNotSupportedException(
2973 "OpenStack VIM connector can only have 1 ingress port per SFI"
2976 if len(egress_ports
) != 1:
2977 raise vimconn
.VimConnNotSupportedException(
2978 "OpenStack VIM connector can only have 1 egress port per SFI"
2983 "ingress": ingress_ports
[0],
2984 "egress": egress_ports
[0],
2985 "service_function_parameters": {"correlation": correlation
},
2987 new_sfi
= self
.neutron
.create_sfc_port_pair({"port_pair": sfi_dict
})
2989 return new_sfi
["port_pair"]["id"]
2991 neExceptions
.ConnectionFailed
,
2992 ksExceptions
.ClientException
,
2993 neExceptions
.NeutronException
,
2998 self
.neutron
.delete_sfc_port_pair(new_sfi
["port_pair"]["id"])
3001 "Creation of Service Function Instance failed, with "
3002 "subsequent deletion failure as well."
3005 self
._format
_exception
(e
)
3007 def get_sfi(self
, sfi_id
):
3008 self
.logger
.debug("Getting Service Function Instance %s from VIM", sfi_id
)
3009 filter_dict
= {"id": sfi_id
}
3010 sfi_list
= self
.get_sfi_list(filter_dict
)
3012 if len(sfi_list
) == 0:
3013 raise vimconn
.VimConnNotFoundException(
3014 "Service Function Instance '{}' not found".format(sfi_id
)
3016 elif len(sfi_list
) > 1:
3017 raise vimconn
.VimConnConflictException(
3018 "Found more than one Service Function Instance with this criteria"
3025 def get_sfi_list(self
, filter_dict
={}):
3027 "Getting Service Function Instances from VIM filter: '%s'", str(filter_dict
)
3031 self
._reload
_connection
()
3032 filter_dict_os
= filter_dict
.copy()
3034 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3035 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3037 sfi_dict
= self
.neutron
.list_sfc_port_pairs(**filter_dict_os
)
3038 sfi_list
= sfi_dict
["port_pairs"]
3039 self
.__sfi
_os
2mano
(sfi_list
)
3043 neExceptions
.ConnectionFailed
,
3044 ksExceptions
.ClientException
,
3045 neExceptions
.NeutronException
,
3048 self
._format
_exception
(e
)
3050 def delete_sfi(self
, sfi_id
):
3051 self
.logger
.debug("Deleting Service Function Instance '%s' from VIM", sfi_id
)
3054 self
._reload
_connection
()
3055 self
.neutron
.delete_sfc_port_pair(sfi_id
)
3059 neExceptions
.ConnectionFailed
,
3060 neExceptions
.NeutronException
,
3061 ksExceptions
.ClientException
,
3062 neExceptions
.NeutronException
,
3065 self
._format
_exception
(e
)
3067 def new_sf(self
, name
, sfis
, sfc_encap
=True):
3068 self
.logger
.debug("Adding a new Service Function to VIM, named '%s'", name
)
3072 self
._reload
_connection
()
3073 # correlation = None
3075 # correlation = "nsh"
3077 for instance
in sfis
:
3078 sfi
= self
.get_sfi(instance
)
3080 if sfi
.get("sfc_encap") != sfc_encap
:
3081 raise vimconn
.VimConnNotSupportedException(
3082 "OpenStack VIM connector requires all SFIs of the "
3083 "same SF to share the same SFC Encapsulation"
3086 sf_dict
= {"name": name
, "port_pairs": sfis
}
3087 new_sf
= self
.neutron
.create_sfc_port_pair_group(
3088 {"port_pair_group": sf_dict
}
3091 return new_sf
["port_pair_group"]["id"]
3093 neExceptions
.ConnectionFailed
,
3094 ksExceptions
.ClientException
,
3095 neExceptions
.NeutronException
,
3100 self
.neutron
.delete_sfc_port_pair_group(
3101 new_sf
["port_pair_group"]["id"]
3105 "Creation of Service Function failed, with "
3106 "subsequent deletion failure as well."
3109 self
._format
_exception
(e
)
3111 def get_sf(self
, sf_id
):
3112 self
.logger
.debug("Getting Service Function %s from VIM", sf_id
)
3113 filter_dict
= {"id": sf_id
}
3114 sf_list
= self
.get_sf_list(filter_dict
)
3116 if len(sf_list
) == 0:
3117 raise vimconn
.VimConnNotFoundException(
3118 "Service Function '{}' not found".format(sf_id
)
3120 elif len(sf_list
) > 1:
3121 raise vimconn
.VimConnConflictException(
3122 "Found more than one Service Function with this criteria"
3129 def get_sf_list(self
, filter_dict
={}):
3131 "Getting Service Function from VIM filter: '%s'", str(filter_dict
)
3135 self
._reload
_connection
()
3136 filter_dict_os
= filter_dict
.copy()
3138 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3139 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3141 sf_dict
= self
.neutron
.list_sfc_port_pair_groups(**filter_dict_os
)
3142 sf_list
= sf_dict
["port_pair_groups"]
3143 self
.__sf
_os
2mano
(sf_list
)
3147 neExceptions
.ConnectionFailed
,
3148 ksExceptions
.ClientException
,
3149 neExceptions
.NeutronException
,
3152 self
._format
_exception
(e
)
3154 def delete_sf(self
, sf_id
):
3155 self
.logger
.debug("Deleting Service Function '%s' from VIM", sf_id
)
3158 self
._reload
_connection
()
3159 self
.neutron
.delete_sfc_port_pair_group(sf_id
)
3163 neExceptions
.ConnectionFailed
,
3164 neExceptions
.NeutronException
,
3165 ksExceptions
.ClientException
,
3166 neExceptions
.NeutronException
,
3169 self
._format
_exception
(e
)
3171 def new_sfp(self
, name
, classifications
, sfs
, sfc_encap
=True, spi
=None):
3172 self
.logger
.debug("Adding a new Service Function Path to VIM, named '%s'", name
)
3176 self
._reload
_connection
()
3177 # In networking-sfc the MPLS encapsulation is legacy
3178 # should be used when no full SFC Encapsulation is intended
3179 correlation
= "mpls"
3186 "flow_classifiers": classifications
,
3187 "port_pair_groups": sfs
,
3188 "chain_parameters": {"correlation": correlation
},
3192 sfp_dict
["chain_id"] = spi
3194 new_sfp
= self
.neutron
.create_sfc_port_chain({"port_chain": sfp_dict
})
3196 return new_sfp
["port_chain"]["id"]
3198 neExceptions
.ConnectionFailed
,
3199 ksExceptions
.ClientException
,
3200 neExceptions
.NeutronException
,
3205 self
.neutron
.delete_sfc_port_chain(new_sfp
["port_chain"]["id"])
3208 "Creation of Service Function Path failed, with "
3209 "subsequent deletion failure as well."
3212 self
._format
_exception
(e
)
3214 def get_sfp(self
, sfp_id
):
3215 self
.logger
.debug(" Getting Service Function Path %s from VIM", sfp_id
)
3217 filter_dict
= {"id": sfp_id
}
3218 sfp_list
= self
.get_sfp_list(filter_dict
)
3220 if len(sfp_list
) == 0:
3221 raise vimconn
.VimConnNotFoundException(
3222 "Service Function Path '{}' not found".format(sfp_id
)
3224 elif len(sfp_list
) > 1:
3225 raise vimconn
.VimConnConflictException(
3226 "Found more than one Service Function Path with this criteria"
3233 def get_sfp_list(self
, filter_dict
={}):
3235 "Getting Service Function Paths from VIM filter: '%s'", str(filter_dict
)
3239 self
._reload
_connection
()
3240 filter_dict_os
= filter_dict
.copy()
3242 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3243 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3245 sfp_dict
= self
.neutron
.list_sfc_port_chains(**filter_dict_os
)
3246 sfp_list
= sfp_dict
["port_chains"]
3247 self
.__sfp
_os
2mano
(sfp_list
)
3251 neExceptions
.ConnectionFailed
,
3252 ksExceptions
.ClientException
,
3253 neExceptions
.NeutronException
,
3256 self
._format
_exception
(e
)
3258 def delete_sfp(self
, sfp_id
):
3259 self
.logger
.debug("Deleting Service Function Path '%s' from VIM", sfp_id
)
3262 self
._reload
_connection
()
3263 self
.neutron
.delete_sfc_port_chain(sfp_id
)
3267 neExceptions
.ConnectionFailed
,
3268 neExceptions
.NeutronException
,
3269 ksExceptions
.ClientException
,
3270 neExceptions
.NeutronException
,
3273 self
._format
_exception
(e
)
3275 def refresh_sfps_status(self
, sfp_list
):
3276 """Get the status of the service function path
3277 Params: the list of sfp identifiers
3278 Returns a dictionary with:
3279 vm_id: #VIM id of this service function path
3280 status: #Mandatory. Text with one of:
3281 # DELETED (not found at vim)
3282 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3283 # OTHER (Vim reported other status not understood)
3284 # ERROR (VIM indicates an ERROR status)
3286 # CREATING (on building process)
3287 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3288 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)F
3292 "refresh_sfps status: Getting tenant SFP information from VIM"
3295 for sfp_id
in sfp_list
:
3299 sfp_vim
= self
.get_sfp(sfp_id
)
3302 sfp
["status"] = vmStatus2manoFormat
["ACTIVE"]
3304 sfp
["status"] = "OTHER"
3305 sfp
["error_msg"] = "VIM status reported " + sfp
["status"]
3307 sfp
["vim_info"] = self
.serialize(sfp_vim
)
3309 if sfp_vim
.get("fault"):
3310 sfp
["error_msg"] = str(sfp_vim
["fault"])
3311 except vimconn
.VimConnNotFoundException
as e
:
3312 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3313 sfp
["status"] = "DELETED"
3314 sfp
["error_msg"] = str(e
)
3315 except vimconn
.VimConnException
as e
:
3316 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3317 sfp
["status"] = "VIM_ERROR"
3318 sfp
["error_msg"] = str(e
)
3320 sfp_dict
[sfp_id
] = sfp
3324 def refresh_sfis_status(self
, sfi_list
):
3325 """Get the status of the service function instances
3326 Params: the list of sfi identifiers
3327 Returns a dictionary with:
3328 vm_id: #VIM id of this service function instance
3329 status: #Mandatory. Text with one of:
3330 # DELETED (not found at vim)
3331 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3332 # OTHER (Vim reported other status not understood)
3333 # ERROR (VIM indicates an ERROR status)
3335 # CREATING (on building process)
3336 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3337 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3341 "refresh_sfis status: Getting tenant sfi information from VIM"
3344 for sfi_id
in sfi_list
:
3348 sfi_vim
= self
.get_sfi(sfi_id
)
3351 sfi
["status"] = vmStatus2manoFormat
["ACTIVE"]
3353 sfi
["status"] = "OTHER"
3354 sfi
["error_msg"] = "VIM status reported " + sfi
["status"]
3356 sfi
["vim_info"] = self
.serialize(sfi_vim
)
3358 if sfi_vim
.get("fault"):
3359 sfi
["error_msg"] = str(sfi_vim
["fault"])
3360 except vimconn
.VimConnNotFoundException
as e
:
3361 self
.logger
.error("Exception getting sfi status: %s", str(e
))
3362 sfi
["status"] = "DELETED"
3363 sfi
["error_msg"] = str(e
)
3364 except vimconn
.VimConnException
as e
:
3365 self
.logger
.error("Exception getting sfi status: %s", str(e
))
3366 sfi
["status"] = "VIM_ERROR"
3367 sfi
["error_msg"] = str(e
)
3369 sfi_dict
[sfi_id
] = sfi
3373 def refresh_sfs_status(self
, sf_list
):
3374 """Get the status of the service functions
3375 Params: the list of sf identifiers
3376 Returns a dictionary with:
3377 vm_id: #VIM id of this service function
3378 status: #Mandatory. Text with one of:
3379 # DELETED (not found at vim)
3380 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3381 # OTHER (Vim reported other status not understood)
3382 # ERROR (VIM indicates an ERROR status)
3384 # CREATING (on building process)
3385 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3386 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3389 self
.logger
.debug("refresh_sfs status: Getting tenant sf information from VIM")
3391 for sf_id
in sf_list
:
3395 sf_vim
= self
.get_sf(sf_id
)
3398 sf
["status"] = vmStatus2manoFormat
["ACTIVE"]
3400 sf
["status"] = "OTHER"
3401 sf
["error_msg"] = "VIM status reported " + sf_vim
["status"]
3403 sf
["vim_info"] = self
.serialize(sf_vim
)
3405 if sf_vim
.get("fault"):
3406 sf
["error_msg"] = str(sf_vim
["fault"])
3407 except vimconn
.VimConnNotFoundException
as e
:
3408 self
.logger
.error("Exception getting sf status: %s", str(e
))
3409 sf
["status"] = "DELETED"
3410 sf
["error_msg"] = str(e
)
3411 except vimconn
.VimConnException
as e
:
3412 self
.logger
.error("Exception getting sf status: %s", str(e
))
3413 sf
["status"] = "VIM_ERROR"
3414 sf
["error_msg"] = str(e
)
3420 def refresh_classifications_status(self
, classification_list
):
3421 """Get the status of the classifications
3422 Params: the list of classification identifiers
3423 Returns a dictionary with:
3424 vm_id: #VIM id of this classifier
3425 status: #Mandatory. Text with one of:
3426 # DELETED (not found at vim)
3427 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3428 # OTHER (Vim reported other status not understood)
3429 # ERROR (VIM indicates an ERROR status)
3431 # CREATING (on building process)
3432 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3433 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3435 classification_dict
= {}
3437 "refresh_classifications status: Getting tenant classification information from VIM"
3440 for classification_id
in classification_list
:
3444 classification_vim
= self
.get_classification(classification_id
)
3446 if classification_vim
:
3447 classification
["status"] = vmStatus2manoFormat
["ACTIVE"]
3449 classification
["status"] = "OTHER"
3450 classification
["error_msg"] = (
3451 "VIM status reported " + classification
["status"]
3454 classification
["vim_info"] = self
.serialize(classification_vim
)
3456 if classification_vim
.get("fault"):
3457 classification
["error_msg"] = str(classification_vim
["fault"])
3458 except vimconn
.VimConnNotFoundException
as e
:
3459 self
.logger
.error("Exception getting classification status: %s", str(e
))
3460 classification
["status"] = "DELETED"
3461 classification
["error_msg"] = str(e
)
3462 except vimconn
.VimConnException
as e
:
3463 self
.logger
.error("Exception getting classification status: %s", str(e
))
3464 classification
["status"] = "VIM_ERROR"
3465 classification
["error_msg"] = str(e
)
3467 classification_dict
[classification_id
] = classification
3469 return classification_dict
3471 def new_affinity_group(self
, affinity_group_data
):
3472 """Adds a server group to VIM
3473 affinity_group_data contains a dictionary with information, keys:
3474 name: name in VIM for the server group
3475 type: affinity or anti-affinity
3476 scope: Only nfvi-node allowed
3477 Returns the server group identifier"""
3478 self
.logger
.debug("Adding Server Group '%s'", str(affinity_group_data
))
3481 name
= affinity_group_data
["name"]
3482 policy
= affinity_group_data
["type"]
3484 self
._reload
_connection
()
3485 new_server_group
= self
.nova
.server_groups
.create(name
, policy
)
3487 return new_server_group
.id
3489 ksExceptions
.ClientException
,
3490 nvExceptions
.ClientException
,
3494 self
._format
_exception
(e
)
3496 def get_affinity_group(self
, affinity_group_id
):
3497 """Obtain server group details from the VIM. Returns the server group detais as a dict"""
3498 self
.logger
.debug("Getting flavor '%s'", affinity_group_id
)
3500 self
._reload
_connection
()
3501 server_group
= self
.nova
.server_groups
.find(id=affinity_group_id
)
3503 return server_group
.to_dict()
3505 nvExceptions
.NotFound
,
3506 nvExceptions
.ClientException
,
3507 ksExceptions
.ClientException
,
3510 self
._format
_exception
(e
)
3512 def delete_affinity_group(self
, affinity_group_id
):
3513 """Deletes a server group from the VIM. Returns the old affinity_group_id"""
3514 self
.logger
.debug("Getting server group '%s'", affinity_group_id
)
3516 self
._reload
_connection
()
3517 self
.nova
.server_groups
.delete(affinity_group_id
)
3519 return affinity_group_id
3521 nvExceptions
.NotFound
,
3522 ksExceptions
.ClientException
,
3523 nvExceptions
.ClientException
,
3526 self
._format
_exception
(e
)