1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U.
5 # This file is part of openmano
8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
9 # not use this file except in compliance with the License. You may obtain
10 # a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 # License for the specific language governing permissions and limitations
22 osconnector implements all the methods to interact with openstack using the python-neutronclient.
24 For the VNF forwarding graph, The OpenStack VIM connector calls the
25 networking-sfc Neutron extension methods, whose resources are mapped
26 to the VIM connector's SFC resources as follows:
27 - Classification (OSM) -> Flow Classifier (Neutron)
28 - Service Function Instance (OSM) -> Port Pair (Neutron)
29 - Service Function (OSM) -> Port Pair Group (Neutron)
30 - Service Function Path (OSM) -> Port Chain (Neutron)
34 from http
.client
import HTTPException
37 from pprint
import pformat
41 from typing
import Dict
, List
, Optional
, Tuple
43 from cinderclient
import client
as cClient
44 from glanceclient
import client
as glClient
45 import glanceclient
.exc
as gl1Exceptions
46 from keystoneauth1
import session
47 from keystoneauth1
.identity
import v2
, v3
48 import keystoneclient
.exceptions
as ksExceptions
49 import keystoneclient
.v2_0
.client
as ksClient_v2
50 import keystoneclient
.v3
.client
as ksClient_v3
52 from neutronclient
.common
import exceptions
as neExceptions
53 from neutronclient
.neutron
import client
as neClient
54 from novaclient
import client
as nClient
, exceptions
as nvExceptions
55 from osm_ro_plugin
import vimconn
56 from requests
.exceptions
import ConnectionError
59 __author__
= "Alfonso Tierno, Gerardo Garcia, Pablo Montes, xFlow Research, Igor D.C., Eduardo Sousa"
60 __date__
= "$22-sep-2017 23:59:59$"
62 """contain the openstack virtual machine status to openmano status"""
63 vmStatus2manoFormat
= {
66 "SUSPENDED": "SUSPENDED",
67 "SHUTOFF": "INACTIVE",
72 netStatus2manoFormat
= {
75 "INACTIVE": "INACTIVE",
81 supportedClassificationTypes
= ["legacy_flow_classifier"]
83 # global var to have a timeout creating and deleting volumes
88 class SafeDumper(yaml
.SafeDumper
):
89 def represent_data(self
, data
):
90 # Openstack APIs use custom subclasses of dict and YAML safe dumper
91 # is designed to not handle that (reference issue 142 of pyyaml)
92 if isinstance(data
, dict) and data
.__class
__ != dict:
93 # A simple solution is to convert those items back to dicts
94 data
= dict(data
.items())
96 return super(SafeDumper
, self
).represent_data(data
)
99 class vimconnector(vimconn
.VimConnector
):
114 """using common constructor parameters. In this case
115 'url' is the keystone authorization url,
116 'url_admin' is not use
118 api_version
= config
.get("APIversion")
120 if api_version
and api_version
not in ("v3.3", "v2.0", "2", "3"):
121 raise vimconn
.VimConnException(
122 "Invalid value '{}' for config:APIversion. "
123 "Allowed values are 'v3.3', 'v2.0', '2' or '3'".format(api_version
)
126 vim_type
= config
.get("vim_type")
128 if vim_type
and vim_type
not in ("vio", "VIO"):
129 raise vimconn
.VimConnException(
130 "Invalid value '{}' for config:vim_type."
131 "Allowed values are 'vio' or 'VIO'".format(vim_type
)
134 if config
.get("dataplane_net_vlan_range") is not None:
135 # validate vlan ranges provided by user
136 self
._validate
_vlan
_ranges
(
137 config
.get("dataplane_net_vlan_range"), "dataplane_net_vlan_range"
140 if config
.get("multisegment_vlan_range") is not None:
141 # validate vlan ranges provided by user
142 self
._validate
_vlan
_ranges
(
143 config
.get("multisegment_vlan_range"), "multisegment_vlan_range"
146 vimconn
.VimConnector
.__init
__(
160 if self
.config
.get("insecure") and self
.config
.get("ca_cert"):
161 raise vimconn
.VimConnException(
162 "options insecure and ca_cert are mutually exclusive"
167 if self
.config
.get("insecure"):
170 if self
.config
.get("ca_cert"):
171 self
.verify
= self
.config
.get("ca_cert")
174 raise TypeError("url param can not be NoneType")
176 self
.persistent_info
= persistent_info
177 self
.availability_zone
= persistent_info
.get("availability_zone", None)
178 self
.session
= persistent_info
.get("session", {"reload_client": True})
179 self
.my_tenant_id
= self
.session
.get("my_tenant_id")
180 self
.nova
= self
.session
.get("nova")
181 self
.neutron
= self
.session
.get("neutron")
182 self
.cinder
= self
.session
.get("cinder")
183 self
.glance
= self
.session
.get("glance")
184 # self.glancev1 = self.session.get("glancev1")
185 self
.keystone
= self
.session
.get("keystone")
186 self
.api_version3
= self
.session
.get("api_version3")
187 self
.vim_type
= self
.config
.get("vim_type")
190 self
.vim_type
= self
.vim_type
.upper()
192 if self
.config
.get("use_internal_endpoint"):
193 self
.endpoint_type
= "internalURL"
195 self
.endpoint_type
= None
197 logging
.getLogger("urllib3").setLevel(logging
.WARNING
)
198 logging
.getLogger("keystoneauth").setLevel(logging
.WARNING
)
199 logging
.getLogger("novaclient").setLevel(logging
.WARNING
)
200 self
.logger
= logging
.getLogger("ro.vim.openstack")
202 # allow security_groups to be a list or a single string
203 if isinstance(self
.config
.get("security_groups"), str):
204 self
.config
["security_groups"] = [self
.config
["security_groups"]]
206 self
.security_groups_id
= None
208 # ###### VIO Specific Changes #########
209 if self
.vim_type
== "VIO":
210 self
.logger
= logging
.getLogger("ro.vim.vio")
213 self
.logger
.setLevel(getattr(logging
, log_level
))
215 def __getitem__(self
, index
):
216 """Get individuals parameters.
218 if index
== "project_domain_id":
219 return self
.config
.get("project_domain_id")
220 elif index
== "user_domain_id":
221 return self
.config
.get("user_domain_id")
223 return vimconn
.VimConnector
.__getitem
__(self
, index
)
225 def __setitem__(self
, index
, value
):
226 """Set individuals parameters and it is marked as dirty so to force connection reload.
228 if index
== "project_domain_id":
229 self
.config
["project_domain_id"] = value
230 elif index
== "user_domain_id":
231 self
.config
["user_domain_id"] = value
233 vimconn
.VimConnector
.__setitem
__(self
, index
, value
)
235 self
.session
["reload_client"] = True
237 def serialize(self
, value
):
238 """Serialization of python basic types.
240 In the case value is not serializable a message will be logged and a
241 simple representation of the data that cannot be converted back to
244 if isinstance(value
, str):
249 value
, Dumper
=SafeDumper
, default_flow_style
=True, width
=256
251 except yaml
.representer
.RepresenterError
:
253 "The following entity cannot be serialized in YAML:\n\n%s\n\n",
260 def _reload_connection(self
):
261 """Called before any operation, it check if credentials has changed
262 Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
264 # TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
265 if self
.session
["reload_client"]:
266 if self
.config
.get("APIversion"):
267 self
.api_version3
= (
268 self
.config
["APIversion"] == "v3.3"
269 or self
.config
["APIversion"] == "3"
271 else: # get from ending auth_url that end with v3 or with v2.0
272 self
.api_version3
= self
.url
.endswith("/v3") or self
.url
.endswith(
276 self
.session
["api_version3"] = self
.api_version3
278 if self
.api_version3
:
279 if self
.config
.get("project_domain_id") or self
.config
.get(
280 "project_domain_name"
282 project_domain_id_default
= None
284 project_domain_id_default
= "default"
286 if self
.config
.get("user_domain_id") or self
.config
.get(
289 user_domain_id_default
= None
291 user_domain_id_default
= "default"
295 password
=self
.passwd
,
296 project_name
=self
.tenant_name
,
297 project_id
=self
.tenant_id
,
298 project_domain_id
=self
.config
.get(
299 "project_domain_id", project_domain_id_default
301 user_domain_id
=self
.config
.get(
302 "user_domain_id", user_domain_id_default
304 project_domain_name
=self
.config
.get("project_domain_name"),
305 user_domain_name
=self
.config
.get("user_domain_name"),
311 password
=self
.passwd
,
312 tenant_name
=self
.tenant_name
,
313 tenant_id
=self
.tenant_id
,
316 sess
= session
.Session(auth
=auth
, verify
=self
.verify
)
317 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
318 # Titanium cloud and StarlingX
319 region_name
= self
.config
.get("region_name")
321 if self
.api_version3
:
322 self
.keystone
= ksClient_v3
.Client(
324 endpoint_type
=self
.endpoint_type
,
325 region_name
=region_name
,
328 self
.keystone
= ksClient_v2
.Client(
329 session
=sess
, endpoint_type
=self
.endpoint_type
332 self
.session
["keystone"] = self
.keystone
333 # In order to enable microversion functionality an explicit microversion must be specified in "config".
334 # This implementation approach is due to the warning message in
335 # https://developer.openstack.org/api-guide/compute/microversions.html
336 # where it is stated that microversion backwards compatibility is not guaranteed and clients should
337 # always require an specific microversion.
338 # To be able to use "device role tagging" functionality define "microversion: 2.32" in datacenter config
339 version
= self
.config
.get("microversion")
344 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
345 # Titanium cloud and StarlingX
346 self
.nova
= self
.session
["nova"] = nClient
.Client(
349 endpoint_type
=self
.endpoint_type
,
350 region_name
=region_name
,
352 self
.neutron
= self
.session
["neutron"] = neClient
.Client(
355 endpoint_type
=self
.endpoint_type
,
356 region_name
=region_name
,
358 self
.cinder
= self
.session
["cinder"] = cClient
.Client(
361 endpoint_type
=self
.endpoint_type
,
362 region_name
=region_name
,
366 self
.my_tenant_id
= self
.session
["my_tenant_id"] = sess
.get_project_id()
368 self
.logger
.error("Cannot get project_id from session", exc_info
=True)
370 if self
.endpoint_type
== "internalURL":
371 glance_service_id
= self
.keystone
.services
.list(name
="glance")[0].id
372 glance_endpoint
= self
.keystone
.endpoints
.list(
373 glance_service_id
, interface
="internal"
376 glance_endpoint
= None
378 self
.glance
= self
.session
["glance"] = glClient
.Client(
379 2, session
=sess
, endpoint
=glance_endpoint
381 # using version 1 of glance client in new_image()
382 # self.glancev1 = self.session["glancev1"] = glClient.Client("1", session=sess,
383 # endpoint=glance_endpoint)
384 self
.session
["reload_client"] = False
385 self
.persistent_info
["session"] = self
.session
386 # add availablity zone info inside self.persistent_info
387 self
._set
_availablity
_zones
()
388 self
.persistent_info
["availability_zone"] = self
.availability_zone
389 # force to get again security_groups_ids next time they are needed
390 self
.security_groups_id
= None
392 def __net_os2mano(self
, net_list_dict
):
393 """Transform the net openstack format to mano format
394 net_list_dict can be a list of dict or a single dict"""
395 if type(net_list_dict
) is dict:
396 net_list_
= (net_list_dict
,)
397 elif type(net_list_dict
) is list:
398 net_list_
= net_list_dict
400 raise TypeError("param net_list_dict must be a list or a dictionary")
401 for net
in net_list_
:
402 if net
.get("provider:network_type") == "vlan":
405 net
["type"] = "bridge"
407 def __classification_os2mano(self
, class_list_dict
):
408 """Transform the openstack format (Flow Classifier) to mano format
409 (Classification) class_list_dict can be a list of dict or a single dict
411 if isinstance(class_list_dict
, dict):
412 class_list_
= [class_list_dict
]
413 elif isinstance(class_list_dict
, list):
414 class_list_
= class_list_dict
416 raise TypeError("param class_list_dict must be a list or a dictionary")
417 for classification
in class_list_
:
418 id = classification
.pop("id")
419 name
= classification
.pop("name")
420 description
= classification
.pop("description")
421 project_id
= classification
.pop("project_id")
422 tenant_id
= classification
.pop("tenant_id")
423 original_classification
= copy
.deepcopy(classification
)
424 classification
.clear()
425 classification
["ctype"] = "legacy_flow_classifier"
426 classification
["definition"] = original_classification
427 classification
["id"] = id
428 classification
["name"] = name
429 classification
["description"] = description
430 classification
["project_id"] = project_id
431 classification
["tenant_id"] = tenant_id
433 def __sfi_os2mano(self
, sfi_list_dict
):
434 """Transform the openstack format (Port Pair) to mano format (SFI)
435 sfi_list_dict can be a list of dict or a single dict
437 if isinstance(sfi_list_dict
, dict):
438 sfi_list_
= [sfi_list_dict
]
439 elif isinstance(sfi_list_dict
, list):
440 sfi_list_
= sfi_list_dict
442 raise TypeError("param sfi_list_dict must be a list or a dictionary")
444 for sfi
in sfi_list_
:
445 sfi
["ingress_ports"] = []
446 sfi
["egress_ports"] = []
448 if sfi
.get("ingress"):
449 sfi
["ingress_ports"].append(sfi
["ingress"])
451 if sfi
.get("egress"):
452 sfi
["egress_ports"].append(sfi
["egress"])
456 params
= sfi
.get("service_function_parameters")
460 correlation
= params
.get("correlation")
465 sfi
["sfc_encap"] = sfc_encap
466 del sfi
["service_function_parameters"]
468 def __sf_os2mano(self
, sf_list_dict
):
469 """Transform the openstack format (Port Pair Group) to mano format (SF)
470 sf_list_dict can be a list of dict or a single dict
472 if isinstance(sf_list_dict
, dict):
473 sf_list_
= [sf_list_dict
]
474 elif isinstance(sf_list_dict
, list):
475 sf_list_
= sf_list_dict
477 raise TypeError("param sf_list_dict must be a list or a dictionary")
480 del sf
["port_pair_group_parameters"]
481 sf
["sfis"] = sf
["port_pairs"]
484 def __sfp_os2mano(self
, sfp_list_dict
):
485 """Transform the openstack format (Port Chain) to mano format (SFP)
486 sfp_list_dict can be a list of dict or a single dict
488 if isinstance(sfp_list_dict
, dict):
489 sfp_list_
= [sfp_list_dict
]
490 elif isinstance(sfp_list_dict
, list):
491 sfp_list_
= sfp_list_dict
493 raise TypeError("param sfp_list_dict must be a list or a dictionary")
495 for sfp
in sfp_list_
:
496 params
= sfp
.pop("chain_parameters")
500 correlation
= params
.get("correlation")
505 sfp
["sfc_encap"] = sfc_encap
506 sfp
["spi"] = sfp
.pop("chain_id")
507 sfp
["classifications"] = sfp
.pop("flow_classifiers")
508 sfp
["service_functions"] = sfp
.pop("port_pair_groups")
510 # placeholder for now; read TODO note below
511 def _validate_classification(self
, type, definition
):
512 # only legacy_flow_classifier Type is supported at this point
514 # TODO(igordcard): this method should be an abstract method of an
515 # abstract Classification class to be implemented by the specific
516 # Types. Also, abstract vimconnector should call the validation
517 # method before the implemented VIM connectors are called.
519 def _format_exception(self
, exception
):
520 """Transform a keystone, nova, neutron exception into a vimconn exception discovering the cause"""
521 message_error
= str(exception
)
527 neExceptions
.NetworkNotFoundClient
,
528 nvExceptions
.NotFound
,
529 ksExceptions
.NotFound
,
530 gl1Exceptions
.HTTPNotFound
,
533 raise vimconn
.VimConnNotFoundException(
534 type(exception
).__name
__ + ": " + message_error
540 gl1Exceptions
.HTTPException
,
541 gl1Exceptions
.CommunicationError
,
543 ksExceptions
.ConnectionError
,
544 neExceptions
.ConnectionFailed
,
547 if type(exception
).__name
__ == "SSLError":
548 tip
= " (maybe option 'insecure' must be added to the VIM)"
550 raise vimconn
.VimConnConnectionException(
551 "Invalid URL or credentials{}: {}".format(tip
, message_error
)
557 nvExceptions
.BadRequest
,
558 ksExceptions
.BadRequest
,
561 raise vimconn
.VimConnException(
562 type(exception
).__name
__ + ": " + message_error
567 nvExceptions
.ClientException
,
568 ksExceptions
.ClientException
,
569 neExceptions
.NeutronException
,
572 raise vimconn
.VimConnUnexpectedResponse(
573 type(exception
).__name
__ + ": " + message_error
575 elif isinstance(exception
, nvExceptions
.Conflict
):
576 raise vimconn
.VimConnConflictException(
577 type(exception
).__name
__ + ": " + message_error
579 elif isinstance(exception
, vimconn
.VimConnException
):
582 self
.logger
.error("General Exception " + message_error
, exc_info
=True)
584 raise vimconn
.VimConnConnectionException(
585 type(exception
).__name
__ + ": " + message_error
588 def _get_ids_from_name(self
):
590 Obtain ids from name of tenant and security_groups. Store at self .security_groups_id"
593 # get tenant_id if only tenant_name is supplied
594 self
._reload
_connection
()
596 if not self
.my_tenant_id
:
597 raise vimconn
.VimConnConnectionException(
598 "Error getting tenant information from name={} id={}".format(
599 self
.tenant_name
, self
.tenant_id
603 if self
.config
.get("security_groups") and not self
.security_groups_id
:
604 # convert from name to id
605 neutron_sg_list
= self
.neutron
.list_security_groups(
606 tenant_id
=self
.my_tenant_id
609 self
.security_groups_id
= []
610 for sg
in self
.config
.get("security_groups"):
611 for neutron_sg
in neutron_sg_list
:
612 if sg
in (neutron_sg
["id"], neutron_sg
["name"]):
613 self
.security_groups_id
.append(neutron_sg
["id"])
616 self
.security_groups_id
= None
618 raise vimconn
.VimConnConnectionException(
619 "Not found security group {} for this tenant".format(sg
)
622 def check_vim_connectivity(self
):
623 # just get network list to check connectivity and credentials
624 self
.get_network_list(filter_dict
={})
626 def get_tenant_list(self
, filter_dict
={}):
627 """Obtain tenants of VIM
628 filter_dict can contain the following keys:
629 name: filter by tenant name
630 id: filter by tenant uuid/id
632 Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
634 self
.logger
.debug("Getting tenants from VIM filter: '%s'", str(filter_dict
))
637 self
._reload
_connection
()
639 if self
.api_version3
:
640 project_class_list
= self
.keystone
.projects
.list(
641 name
=filter_dict
.get("name")
644 project_class_list
= self
.keystone
.tenants
.findall(**filter_dict
)
648 for project
in project_class_list
:
649 if filter_dict
.get("id") and filter_dict
["id"] != project
.id:
652 project_list
.append(project
.to_dict())
656 ksExceptions
.ConnectionError
,
657 ksExceptions
.ClientException
,
660 self
._format
_exception
(e
)
662 def new_tenant(self
, tenant_name
, tenant_description
):
663 """Adds a new tenant to openstack VIM. Returns the tenant identifier"""
664 self
.logger
.debug("Adding a new tenant name: %s", tenant_name
)
667 self
._reload
_connection
()
669 if self
.api_version3
:
670 project
= self
.keystone
.projects
.create(
672 self
.config
.get("project_domain_id", "default"),
673 description
=tenant_description
,
677 project
= self
.keystone
.tenants
.create(tenant_name
, tenant_description
)
681 ksExceptions
.ConnectionError
,
682 ksExceptions
.ClientException
,
683 ksExceptions
.BadRequest
,
686 self
._format
_exception
(e
)
688 def delete_tenant(self
, tenant_id
):
689 """Delete a tenant from openstack VIM. Returns the old tenant identifier"""
690 self
.logger
.debug("Deleting tenant %s from VIM", tenant_id
)
693 self
._reload
_connection
()
695 if self
.api_version3
:
696 self
.keystone
.projects
.delete(tenant_id
)
698 self
.keystone
.tenants
.delete(tenant_id
)
702 ksExceptions
.ConnectionError
,
703 ksExceptions
.ClientException
,
704 ksExceptions
.NotFound
,
707 self
._format
_exception
(e
)
715 provider_network_profile
=None,
717 """Adds a tenant network to VIM
719 'net_name': name of the network
721 'bridge': overlay isolated network
722 'data': underlay E-LAN network for Passthrough and SRIOV interfaces
723 'ptp': underlay E-LINE network for Passthrough and SRIOV interfaces.
724 'ip_profile': is a dict containing the IP parameters of the network
725 'ip_version': can be "IPv4" or "IPv6" (Currently only IPv4 is implemented)
726 'subnet_address': ip_prefix_schema, that is X.X.X.X/Y
727 'gateway_address': (Optional) ip_schema, that is X.X.X.X
728 'dns_address': (Optional) comma separated list of ip_schema, e.g. X.X.X.X[,X,X,X,X]
729 'dhcp_enabled': True or False
730 'dhcp_start_address': ip_schema, first IP to grant
731 'dhcp_count': number of IPs to grant.
732 'shared': if this network can be seen/use by other tenants/organization
733 'provider_network_profile': (optional) contains {segmentation-id: vlan, network-type: vlan|vxlan,
734 physical-network: physnet-label}
735 Returns a tuple with the network identifier and created_items, or raises an exception on error
736 created_items can be None or a dictionary where this method can include key-values that will be passed to
737 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
738 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
742 "Adding a new network to VIM name '%s', type '%s'", net_name
, net_type
744 # self.logger.debug(">>>>>>>>>>>>>>>>>> IP profile %s", str(ip_profile))
749 if provider_network_profile
:
750 vlan
= provider_network_profile
.get("segmentation-id")
754 self
._reload
_connection
()
755 network_dict
= {"name": net_name
, "admin_state_up": True}
757 if net_type
in ("data", "ptp") or provider_network_profile
:
758 provider_physical_network
= None
760 if provider_network_profile
and provider_network_profile
.get(
763 provider_physical_network
= provider_network_profile
.get(
767 # provider-network must be one of the dataplane_physcial_netowrk if this is a list. If it is string
768 # or not declared, just ignore the checking
771 self
.config
.get("dataplane_physical_net"), (tuple, list)
773 and provider_physical_network
774 not in self
.config
["dataplane_physical_net"]
776 raise vimconn
.VimConnConflictException(
777 "Invalid parameter 'provider-network:physical-network' "
778 "for network creation. '{}' is not one of the declared "
779 "list at VIM_config:dataplane_physical_net".format(
780 provider_physical_network
784 # use the default dataplane_physical_net
785 if not provider_physical_network
:
786 provider_physical_network
= self
.config
.get(
787 "dataplane_physical_net"
790 # if it is non empty list, use the first value. If it is a string use the value directly
792 isinstance(provider_physical_network
, (tuple, list))
793 and provider_physical_network
795 provider_physical_network
= provider_physical_network
[0]
797 if not provider_physical_network
:
798 raise vimconn
.VimConnConflictException(
799 "missing information needed for underlay networks. Provide "
800 "'dataplane_physical_net' configuration at VIM or use the NS "
801 "instantiation parameter 'provider-network.physical-network'"
805 if not self
.config
.get("multisegment_support"):
807 "provider:physical_network"
808 ] = provider_physical_network
811 provider_network_profile
812 and "network-type" in provider_network_profile
815 "provider:network_type"
816 ] = provider_network_profile
["network-type"]
818 network_dict
["provider:network_type"] = self
.config
.get(
819 "dataplane_network_type", "vlan"
823 network_dict
["provider:segmentation_id"] = vlan
828 "provider:physical_network": "",
829 "provider:network_type": "vxlan",
831 segment_list
.append(segment1_dict
)
833 "provider:physical_network": provider_physical_network
,
834 "provider:network_type": "vlan",
838 segment2_dict
["provider:segmentation_id"] = vlan
839 elif self
.config
.get("multisegment_vlan_range"):
840 vlanID
= self
._generate
_multisegment
_vlanID
()
841 segment2_dict
["provider:segmentation_id"] = vlanID
844 # raise vimconn.VimConnConflictException(
845 # "You must provide "multisegment_vlan_range" at config dict before creating a multisegment
847 segment_list
.append(segment2_dict
)
848 network_dict
["segments"] = segment_list
850 # VIO Specific Changes. It needs a concrete VLAN
851 if self
.vim_type
== "VIO" and vlan
is None:
852 if self
.config
.get("dataplane_net_vlan_range") is None:
853 raise vimconn
.VimConnConflictException(
854 "You must provide 'dataplane_net_vlan_range' in format "
855 "[start_ID - end_ID] at VIM_config for creating underlay "
859 network_dict
["provider:segmentation_id"] = self
._generate
_vlanID
()
861 network_dict
["shared"] = shared
863 if self
.config
.get("disable_network_port_security"):
864 network_dict
["port_security_enabled"] = False
866 if self
.config
.get("neutron_availability_zone_hints"):
867 hints
= self
.config
.get("neutron_availability_zone_hints")
869 if isinstance(hints
, str):
872 network_dict
["availability_zone_hints"] = hints
874 new_net
= self
.neutron
.create_network({"network": network_dict
})
876 # create subnetwork, even if there is no profile
881 if not ip_profile
.get("subnet_address"):
882 # Fake subnet is required
883 subnet_rand
= random
.randint(0, 255)
884 ip_profile
["subnet_address"] = "192.168.{}.0/24".format(subnet_rand
)
886 if "ip_version" not in ip_profile
:
887 ip_profile
["ip_version"] = "IPv4"
890 "name": net_name
+ "-subnet",
891 "network_id": new_net
["network"]["id"],
892 "ip_version": 4 if ip_profile
["ip_version"] == "IPv4" else 6,
893 "cidr": ip_profile
["subnet_address"],
896 # Gateway should be set to None if not needed. Otherwise openstack assigns one by default
897 if ip_profile
.get("gateway_address"):
898 subnet
["gateway_ip"] = ip_profile
["gateway_address"]
900 subnet
["gateway_ip"] = None
902 if ip_profile
.get("dns_address"):
903 subnet
["dns_nameservers"] = ip_profile
["dns_address"].split(";")
905 if "dhcp_enabled" in ip_profile
:
906 subnet
["enable_dhcp"] = (
908 if ip_profile
["dhcp_enabled"] == "false"
909 or ip_profile
["dhcp_enabled"] is False
913 if ip_profile
.get("dhcp_start_address"):
914 subnet
["allocation_pools"] = []
915 subnet
["allocation_pools"].append(dict())
916 subnet
["allocation_pools"][0]["start"] = ip_profile
[
920 if ip_profile
.get("dhcp_count"):
921 # parts = ip_profile["dhcp_start_address"].split(".")
922 # ip_int = (int(parts[0]) << 24) + (int(parts[1]) << 16) + (int(parts[2]) << 8) + int(parts[3])
923 ip_int
= int(netaddr
.IPAddress(ip_profile
["dhcp_start_address"]))
924 ip_int
+= ip_profile
["dhcp_count"] - 1
925 ip_str
= str(netaddr
.IPAddress(ip_int
))
926 subnet
["allocation_pools"][0]["end"] = ip_str
928 # self.logger.debug(">>>>>>>>>>>>>>>>>> Subnet: %s", str(subnet))
929 self
.neutron
.create_subnet({"subnet": subnet
})
931 if net_type
== "data" and self
.config
.get("multisegment_support"):
932 if self
.config
.get("l2gw_support"):
933 l2gw_list
= self
.neutron
.list_l2_gateways().get("l2_gateways", ())
934 for l2gw
in l2gw_list
:
936 "l2_gateway_id": l2gw
["id"],
937 "network_id": new_net
["network"]["id"],
938 "segmentation_id": str(vlanID
),
940 new_l2gw_conn
= self
.neutron
.create_l2_gateway_connection(
941 {"l2_gateway_connection": l2gw_conn
}
945 + str(new_l2gw_conn
["l2_gateway_connection"]["id"])
948 return new_net
["network"]["id"], created_items
949 except Exception as e
:
950 # delete l2gw connections (if any) before deleting the network
951 for k
, v
in created_items
.items():
952 if not v
: # skip already deleted
956 k_item
, _
, k_id
= k
.partition(":")
958 if k_item
== "l2gwconn":
959 self
.neutron
.delete_l2_gateway_connection(k_id
)
960 except Exception as e2
:
962 "Error deleting l2 gateway connection: {}: {}".format(
963 type(e2
).__name
__, e2
968 self
.neutron
.delete_network(new_net
["network"]["id"])
970 self
._format
_exception
(e
)
972 def get_network_list(self
, filter_dict
={}):
973 """Obtain tenant networks of VIM
979 admin_state_up: boolean
981 Returns the network list of dictionaries
983 self
.logger
.debug("Getting network from VIM filter: '%s'", str(filter_dict
))
986 self
._reload
_connection
()
987 filter_dict_os
= filter_dict
.copy()
989 if self
.api_version3
and "tenant_id" in filter_dict_os
:
991 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
993 net_dict
= self
.neutron
.list_networks(**filter_dict_os
)
994 net_list
= net_dict
["networks"]
995 self
.__net
_os
2mano
(net_list
)
999 neExceptions
.ConnectionFailed
,
1000 ksExceptions
.ClientException
,
1001 neExceptions
.NeutronException
,
1004 self
._format
_exception
(e
)
1006 def get_network(self
, net_id
):
1007 """Obtain details of network from VIM
1008 Returns the network information from a network id"""
1009 self
.logger
.debug(" Getting tenant network %s from VIM", net_id
)
1010 filter_dict
= {"id": net_id
}
1011 net_list
= self
.get_network_list(filter_dict
)
1013 if len(net_list
) == 0:
1014 raise vimconn
.VimConnNotFoundException(
1015 "Network '{}' not found".format(net_id
)
1017 elif len(net_list
) > 1:
1018 raise vimconn
.VimConnConflictException(
1019 "Found more than one network with this criteria"
1024 for subnet_id
in net
.get("subnets", ()):
1026 subnet
= self
.neutron
.show_subnet(subnet_id
)
1027 except Exception as e
:
1029 "osconnector.get_network(): Error getting subnet %s %s"
1032 subnet
= {"id": subnet_id
, "fault": str(e
)}
1034 subnets
.append(subnet
)
1036 net
["subnets"] = subnets
1037 net
["encapsulation"] = net
.get("provider:network_type")
1038 net
["encapsulation_type"] = net
.get("provider:network_type")
1039 net
["segmentation_id"] = net
.get("provider:segmentation_id")
1040 net
["encapsulation_id"] = net
.get("provider:segmentation_id")
1044 def delete_network(self
, net_id
, created_items
=None):
1046 Removes a tenant network from VIM and its associated elements
1047 :param net_id: VIM identifier of the network, provided by method new_network
1048 :param created_items: dictionary with extra items to be deleted. provided by method new_network
1049 Returns the network identifier or raises an exception upon error or when network is not found
1051 self
.logger
.debug("Deleting network '%s' from VIM", net_id
)
1053 if created_items
is None:
1057 self
._reload
_connection
()
1058 # delete l2gw connections (if any) before deleting the network
1059 for k
, v
in created_items
.items():
1060 if not v
: # skip already deleted
1064 k_item
, _
, k_id
= k
.partition(":")
1065 if k_item
== "l2gwconn":
1066 self
.neutron
.delete_l2_gateway_connection(k_id
)
1067 except Exception as e
:
1069 "Error deleting l2 gateway connection: {}: {}".format(
1074 # delete VM ports attached to this networks before the network
1075 ports
= self
.neutron
.list_ports(network_id
=net_id
)
1076 for p
in ports
["ports"]:
1078 self
.neutron
.delete_port(p
["id"])
1079 except Exception as e
:
1080 self
.logger
.error("Error deleting port %s: %s", p
["id"], str(e
))
1082 self
.neutron
.delete_network(net_id
)
1086 neExceptions
.ConnectionFailed
,
1087 neExceptions
.NetworkNotFoundClient
,
1088 neExceptions
.NeutronException
,
1089 ksExceptions
.ClientException
,
1090 neExceptions
.NeutronException
,
1093 self
._format
_exception
(e
)
1095 def refresh_nets_status(self
, net_list
):
1096 """Get the status of the networks
1097 Params: the list of network identifiers
1098 Returns a dictionary with:
1099 net_id: #VIM id of this network
1100 status: #Mandatory. Text with one of:
1101 # DELETED (not found at vim)
1102 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1103 # OTHER (Vim reported other status not understood)
1104 # ERROR (VIM indicates an ERROR status)
1105 # ACTIVE, INACTIVE, DOWN (admin down),
1106 # BUILD (on building process)
1108 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
1109 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1113 for net_id
in net_list
:
1117 net_vim
= self
.get_network(net_id
)
1119 if net_vim
["status"] in netStatus2manoFormat
:
1120 net
["status"] = netStatus2manoFormat
[net_vim
["status"]]
1122 net
["status"] = "OTHER"
1123 net
["error_msg"] = "VIM status reported " + net_vim
["status"]
1125 if net
["status"] == "ACTIVE" and not net_vim
["admin_state_up"]:
1126 net
["status"] = "DOWN"
1128 net
["vim_info"] = self
.serialize(net_vim
)
1130 if net_vim
.get("fault"): # TODO
1131 net
["error_msg"] = str(net_vim
["fault"])
1132 except vimconn
.VimConnNotFoundException
as e
:
1133 self
.logger
.error("Exception getting net status: %s", str(e
))
1134 net
["status"] = "DELETED"
1135 net
["error_msg"] = str(e
)
1136 except vimconn
.VimConnException
as e
:
1137 self
.logger
.error("Exception getting net status: %s", str(e
))
1138 net
["status"] = "VIM_ERROR"
1139 net
["error_msg"] = str(e
)
1140 net_dict
[net_id
] = net
1143 def get_flavor(self
, flavor_id
):
1144 """Obtain flavor details from the VIM. Returns the flavor dict details"""
1145 self
.logger
.debug("Getting flavor '%s'", flavor_id
)
1148 self
._reload
_connection
()
1149 flavor
= self
.nova
.flavors
.find(id=flavor_id
)
1150 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
1152 return flavor
.to_dict()
1154 nvExceptions
.NotFound
,
1155 nvExceptions
.ClientException
,
1156 ksExceptions
.ClientException
,
1159 self
._format
_exception
(e
)
1161 def get_flavor_id_from_data(self
, flavor_dict
):
1162 """Obtain flavor id that match the flavor description
1163 Returns the flavor_id or raises a vimconnNotFoundException
1164 flavor_dict: contains the required ram, vcpus, disk
1165 If 'use_existing_flavors' is set to True at config, the closer flavor that provides same or more ram, vcpus
1166 and disk is returned. Otherwise a flavor with exactly same ram, vcpus and disk is returned or a
1167 vimconnNotFoundException is raised
1169 exact_match
= False if self
.config
.get("use_existing_flavors") else True
1172 self
._reload
_connection
()
1173 flavor_candidate_id
= None
1174 flavor_candidate_data
= (10000, 10000, 10000)
1177 flavor_dict
["vcpus"],
1178 flavor_dict
["disk"],
1179 flavor_dict
.get("ephemeral", 0),
1180 flavor_dict
.get("swap", 0),
1183 extended
= flavor_dict
.get("extended", {})
1186 raise vimconn
.VimConnNotFoundException(
1187 "Flavor with EPA still not implemented"
1189 # if len(numas) > 1:
1190 # raise vimconn.VimConnNotFoundException("Cannot find any flavor with more than one numa")
1192 # numas = extended.get("numas")
1193 for flavor
in self
.nova
.flavors
.list():
1194 epa
= flavor
.get_keys()
1205 flavor
.swap
if isinstance(flavor
.swap
, int) else 0,
1207 if flavor_data
== flavor_target
:
1211 and flavor_target
< flavor_data
< flavor_candidate_data
1213 flavor_candidate_id
= flavor
.id
1214 flavor_candidate_data
= flavor_data
1216 if not exact_match
and flavor_candidate_id
:
1217 return flavor_candidate_id
1219 raise vimconn
.VimConnNotFoundException(
1220 "Cannot find any flavor matching '{}'".format(flavor_dict
)
1223 nvExceptions
.NotFound
,
1224 nvExceptions
.ClientException
,
1225 ksExceptions
.ClientException
,
1228 self
._format
_exception
(e
)
1231 def process_resource_quota(quota
: dict, prefix
: str, extra_specs
: dict) -> None:
1232 """Process resource quota and fill up extra_specs.
1234 quota (dict): Keeping the quota of resurces
1236 extra_specs (dict) Dict to be filled to be used during flavor creation
1239 if "limit" in quota
:
1240 extra_specs
["quota:" + prefix
+ "_limit"] = quota
["limit"]
1242 if "reserve" in quota
:
1243 extra_specs
["quota:" + prefix
+ "_reservation"] = quota
["reserve"]
1245 if "shares" in quota
:
1246 extra_specs
["quota:" + prefix
+ "_shares_level"] = "custom"
1247 extra_specs
["quota:" + prefix
+ "_shares_share"] = quota
["shares"]
1250 def process_numa_memory(
1251 numa
: dict, node_id
: Optional
[int], extra_specs
: dict
1253 """Set the memory in extra_specs.
1255 numa (dict): A dictionary which includes numa information
1256 node_id (int): ID of numa node
1257 extra_specs (dict): To be filled.
1260 if not numa
.get("memory"):
1262 memory_mb
= numa
["memory"] * 1024
1263 memory
= "hw:numa_mem.{}".format(node_id
)
1264 extra_specs
[memory
] = int(memory_mb
)
1267 def process_numa_vcpu(numa
: dict, node_id
: int, extra_specs
: dict) -> None:
1268 """Set the cpu in extra_specs.
1270 numa (dict): A dictionary which includes numa information
1271 node_id (int): ID of numa node
1272 extra_specs (dict): To be filled.
1275 if not numa
.get("vcpu"):
1278 cpu
= "hw:numa_cpus.{}".format(node_id
)
1279 vcpu
= ",".join(map(str, vcpu
))
1280 extra_specs
[cpu
] = vcpu
1283 def process_numa_paired_threads(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1284 """Fill up extra_specs if numa has paired-threads.
1286 numa (dict): A dictionary which includes numa information
1287 extra_specs (dict): To be filled.
1290 vcpus (int) Number of virtual cpus
1293 if not numa
.get("paired-threads"):
1295 # cpu_thread_policy "require" implies that compute node must have an STM architecture
1296 vcpus
= numa
["paired-threads"] * 2
1297 extra_specs
["hw:cpu_thread_policy"] = "require"
1298 extra_specs
["hw:cpu_policy"] = "dedicated"
1302 def process_numa_cores(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1303 """Fill up extra_specs if numa has cores.
1305 numa (dict): A dictionary which includes numa information
1306 extra_specs (dict): To be filled.
1309 vcpus (int) Number of virtual cpus
1312 # cpu_thread_policy "isolate" implies that the host must not have an SMT
1313 # architecture, or a non-SMT architecture will be emulated
1314 if not numa
.get("cores"):
1316 vcpus
= numa
["cores"]
1317 extra_specs
["hw:cpu_thread_policy"] = "isolate"
1318 extra_specs
["hw:cpu_policy"] = "dedicated"
1322 def process_numa_threads(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1323 """Fill up extra_specs if numa has threads.
1325 numa (dict): A dictionary which includes numa information
1326 extra_specs (dict): To be filled.
1329 vcpus (int) Number of virtual cpus
1332 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT architecture
1333 if not numa
.get("threads"):
1335 vcpus
= numa
["threads"]
1336 extra_specs
["hw:cpu_thread_policy"] = "prefer"
1337 extra_specs
["hw:cpu_policy"] = "dedicated"
1340 def _process_numa_parameters_of_flavor(
1341 self
, numas
: List
, extra_specs
: Dict
, vcpus
: Optional
[int]
1343 """Process numa parameters and fill up extra_specs.
1346 numas (list): List of dictionary which includes numa information
1347 extra_specs (dict): To be filled.
1348 vcpus (int) Number of virtual cpus
1351 vcpus (int) Number of virtual cpus
1354 numa_nodes
= len(numas
)
1355 extra_specs
["hw:numa_nodes"] = str(numa_nodes
)
1357 if self
.vim_type
== "VIO":
1358 extra_specs
["vmware:extra_config"] = '{"numa.nodeAffinity":"0"}'
1359 extra_specs
["vmware:latency_sensitivity_level"] = "high"
1363 node_id
= numa
["id"]
1364 # overwrite ram and vcpus
1365 # check if key "memory" is present in numa else use ram value at flavor
1366 self
.process_numa_memory(numa
, node_id
, extra_specs
)
1367 self
.process_numa_vcpu(numa
, node_id
, extra_specs
)
1369 # See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/implemented/virt-driver-cpu-thread-pinning.html
1370 extra_specs
["hw:cpu_sockets"] = str(numa_nodes
)
1372 if "paired-threads" in numa
:
1373 vcpus
= self
.process_numa_paired_threads(numa
, extra_specs
)
1375 elif "cores" in numa
:
1376 vcpus
= self
.process_numa_cores(numa
, extra_specs
)
1378 elif "threads" in numa
:
1379 vcpus
= self
.process_numa_threads(numa
, extra_specs
)
1383 def _change_flavor_name(
1384 self
, name
: str, name_suffix
: int, flavor_data
: dict
1386 """Change the flavor name if the name already exists.
1389 name (str): Flavor name to be checked
1390 name_suffix (int): Suffix to be appended to name
1391 flavor_data (dict): Flavor dict
1394 name (str): New flavor name to be used
1398 fl
= self
.nova
.flavors
.list()
1399 fl_names
= [f
.name
for f
in fl
]
1401 while name
in fl_names
:
1403 name
= flavor_data
["name"] + "-" + str(name_suffix
)
1407 def _process_extended_config_of_flavor(
1408 self
, extended
: dict, extra_specs
: dict, vcpus
: Optional
[int]
1410 """Process the extended dict to fill up extra_specs.
1413 extended (dict): Keeping the extra specification of flavor
1414 extra_specs (dict) Dict to be filled to be used during flavor creation
1415 vcpus (int) Number of virtual cpus
1418 vcpus (int) Number of virtual cpus
1423 "mem-quota": "memory",
1425 "disk-io-quota": "disk_io",
1433 "PREFER_LARGE": "any",
1437 "cpu-pinning-policy": "hw:cpu_policy",
1438 "cpu-thread-pinning-policy": "hw:cpu_thread_policy",
1439 "mem-policy": "hw:numa_mempolicy",
1442 numas
= extended
.get("numas")
1444 vcpus
= self
._process
_numa
_parameters
_of
_flavor
(numas
, extra_specs
, vcpus
)
1446 for quota
, item
in quotas
.items():
1447 if quota
in extended
.keys():
1448 self
.process_resource_quota(extended
.get(quota
), item
, extra_specs
)
1450 # Set the mempage size as specified in the descriptor
1451 if extended
.get("mempage-size"):
1452 if extended
["mempage-size"] in page_sizes
.keys():
1453 extra_specs
["hw:mem_page_size"] = page_sizes
[extended
["mempage-size"]]
1455 # Normally, validations in NBI should not allow to this condition.
1457 "Invalid mempage-size %s. Will be ignored",
1458 extended
.get("mempage-size"),
1461 for policy
, hw_policy
in policies
.items():
1462 if extended
.get(policy
):
1463 extra_specs
[hw_policy
] = extended
[policy
].lower()
1468 def _get_flavor_details(flavor_data
: dict) -> Tuple
:
1469 """Returns the details of flavor
1471 flavor_data (dict): Dictionary that includes required flavor details
1474 ram, vcpus, extra_specs, extended (tuple): Main items of required flavor
1478 flavor_data
.get("ram", 64),
1479 flavor_data
.get("vcpus", 1),
1481 flavor_data
.get("extended"),
1484 def new_flavor(self
, flavor_data
: dict, change_name_if_used
: bool = True) -> str:
1485 """Adds a tenant flavor to openstack VIM.
1486 if change_name_if_used is True, it will change name in case of conflict,
1487 because it is not supported name repetition.
1490 flavor_data (dict): Flavor details to be processed
1491 change_name_if_used (bool): Change name in case of conflict
1494 flavor_id (str): flavor identifier
1497 self
.logger
.debug("Adding flavor '%s'", str(flavor_data
))
1503 name
= flavor_data
["name"]
1504 while retry
< max_retries
:
1507 self
._reload
_connection
()
1509 if change_name_if_used
:
1510 name
= self
._change
_flavor
_name
(name
, name_suffix
, flavor_data
)
1512 ram
, vcpus
, extra_specs
, extended
= self
._get
_flavor
_details
(
1516 vcpus
= self
._process
_extended
_config
_of
_flavor
(
1517 extended
, extra_specs
, vcpus
1522 new_flavor
= self
.nova
.flavors
.create(
1526 disk
=flavor_data
.get("disk", 0),
1527 ephemeral
=flavor_data
.get("ephemeral", 0),
1528 swap
=flavor_data
.get("swap", 0),
1529 is_public
=flavor_data
.get("is_public", True),
1534 new_flavor
.set_keys(extra_specs
)
1536 return new_flavor
.id
1538 except nvExceptions
.Conflict
as e
:
1539 if change_name_if_used
and retry
< max_retries
:
1542 self
._format
_exception
(e
)
1545 ksExceptions
.ClientException
,
1546 nvExceptions
.ClientException
,
1550 self
._format
_exception
(e
)
1552 def delete_flavor(self
, flavor_id
):
1553 """Deletes a tenant flavor from openstack VIM. Returns the old flavor_id"""
1555 self
._reload
_connection
()
1556 self
.nova
.flavors
.delete(flavor_id
)
1559 # except nvExceptions.BadRequest as e:
1561 nvExceptions
.NotFound
,
1562 ksExceptions
.ClientException
,
1563 nvExceptions
.ClientException
,
1566 self
._format
_exception
(e
)
1568 def new_image(self
, image_dict
):
1570 Adds a tenant image to VIM. imge_dict is a dictionary with:
1572 disk_format: qcow2, vhd, vmdk, raw (by default), ...
1573 location: path or URI
1574 public: "yes" or "no"
1575 metadata: metadata of the image
1576 Returns the image_id
1581 while retry
< max_retries
:
1584 self
._reload
_connection
()
1586 # determine format http://docs.openstack.org/developer/glance/formats.html
1587 if "disk_format" in image_dict
:
1588 disk_format
= image_dict
["disk_format"]
1589 else: # autodiscover based on extension
1590 if image_dict
["location"].endswith(".qcow2"):
1591 disk_format
= "qcow2"
1592 elif image_dict
["location"].endswith(".vhd"):
1594 elif image_dict
["location"].endswith(".vmdk"):
1595 disk_format
= "vmdk"
1596 elif image_dict
["location"].endswith(".vdi"):
1598 elif image_dict
["location"].endswith(".iso"):
1600 elif image_dict
["location"].endswith(".aki"):
1602 elif image_dict
["location"].endswith(".ari"):
1604 elif image_dict
["location"].endswith(".ami"):
1610 "new_image: '%s' loading from '%s'",
1612 image_dict
["location"],
1614 if self
.vim_type
== "VIO":
1615 container_format
= "bare"
1616 if "container_format" in image_dict
:
1617 container_format
= image_dict
["container_format"]
1619 new_image
= self
.glance
.images
.create(
1620 name
=image_dict
["name"],
1621 container_format
=container_format
,
1622 disk_format
=disk_format
,
1625 new_image
= self
.glance
.images
.create(name
=image_dict
["name"])
1627 if image_dict
["location"].startswith("http"):
1628 # TODO there is not a method to direct download. It must be downloaded locally with requests
1629 raise vimconn
.VimConnNotImplemented("Cannot create image from URL")
1631 with
open(image_dict
["location"]) as fimage
:
1632 self
.glance
.images
.upload(new_image
.id, fimage
)
1633 # new_image = self.glancev1.images.create(name=image_dict["name"], is_public=
1634 # image_dict.get("public","yes")=="yes",
1635 # container_format="bare", data=fimage, disk_format=disk_format)
1637 metadata_to_load
= image_dict
.get("metadata")
1639 # TODO location is a reserved word for current openstack versions. fixed for VIO please check
1641 if self
.vim_type
== "VIO":
1642 metadata_to_load
["upload_location"] = image_dict
["location"]
1644 metadata_to_load
["location"] = image_dict
["location"]
1646 self
.glance
.images
.update(new_image
.id, **metadata_to_load
)
1650 nvExceptions
.Conflict
,
1651 ksExceptions
.ClientException
,
1652 nvExceptions
.ClientException
,
1654 self
._format
_exception
(e
)
1657 gl1Exceptions
.HTTPException
,
1658 gl1Exceptions
.CommunicationError
,
1661 if retry
== max_retries
:
1664 self
._format
_exception
(e
)
1665 except IOError as e
: # can not open the file
1666 raise vimconn
.VimConnConnectionException(
1667 "{}: {} for {}".format(type(e
).__name
__, e
, image_dict
["location"]),
1668 http_code
=vimconn
.HTTP_Bad_Request
,
1671 def delete_image(self
, image_id
):
1672 """Deletes a tenant image from openstack VIM. Returns the old id"""
1674 self
._reload
_connection
()
1675 self
.glance
.images
.delete(image_id
)
1679 nvExceptions
.NotFound
,
1680 ksExceptions
.ClientException
,
1681 nvExceptions
.ClientException
,
1682 gl1Exceptions
.CommunicationError
,
1683 gl1Exceptions
.HTTPNotFound
,
1685 ) as e
: # TODO remove
1686 self
._format
_exception
(e
)
1688 def get_image_id_from_path(self
, path
):
1689 """Get the image id from image path in the VIM database. Returns the image_id"""
1691 self
._reload
_connection
()
1692 images
= self
.glance
.images
.list()
1694 for image
in images
:
1695 if image
.metadata
.get("location") == path
:
1698 raise vimconn
.VimConnNotFoundException(
1699 "image with location '{}' not found".format(path
)
1702 ksExceptions
.ClientException
,
1703 nvExceptions
.ClientException
,
1704 gl1Exceptions
.CommunicationError
,
1707 self
._format
_exception
(e
)
1709 def get_image_list(self
, filter_dict
={}):
1710 """Obtain tenant images from VIM
1714 checksum: image checksum
1715 Returns the image list of dictionaries:
1716 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1719 self
.logger
.debug("Getting image list from VIM filter: '%s'", str(filter_dict
))
1722 self
._reload
_connection
()
1723 # filter_dict_os = filter_dict.copy()
1724 # First we filter by the available filter fields: name, id. The others are removed.
1725 image_list
= self
.glance
.images
.list()
1728 for image
in image_list
:
1730 if filter_dict
.get("name") and image
["name"] != filter_dict
["name"]:
1733 if filter_dict
.get("id") and image
["id"] != filter_dict
["id"]:
1737 filter_dict
.get("checksum")
1738 and image
["checksum"] != filter_dict
["checksum"]
1742 filtered_list
.append(image
.copy())
1743 except gl1Exceptions
.HTTPNotFound
:
1746 return filtered_list
1748 ksExceptions
.ClientException
,
1749 nvExceptions
.ClientException
,
1750 gl1Exceptions
.CommunicationError
,
1753 self
._format
_exception
(e
)
1755 def __wait_for_vm(self
, vm_id
, status
):
1756 """wait until vm is in the desired status and return True.
1757 If the VM gets in ERROR status, return false.
1758 If the timeout is reached generate an exception"""
1760 while elapsed_time
< server_timeout
:
1761 vm_status
= self
.nova
.servers
.get(vm_id
).status
1763 if vm_status
== status
:
1766 if vm_status
== "ERROR":
1772 # if we exceeded the timeout rollback
1773 if elapsed_time
>= server_timeout
:
1774 raise vimconn
.VimConnException(
1775 "Timeout waiting for instance " + vm_id
+ " to get " + status
,
1776 http_code
=vimconn
.HTTP_Request_Timeout
,
1779 def _get_openstack_availablity_zones(self
):
1781 Get from openstack availability zones available
1785 openstack_availability_zone
= self
.nova
.availability_zones
.list()
1786 openstack_availability_zone
= [
1788 for zone
in openstack_availability_zone
1789 if zone
.zoneName
!= "internal"
1792 return openstack_availability_zone
1796 def _set_availablity_zones(self
):
1798 Set vim availablity zone
1801 if "availability_zone" in self
.config
:
1802 vim_availability_zones
= self
.config
.get("availability_zone")
1804 if isinstance(vim_availability_zones
, str):
1805 self
.availability_zone
= [vim_availability_zones
]
1806 elif isinstance(vim_availability_zones
, list):
1807 self
.availability_zone
= vim_availability_zones
1809 self
.availability_zone
= self
._get
_openstack
_availablity
_zones
()
1811 def _get_vm_availability_zone(
1812 self
, availability_zone_index
, availability_zone_list
1815 Return thge availability zone to be used by the created VM.
1816 :return: The VIM availability zone to be used or None
1818 if availability_zone_index
is None:
1819 if not self
.config
.get("availability_zone"):
1821 elif isinstance(self
.config
.get("availability_zone"), str):
1822 return self
.config
["availability_zone"]
1824 # TODO consider using a different parameter at config for default AV and AV list match
1825 return self
.config
["availability_zone"][0]
1827 vim_availability_zones
= self
.availability_zone
1828 # check if VIM offer enough availability zones describe in the VNFD
1829 if vim_availability_zones
and len(availability_zone_list
) <= len(
1830 vim_availability_zones
1832 # check if all the names of NFV AV match VIM AV names
1833 match_by_index
= False
1834 for av
in availability_zone_list
:
1835 if av
not in vim_availability_zones
:
1836 match_by_index
= True
1840 return vim_availability_zones
[availability_zone_index
]
1842 return availability_zone_list
[availability_zone_index
]
1844 raise vimconn
.VimConnConflictException(
1845 "No enough availability zones at VIM for this deployment"
1848 def _prepare_port_dict_security_groups(self
, net
: dict, port_dict
: dict) -> None:
1849 """Fill up the security_groups in the port_dict.
1852 net (dict): Network details
1853 port_dict (dict): Port details
1857 self
.config
.get("security_groups")
1858 and net
.get("port_security") is not False
1859 and not self
.config
.get("no_port_security_extension")
1861 if not self
.security_groups_id
:
1862 self
._get
_ids
_from
_name
()
1864 port_dict
["security_groups"] = self
.security_groups_id
1866 def _prepare_port_dict_binding(self
, net
: dict, port_dict
: dict) -> None:
1867 """Fill up the network binding depending on network type in the port_dict.
1870 net (dict): Network details
1871 port_dict (dict): Port details
1874 if not net
.get("type"):
1875 raise vimconn
.VimConnException("Type is missing in the network details.")
1877 if net
["type"] == "virtual":
1881 elif net
["type"] == "VF" or net
["type"] == "SR-IOV":
1882 port_dict
["binding:vnic_type"] = "direct"
1884 # VIO specific Changes
1885 if self
.vim_type
== "VIO":
1886 # Need to create port with port_security_enabled = False and no-security-groups
1887 port_dict
["port_security_enabled"] = False
1888 port_dict
["provider_security_groups"] = []
1889 port_dict
["security_groups"] = []
1892 # For PT PCI-PASSTHROUGH
1893 port_dict
["binding:vnic_type"] = "direct-physical"
1896 def _set_fixed_ip(new_port
: dict, net
: dict) -> None:
1897 """Set the "ip" parameter in net dictionary.
1900 new_port (dict): New created port
1901 net (dict): Network details
1904 fixed_ips
= new_port
["port"].get("fixed_ips")
1907 net
["ip"] = fixed_ips
[0].get("ip_address")
1912 def _prepare_port_dict_mac_ip_addr(net
: dict, port_dict
: dict) -> None:
1913 """Fill up the mac_address and fixed_ips in port_dict.
1916 net (dict): Network details
1917 port_dict (dict): Port details
1920 if net
.get("mac_address"):
1921 port_dict
["mac_address"] = net
["mac_address"]
1923 if net
.get("ip_address"):
1924 port_dict
["fixed_ips"] = [{"ip_address": net
["ip_address"]}]
1925 # TODO add "subnet_id": <subnet_id>
1927 def _create_new_port(self
, port_dict
: dict, created_items
: dict, net
: dict) -> Dict
:
1928 """Create new port using neutron.
1931 port_dict (dict): Port details
1932 created_items (dict): All created items
1933 net (dict): Network details
1936 new_port (dict): New created port
1939 new_port
= self
.neutron
.create_port({"port": port_dict
})
1940 created_items
["port:" + str(new_port
["port"]["id"])] = True
1941 net
["mac_adress"] = new_port
["port"]["mac_address"]
1942 net
["vim_id"] = new_port
["port"]["id"]
1947 self
, net
: dict, name
: str, created_items
: dict
1948 ) -> Tuple
[dict, dict]:
1949 """Create port using net details.
1952 net (dict): Network details
1953 name (str): Name to be used as network name if net dict does not include name
1954 created_items (dict): All created items
1957 new_port, port New created port, port dictionary
1962 "network_id": net
["net_id"],
1963 "name": net
.get("name"),
1964 "admin_state_up": True,
1967 if not port_dict
["name"]:
1968 port_dict
["name"] = name
1970 self
._prepare
_port
_dict
_security
_groups
(net
, port_dict
)
1972 self
._prepare
_port
_dict
_binding
(net
, port_dict
)
1974 vimconnector
._prepare
_port
_dict
_mac
_ip
_addr
(net
, port_dict
)
1976 new_port
= self
._create
_new
_port
(port_dict
, created_items
, net
)
1978 vimconnector
._set
_fixed
_ip
(new_port
, net
)
1980 port
= {"port-id": new_port
["port"]["id"]}
1982 if float(self
.nova
.api_version
.get_string()) >= 2.32:
1983 port
["tag"] = new_port
["port"]["name"]
1985 return new_port
, port
1987 def _prepare_network_for_vminstance(
1991 created_items
: dict,
1993 external_network
: list,
1994 no_secured_ports
: list,
1996 """Create port and fill up net dictionary for new VM instance creation.
1999 name (str): Name of network
2000 net_list (list): List of networks
2001 created_items (dict): All created items belongs to a VM
2002 net_list_vim (list): List of ports
2003 external_network (list): List of external-networks
2004 no_secured_ports (list): Port security disabled ports
2007 self
._reload
_connection
()
2009 for net
in net_list
:
2010 # Skip non-connected iface
2011 if not net
.get("net_id"):
2014 new_port
, port
= self
._create
_port
(net
, name
, created_items
)
2016 net_list_vim
.append(port
)
2018 if net
.get("floating_ip", False):
2019 net
["exit_on_floating_ip_error"] = True
2020 external_network
.append(net
)
2022 elif net
["use"] == "mgmt" and self
.config
.get("use_floating_ip"):
2023 net
["exit_on_floating_ip_error"] = False
2024 external_network
.append(net
)
2025 net
["floating_ip"] = self
.config
.get("use_floating_ip")
2027 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic
2028 # is dropped. As a workaround we wait until the VM is active and then disable the port-security
2029 if net
.get("port_security") is False and not self
.config
.get(
2030 "no_port_security_extension"
2032 no_secured_ports
.append(
2034 new_port
["port"]["id"],
2035 net
.get("port_security_disable_strategy"),
2039 def _prepare_persistent_root_volumes(
2044 base_disk_index
: int,
2045 block_device_mapping
: dict,
2046 existing_vim_volumes
: list,
2047 created_items
: dict,
2049 """Prepare persistent root volumes for new VM instance.
2052 name (str): Name of VM instance
2053 vm_av_zone (list): List of availability zones
2054 disk (dict): Disk details
2055 base_disk_index (int): Disk index
2056 block_device_mapping (dict): Block device details
2057 existing_vim_volumes (list): Existing disk details
2058 created_items (dict): All created items belongs to VM
2061 boot_volume_id (str): ID of boot volume
2064 # Disk may include only vim_volume_id or only vim_id."
2065 # Use existing persistent root volume finding with volume_id or vim_id
2066 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
2068 if disk
.get(key_id
):
2069 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
2070 existing_vim_volumes
.append({"id": disk
[key_id
]})
2073 # Create persistent root volume
2074 volume
= self
.cinder
.volumes
.create(
2076 name
=name
+ "vd" + chr(base_disk_index
),
2077 imageRef
=disk
["image_id"],
2078 # Make sure volume is in the same AZ as the VM to be attached to
2079 availability_zone
=vm_av_zone
,
2081 boot_volume_id
= volume
.id
2082 self
.update_block_device_mapping(
2084 block_device_mapping
=block_device_mapping
,
2085 base_disk_index
=base_disk_index
,
2087 created_items
=created_items
,
2090 return boot_volume_id
2093 def update_block_device_mapping(
2095 block_device_mapping
: dict,
2096 base_disk_index
: int,
2098 created_items
: dict,
2100 """Add volume information to block device mapping dict.
2102 volume (object): Created volume object
2103 block_device_mapping (dict): Block device details
2104 base_disk_index (int): Disk index
2105 disk (dict): Disk details
2106 created_items (dict): All created items belongs to VM
2109 raise vimconn
.VimConnException("Volume is empty.")
2111 if not hasattr(volume
, "id"):
2112 raise vimconn
.VimConnException(
2113 "Created volume is not valid, does not have id attribute."
2116 volume_txt
= "volume:" + str(volume
.id)
2117 if disk
.get("keep"):
2118 volume_txt
+= ":keep"
2119 created_items
[volume_txt
] = True
2120 block_device_mapping
["vd" + chr(base_disk_index
)] = volume
.id
2122 def _prepare_non_root_persistent_volumes(
2127 block_device_mapping
: dict,
2128 base_disk_index
: int,
2129 existing_vim_volumes
: list,
2130 created_items
: dict,
2132 """Prepare persistent volumes for new VM instance.
2135 name (str): Name of VM instance
2136 disk (dict): Disk details
2137 vm_av_zone (list): List of availability zones
2138 block_device_mapping (dict): Block device details
2139 base_disk_index (int): Disk index
2140 existing_vim_volumes (list): Existing disk details
2141 created_items (dict): All created items belongs to VM
2143 # Non-root persistent volumes
2144 # Disk may include only vim_volume_id or only vim_id."
2145 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
2147 if disk
.get(key_id
):
2148 # Use existing persistent volume
2149 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
2150 existing_vim_volumes
.append({"id": disk
[key_id
]})
2153 # Create persistent volume
2154 volume
= self
.cinder
.volumes
.create(
2156 name
=name
+ "vd" + chr(base_disk_index
),
2157 # Make sure volume is in the same AZ as the VM to be attached to
2158 availability_zone
=vm_av_zone
,
2160 self
.update_block_device_mapping(
2162 block_device_mapping
=block_device_mapping
,
2163 base_disk_index
=base_disk_index
,
2165 created_items
=created_items
,
2168 def _wait_for_created_volumes_availability(
2169 self
, elapsed_time
: int, created_items
: dict
2171 """Wait till created volumes become available.
2174 elapsed_time (int): Passed time while waiting
2175 created_items (dict): All created items belongs to VM
2178 elapsed_time (int): Time spent while waiting
2182 while elapsed_time
< volume_timeout
:
2183 for created_item
in created_items
:
2185 created_item
.split(":")[0],
2186 created_item
.split(":")[1],
2189 if self
.cinder
.volumes
.get(volume_id
).status
!= "available":
2192 # All ready: break from while
2200 def _wait_for_existing_volumes_availability(
2201 self
, elapsed_time
: int, existing_vim_volumes
: list
2203 """Wait till existing volumes become available.
2206 elapsed_time (int): Passed time while waiting
2207 existing_vim_volumes (list): Existing volume details
2210 elapsed_time (int): Time spent while waiting
2214 while elapsed_time
< volume_timeout
:
2215 for volume
in existing_vim_volumes
:
2216 if self
.cinder
.volumes
.get(volume
["id"]).status
!= "available":
2218 else: # all ready: break from while
2226 def _prepare_disk_for_vminstance(
2229 existing_vim_volumes
: list,
2230 created_items
: dict,
2232 block_device_mapping
: dict,
2233 disk_list
: list = None,
2235 """Prepare all volumes for new VM instance.
2238 name (str): Name of Instance
2239 existing_vim_volumes (list): List of existing volumes
2240 created_items (dict): All created items belongs to VM
2241 vm_av_zone (list): VM availability zone
2242 block_device_mapping (dict): Block devices to be attached to VM
2243 disk_list (list): List of disks
2246 # Create additional volumes in case these are present in disk_list
2247 base_disk_index
= ord("b")
2248 boot_volume_id
= None
2251 for disk
in disk_list
:
2252 if "image_id" in disk
:
2253 # Root persistent volume
2254 base_disk_index
= ord("a")
2255 boot_volume_id
= self
._prepare
_persistent
_root
_volumes
(
2257 vm_av_zone
=vm_av_zone
,
2259 base_disk_index
=base_disk_index
,
2260 block_device_mapping
=block_device_mapping
,
2261 existing_vim_volumes
=existing_vim_volumes
,
2262 created_items
=created_items
,
2265 # Non-root persistent volume
2266 self
._prepare
_non
_root
_persistent
_volumes
(
2269 vm_av_zone
=vm_av_zone
,
2270 block_device_mapping
=block_device_mapping
,
2271 base_disk_index
=base_disk_index
,
2272 existing_vim_volumes
=existing_vim_volumes
,
2273 created_items
=created_items
,
2275 base_disk_index
+= 1
2277 # Wait until created volumes are with status available
2278 elapsed_time
= self
._wait
_for
_created
_volumes
_availability
(
2279 elapsed_time
, created_items
2281 # Wait until existing volumes in vim are with status available
2282 elapsed_time
= self
._wait
_for
_existing
_volumes
_availability
(
2283 elapsed_time
, existing_vim_volumes
2285 # If we exceeded the timeout rollback
2286 if elapsed_time
>= volume_timeout
:
2287 raise vimconn
.VimConnException(
2288 "Timeout creating volumes for instance " + name
,
2289 http_code
=vimconn
.HTTP_Request_Timeout
,
2292 self
.cinder
.volumes
.set_bootable(boot_volume_id
, True)
2294 def _find_the_external_network_for_floating_ip(self
):
2295 """Get the external network ip in order to create floating IP.
2298 pool_id (str): External network pool ID
2302 # Find the external network
2303 external_nets
= list()
2305 for net
in self
.neutron
.list_networks()["networks"]:
2306 if net
["router:external"]:
2307 external_nets
.append(net
)
2309 if len(external_nets
) == 0:
2310 raise vimconn
.VimConnException(
2311 "Cannot create floating_ip automatically since "
2312 "no external network is present",
2313 http_code
=vimconn
.HTTP_Conflict
,
2316 if len(external_nets
) > 1:
2317 raise vimconn
.VimConnException(
2318 "Cannot create floating_ip automatically since "
2319 "multiple external networks are present",
2320 http_code
=vimconn
.HTTP_Conflict
,
2324 return external_nets
[0].get("id")
2326 def _neutron_create_float_ip(self
, param
: dict, created_items
: dict) -> None:
2327 """Trigger neutron to create a new floating IP using external network ID.
2330 param (dict): Input parameters to create a floating IP
2331 created_items (dict): All created items belongs to new VM instance
2338 self
.logger
.debug("Creating floating IP")
2339 new_floating_ip
= self
.neutron
.create_floatingip(param
)
2340 free_floating_ip
= new_floating_ip
["floatingip"]["id"]
2341 created_items
["floating_ip:" + str(free_floating_ip
)] = True
2343 except Exception as e
:
2344 raise vimconn
.VimConnException(
2345 type(e
).__name
__ + ": Cannot create new floating_ip " + str(e
),
2346 http_code
=vimconn
.HTTP_Conflict
,
2349 def _create_floating_ip(
2350 self
, floating_network
: dict, server
: object, created_items
: dict
2352 """Get the available Pool ID and create a new floating IP.
2355 floating_network (dict): Dict including external network ID
2356 server (object): Server object
2357 created_items (dict): All created items belongs to new VM instance
2361 # Pool_id is available
2363 isinstance(floating_network
["floating_ip"], str)
2364 and floating_network
["floating_ip"].lower() != "true"
2366 pool_id
= floating_network
["floating_ip"]
2370 pool_id
= self
._find
_the
_external
_network
_for
_floating
_ip
()
2374 "floating_network_id": pool_id
,
2375 "tenant_id": server
.tenant_id
,
2379 self
._neutron
_create
_float
_ip
(param
, created_items
)
2381 def _find_floating_ip(
2385 floating_network
: dict,
2387 """Find the available free floating IPs if there are.
2390 server (object): Server object
2391 floating_ips (list): List of floating IPs
2392 floating_network (dict): Details of floating network such as ID
2395 free_floating_ip (str): Free floating ip address
2398 for fip
in floating_ips
:
2399 if fip
.get("port_id") or fip
.get("tenant_id") != server
.tenant_id
:
2402 if isinstance(floating_network
["floating_ip"], str):
2403 if fip
.get("floating_network_id") != floating_network
["floating_ip"]:
2408 def _assign_floating_ip(
2409 self
, free_floating_ip
: str, floating_network
: dict
2411 """Assign the free floating ip address to port.
2414 free_floating_ip (str): Floating IP to be assigned
2415 floating_network (dict): ID of floating network
2418 fip (dict) (dict): Floating ip details
2421 # The vim_id key contains the neutron.port_id
2422 self
.neutron
.update_floatingip(
2424 {"floatingip": {"port_id": floating_network
["vim_id"]}},
2426 # For race condition ensure not re-assigned to other VM after 5 seconds
2429 return self
.neutron
.show_floatingip(free_floating_ip
)
2431 def _get_free_floating_ip(
2432 self
, server
: object, floating_network
: dict
2434 """Get the free floating IP address.
2437 server (object): Server Object
2438 floating_network (dict): Floating network details
2441 free_floating_ip (str): Free floating ip addr
2445 floating_ips
= self
.neutron
.list_floatingips().get("floatingips", ())
2448 random
.shuffle(floating_ips
)
2450 return self
._find
_floating
_ip
(server
, floating_ips
, floating_network
)
2452 def _prepare_external_network_for_vminstance(
2454 external_network
: list,
2456 created_items
: dict,
2457 vm_start_time
: float,
2459 """Assign floating IP address for VM instance.
2462 external_network (list): ID of External network
2463 server (object): Server Object
2464 created_items (dict): All created items belongs to new VM instance
2465 vm_start_time (float): Time as a floating point number expressed in seconds since the epoch, in UTC
2471 for floating_network
in external_network
:
2474 floating_ip_retries
= 3
2475 # In case of RO in HA there can be conflicts, two RO trying to assign same floating IP, so retry
2478 free_floating_ip
= self
._get
_free
_floating
_ip
(
2479 server
, floating_network
2482 if not free_floating_ip
:
2483 self
._create
_floating
_ip
(
2484 floating_network
, server
, created_items
2488 # For race condition ensure not already assigned
2489 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2491 if fip
["floatingip"].get("port_id"):
2494 # Assign floating ip
2495 fip
= self
._assign
_floating
_ip
(
2496 free_floating_ip
, floating_network
2499 if fip
["floatingip"]["port_id"] != floating_network
["vim_id"]:
2500 self
.logger
.warning(
2501 "floating_ip {} re-assigned to other port".format(
2508 "Assigned floating_ip {} to VM {}".format(
2509 free_floating_ip
, server
.id
2515 except Exception as e
:
2516 # Openstack need some time after VM creation to assign an IP. So retry if fails
2517 vm_status
= self
.nova
.servers
.get(server
.id).status
2519 if vm_status
not in ("ACTIVE", "ERROR"):
2520 if time
.time() - vm_start_time
< server_timeout
:
2523 elif floating_ip_retries
> 0:
2524 floating_ip_retries
-= 1
2527 raise vimconn
.VimConnException(
2528 "Cannot create floating_ip: {} {}".format(
2531 http_code
=vimconn
.HTTP_Conflict
,
2534 except Exception as e
:
2535 if not floating_network
["exit_on_floating_ip_error"]:
2536 self
.logger
.error("Cannot create floating_ip. %s", str(e
))
2541 def _update_port_security_for_vminstance(
2543 no_secured_ports
: list,
2546 """Updates the port security according to no_secured_ports list.
2549 no_secured_ports (list): List of ports that security will be disabled
2550 server (object): Server Object
2556 # Wait until the VM is active and then disable the port-security
2557 if no_secured_ports
:
2558 self
.__wait
_for
_vm
(server
.id, "ACTIVE")
2560 for port
in no_secured_ports
:
2562 "port": {"port_security_enabled": False, "security_groups": None}
2565 if port
[1] == "allow-address-pairs":
2567 "port": {"allowed_address_pairs": [{"ip_address": "0.0.0.0/0"}]}
2571 self
.neutron
.update_port(port
[0], port_update
)
2574 raise vimconn
.VimConnException(
2575 "It was not possible to disable port security for port {}".format(
2587 affinity_group_list
: list,
2591 availability_zone_index
=None,
2592 availability_zone_list
=None,
2594 """Adds a VM instance to VIM.
2597 name (str): name of VM
2598 description (str): description
2599 start (bool): indicates if VM must start or boot in pause mode. Ignored
2600 image_id (str) image uuid
2601 flavor_id (str) flavor uuid
2602 affinity_group_list (list): list of affinity groups, each one is a dictionary.Ignore if empty.
2603 net_list (list): list of interfaces, each one is a dictionary with:
2604 name: name of network
2605 net_id: network uuid to connect
2606 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
2607 model: interface model, ignored #TODO
2608 mac_address: used for SR-IOV ifaces #TODO for other types
2609 use: 'data', 'bridge', 'mgmt'
2610 type: 'virtual', 'PCI-PASSTHROUGH'('PF'), 'SR-IOV'('VF'), 'VFnotShared'
2611 vim_id: filled/added by this function
2612 floating_ip: True/False (or it can be None)
2613 port_security: True/False
2614 cloud_config (dict): (optional) dictionary with:
2615 key-pairs: (optional) list of strings with the public key to be inserted to the default user
2616 users: (optional) list of users to be inserted, each item is a dict with:
2617 name: (mandatory) user name,
2618 key-pairs: (optional) list of strings with the public key to be inserted to the user
2619 user-data: (optional) string is a text script to be passed directly to cloud-init
2620 config-files: (optional). List of files to be transferred. Each item is a dict with:
2621 dest: (mandatory) string with the destination absolute path
2622 encoding: (optional, by default text). Can be one of:
2623 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
2624 content : (mandatory) string with the content of the file
2625 permissions: (optional) string with file permissions, typically octal notation '0644'
2626 owner: (optional) file owner, string with the format 'owner:group'
2627 boot-data-drive: boolean to indicate if user-data must be passed using a boot drive (hard disk)
2628 disk_list: (optional) list with additional disks to the VM. Each item is a dict with:
2629 image_id: (optional). VIM id of an existing image. If not provided an empty disk must be mounted
2630 size: (mandatory) string with the size of the disk in GB
2631 vim_id: (optional) should use this existing volume id
2632 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
2633 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
2634 availability_zone_index is None
2635 #TODO ip, security groups
2638 A tuple with the instance identifier and created_items or raises an exception on error
2639 created_items can be None or a dictionary where this method can include key-values that will be passed to
2640 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
2641 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
2646 "new_vminstance input: image='%s' flavor='%s' nics='%s'",
2656 # list of external networks to be connected to instance, later on used to create floating_ip
2657 external_network
= []
2658 # List of ports with port-security disabled
2659 no_secured_ports
= []
2660 block_device_mapping
= {}
2661 existing_vim_volumes
= []
2662 server_group_id
= None
2663 scheduller_hints
= {}
2665 # Check the Openstack Connection
2666 self
._reload
_connection
()
2668 # Prepare network list
2669 self
._prepare
_network
_for
_vminstance
(
2672 created_items
=created_items
,
2673 net_list_vim
=net_list_vim
,
2674 external_network
=external_network
,
2675 no_secured_ports
=no_secured_ports
,
2679 config_drive
, userdata
= self
._create
_user
_data
(cloud_config
)
2681 # Get availability Zone
2682 vm_av_zone
= self
._get
_vm
_availability
_zone
(
2683 availability_zone_index
, availability_zone_list
2688 self
._prepare
_disk
_for
_vminstance
(
2690 existing_vim_volumes
=existing_vim_volumes
,
2691 created_items
=created_items
,
2692 vm_av_zone
=vm_av_zone
,
2693 block_device_mapping
=block_device_mapping
,
2694 disk_list
=disk_list
,
2697 if affinity_group_list
:
2698 # Only first id on the list will be used. Openstack restriction
2699 server_group_id
= affinity_group_list
[0]["affinity_group_id"]
2700 scheduller_hints
["group"] = server_group_id
2703 "nova.servers.create({}, {}, {}, nics={}, security_groups={}, "
2704 "availability_zone={}, key_name={}, userdata={}, config_drive={}, "
2705 "block_device_mapping={}, server_group={})".format(
2710 self
.config
.get("security_groups"),
2712 self
.config
.get("keypair"),
2715 block_device_mapping
,
2721 server
= self
.nova
.servers
.create(
2726 security_groups
=self
.config
.get("security_groups"),
2727 # TODO remove security_groups in future versions. Already at neutron port
2728 availability_zone
=vm_av_zone
,
2729 key_name
=self
.config
.get("keypair"),
2731 config_drive
=config_drive
,
2732 block_device_mapping
=block_device_mapping
,
2733 scheduler_hints
=scheduller_hints
,
2736 vm_start_time
= time
.time()
2738 self
._update
_port
_security
_for
_vminstance
(no_secured_ports
, server
)
2740 self
._prepare
_external
_network
_for
_vminstance
(
2741 external_network
=external_network
,
2743 created_items
=created_items
,
2744 vm_start_time
=vm_start_time
,
2747 return server
.id, created_items
2749 except Exception as e
:
2752 server_id
= server
.id
2755 created_items
= self
.remove_keep_tag_from_persistent_volumes(
2759 self
.delete_vminstance(server_id
, created_items
)
2761 except Exception as e2
:
2762 self
.logger
.error("new_vminstance rollback fail {}".format(e2
))
2764 self
._format
_exception
(e
)
2767 def remove_keep_tag_from_persistent_volumes(created_items
: Dict
) -> Dict
:
2768 """Removes the keep flag from persistent volumes. So, those volumes could be removed.
2771 created_items (dict): All created items belongs to VM
2774 updated_created_items (dict): Dict which does not include keep flag for volumes.
2778 key
.replace(":keep", ""): value
for (key
, value
) in created_items
.items()
2781 def get_vminstance(self
, vm_id
):
2782 """Returns the VM instance information from VIM"""
2783 # self.logger.debug("Getting VM from VIM")
2785 self
._reload
_connection
()
2786 server
= self
.nova
.servers
.find(id=vm_id
)
2787 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
2789 return server
.to_dict()
2791 ksExceptions
.ClientException
,
2792 nvExceptions
.ClientException
,
2793 nvExceptions
.NotFound
,
2796 self
._format
_exception
(e
)
2798 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
2800 Get a console for the virtual machine
2802 vm_id: uuid of the VM
2803 console_type, can be:
2804 "novnc" (by default), "xvpvnc" for VNC types,
2805 "rdp-html5" for RDP types, "spice-html5" for SPICE types
2806 Returns dict with the console parameters:
2807 protocol: ssh, ftp, http, https, ...
2808 server: usually ip address
2809 port: the http, ssh, ... port
2810 suffix: extra text, e.g. the http path and query string
2812 self
.logger
.debug("Getting VM CONSOLE from VIM")
2815 self
._reload
_connection
()
2816 server
= self
.nova
.servers
.find(id=vm_id
)
2818 if console_type
is None or console_type
== "novnc":
2819 console_dict
= server
.get_vnc_console("novnc")
2820 elif console_type
== "xvpvnc":
2821 console_dict
= server
.get_vnc_console(console_type
)
2822 elif console_type
== "rdp-html5":
2823 console_dict
= server
.get_rdp_console(console_type
)
2824 elif console_type
== "spice-html5":
2825 console_dict
= server
.get_spice_console(console_type
)
2827 raise vimconn
.VimConnException(
2828 "console type '{}' not allowed".format(console_type
),
2829 http_code
=vimconn
.HTTP_Bad_Request
,
2832 console_dict1
= console_dict
.get("console")
2835 console_url
= console_dict1
.get("url")
2839 protocol_index
= console_url
.find("//")
2841 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2844 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2849 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2851 -vimconn
.HTTP_Internal_Server_Error
,
2852 "Unexpected response from VIM",
2856 "protocol": console_url
[0:protocol_index
],
2857 "server": console_url
[protocol_index
+ 2 : port_index
],
2858 "port": console_url
[port_index
:suffix_index
],
2859 "suffix": console_url
[suffix_index
+ 1 :],
2864 raise vimconn
.VimConnUnexpectedResponse("Unexpected response from VIM")
2866 nvExceptions
.NotFound
,
2867 ksExceptions
.ClientException
,
2868 nvExceptions
.ClientException
,
2869 nvExceptions
.BadRequest
,
2872 self
._format
_exception
(e
)
2874 def _delete_ports_by_id_wth_neutron(self
, k_id
: str) -> None:
2875 """Neutron delete ports by id.
2877 k_id (str): Port id in the VIM
2880 port_dict
= self
.neutron
.list_ports()
2881 existing_ports
= [port
["id"] for port
in port_dict
["ports"] if port_dict
]
2883 if k_id
in existing_ports
:
2884 self
.neutron
.delete_port(k_id
)
2886 except Exception as e
:
2887 self
.logger
.error("Error deleting port: {}: {}".format(type(e
).__name
__, e
))
2889 def _delete_volumes_by_id_wth_cinder(
2890 self
, k
: str, k_id
: str, volumes_to_hold
: list, created_items
: dict
2892 """Cinder delete volume by id.
2894 k (str): Full item name in created_items
2895 k_id (str): ID of floating ip in VIM
2896 volumes_to_hold (list): Volumes not to delete
2897 created_items (dict): All created items belongs to VM
2900 if k_id
in volumes_to_hold
:
2903 if self
.cinder
.volumes
.get(k_id
).status
!= "available":
2907 self
.cinder
.volumes
.delete(k_id
)
2908 created_items
[k
] = None
2910 except Exception as e
:
2912 "Error deleting volume: {}: {}".format(type(e
).__name
__, e
)
2915 def _delete_floating_ip_by_id(self
, k
: str, k_id
: str, created_items
: dict) -> None:
2916 """Neutron delete floating ip by id.
2918 k (str): Full item name in created_items
2919 k_id (str): ID of floating ip in VIM
2920 created_items (dict): All created items belongs to VM
2923 self
.neutron
.delete_floatingip(k_id
)
2924 created_items
[k
] = None
2926 except Exception as e
:
2928 "Error deleting floating ip: {}: {}".format(type(e
).__name
__, e
)
2932 def _get_item_name_id(k
: str) -> Tuple
[str, str]:
2933 k_item
, _
, k_id
= k
.partition(":")
2936 def _delete_vm_ports_attached_to_network(self
, created_items
: dict) -> None:
2937 """Delete VM ports attached to the networks before deleting virtual machine.
2939 created_items (dict): All created items belongs to VM
2942 for k
, v
in created_items
.items():
2943 if not v
: # skip already deleted
2947 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2948 if k_item
== "port":
2949 self
._delete
_ports
_by
_id
_wth
_neutron
(k_id
)
2951 except Exception as e
:
2953 "Error deleting port: {}: {}".format(type(e
).__name
__, e
)
2956 def _delete_created_items(
2957 self
, created_items
: dict, volumes_to_hold
: list, keep_waiting
: bool
2959 """Delete Volumes and floating ip if they exist in created_items."""
2960 for k
, v
in created_items
.items():
2961 if not v
: # skip already deleted
2965 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2967 if k_item
== "volume":
2968 unavailable_vol
= self
._delete
_volumes
_by
_id
_wth
_cinder
(
2969 k
, k_id
, volumes_to_hold
, created_items
2975 elif k_item
== "floating_ip":
2976 self
._delete
_floating
_ip
_by
_id
(k
, k_id
, created_items
)
2978 except Exception as e
:
2979 self
.logger
.error("Error deleting {}: {}".format(k
, e
))
2984 def _extract_items_wth_keep_flag_from_created_items(created_items
: dict) -> dict:
2985 """Remove the volumes which has key flag from created_items
2988 created_items (dict): All created items belongs to VM
2991 created_items (dict): Persistent volumes eliminated created_items
2995 for (key
, value
) in created_items
.items()
2996 if len(key
.split(":")) == 2
2999 def delete_vminstance(
3000 self
, vm_id
: str, created_items
: dict = None, volumes_to_hold
: list = None
3002 """Removes a VM instance from VIM. Returns the old identifier.
3004 vm_id (str): Identifier of VM instance
3005 created_items (dict): All created items belongs to VM
3006 volumes_to_hold (list): Volumes_to_hold
3008 if created_items
is None:
3010 if volumes_to_hold
is None:
3011 volumes_to_hold
= []
3014 created_items
= self
._extract
_items
_wth
_keep
_flag
_from
_created
_items
(
3018 self
._reload
_connection
()
3020 # Delete VM ports attached to the networks before the virtual machine
3022 self
._delete
_vm
_ports
_attached
_to
_network
(created_items
)
3025 self
.nova
.servers
.delete(vm_id
)
3027 # Although having detached, volumes should have in active status before deleting.
3028 # We ensure in this loop
3032 while keep_waiting
and elapsed_time
< volume_timeout
:
3033 keep_waiting
= False
3035 # Delete volumes and floating IP.
3036 keep_waiting
= self
._delete
_created
_items
(
3037 created_items
, volumes_to_hold
, keep_waiting
3045 nvExceptions
.NotFound
,
3046 ksExceptions
.ClientException
,
3047 nvExceptions
.ClientException
,
3050 self
._format
_exception
(e
)
3052 def refresh_vms_status(self
, vm_list
):
3053 """Get the status of the virtual machines and their interfaces/ports
3054 Params: the list of VM identifiers
3055 Returns a dictionary with:
3056 vm_id: #VIM id of this Virtual Machine
3057 status: #Mandatory. Text with one of:
3058 # DELETED (not found at vim)
3059 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3060 # OTHER (Vim reported other status not understood)
3061 # ERROR (VIM indicates an ERROR status)
3062 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
3063 # CREATING (on building process), ERROR
3064 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
3066 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3067 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3069 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
3070 mac_address: #Text format XX:XX:XX:XX:XX:XX
3071 vim_net_id: #network id where this interface is connected
3072 vim_interface_id: #interface/port VIM id
3073 ip_address: #null, or text with IPv4, IPv6 address
3074 compute_node: #identification of compute node where PF,VF interface is allocated
3075 pci: #PCI address of the NIC that hosts the PF,VF
3076 vlan: #physical VLAN used for VF
3080 "refresh_vms status: Getting tenant VM instance information from VIM"
3083 for vm_id
in vm_list
:
3087 vm_vim
= self
.get_vminstance(vm_id
)
3089 if vm_vim
["status"] in vmStatus2manoFormat
:
3090 vm
["status"] = vmStatus2manoFormat
[vm_vim
["status"]]
3092 vm
["status"] = "OTHER"
3093 vm
["error_msg"] = "VIM status reported " + vm_vim
["status"]
3095 vm_vim
.pop("OS-EXT-SRV-ATTR:user_data", None)
3096 vm_vim
.pop("user_data", None)
3097 vm
["vim_info"] = self
.serialize(vm_vim
)
3099 vm
["interfaces"] = []
3100 if vm_vim
.get("fault"):
3101 vm
["error_msg"] = str(vm_vim
["fault"])
3105 self
._reload
_connection
()
3106 port_dict
= self
.neutron
.list_ports(device_id
=vm_id
)
3108 for port
in port_dict
["ports"]:
3110 interface
["vim_info"] = self
.serialize(port
)
3111 interface
["mac_address"] = port
.get("mac_address")
3112 interface
["vim_net_id"] = port
["network_id"]
3113 interface
["vim_interface_id"] = port
["id"]
3114 # check if OS-EXT-SRV-ATTR:host is there,
3115 # in case of non-admin credentials, it will be missing
3117 if vm_vim
.get("OS-EXT-SRV-ATTR:host"):
3118 interface
["compute_node"] = vm_vim
["OS-EXT-SRV-ATTR:host"]
3120 interface
["pci"] = None
3122 # check if binding:profile is there,
3123 # in case of non-admin credentials, it will be missing
3124 if port
.get("binding:profile"):
3125 if port
["binding:profile"].get("pci_slot"):
3126 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting
3128 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
3129 # CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2) assuming there are 2 ports per nic
3130 pci
= port
["binding:profile"]["pci_slot"]
3131 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
3132 interface
["pci"] = pci
3134 interface
["vlan"] = None
3136 if port
.get("binding:vif_details"):
3137 interface
["vlan"] = port
["binding:vif_details"].get("vlan")
3139 # Get vlan from network in case not present in port for those old openstacks and cases where
3140 # it is needed vlan at PT
3141 if not interface
["vlan"]:
3142 # if network is of type vlan and port is of type direct (sr-iov) then set vlan id
3143 network
= self
.neutron
.show_network(port
["network_id"])
3146 network
["network"].get("provider:network_type")
3149 # and port.get("binding:vnic_type") in ("direct", "direct-physical"):
3150 interface
["vlan"] = network
["network"].get(
3151 "provider:segmentation_id"
3155 # look for floating ip address
3157 floating_ip_dict
= self
.neutron
.list_floatingips(
3161 if floating_ip_dict
.get("floatingips"):
3163 floating_ip_dict
["floatingips"][0].get(
3164 "floating_ip_address"
3170 for subnet
in port
["fixed_ips"]:
3171 ips
.append(subnet
["ip_address"])
3173 interface
["ip_address"] = ";".join(ips
)
3174 vm
["interfaces"].append(interface
)
3175 except Exception as e
:
3177 "Error getting vm interface information {}: {}".format(
3182 except vimconn
.VimConnNotFoundException
as e
:
3183 self
.logger
.error("Exception getting vm status: %s", str(e
))
3184 vm
["status"] = "DELETED"
3185 vm
["error_msg"] = str(e
)
3186 except vimconn
.VimConnException
as e
:
3187 self
.logger
.error("Exception getting vm status: %s", str(e
))
3188 vm
["status"] = "VIM_ERROR"
3189 vm
["error_msg"] = str(e
)
3195 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
3196 """Send and action over a VM instance from VIM
3197 Returns None or the console dict if the action was successfully sent to the VIM
3199 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
3202 self
._reload
_connection
()
3203 server
= self
.nova
.servers
.find(id=vm_id
)
3205 if "start" in action_dict
:
3206 if action_dict
["start"] == "rebuild":
3209 if server
.status
== "PAUSED":
3211 elif server
.status
== "SUSPENDED":
3213 elif server
.status
== "SHUTOFF":
3217 "ERROR : Instance is not in SHUTOFF/PAUSE/SUSPEND state"
3219 raise vimconn
.VimConnException(
3220 "Cannot 'start' instance while it is in active state",
3221 http_code
=vimconn
.HTTP_Bad_Request
,
3224 elif "pause" in action_dict
:
3226 elif "resume" in action_dict
:
3228 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
3229 self
.logger
.debug("server status %s", server
.status
)
3230 if server
.status
== "ACTIVE":
3233 self
.logger
.debug("ERROR: VM is not in Active state")
3234 raise vimconn
.VimConnException(
3235 "VM is not in active state, stop operation is not allowed",
3236 http_code
=vimconn
.HTTP_Bad_Request
,
3238 elif "forceOff" in action_dict
:
3239 server
.stop() # TODO
3240 elif "terminate" in action_dict
:
3242 elif "createImage" in action_dict
:
3243 server
.create_image()
3244 # "path":path_schema,
3245 # "description":description_schema,
3246 # "name":name_schema,
3247 # "metadata":metadata_schema,
3248 # "imageRef": id_schema,
3249 # "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
3250 elif "rebuild" in action_dict
:
3251 server
.rebuild(server
.image
["id"])
3252 elif "reboot" in action_dict
:
3253 server
.reboot() # reboot_type="SOFT"
3254 elif "console" in action_dict
:
3255 console_type
= action_dict
["console"]
3257 if console_type
is None or console_type
== "novnc":
3258 console_dict
= server
.get_vnc_console("novnc")
3259 elif console_type
== "xvpvnc":
3260 console_dict
= server
.get_vnc_console(console_type
)
3261 elif console_type
== "rdp-html5":
3262 console_dict
= server
.get_rdp_console(console_type
)
3263 elif console_type
== "spice-html5":
3264 console_dict
= server
.get_spice_console(console_type
)
3266 raise vimconn
.VimConnException(
3267 "console type '{}' not allowed".format(console_type
),
3268 http_code
=vimconn
.HTTP_Bad_Request
,
3272 console_url
= console_dict
["console"]["url"]
3274 protocol_index
= console_url
.find("//")
3276 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
3279 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
3284 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
3285 raise vimconn
.VimConnException(
3286 "Unexpected response from VIM " + str(console_dict
)
3290 "protocol": console_url
[0:protocol_index
],
3291 "server": console_url
[protocol_index
+ 2 : port_index
],
3292 "port": int(console_url
[port_index
+ 1 : suffix_index
]),
3293 "suffix": console_url
[suffix_index
+ 1 :],
3296 return console_dict2
3298 raise vimconn
.VimConnException(
3299 "Unexpected response from VIM " + str(console_dict
)
3304 ksExceptions
.ClientException
,
3305 nvExceptions
.ClientException
,
3306 nvExceptions
.NotFound
,
3309 self
._format
_exception
(e
)
3310 # TODO insert exception vimconn.HTTP_Unauthorized
3312 # ###### VIO Specific Changes #########
3313 def _generate_vlanID(self
):
3315 Method to get unused vlanID
3323 networks
= self
.get_network_list()
3325 for net
in networks
:
3326 if net
.get("provider:segmentation_id"):
3327 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3329 used_vlanIDs
= set(usedVlanIDs
)
3331 # find unused VLAN ID
3332 for vlanID_range
in self
.config
.get("dataplane_net_vlan_range"):
3334 start_vlanid
, end_vlanid
= map(
3335 int, vlanID_range
.replace(" ", "").split("-")
3338 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3339 if vlanID
not in used_vlanIDs
:
3341 except Exception as exp
:
3342 raise vimconn
.VimConnException(
3343 "Exception {} occurred while generating VLAN ID.".format(exp
)
3346 raise vimconn
.VimConnConflictException(
3347 "Unable to create the SRIOV VLAN network. All given Vlan IDs {} are in use.".format(
3348 self
.config
.get("dataplane_net_vlan_range")
3352 def _generate_multisegment_vlanID(self
):
3354 Method to get unused vlanID
3362 networks
= self
.get_network_list()
3363 for net
in networks
:
3364 if net
.get("provider:network_type") == "vlan" and net
.get(
3365 "provider:segmentation_id"
3367 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3368 elif net
.get("segments"):
3369 for segment
in net
.get("segments"):
3370 if segment
.get("provider:network_type") == "vlan" and segment
.get(
3371 "provider:segmentation_id"
3373 usedVlanIDs
.append(segment
.get("provider:segmentation_id"))
3375 used_vlanIDs
= set(usedVlanIDs
)
3377 # find unused VLAN ID
3378 for vlanID_range
in self
.config
.get("multisegment_vlan_range"):
3380 start_vlanid
, end_vlanid
= map(
3381 int, vlanID_range
.replace(" ", "").split("-")
3384 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3385 if vlanID
not in used_vlanIDs
:
3387 except Exception as exp
:
3388 raise vimconn
.VimConnException(
3389 "Exception {} occurred while generating VLAN ID.".format(exp
)
3392 raise vimconn
.VimConnConflictException(
3393 "Unable to create the VLAN segment. All VLAN IDs {} are in use.".format(
3394 self
.config
.get("multisegment_vlan_range")
3398 def _validate_vlan_ranges(self
, input_vlan_range
, text_vlan_range
):
3400 Method to validate user given vlanID ranges
3404 for vlanID_range
in input_vlan_range
:
3405 vlan_range
= vlanID_range
.replace(" ", "")
3407 vlanID_pattern
= r
"(\d)*-(\d)*$"
3408 match_obj
= re
.match(vlanID_pattern
, vlan_range
)
3410 raise vimconn
.VimConnConflictException(
3411 "Invalid VLAN range for {}: {}.You must provide "
3412 "'{}' in format [start_ID - end_ID].".format(
3413 text_vlan_range
, vlanID_range
, text_vlan_range
3417 start_vlanid
, end_vlanid
= map(int, vlan_range
.split("-"))
3418 if start_vlanid
<= 0:
3419 raise vimconn
.VimConnConflictException(
3420 "Invalid VLAN range for {}: {}. Start ID can not be zero. For VLAN "
3421 "networks valid IDs are 1 to 4094 ".format(
3422 text_vlan_range
, vlanID_range
3426 if end_vlanid
> 4094:
3427 raise vimconn
.VimConnConflictException(
3428 "Invalid VLAN range for {}: {}. End VLAN ID can not be "
3429 "greater than 4094. For VLAN networks valid IDs are 1 to 4094 ".format(
3430 text_vlan_range
, vlanID_range
3434 if start_vlanid
> end_vlanid
:
3435 raise vimconn
.VimConnConflictException(
3436 "Invalid VLAN range for {}: {}. You must provide '{}'"
3437 " in format start_ID - end_ID and start_ID < end_ID ".format(
3438 text_vlan_range
, vlanID_range
, text_vlan_range
3442 # NOT USED FUNCTIONS
3444 def new_external_port(self
, port_data
):
3445 """Adds a external port to VIM
3446 Returns the port identifier"""
3447 # TODO openstack if needed
3449 -vimconn
.HTTP_Internal_Server_Error
,
3450 "osconnector.new_external_port() not implemented",
3453 def connect_port_network(self
, port_id
, network_id
, admin
=False):
3454 """Connects a external port to a network
3455 Returns status code of the VIM response"""
3456 # TODO openstack if needed
3458 -vimconn
.HTTP_Internal_Server_Error
,
3459 "osconnector.connect_port_network() not implemented",
3462 def new_user(self
, user_name
, user_passwd
, tenant_id
=None):
3463 """Adds a new user to openstack VIM
3464 Returns the user identifier"""
3465 self
.logger
.debug("osconnector: Adding a new user to VIM")
3468 self
._reload
_connection
()
3469 user
= self
.keystone
.users
.create(
3470 user_name
, password
=user_passwd
, default_project
=tenant_id
3472 # self.keystone.tenants.add_user(self.k_creds["username"], #role)
3475 except ksExceptions
.ConnectionError
as e
:
3476 error_value
= -vimconn
.HTTP_Bad_Request
3480 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3482 except ksExceptions
.ClientException
as e
: # TODO remove
3483 error_value
= -vimconn
.HTTP_Bad_Request
3487 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3490 # TODO insert exception vimconn.HTTP_Unauthorized
3491 # if reaching here is because an exception
3492 self
.logger
.debug("new_user " + error_text
)
3494 return error_value
, error_text
3496 def delete_user(self
, user_id
):
3497 """Delete a user from openstack VIM
3498 Returns the user identifier"""
3500 print("osconnector: Deleting a user from VIM")
3503 self
._reload
_connection
()
3504 self
.keystone
.users
.delete(user_id
)
3507 except ksExceptions
.ConnectionError
as e
:
3508 error_value
= -vimconn
.HTTP_Bad_Request
3512 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3514 except ksExceptions
.NotFound
as e
:
3515 error_value
= -vimconn
.HTTP_Not_Found
3519 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3521 except ksExceptions
.ClientException
as e
: # TODO remove
3522 error_value
= -vimconn
.HTTP_Bad_Request
3526 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3529 # TODO insert exception vimconn.HTTP_Unauthorized
3530 # if reaching here is because an exception
3531 self
.logger
.debug("delete_tenant " + error_text
)
3533 return error_value
, error_text
3535 def get_hosts_info(self
):
3536 """Get the information of deployed hosts
3537 Returns the hosts content"""
3539 print("osconnector: Getting Host info from VIM")
3543 self
._reload
_connection
()
3544 hypervisors
= self
.nova
.hypervisors
.list()
3546 for hype
in hypervisors
:
3547 h_list
.append(hype
.to_dict())
3549 return 1, {"hosts": h_list
}
3550 except nvExceptions
.NotFound
as e
:
3551 error_value
= -vimconn
.HTTP_Not_Found
3552 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3553 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
3554 error_value
= -vimconn
.HTTP_Bad_Request
3558 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3561 # TODO insert exception vimconn.HTTP_Unauthorized
3562 # if reaching here is because an exception
3563 self
.logger
.debug("get_hosts_info " + error_text
)
3565 return error_value
, error_text
3567 def get_hosts(self
, vim_tenant
):
3568 """Get the hosts and deployed instances
3569 Returns the hosts content"""
3570 r
, hype_dict
= self
.get_hosts_info()
3575 hypervisors
= hype_dict
["hosts"]
3578 servers
= self
.nova
.servers
.list()
3579 for hype
in hypervisors
:
3580 for server
in servers
:
3582 server
.to_dict()["OS-EXT-SRV-ATTR:hypervisor_hostname"]
3583 == hype
["hypervisor_hostname"]
3586 hype
["vm"].append(server
.id)
3588 hype
["vm"] = [server
.id]
3591 except nvExceptions
.NotFound
as e
:
3592 error_value
= -vimconn
.HTTP_Not_Found
3593 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3594 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
3595 error_value
= -vimconn
.HTTP_Bad_Request
3599 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3602 # TODO insert exception vimconn.HTTP_Unauthorized
3603 # if reaching here is because an exception
3604 self
.logger
.debug("get_hosts " + error_text
)
3606 return error_value
, error_text
3608 def new_classification(self
, name
, ctype
, definition
):
3610 "Adding a new (Traffic) Classification to VIM, named %s", name
3615 self
._reload
_connection
()
3617 if ctype
not in supportedClassificationTypes
:
3618 raise vimconn
.VimConnNotSupportedException(
3619 "OpenStack VIM connector does not support provided "
3620 "Classification Type {}, supported ones are: {}".format(
3621 ctype
, supportedClassificationTypes
3625 if not self
._validate
_classification
(ctype
, definition
):
3626 raise vimconn
.VimConnException(
3627 "Incorrect Classification definition for the type specified."
3630 classification_dict
= definition
3631 classification_dict
["name"] = name
3632 new_class
= self
.neutron
.create_sfc_flow_classifier(
3633 {"flow_classifier": classification_dict
}
3636 return new_class
["flow_classifier"]["id"]
3638 neExceptions
.ConnectionFailed
,
3639 ksExceptions
.ClientException
,
3640 neExceptions
.NeutronException
,
3643 self
.logger
.error("Creation of Classification failed.")
3644 self
._format
_exception
(e
)
3646 def get_classification(self
, class_id
):
3647 self
.logger
.debug(" Getting Classification %s from VIM", class_id
)
3648 filter_dict
= {"id": class_id
}
3649 class_list
= self
.get_classification_list(filter_dict
)
3651 if len(class_list
) == 0:
3652 raise vimconn
.VimConnNotFoundException(
3653 "Classification '{}' not found".format(class_id
)
3655 elif len(class_list
) > 1:
3656 raise vimconn
.VimConnConflictException(
3657 "Found more than one Classification with this criteria"
3660 classification
= class_list
[0]
3662 return classification
3664 def get_classification_list(self
, filter_dict
={}):
3666 "Getting Classifications from VIM filter: '%s'", str(filter_dict
)
3670 filter_dict_os
= filter_dict
.copy()
3671 self
._reload
_connection
()
3673 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3674 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3676 classification_dict
= self
.neutron
.list_sfc_flow_classifiers(
3679 classification_list
= classification_dict
["flow_classifiers"]
3680 self
.__classification
_os
2mano
(classification_list
)
3682 return classification_list
3684 neExceptions
.ConnectionFailed
,
3685 ksExceptions
.ClientException
,
3686 neExceptions
.NeutronException
,
3689 self
._format
_exception
(e
)
3691 def delete_classification(self
, class_id
):
3692 self
.logger
.debug("Deleting Classification '%s' from VIM", class_id
)
3695 self
._reload
_connection
()
3696 self
.neutron
.delete_sfc_flow_classifier(class_id
)
3700 neExceptions
.ConnectionFailed
,
3701 neExceptions
.NeutronException
,
3702 ksExceptions
.ClientException
,
3703 neExceptions
.NeutronException
,
3706 self
._format
_exception
(e
)
3708 def new_sfi(self
, name
, ingress_ports
, egress_ports
, sfc_encap
=True):
3710 "Adding a new Service Function Instance to VIM, named '%s'", name
3715 self
._reload
_connection
()
3721 if len(ingress_ports
) != 1:
3722 raise vimconn
.VimConnNotSupportedException(
3723 "OpenStack VIM connector can only have 1 ingress port per SFI"
3726 if len(egress_ports
) != 1:
3727 raise vimconn
.VimConnNotSupportedException(
3728 "OpenStack VIM connector can only have 1 egress port per SFI"
3733 "ingress": ingress_ports
[0],
3734 "egress": egress_ports
[0],
3735 "service_function_parameters": {"correlation": correlation
},
3737 new_sfi
= self
.neutron
.create_sfc_port_pair({"port_pair": sfi_dict
})
3739 return new_sfi
["port_pair"]["id"]
3741 neExceptions
.ConnectionFailed
,
3742 ksExceptions
.ClientException
,
3743 neExceptions
.NeutronException
,
3748 self
.neutron
.delete_sfc_port_pair(new_sfi
["port_pair"]["id"])
3751 "Creation of Service Function Instance failed, with "
3752 "subsequent deletion failure as well."
3755 self
._format
_exception
(e
)
3757 def get_sfi(self
, sfi_id
):
3758 self
.logger
.debug("Getting Service Function Instance %s from VIM", sfi_id
)
3759 filter_dict
= {"id": sfi_id
}
3760 sfi_list
= self
.get_sfi_list(filter_dict
)
3762 if len(sfi_list
) == 0:
3763 raise vimconn
.VimConnNotFoundException(
3764 "Service Function Instance '{}' not found".format(sfi_id
)
3766 elif len(sfi_list
) > 1:
3767 raise vimconn
.VimConnConflictException(
3768 "Found more than one Service Function Instance with this criteria"
3775 def get_sfi_list(self
, filter_dict
={}):
3777 "Getting Service Function Instances from VIM filter: '%s'", str(filter_dict
)
3781 self
._reload
_connection
()
3782 filter_dict_os
= filter_dict
.copy()
3784 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3785 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3787 sfi_dict
= self
.neutron
.list_sfc_port_pairs(**filter_dict_os
)
3788 sfi_list
= sfi_dict
["port_pairs"]
3789 self
.__sfi
_os
2mano
(sfi_list
)
3793 neExceptions
.ConnectionFailed
,
3794 ksExceptions
.ClientException
,
3795 neExceptions
.NeutronException
,
3798 self
._format
_exception
(e
)
3800 def delete_sfi(self
, sfi_id
):
3801 self
.logger
.debug("Deleting Service Function Instance '%s' from VIM", sfi_id
)
3804 self
._reload
_connection
()
3805 self
.neutron
.delete_sfc_port_pair(sfi_id
)
3809 neExceptions
.ConnectionFailed
,
3810 neExceptions
.NeutronException
,
3811 ksExceptions
.ClientException
,
3812 neExceptions
.NeutronException
,
3815 self
._format
_exception
(e
)
3817 def new_sf(self
, name
, sfis
, sfc_encap
=True):
3818 self
.logger
.debug("Adding a new Service Function to VIM, named '%s'", name
)
3822 self
._reload
_connection
()
3823 # correlation = None
3825 # correlation = "nsh"
3827 for instance
in sfis
:
3828 sfi
= self
.get_sfi(instance
)
3830 if sfi
.get("sfc_encap") != sfc_encap
:
3831 raise vimconn
.VimConnNotSupportedException(
3832 "OpenStack VIM connector requires all SFIs of the "
3833 "same SF to share the same SFC Encapsulation"
3836 sf_dict
= {"name": name
, "port_pairs": sfis
}
3837 new_sf
= self
.neutron
.create_sfc_port_pair_group(
3838 {"port_pair_group": sf_dict
}
3841 return new_sf
["port_pair_group"]["id"]
3843 neExceptions
.ConnectionFailed
,
3844 ksExceptions
.ClientException
,
3845 neExceptions
.NeutronException
,
3850 self
.neutron
.delete_sfc_port_pair_group(
3851 new_sf
["port_pair_group"]["id"]
3855 "Creation of Service Function failed, with "
3856 "subsequent deletion failure as well."
3859 self
._format
_exception
(e
)
3861 def get_sf(self
, sf_id
):
3862 self
.logger
.debug("Getting Service Function %s from VIM", sf_id
)
3863 filter_dict
= {"id": sf_id
}
3864 sf_list
= self
.get_sf_list(filter_dict
)
3866 if len(sf_list
) == 0:
3867 raise vimconn
.VimConnNotFoundException(
3868 "Service Function '{}' not found".format(sf_id
)
3870 elif len(sf_list
) > 1:
3871 raise vimconn
.VimConnConflictException(
3872 "Found more than one Service Function with this criteria"
3879 def get_sf_list(self
, filter_dict
={}):
3881 "Getting Service Function from VIM filter: '%s'", str(filter_dict
)
3885 self
._reload
_connection
()
3886 filter_dict_os
= filter_dict
.copy()
3888 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3889 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3891 sf_dict
= self
.neutron
.list_sfc_port_pair_groups(**filter_dict_os
)
3892 sf_list
= sf_dict
["port_pair_groups"]
3893 self
.__sf
_os
2mano
(sf_list
)
3897 neExceptions
.ConnectionFailed
,
3898 ksExceptions
.ClientException
,
3899 neExceptions
.NeutronException
,
3902 self
._format
_exception
(e
)
3904 def delete_sf(self
, sf_id
):
3905 self
.logger
.debug("Deleting Service Function '%s' from VIM", sf_id
)
3908 self
._reload
_connection
()
3909 self
.neutron
.delete_sfc_port_pair_group(sf_id
)
3913 neExceptions
.ConnectionFailed
,
3914 neExceptions
.NeutronException
,
3915 ksExceptions
.ClientException
,
3916 neExceptions
.NeutronException
,
3919 self
._format
_exception
(e
)
3921 def new_sfp(self
, name
, classifications
, sfs
, sfc_encap
=True, spi
=None):
3922 self
.logger
.debug("Adding a new Service Function Path to VIM, named '%s'", name
)
3926 self
._reload
_connection
()
3927 # In networking-sfc the MPLS encapsulation is legacy
3928 # should be used when no full SFC Encapsulation is intended
3929 correlation
= "mpls"
3936 "flow_classifiers": classifications
,
3937 "port_pair_groups": sfs
,
3938 "chain_parameters": {"correlation": correlation
},
3942 sfp_dict
["chain_id"] = spi
3944 new_sfp
= self
.neutron
.create_sfc_port_chain({"port_chain": sfp_dict
})
3946 return new_sfp
["port_chain"]["id"]
3948 neExceptions
.ConnectionFailed
,
3949 ksExceptions
.ClientException
,
3950 neExceptions
.NeutronException
,
3955 self
.neutron
.delete_sfc_port_chain(new_sfp
["port_chain"]["id"])
3958 "Creation of Service Function Path failed, with "
3959 "subsequent deletion failure as well."
3962 self
._format
_exception
(e
)
3964 def get_sfp(self
, sfp_id
):
3965 self
.logger
.debug(" Getting Service Function Path %s from VIM", sfp_id
)
3967 filter_dict
= {"id": sfp_id
}
3968 sfp_list
= self
.get_sfp_list(filter_dict
)
3970 if len(sfp_list
) == 0:
3971 raise vimconn
.VimConnNotFoundException(
3972 "Service Function Path '{}' not found".format(sfp_id
)
3974 elif len(sfp_list
) > 1:
3975 raise vimconn
.VimConnConflictException(
3976 "Found more than one Service Function Path with this criteria"
3983 def get_sfp_list(self
, filter_dict
={}):
3985 "Getting Service Function Paths from VIM filter: '%s'", str(filter_dict
)
3989 self
._reload
_connection
()
3990 filter_dict_os
= filter_dict
.copy()
3992 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3993 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3995 sfp_dict
= self
.neutron
.list_sfc_port_chains(**filter_dict_os
)
3996 sfp_list
= sfp_dict
["port_chains"]
3997 self
.__sfp
_os
2mano
(sfp_list
)
4001 neExceptions
.ConnectionFailed
,
4002 ksExceptions
.ClientException
,
4003 neExceptions
.NeutronException
,
4006 self
._format
_exception
(e
)
4008 def delete_sfp(self
, sfp_id
):
4009 self
.logger
.debug("Deleting Service Function Path '%s' from VIM", sfp_id
)
4012 self
._reload
_connection
()
4013 self
.neutron
.delete_sfc_port_chain(sfp_id
)
4017 neExceptions
.ConnectionFailed
,
4018 neExceptions
.NeutronException
,
4019 ksExceptions
.ClientException
,
4020 neExceptions
.NeutronException
,
4023 self
._format
_exception
(e
)
4025 def refresh_sfps_status(self
, sfp_list
):
4026 """Get the status of the service function path
4027 Params: the list of sfp identifiers
4028 Returns a dictionary with:
4029 vm_id: #VIM id of this service function path
4030 status: #Mandatory. Text with one of:
4031 # DELETED (not found at vim)
4032 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4033 # OTHER (Vim reported other status not understood)
4034 # ERROR (VIM indicates an ERROR status)
4036 # CREATING (on building process)
4037 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4038 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)F
4042 "refresh_sfps status: Getting tenant SFP information from VIM"
4045 for sfp_id
in sfp_list
:
4049 sfp_vim
= self
.get_sfp(sfp_id
)
4052 sfp
["status"] = vmStatus2manoFormat
["ACTIVE"]
4054 sfp
["status"] = "OTHER"
4055 sfp
["error_msg"] = "VIM status reported " + sfp
["status"]
4057 sfp
["vim_info"] = self
.serialize(sfp_vim
)
4059 if sfp_vim
.get("fault"):
4060 sfp
["error_msg"] = str(sfp_vim
["fault"])
4061 except vimconn
.VimConnNotFoundException
as e
:
4062 self
.logger
.error("Exception getting sfp status: %s", str(e
))
4063 sfp
["status"] = "DELETED"
4064 sfp
["error_msg"] = str(e
)
4065 except vimconn
.VimConnException
as e
:
4066 self
.logger
.error("Exception getting sfp status: %s", str(e
))
4067 sfp
["status"] = "VIM_ERROR"
4068 sfp
["error_msg"] = str(e
)
4070 sfp_dict
[sfp_id
] = sfp
4074 def refresh_sfis_status(self
, sfi_list
):
4075 """Get the status of the service function instances
4076 Params: the list of sfi identifiers
4077 Returns a dictionary with:
4078 vm_id: #VIM id of this service function instance
4079 status: #Mandatory. Text with one of:
4080 # DELETED (not found at vim)
4081 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4082 # OTHER (Vim reported other status not understood)
4083 # ERROR (VIM indicates an ERROR status)
4085 # CREATING (on building process)
4086 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4087 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4091 "refresh_sfis status: Getting tenant sfi information from VIM"
4094 for sfi_id
in sfi_list
:
4098 sfi_vim
= self
.get_sfi(sfi_id
)
4101 sfi
["status"] = vmStatus2manoFormat
["ACTIVE"]
4103 sfi
["status"] = "OTHER"
4104 sfi
["error_msg"] = "VIM status reported " + sfi
["status"]
4106 sfi
["vim_info"] = self
.serialize(sfi_vim
)
4108 if sfi_vim
.get("fault"):
4109 sfi
["error_msg"] = str(sfi_vim
["fault"])
4110 except vimconn
.VimConnNotFoundException
as e
:
4111 self
.logger
.error("Exception getting sfi status: %s", str(e
))
4112 sfi
["status"] = "DELETED"
4113 sfi
["error_msg"] = str(e
)
4114 except vimconn
.VimConnException
as e
:
4115 self
.logger
.error("Exception getting sfi status: %s", str(e
))
4116 sfi
["status"] = "VIM_ERROR"
4117 sfi
["error_msg"] = str(e
)
4119 sfi_dict
[sfi_id
] = sfi
4123 def refresh_sfs_status(self
, sf_list
):
4124 """Get the status of the service functions
4125 Params: the list of sf identifiers
4126 Returns a dictionary with:
4127 vm_id: #VIM id of this service function
4128 status: #Mandatory. Text with one of:
4129 # DELETED (not found at vim)
4130 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4131 # OTHER (Vim reported other status not understood)
4132 # ERROR (VIM indicates an ERROR status)
4134 # CREATING (on building process)
4135 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4136 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4139 self
.logger
.debug("refresh_sfs status: Getting tenant sf information from VIM")
4141 for sf_id
in sf_list
:
4145 sf_vim
= self
.get_sf(sf_id
)
4148 sf
["status"] = vmStatus2manoFormat
["ACTIVE"]
4150 sf
["status"] = "OTHER"
4151 sf
["error_msg"] = "VIM status reported " + sf_vim
["status"]
4153 sf
["vim_info"] = self
.serialize(sf_vim
)
4155 if sf_vim
.get("fault"):
4156 sf
["error_msg"] = str(sf_vim
["fault"])
4157 except vimconn
.VimConnNotFoundException
as e
:
4158 self
.logger
.error("Exception getting sf status: %s", str(e
))
4159 sf
["status"] = "DELETED"
4160 sf
["error_msg"] = str(e
)
4161 except vimconn
.VimConnException
as e
:
4162 self
.logger
.error("Exception getting sf status: %s", str(e
))
4163 sf
["status"] = "VIM_ERROR"
4164 sf
["error_msg"] = str(e
)
4170 def refresh_classifications_status(self
, classification_list
):
4171 """Get the status of the classifications
4172 Params: the list of classification identifiers
4173 Returns a dictionary with:
4174 vm_id: #VIM id of this classifier
4175 status: #Mandatory. Text with one of:
4176 # DELETED (not found at vim)
4177 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4178 # OTHER (Vim reported other status not understood)
4179 # ERROR (VIM indicates an ERROR status)
4181 # CREATING (on building process)
4182 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4183 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4185 classification_dict
= {}
4187 "refresh_classifications status: Getting tenant classification information from VIM"
4190 for classification_id
in classification_list
:
4194 classification_vim
= self
.get_classification(classification_id
)
4196 if classification_vim
:
4197 classification
["status"] = vmStatus2manoFormat
["ACTIVE"]
4199 classification
["status"] = "OTHER"
4200 classification
["error_msg"] = (
4201 "VIM status reported " + classification
["status"]
4204 classification
["vim_info"] = self
.serialize(classification_vim
)
4206 if classification_vim
.get("fault"):
4207 classification
["error_msg"] = str(classification_vim
["fault"])
4208 except vimconn
.VimConnNotFoundException
as e
:
4209 self
.logger
.error("Exception getting classification status: %s", str(e
))
4210 classification
["status"] = "DELETED"
4211 classification
["error_msg"] = str(e
)
4212 except vimconn
.VimConnException
as e
:
4213 self
.logger
.error("Exception getting classification status: %s", str(e
))
4214 classification
["status"] = "VIM_ERROR"
4215 classification
["error_msg"] = str(e
)
4217 classification_dict
[classification_id
] = classification
4219 return classification_dict
4221 def new_affinity_group(self
, affinity_group_data
):
4222 """Adds a server group to VIM
4223 affinity_group_data contains a dictionary with information, keys:
4224 name: name in VIM for the server group
4225 type: affinity or anti-affinity
4226 scope: Only nfvi-node allowed
4227 Returns the server group identifier"""
4228 self
.logger
.debug("Adding Server Group '%s'", str(affinity_group_data
))
4231 name
= affinity_group_data
["name"]
4232 policy
= affinity_group_data
["type"]
4234 self
._reload
_connection
()
4235 new_server_group
= self
.nova
.server_groups
.create(name
, policy
)
4237 return new_server_group
.id
4239 ksExceptions
.ClientException
,
4240 nvExceptions
.ClientException
,
4244 self
._format
_exception
(e
)
4246 def get_affinity_group(self
, affinity_group_id
):
4247 """Obtain server group details from the VIM. Returns the server group detais as a dict"""
4248 self
.logger
.debug("Getting flavor '%s'", affinity_group_id
)
4250 self
._reload
_connection
()
4251 server_group
= self
.nova
.server_groups
.find(id=affinity_group_id
)
4253 return server_group
.to_dict()
4255 nvExceptions
.NotFound
,
4256 nvExceptions
.ClientException
,
4257 ksExceptions
.ClientException
,
4260 self
._format
_exception
(e
)
4262 def delete_affinity_group(self
, affinity_group_id
):
4263 """Deletes a server group from the VIM. Returns the old affinity_group_id"""
4264 self
.logger
.debug("Getting server group '%s'", affinity_group_id
)
4266 self
._reload
_connection
()
4267 self
.nova
.server_groups
.delete(affinity_group_id
)
4269 return affinity_group_id
4271 nvExceptions
.NotFound
,
4272 ksExceptions
.ClientException
,
4273 nvExceptions
.ClientException
,
4276 self
._format
_exception
(e
)
4278 def get_vdu_state(self
, vm_id
):
4280 Getting the state of a vdu
4282 vm_id: ID of an instance
4284 self
.logger
.debug("Getting the status of VM")
4285 self
.logger
.debug("VIM VM ID %s", vm_id
)
4286 self
._reload
_connection
()
4287 server
= self
.nova
.servers
.find(id=vm_id
)
4288 server_dict
= server
.to_dict()
4290 server_dict
["status"],
4291 server_dict
["flavor"]["id"],
4292 server_dict
["OS-EXT-SRV-ATTR:host"],
4293 server_dict
["OS-EXT-AZ:availability_zone"],
4295 self
.logger
.debug("vdu_data %s", vdu_data
)
4298 def check_compute_availability(self
, host
, server_flavor_details
):
4299 self
._reload
_connection
()
4300 hypervisor_search
= self
.nova
.hypervisors
.search(
4301 hypervisor_match
=host
, servers
=True
4303 for hypervisor
in hypervisor_search
:
4304 hypervisor_id
= hypervisor
.to_dict()["id"]
4305 hypervisor_details
= self
.nova
.hypervisors
.get(hypervisor
=hypervisor_id
)
4306 hypervisor_dict
= hypervisor_details
.to_dict()
4307 hypervisor_temp
= json
.dumps(hypervisor_dict
)
4308 hypervisor_json
= json
.loads(hypervisor_temp
)
4309 resources_available
= [
4310 hypervisor_json
["free_ram_mb"],
4311 hypervisor_json
["disk_available_least"],
4312 hypervisor_json
["vcpus"] - hypervisor_json
["vcpus_used"],
4314 compute_available
= all(
4315 x
> y
for x
, y
in zip(resources_available
, server_flavor_details
)
4317 if compute_available
:
4320 def check_availability_zone(
4321 self
, old_az
, server_flavor_details
, old_host
, host
=None
4323 self
._reload
_connection
()
4324 az_check
= {"zone_check": False, "compute_availability": None}
4325 aggregates_list
= self
.nova
.aggregates
.list()
4326 for aggregate
in aggregates_list
:
4327 aggregate_details
= aggregate
.to_dict()
4328 aggregate_temp
= json
.dumps(aggregate_details
)
4329 aggregate_json
= json
.loads(aggregate_temp
)
4330 if aggregate_json
["availability_zone"] == old_az
:
4331 hosts_list
= aggregate_json
["hosts"]
4332 if host
is not None:
4333 if host
in hosts_list
:
4334 az_check
["zone_check"] = True
4335 available_compute_id
= self
.check_compute_availability(
4336 host
, server_flavor_details
4338 if available_compute_id
is not None:
4339 az_check
["compute_availability"] = available_compute_id
4341 for check_host
in hosts_list
:
4342 if check_host
!= old_host
:
4343 available_compute_id
= self
.check_compute_availability(
4344 check_host
, server_flavor_details
4346 if available_compute_id
is not None:
4347 az_check
["zone_check"] = True
4348 az_check
["compute_availability"] = available_compute_id
4351 az_check
["zone_check"] = True
4354 def migrate_instance(self
, vm_id
, compute_host
=None):
4358 vm_id: ID of an instance
4359 compute_host: Host to migrate the vdu to
4361 self
._reload
_connection
()
4363 instance_state
= self
.get_vdu_state(vm_id
)
4364 server_flavor_id
= instance_state
[1]
4365 server_hypervisor_name
= instance_state
[2]
4366 server_availability_zone
= instance_state
[3]
4368 server_flavor
= self
.nova
.flavors
.find(id=server_flavor_id
).to_dict()
4369 server_flavor_details
= [
4370 server_flavor
["ram"],
4371 server_flavor
["disk"],
4372 server_flavor
["vcpus"],
4374 if compute_host
== server_hypervisor_name
:
4375 raise vimconn
.VimConnException(
4376 "Unable to migrate instance '{}' to the same host '{}'".format(
4379 http_code
=vimconn
.HTTP_Bad_Request
,
4381 az_status
= self
.check_availability_zone(
4382 server_availability_zone
,
4383 server_flavor_details
,
4384 server_hypervisor_name
,
4387 availability_zone_check
= az_status
["zone_check"]
4388 available_compute_id
= az_status
.get("compute_availability")
4390 if availability_zone_check
is False:
4391 raise vimconn
.VimConnException(
4392 "Unable to migrate instance '{}' to a different availability zone".format(
4395 http_code
=vimconn
.HTTP_Bad_Request
,
4397 if available_compute_id
is not None:
4398 self
.nova
.servers
.live_migrate(
4400 host
=available_compute_id
,
4401 block_migration
=True,
4402 disk_over_commit
=False,
4405 changed_compute_host
= ""
4406 if state
== "MIGRATING":
4407 vm_state
= self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4408 changed_compute_host
= self
.get_vdu_state(vm_id
)[2]
4409 if vm_state
and changed_compute_host
== available_compute_id
:
4411 "Instance '{}' migrated to the new compute host '{}'".format(
4412 vm_id
, changed_compute_host
4415 return state
, available_compute_id
4417 raise vimconn
.VimConnException(
4418 "Migration Failed. Instance '{}' not moved to the new host {}".format(
4419 vm_id
, available_compute_id
4421 http_code
=vimconn
.HTTP_Bad_Request
,
4424 raise vimconn
.VimConnException(
4425 "Compute '{}' not available or does not have enough resources to migrate the instance".format(
4426 available_compute_id
4428 http_code
=vimconn
.HTTP_Bad_Request
,
4431 nvExceptions
.BadRequest
,
4432 nvExceptions
.ClientException
,
4433 nvExceptions
.NotFound
,
4435 self
._format
_exception
(e
)
4437 def resize_instance(self
, vm_id
, new_flavor_id
):
4439 For resizing the vm based on the given
4442 vm_id : ID of an instance
4443 new_flavor_id : Flavor id to be resized
4444 Return the status of a resized instance
4446 self
._reload
_connection
()
4447 self
.logger
.debug("resize the flavor of an instance")
4448 instance_status
, old_flavor_id
, compute_host
, az
= self
.get_vdu_state(vm_id
)
4449 old_flavor_disk
= self
.nova
.flavors
.find(id=old_flavor_id
).to_dict()["disk"]
4450 new_flavor_disk
= self
.nova
.flavors
.find(id=new_flavor_id
).to_dict()["disk"]
4452 if instance_status
== "ACTIVE" or instance_status
== "SHUTOFF":
4453 if old_flavor_disk
> new_flavor_disk
:
4454 raise nvExceptions
.BadRequest(
4456 message
="Server disk resize failed. Resize to lower disk flavor is not allowed",
4459 self
.nova
.servers
.resize(server
=vm_id
, flavor
=new_flavor_id
)
4460 vm_state
= self
.__wait
_for
_vm
(vm_id
, "VERIFY_RESIZE")
4462 instance_resized_status
= self
.confirm_resize(vm_id
)
4463 return instance_resized_status
4465 raise nvExceptions
.BadRequest(
4467 message
="Cannot 'resize' vm_state is in ERROR",
4471 self
.logger
.debug("ERROR : Instance is not in ACTIVE or SHUTOFF state")
4472 raise nvExceptions
.BadRequest(
4474 message
="Cannot 'resize' instance while it is in vm_state resized",
4477 nvExceptions
.BadRequest
,
4478 nvExceptions
.ClientException
,
4479 nvExceptions
.NotFound
,
4481 self
._format
_exception
(e
)
4483 def confirm_resize(self
, vm_id
):
4485 Confirm the resize of an instance
4487 vm_id: ID of an instance
4489 self
._reload
_connection
()
4490 self
.nova
.servers
.confirm_resize(server
=vm_id
)
4491 if self
.get_vdu_state(vm_id
)[0] == "VERIFY_RESIZE":
4492 self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4493 instance_status
= self
.get_vdu_state(vm_id
)[0]
4494 return instance_status