1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U.
5 # This file is part of openmano
8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
9 # not use this file except in compliance with the License. You may obtain
10 # a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 # License for the specific language governing permissions and limitations
22 osconnector implements all the methods to interact with openstack using the python-neutronclient.
24 For the VNF forwarding graph, The OpenStack VIM connector calls the
25 networking-sfc Neutron extension methods, whose resources are mapped
26 to the VIM connector's SFC resources as follows:
27 - Classification (OSM) -> Flow Classifier (Neutron)
28 - Service Function Instance (OSM) -> Port Pair (Neutron)
29 - Service Function (OSM) -> Port Pair Group (Neutron)
30 - Service Function Path (OSM) -> Port Chain (Neutron)
34 from http
.client
import HTTPException
37 from pprint
import pformat
41 from typing
import Dict
, List
, Optional
, Tuple
43 from cinderclient
import client
as cClient
44 from glanceclient
import client
as glClient
45 import glanceclient
.exc
as gl1Exceptions
46 from keystoneauth1
import session
47 from keystoneauth1
.identity
import v2
, v3
48 import keystoneclient
.exceptions
as ksExceptions
49 import keystoneclient
.v2_0
.client
as ksClient_v2
50 import keystoneclient
.v3
.client
as ksClient_v3
52 from neutronclient
.common
import exceptions
as neExceptions
53 from neutronclient
.neutron
import client
as neClient
54 from novaclient
import client
as nClient
, exceptions
as nvExceptions
55 from osm_ro_plugin
import vimconn
56 from requests
.exceptions
import ConnectionError
59 __author__
= "Alfonso Tierno, Gerardo Garcia, Pablo Montes, xFlow Research, Igor D.C., Eduardo Sousa"
60 __date__
= "$22-sep-2017 23:59:59$"
62 """contain the openstack virtual machine status to openmano status"""
63 vmStatus2manoFormat
= {
66 "SUSPENDED": "SUSPENDED",
67 "SHUTOFF": "INACTIVE",
72 netStatus2manoFormat
= {
75 "INACTIVE": "INACTIVE",
81 supportedClassificationTypes
= ["legacy_flow_classifier"]
83 # global var to have a timeout creating and deleting volumes
88 class SafeDumper(yaml
.SafeDumper
):
89 def represent_data(self
, data
):
90 # Openstack APIs use custom subclasses of dict and YAML safe dumper
91 # is designed to not handle that (reference issue 142 of pyyaml)
92 if isinstance(data
, dict) and data
.__class
__ != dict:
93 # A simple solution is to convert those items back to dicts
94 data
= dict(data
.items())
96 return super(SafeDumper
, self
).represent_data(data
)
99 class vimconnector(vimconn
.VimConnector
):
114 """using common constructor parameters. In this case
115 'url' is the keystone authorization url,
116 'url_admin' is not use
118 api_version
= config
.get("APIversion")
120 if api_version
and api_version
not in ("v3.3", "v2.0", "2", "3"):
121 raise vimconn
.VimConnException(
122 "Invalid value '{}' for config:APIversion. "
123 "Allowed values are 'v3.3', 'v2.0', '2' or '3'".format(api_version
)
126 vim_type
= config
.get("vim_type")
128 if vim_type
and vim_type
not in ("vio", "VIO"):
129 raise vimconn
.VimConnException(
130 "Invalid value '{}' for config:vim_type."
131 "Allowed values are 'vio' or 'VIO'".format(vim_type
)
134 if config
.get("dataplane_net_vlan_range") is not None:
135 # validate vlan ranges provided by user
136 self
._validate
_vlan
_ranges
(
137 config
.get("dataplane_net_vlan_range"), "dataplane_net_vlan_range"
140 if config
.get("multisegment_vlan_range") is not None:
141 # validate vlan ranges provided by user
142 self
._validate
_vlan
_ranges
(
143 config
.get("multisegment_vlan_range"), "multisegment_vlan_range"
146 vimconn
.VimConnector
.__init
__(
160 if self
.config
.get("insecure") and self
.config
.get("ca_cert"):
161 raise vimconn
.VimConnException(
162 "options insecure and ca_cert are mutually exclusive"
167 if self
.config
.get("insecure"):
170 if self
.config
.get("ca_cert"):
171 self
.verify
= self
.config
.get("ca_cert")
174 raise TypeError("url param can not be NoneType")
176 self
.persistent_info
= persistent_info
177 self
.availability_zone
= persistent_info
.get("availability_zone", None)
178 self
.session
= persistent_info
.get("session", {"reload_client": True})
179 self
.my_tenant_id
= self
.session
.get("my_tenant_id")
180 self
.nova
= self
.session
.get("nova")
181 self
.neutron
= self
.session
.get("neutron")
182 self
.cinder
= self
.session
.get("cinder")
183 self
.glance
= self
.session
.get("glance")
184 # self.glancev1 = self.session.get("glancev1")
185 self
.keystone
= self
.session
.get("keystone")
186 self
.api_version3
= self
.session
.get("api_version3")
187 self
.vim_type
= self
.config
.get("vim_type")
190 self
.vim_type
= self
.vim_type
.upper()
192 if self
.config
.get("use_internal_endpoint"):
193 self
.endpoint_type
= "internalURL"
195 self
.endpoint_type
= None
197 logging
.getLogger("urllib3").setLevel(logging
.WARNING
)
198 logging
.getLogger("keystoneauth").setLevel(logging
.WARNING
)
199 logging
.getLogger("novaclient").setLevel(logging
.WARNING
)
200 self
.logger
= logging
.getLogger("ro.vim.openstack")
202 # allow security_groups to be a list or a single string
203 if isinstance(self
.config
.get("security_groups"), str):
204 self
.config
["security_groups"] = [self
.config
["security_groups"]]
206 self
.security_groups_id
= None
208 # ###### VIO Specific Changes #########
209 if self
.vim_type
== "VIO":
210 self
.logger
= logging
.getLogger("ro.vim.vio")
213 self
.logger
.setLevel(getattr(logging
, log_level
))
215 def __getitem__(self
, index
):
216 """Get individuals parameters.
218 if index
== "project_domain_id":
219 return self
.config
.get("project_domain_id")
220 elif index
== "user_domain_id":
221 return self
.config
.get("user_domain_id")
223 return vimconn
.VimConnector
.__getitem
__(self
, index
)
225 def __setitem__(self
, index
, value
):
226 """Set individuals parameters and it is marked as dirty so to force connection reload.
228 if index
== "project_domain_id":
229 self
.config
["project_domain_id"] = value
230 elif index
== "user_domain_id":
231 self
.config
["user_domain_id"] = value
233 vimconn
.VimConnector
.__setitem
__(self
, index
, value
)
235 self
.session
["reload_client"] = True
237 def serialize(self
, value
):
238 """Serialization of python basic types.
240 In the case value is not serializable a message will be logged and a
241 simple representation of the data that cannot be converted back to
244 if isinstance(value
, str):
249 value
, Dumper
=SafeDumper
, default_flow_style
=True, width
=256
251 except yaml
.representer
.RepresenterError
:
253 "The following entity cannot be serialized in YAML:\n\n%s\n\n",
260 def _reload_connection(self
):
261 """Called before any operation, it check if credentials has changed
262 Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
264 # TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
265 if self
.session
["reload_client"]:
266 if self
.config
.get("APIversion"):
267 self
.api_version3
= (
268 self
.config
["APIversion"] == "v3.3"
269 or self
.config
["APIversion"] == "3"
271 else: # get from ending auth_url that end with v3 or with v2.0
272 self
.api_version3
= self
.url
.endswith("/v3") or self
.url
.endswith(
276 self
.session
["api_version3"] = self
.api_version3
278 if self
.api_version3
:
279 if self
.config
.get("project_domain_id") or self
.config
.get(
280 "project_domain_name"
282 project_domain_id_default
= None
284 project_domain_id_default
= "default"
286 if self
.config
.get("user_domain_id") or self
.config
.get(
289 user_domain_id_default
= None
291 user_domain_id_default
= "default"
295 password
=self
.passwd
,
296 project_name
=self
.tenant_name
,
297 project_id
=self
.tenant_id
,
298 project_domain_id
=self
.config
.get(
299 "project_domain_id", project_domain_id_default
301 user_domain_id
=self
.config
.get(
302 "user_domain_id", user_domain_id_default
304 project_domain_name
=self
.config
.get("project_domain_name"),
305 user_domain_name
=self
.config
.get("user_domain_name"),
311 password
=self
.passwd
,
312 tenant_name
=self
.tenant_name
,
313 tenant_id
=self
.tenant_id
,
316 sess
= session
.Session(auth
=auth
, verify
=self
.verify
)
317 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
318 # Titanium cloud and StarlingX
319 region_name
= self
.config
.get("region_name")
321 if self
.api_version3
:
322 self
.keystone
= ksClient_v3
.Client(
324 endpoint_type
=self
.endpoint_type
,
325 region_name
=region_name
,
328 self
.keystone
= ksClient_v2
.Client(
329 session
=sess
, endpoint_type
=self
.endpoint_type
332 self
.session
["keystone"] = self
.keystone
333 # In order to enable microversion functionality an explicit microversion must be specified in "config".
334 # This implementation approach is due to the warning message in
335 # https://developer.openstack.org/api-guide/compute/microversions.html
336 # where it is stated that microversion backwards compatibility is not guaranteed and clients should
337 # always require an specific microversion.
338 # To be able to use "device role tagging" functionality define "microversion: 2.32" in datacenter config
339 version
= self
.config
.get("microversion")
344 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
345 # Titanium cloud and StarlingX
346 self
.nova
= self
.session
["nova"] = nClient
.Client(
349 endpoint_type
=self
.endpoint_type
,
350 region_name
=region_name
,
352 self
.neutron
= self
.session
["neutron"] = neClient
.Client(
355 endpoint_type
=self
.endpoint_type
,
356 region_name
=region_name
,
358 self
.cinder
= self
.session
["cinder"] = cClient
.Client(
361 endpoint_type
=self
.endpoint_type
,
362 region_name
=region_name
,
366 self
.my_tenant_id
= self
.session
["my_tenant_id"] = sess
.get_project_id()
368 self
.logger
.error("Cannot get project_id from session", exc_info
=True)
370 if self
.endpoint_type
== "internalURL":
371 glance_service_id
= self
.keystone
.services
.list(name
="glance")[0].id
372 glance_endpoint
= self
.keystone
.endpoints
.list(
373 glance_service_id
, interface
="internal"
376 glance_endpoint
= None
378 self
.glance
= self
.session
["glance"] = glClient
.Client(
379 2, session
=sess
, endpoint
=glance_endpoint
381 # using version 1 of glance client in new_image()
382 # self.glancev1 = self.session["glancev1"] = glClient.Client("1", session=sess,
383 # endpoint=glance_endpoint)
384 self
.session
["reload_client"] = False
385 self
.persistent_info
["session"] = self
.session
386 # add availablity zone info inside self.persistent_info
387 self
._set
_availablity
_zones
()
388 self
.persistent_info
["availability_zone"] = self
.availability_zone
389 # force to get again security_groups_ids next time they are needed
390 self
.security_groups_id
= None
392 def __net_os2mano(self
, net_list_dict
):
393 """Transform the net openstack format to mano format
394 net_list_dict can be a list of dict or a single dict"""
395 if type(net_list_dict
) is dict:
396 net_list_
= (net_list_dict
,)
397 elif type(net_list_dict
) is list:
398 net_list_
= net_list_dict
400 raise TypeError("param net_list_dict must be a list or a dictionary")
401 for net
in net_list_
:
402 if net
.get("provider:network_type") == "vlan":
405 net
["type"] = "bridge"
407 def __classification_os2mano(self
, class_list_dict
):
408 """Transform the openstack format (Flow Classifier) to mano format
409 (Classification) class_list_dict can be a list of dict or a single dict
411 if isinstance(class_list_dict
, dict):
412 class_list_
= [class_list_dict
]
413 elif isinstance(class_list_dict
, list):
414 class_list_
= class_list_dict
416 raise TypeError("param class_list_dict must be a list or a dictionary")
417 for classification
in class_list_
:
418 id = classification
.pop("id")
419 name
= classification
.pop("name")
420 description
= classification
.pop("description")
421 project_id
= classification
.pop("project_id")
422 tenant_id
= classification
.pop("tenant_id")
423 original_classification
= copy
.deepcopy(classification
)
424 classification
.clear()
425 classification
["ctype"] = "legacy_flow_classifier"
426 classification
["definition"] = original_classification
427 classification
["id"] = id
428 classification
["name"] = name
429 classification
["description"] = description
430 classification
["project_id"] = project_id
431 classification
["tenant_id"] = tenant_id
433 def __sfi_os2mano(self
, sfi_list_dict
):
434 """Transform the openstack format (Port Pair) to mano format (SFI)
435 sfi_list_dict can be a list of dict or a single dict
437 if isinstance(sfi_list_dict
, dict):
438 sfi_list_
= [sfi_list_dict
]
439 elif isinstance(sfi_list_dict
, list):
440 sfi_list_
= sfi_list_dict
442 raise TypeError("param sfi_list_dict must be a list or a dictionary")
444 for sfi
in sfi_list_
:
445 sfi
["ingress_ports"] = []
446 sfi
["egress_ports"] = []
448 if sfi
.get("ingress"):
449 sfi
["ingress_ports"].append(sfi
["ingress"])
451 if sfi
.get("egress"):
452 sfi
["egress_ports"].append(sfi
["egress"])
456 params
= sfi
.get("service_function_parameters")
460 correlation
= params
.get("correlation")
465 sfi
["sfc_encap"] = sfc_encap
466 del sfi
["service_function_parameters"]
468 def __sf_os2mano(self
, sf_list_dict
):
469 """Transform the openstack format (Port Pair Group) to mano format (SF)
470 sf_list_dict can be a list of dict or a single dict
472 if isinstance(sf_list_dict
, dict):
473 sf_list_
= [sf_list_dict
]
474 elif isinstance(sf_list_dict
, list):
475 sf_list_
= sf_list_dict
477 raise TypeError("param sf_list_dict must be a list or a dictionary")
480 del sf
["port_pair_group_parameters"]
481 sf
["sfis"] = sf
["port_pairs"]
484 def __sfp_os2mano(self
, sfp_list_dict
):
485 """Transform the openstack format (Port Chain) to mano format (SFP)
486 sfp_list_dict can be a list of dict or a single dict
488 if isinstance(sfp_list_dict
, dict):
489 sfp_list_
= [sfp_list_dict
]
490 elif isinstance(sfp_list_dict
, list):
491 sfp_list_
= sfp_list_dict
493 raise TypeError("param sfp_list_dict must be a list or a dictionary")
495 for sfp
in sfp_list_
:
496 params
= sfp
.pop("chain_parameters")
500 correlation
= params
.get("correlation")
505 sfp
["sfc_encap"] = sfc_encap
506 sfp
["spi"] = sfp
.pop("chain_id")
507 sfp
["classifications"] = sfp
.pop("flow_classifiers")
508 sfp
["service_functions"] = sfp
.pop("port_pair_groups")
510 # placeholder for now; read TODO note below
511 def _validate_classification(self
, type, definition
):
512 # only legacy_flow_classifier Type is supported at this point
514 # TODO(igordcard): this method should be an abstract method of an
515 # abstract Classification class to be implemented by the specific
516 # Types. Also, abstract vimconnector should call the validation
517 # method before the implemented VIM connectors are called.
519 def _format_exception(self
, exception
):
520 """Transform a keystone, nova, neutron exception into a vimconn exception discovering the cause"""
521 message_error
= str(exception
)
527 neExceptions
.NetworkNotFoundClient
,
528 nvExceptions
.NotFound
,
529 ksExceptions
.NotFound
,
530 gl1Exceptions
.HTTPNotFound
,
533 raise vimconn
.VimConnNotFoundException(
534 type(exception
).__name
__ + ": " + message_error
540 gl1Exceptions
.HTTPException
,
541 gl1Exceptions
.CommunicationError
,
543 ksExceptions
.ConnectionError
,
544 neExceptions
.ConnectionFailed
,
547 if type(exception
).__name
__ == "SSLError":
548 tip
= " (maybe option 'insecure' must be added to the VIM)"
550 raise vimconn
.VimConnConnectionException(
551 "Invalid URL or credentials{}: {}".format(tip
, message_error
)
557 nvExceptions
.BadRequest
,
558 ksExceptions
.BadRequest
,
561 raise vimconn
.VimConnException(
562 type(exception
).__name
__ + ": " + message_error
567 nvExceptions
.ClientException
,
568 ksExceptions
.ClientException
,
569 neExceptions
.NeutronException
,
572 raise vimconn
.VimConnUnexpectedResponse(
573 type(exception
).__name
__ + ": " + message_error
575 elif isinstance(exception
, nvExceptions
.Conflict
):
576 raise vimconn
.VimConnConflictException(
577 type(exception
).__name
__ + ": " + message_error
579 elif isinstance(exception
, vimconn
.VimConnException
):
582 self
.logger
.error("General Exception " + message_error
, exc_info
=True)
584 raise vimconn
.VimConnConnectionException(
585 type(exception
).__name
__ + ": " + message_error
588 def _get_ids_from_name(self
):
590 Obtain ids from name of tenant and security_groups. Store at self .security_groups_id"
593 # get tenant_id if only tenant_name is supplied
594 self
._reload
_connection
()
596 if not self
.my_tenant_id
:
597 raise vimconn
.VimConnConnectionException(
598 "Error getting tenant information from name={} id={}".format(
599 self
.tenant_name
, self
.tenant_id
603 if self
.config
.get("security_groups") and not self
.security_groups_id
:
604 # convert from name to id
605 neutron_sg_list
= self
.neutron
.list_security_groups(
606 tenant_id
=self
.my_tenant_id
609 self
.security_groups_id
= []
610 for sg
in self
.config
.get("security_groups"):
611 for neutron_sg
in neutron_sg_list
:
612 if sg
in (neutron_sg
["id"], neutron_sg
["name"]):
613 self
.security_groups_id
.append(neutron_sg
["id"])
616 self
.security_groups_id
= None
618 raise vimconn
.VimConnConnectionException(
619 "Not found security group {} for this tenant".format(sg
)
622 def check_vim_connectivity(self
):
623 # just get network list to check connectivity and credentials
624 self
.get_network_list(filter_dict
={})
626 def get_tenant_list(self
, filter_dict
={}):
627 """Obtain tenants of VIM
628 filter_dict can contain the following keys:
629 name: filter by tenant name
630 id: filter by tenant uuid/id
632 Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
634 self
.logger
.debug("Getting tenants from VIM filter: '%s'", str(filter_dict
))
637 self
._reload
_connection
()
639 if self
.api_version3
:
640 project_class_list
= self
.keystone
.projects
.list(
641 name
=filter_dict
.get("name")
644 project_class_list
= self
.keystone
.tenants
.findall(**filter_dict
)
648 for project
in project_class_list
:
649 if filter_dict
.get("id") and filter_dict
["id"] != project
.id:
652 project_list
.append(project
.to_dict())
656 ksExceptions
.ConnectionError
,
657 ksExceptions
.ClientException
,
660 self
._format
_exception
(e
)
662 def new_tenant(self
, tenant_name
, tenant_description
):
663 """Adds a new tenant to openstack VIM. Returns the tenant identifier"""
664 self
.logger
.debug("Adding a new tenant name: %s", tenant_name
)
667 self
._reload
_connection
()
669 if self
.api_version3
:
670 project
= self
.keystone
.projects
.create(
672 self
.config
.get("project_domain_id", "default"),
673 description
=tenant_description
,
677 project
= self
.keystone
.tenants
.create(tenant_name
, tenant_description
)
681 ksExceptions
.ConnectionError
,
682 ksExceptions
.ClientException
,
683 ksExceptions
.BadRequest
,
686 self
._format
_exception
(e
)
688 def delete_tenant(self
, tenant_id
):
689 """Delete a tenant from openstack VIM. Returns the old tenant identifier"""
690 self
.logger
.debug("Deleting tenant %s from VIM", tenant_id
)
693 self
._reload
_connection
()
695 if self
.api_version3
:
696 self
.keystone
.projects
.delete(tenant_id
)
698 self
.keystone
.tenants
.delete(tenant_id
)
702 ksExceptions
.ConnectionError
,
703 ksExceptions
.ClientException
,
704 ksExceptions
.NotFound
,
707 self
._format
_exception
(e
)
715 provider_network_profile
=None,
717 """Adds a tenant network to VIM
719 'net_name': name of the network
721 'bridge': overlay isolated network
722 'data': underlay E-LAN network for Passthrough and SRIOV interfaces
723 'ptp': underlay E-LINE network for Passthrough and SRIOV interfaces.
724 'ip_profile': is a dict containing the IP parameters of the network
725 'ip_version': can be "IPv4" or "IPv6" (Currently only IPv4 is implemented)
726 'subnet_address': ip_prefix_schema, that is X.X.X.X/Y
727 'gateway_address': (Optional) ip_schema, that is X.X.X.X
728 'dns_address': (Optional) comma separated list of ip_schema, e.g. X.X.X.X[,X,X,X,X]
729 'dhcp_enabled': True or False
730 'dhcp_start_address': ip_schema, first IP to grant
731 'dhcp_count': number of IPs to grant.
732 'shared': if this network can be seen/use by other tenants/organization
733 'provider_network_profile': (optional) contains {segmentation-id: vlan, network-type: vlan|vxlan,
734 physical-network: physnet-label}
735 Returns a tuple with the network identifier and created_items, or raises an exception on error
736 created_items can be None or a dictionary where this method can include key-values that will be passed to
737 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
738 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
742 "Adding a new network to VIM name '%s', type '%s'", net_name
, net_type
744 # self.logger.debug(">>>>>>>>>>>>>>>>>> IP profile %s", str(ip_profile))
749 if provider_network_profile
:
750 vlan
= provider_network_profile
.get("segmentation-id")
754 self
._reload
_connection
()
755 network_dict
= {"name": net_name
, "admin_state_up": True}
757 if net_type
in ("data", "ptp") or provider_network_profile
:
758 provider_physical_network
= None
760 if provider_network_profile
and provider_network_profile
.get(
763 provider_physical_network
= provider_network_profile
.get(
767 # provider-network must be one of the dataplane_physcial_netowrk if this is a list. If it is string
768 # or not declared, just ignore the checking
771 self
.config
.get("dataplane_physical_net"), (tuple, list)
773 and provider_physical_network
774 not in self
.config
["dataplane_physical_net"]
776 raise vimconn
.VimConnConflictException(
777 "Invalid parameter 'provider-network:physical-network' "
778 "for network creation. '{}' is not one of the declared "
779 "list at VIM_config:dataplane_physical_net".format(
780 provider_physical_network
784 # use the default dataplane_physical_net
785 if not provider_physical_network
:
786 provider_physical_network
= self
.config
.get(
787 "dataplane_physical_net"
790 # if it is non empty list, use the first value. If it is a string use the value directly
792 isinstance(provider_physical_network
, (tuple, list))
793 and provider_physical_network
795 provider_physical_network
= provider_physical_network
[0]
797 if not provider_physical_network
:
798 raise vimconn
.VimConnConflictException(
799 "missing information needed for underlay networks. Provide "
800 "'dataplane_physical_net' configuration at VIM or use the NS "
801 "instantiation parameter 'provider-network.physical-network'"
805 if not self
.config
.get("multisegment_support"):
807 "provider:physical_network"
808 ] = provider_physical_network
811 provider_network_profile
812 and "network-type" in provider_network_profile
815 "provider:network_type"
816 ] = provider_network_profile
["network-type"]
818 network_dict
["provider:network_type"] = self
.config
.get(
819 "dataplane_network_type", "vlan"
823 network_dict
["provider:segmentation_id"] = vlan
828 "provider:physical_network": "",
829 "provider:network_type": "vxlan",
831 segment_list
.append(segment1_dict
)
833 "provider:physical_network": provider_physical_network
,
834 "provider:network_type": "vlan",
838 segment2_dict
["provider:segmentation_id"] = vlan
839 elif self
.config
.get("multisegment_vlan_range"):
840 vlanID
= self
._generate
_multisegment
_vlanID
()
841 segment2_dict
["provider:segmentation_id"] = vlanID
844 # raise vimconn.VimConnConflictException(
845 # "You must provide "multisegment_vlan_range" at config dict before creating a multisegment
847 segment_list
.append(segment2_dict
)
848 network_dict
["segments"] = segment_list
850 # VIO Specific Changes. It needs a concrete VLAN
851 if self
.vim_type
== "VIO" and vlan
is None:
852 if self
.config
.get("dataplane_net_vlan_range") is None:
853 raise vimconn
.VimConnConflictException(
854 "You must provide 'dataplane_net_vlan_range' in format "
855 "[start_ID - end_ID] at VIM_config for creating underlay "
859 network_dict
["provider:segmentation_id"] = self
._generate
_vlanID
()
861 network_dict
["shared"] = shared
863 if self
.config
.get("disable_network_port_security"):
864 network_dict
["port_security_enabled"] = False
866 if self
.config
.get("neutron_availability_zone_hints"):
867 hints
= self
.config
.get("neutron_availability_zone_hints")
869 if isinstance(hints
, str):
872 network_dict
["availability_zone_hints"] = hints
874 new_net
= self
.neutron
.create_network({"network": network_dict
})
876 # create subnetwork, even if there is no profile
881 if not ip_profile
.get("subnet_address"):
882 # Fake subnet is required
883 subnet_rand
= random
.randint(0, 255)
884 ip_profile
["subnet_address"] = "192.168.{}.0/24".format(subnet_rand
)
886 if "ip_version" not in ip_profile
:
887 ip_profile
["ip_version"] = "IPv4"
890 "name": net_name
+ "-subnet",
891 "network_id": new_net
["network"]["id"],
892 "ip_version": 4 if ip_profile
["ip_version"] == "IPv4" else 6,
893 "cidr": ip_profile
["subnet_address"],
896 # Gateway should be set to None if not needed. Otherwise openstack assigns one by default
897 if ip_profile
.get("gateway_address"):
898 subnet
["gateway_ip"] = ip_profile
["gateway_address"]
900 subnet
["gateway_ip"] = None
902 if ip_profile
.get("dns_address"):
903 subnet
["dns_nameservers"] = ip_profile
["dns_address"].split(";")
905 if "dhcp_enabled" in ip_profile
:
906 subnet
["enable_dhcp"] = (
908 if ip_profile
["dhcp_enabled"] == "false"
909 or ip_profile
["dhcp_enabled"] is False
913 if ip_profile
.get("dhcp_start_address"):
914 subnet
["allocation_pools"] = []
915 subnet
["allocation_pools"].append(dict())
916 subnet
["allocation_pools"][0]["start"] = ip_profile
[
920 if ip_profile
.get("dhcp_count"):
921 # parts = ip_profile["dhcp_start_address"].split(".")
922 # ip_int = (int(parts[0]) << 24) + (int(parts[1]) << 16) + (int(parts[2]) << 8) + int(parts[3])
923 ip_int
= int(netaddr
.IPAddress(ip_profile
["dhcp_start_address"]))
924 ip_int
+= ip_profile
["dhcp_count"] - 1
925 ip_str
= str(netaddr
.IPAddress(ip_int
))
926 subnet
["allocation_pools"][0]["end"] = ip_str
928 # self.logger.debug(">>>>>>>>>>>>>>>>>> Subnet: %s", str(subnet))
929 self
.neutron
.create_subnet({"subnet": subnet
})
931 if net_type
== "data" and self
.config
.get("multisegment_support"):
932 if self
.config
.get("l2gw_support"):
933 l2gw_list
= self
.neutron
.list_l2_gateways().get("l2_gateways", ())
934 for l2gw
in l2gw_list
:
936 "l2_gateway_id": l2gw
["id"],
937 "network_id": new_net
["network"]["id"],
938 "segmentation_id": str(vlanID
),
940 new_l2gw_conn
= self
.neutron
.create_l2_gateway_connection(
941 {"l2_gateway_connection": l2gw_conn
}
945 + str(new_l2gw_conn
["l2_gateway_connection"]["id"])
948 return new_net
["network"]["id"], created_items
949 except Exception as e
:
950 # delete l2gw connections (if any) before deleting the network
951 for k
, v
in created_items
.items():
952 if not v
: # skip already deleted
956 k_item
, _
, k_id
= k
.partition(":")
958 if k_item
== "l2gwconn":
959 self
.neutron
.delete_l2_gateway_connection(k_id
)
960 except Exception as e2
:
962 "Error deleting l2 gateway connection: {}: {}".format(
963 type(e2
).__name
__, e2
968 self
.neutron
.delete_network(new_net
["network"]["id"])
970 self
._format
_exception
(e
)
972 def get_network_list(self
, filter_dict
={}):
973 """Obtain tenant networks of VIM
979 admin_state_up: boolean
981 Returns the network list of dictionaries
983 self
.logger
.debug("Getting network from VIM filter: '%s'", str(filter_dict
))
986 self
._reload
_connection
()
987 filter_dict_os
= filter_dict
.copy()
989 if self
.api_version3
and "tenant_id" in filter_dict_os
:
991 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
993 net_dict
= self
.neutron
.list_networks(**filter_dict_os
)
994 net_list
= net_dict
["networks"]
995 self
.__net
_os
2mano
(net_list
)
999 neExceptions
.ConnectionFailed
,
1000 ksExceptions
.ClientException
,
1001 neExceptions
.NeutronException
,
1004 self
._format
_exception
(e
)
1006 def get_network(self
, net_id
):
1007 """Obtain details of network from VIM
1008 Returns the network information from a network id"""
1009 self
.logger
.debug(" Getting tenant network %s from VIM", net_id
)
1010 filter_dict
= {"id": net_id
}
1011 net_list
= self
.get_network_list(filter_dict
)
1013 if len(net_list
) == 0:
1014 raise vimconn
.VimConnNotFoundException(
1015 "Network '{}' not found".format(net_id
)
1017 elif len(net_list
) > 1:
1018 raise vimconn
.VimConnConflictException(
1019 "Found more than one network with this criteria"
1024 for subnet_id
in net
.get("subnets", ()):
1026 subnet
= self
.neutron
.show_subnet(subnet_id
)
1027 except Exception as e
:
1029 "osconnector.get_network(): Error getting subnet %s %s"
1032 subnet
= {"id": subnet_id
, "fault": str(e
)}
1034 subnets
.append(subnet
)
1036 net
["subnets"] = subnets
1037 net
["encapsulation"] = net
.get("provider:network_type")
1038 net
["encapsulation_type"] = net
.get("provider:network_type")
1039 net
["segmentation_id"] = net
.get("provider:segmentation_id")
1040 net
["encapsulation_id"] = net
.get("provider:segmentation_id")
1044 def delete_network(self
, net_id
, created_items
=None):
1046 Removes a tenant network from VIM and its associated elements
1047 :param net_id: VIM identifier of the network, provided by method new_network
1048 :param created_items: dictionary with extra items to be deleted. provided by method new_network
1049 Returns the network identifier or raises an exception upon error or when network is not found
1051 self
.logger
.debug("Deleting network '%s' from VIM", net_id
)
1053 if created_items
is None:
1057 self
._reload
_connection
()
1058 # delete l2gw connections (if any) before deleting the network
1059 for k
, v
in created_items
.items():
1060 if not v
: # skip already deleted
1064 k_item
, _
, k_id
= k
.partition(":")
1065 if k_item
== "l2gwconn":
1066 self
.neutron
.delete_l2_gateway_connection(k_id
)
1067 except Exception as e
:
1069 "Error deleting l2 gateway connection: {}: {}".format(
1074 # delete VM ports attached to this networks before the network
1075 ports
= self
.neutron
.list_ports(network_id
=net_id
)
1076 for p
in ports
["ports"]:
1078 self
.neutron
.delete_port(p
["id"])
1079 except Exception as e
:
1080 self
.logger
.error("Error deleting port %s: %s", p
["id"], str(e
))
1082 self
.neutron
.delete_network(net_id
)
1086 neExceptions
.ConnectionFailed
,
1087 neExceptions
.NetworkNotFoundClient
,
1088 neExceptions
.NeutronException
,
1089 ksExceptions
.ClientException
,
1090 neExceptions
.NeutronException
,
1093 self
._format
_exception
(e
)
1095 def refresh_nets_status(self
, net_list
):
1096 """Get the status of the networks
1097 Params: the list of network identifiers
1098 Returns a dictionary with:
1099 net_id: #VIM id of this network
1100 status: #Mandatory. Text with one of:
1101 # DELETED (not found at vim)
1102 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1103 # OTHER (Vim reported other status not understood)
1104 # ERROR (VIM indicates an ERROR status)
1105 # ACTIVE, INACTIVE, DOWN (admin down),
1106 # BUILD (on building process)
1108 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
1109 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1113 for net_id
in net_list
:
1117 net_vim
= self
.get_network(net_id
)
1119 if net_vim
["status"] in netStatus2manoFormat
:
1120 net
["status"] = netStatus2manoFormat
[net_vim
["status"]]
1122 net
["status"] = "OTHER"
1123 net
["error_msg"] = "VIM status reported " + net_vim
["status"]
1125 if net
["status"] == "ACTIVE" and not net_vim
["admin_state_up"]:
1126 net
["status"] = "DOWN"
1128 net
["vim_info"] = self
.serialize(net_vim
)
1130 if net_vim
.get("fault"): # TODO
1131 net
["error_msg"] = str(net_vim
["fault"])
1132 except vimconn
.VimConnNotFoundException
as e
:
1133 self
.logger
.error("Exception getting net status: %s", str(e
))
1134 net
["status"] = "DELETED"
1135 net
["error_msg"] = str(e
)
1136 except vimconn
.VimConnException
as e
:
1137 self
.logger
.error("Exception getting net status: %s", str(e
))
1138 net
["status"] = "VIM_ERROR"
1139 net
["error_msg"] = str(e
)
1140 net_dict
[net_id
] = net
1143 def get_flavor(self
, flavor_id
):
1144 """Obtain flavor details from the VIM. Returns the flavor dict details"""
1145 self
.logger
.debug("Getting flavor '%s'", flavor_id
)
1148 self
._reload
_connection
()
1149 flavor
= self
.nova
.flavors
.find(id=flavor_id
)
1150 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
1152 return flavor
.to_dict()
1154 nvExceptions
.NotFound
,
1155 nvExceptions
.ClientException
,
1156 ksExceptions
.ClientException
,
1159 self
._format
_exception
(e
)
1161 def get_flavor_id_from_data(self
, flavor_dict
):
1162 """Obtain flavor id that match the flavor description
1163 Returns the flavor_id or raises a vimconnNotFoundException
1164 flavor_dict: contains the required ram, vcpus, disk
1165 If 'use_existing_flavors' is set to True at config, the closer flavor that provides same or more ram, vcpus
1166 and disk is returned. Otherwise a flavor with exactly same ram, vcpus and disk is returned or a
1167 vimconnNotFoundException is raised
1169 exact_match
= False if self
.config
.get("use_existing_flavors") else True
1172 self
._reload
_connection
()
1173 flavor_candidate_id
= None
1174 flavor_candidate_data
= (10000, 10000, 10000)
1177 flavor_dict
["vcpus"],
1178 flavor_dict
["disk"],
1179 flavor_dict
.get("ephemeral", 0),
1180 flavor_dict
.get("swap", 0),
1183 extended
= flavor_dict
.get("extended", {})
1186 raise vimconn
.VimConnNotFoundException(
1187 "Flavor with EPA still not implemented"
1189 # if len(numas) > 1:
1190 # raise vimconn.VimConnNotFoundException("Cannot find any flavor with more than one numa")
1192 # numas = extended.get("numas")
1193 for flavor
in self
.nova
.flavors
.list():
1194 epa
= flavor
.get_keys()
1205 flavor
.swap
if isinstance(flavor
.swap
, int) else 0,
1207 if flavor_data
== flavor_target
:
1211 and flavor_target
< flavor_data
< flavor_candidate_data
1213 flavor_candidate_id
= flavor
.id
1214 flavor_candidate_data
= flavor_data
1216 if not exact_match
and flavor_candidate_id
:
1217 return flavor_candidate_id
1219 raise vimconn
.VimConnNotFoundException(
1220 "Cannot find any flavor matching '{}'".format(flavor_dict
)
1223 nvExceptions
.NotFound
,
1224 nvExceptions
.ClientException
,
1225 ksExceptions
.ClientException
,
1228 self
._format
_exception
(e
)
1231 def process_resource_quota(quota
: dict, prefix
: str, extra_specs
: dict) -> None:
1232 """Process resource quota and fill up extra_specs.
1234 quota (dict): Keeping the quota of resurces
1236 extra_specs (dict) Dict to be filled to be used during flavor creation
1239 if "limit" in quota
:
1240 extra_specs
["quota:" + prefix
+ "_limit"] = quota
["limit"]
1242 if "reserve" in quota
:
1243 extra_specs
["quota:" + prefix
+ "_reservation"] = quota
["reserve"]
1245 if "shares" in quota
:
1246 extra_specs
["quota:" + prefix
+ "_shares_level"] = "custom"
1247 extra_specs
["quota:" + prefix
+ "_shares_share"] = quota
["shares"]
1250 def process_numa_memory(
1251 numa
: dict, node_id
: Optional
[int], extra_specs
: dict
1253 """Set the memory in extra_specs.
1255 numa (dict): A dictionary which includes numa information
1256 node_id (int): ID of numa node
1257 extra_specs (dict): To be filled.
1260 if not numa
.get("memory"):
1262 memory_mb
= numa
["memory"] * 1024
1263 memory
= "hw:numa_mem.{}".format(node_id
)
1264 extra_specs
[memory
] = int(memory_mb
)
1267 def process_numa_vcpu(numa
: dict, node_id
: int, extra_specs
: dict) -> None:
1268 """Set the cpu in extra_specs.
1270 numa (dict): A dictionary which includes numa information
1271 node_id (int): ID of numa node
1272 extra_specs (dict): To be filled.
1275 if not numa
.get("vcpu"):
1278 cpu
= "hw:numa_cpus.{}".format(node_id
)
1279 vcpu
= ",".join(map(str, vcpu
))
1280 extra_specs
[cpu
] = vcpu
1283 def process_numa_paired_threads(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1284 """Fill up extra_specs if numa has paired-threads.
1286 numa (dict): A dictionary which includes numa information
1287 extra_specs (dict): To be filled.
1290 threads (int) Number of virtual cpus
1293 if not numa
.get("paired-threads"):
1296 # cpu_thread_policy "require" implies that compute node must have an STM architecture
1297 threads
= numa
["paired-threads"] * 2
1298 extra_specs
["hw:cpu_thread_policy"] = "require"
1299 extra_specs
["hw:cpu_policy"] = "dedicated"
1303 def process_numa_cores(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1304 """Fill up extra_specs if numa has cores.
1306 numa (dict): A dictionary which includes numa information
1307 extra_specs (dict): To be filled.
1310 cores (int) Number of virtual cpus
1313 # cpu_thread_policy "isolate" implies that the host must not have an SMT
1314 # architecture, or a non-SMT architecture will be emulated
1315 if not numa
.get("cores"):
1317 cores
= numa
["cores"]
1318 extra_specs
["hw:cpu_thread_policy"] = "isolate"
1319 extra_specs
["hw:cpu_policy"] = "dedicated"
1323 def process_numa_threads(numa
: dict, extra_specs
: dict) -> Optional
[int]:
1324 """Fill up extra_specs if numa has threads.
1326 numa (dict): A dictionary which includes numa information
1327 extra_specs (dict): To be filled.
1330 threads (int) Number of virtual cpus
1333 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT architecture
1334 if not numa
.get("threads"):
1336 threads
= numa
["threads"]
1337 extra_specs
["hw:cpu_thread_policy"] = "prefer"
1338 extra_specs
["hw:cpu_policy"] = "dedicated"
1341 def _process_numa_parameters_of_flavor(
1342 self
, numas
: List
, extra_specs
: Dict
1344 """Process numa parameters and fill up extra_specs.
1347 numas (list): List of dictionary which includes numa information
1348 extra_specs (dict): To be filled.
1351 numa_nodes
= len(numas
)
1352 extra_specs
["hw:numa_nodes"] = str(numa_nodes
)
1353 cpu_cores
, cpu_threads
= 0, 0
1355 if self
.vim_type
== "VIO":
1356 self
.process_vio_numa_nodes(numa_nodes
, extra_specs
)
1360 node_id
= numa
["id"]
1361 # overwrite ram and vcpus
1362 # check if key "memory" is present in numa else use ram value at flavor
1363 self
.process_numa_memory(numa
, node_id
, extra_specs
)
1364 self
.process_numa_vcpu(numa
, node_id
, extra_specs
)
1366 # See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/implemented/virt-driver-cpu-thread-pinning.html
1367 extra_specs
["hw:cpu_sockets"] = str(numa_nodes
)
1369 if "paired-threads" in numa
:
1370 threads
= self
.process_numa_paired_threads(numa
, extra_specs
)
1371 cpu_threads
+= threads
1373 elif "cores" in numa
:
1374 cores
= self
.process_numa_cores(numa
, extra_specs
)
1377 elif "threads" in numa
:
1378 threads
= self
.process_numa_threads(numa
, extra_specs
)
1379 cpu_threads
+= threads
1382 extra_specs
["hw:cpu_cores"] = str(cpu_cores
)
1384 extra_specs
["hw:cpu_threads"] = str(cpu_threads
)
1387 def process_vio_numa_nodes(numa_nodes
: int, extra_specs
: Dict
) -> None:
1388 """According to number of numa nodes, updates the extra_specs for VIO.
1392 numa_nodes (int): List keeps the numa node numbers
1393 extra_specs (dict): Extra specs dict to be updated
1396 # If there is not any numa, numas_nodes equals to 0.
1398 extra_specs
["vmware:extra_config"] = '{"numa.nodeAffinity":"0"}'
1400 # If there are several numas, we do not define specific affinity.
1401 extra_specs
["vmware:latency_sensitivity_level"] = "high"
1403 def _change_flavor_name(
1404 self
, name
: str, name_suffix
: int, flavor_data
: dict
1406 """Change the flavor name if the name already exists.
1409 name (str): Flavor name to be checked
1410 name_suffix (int): Suffix to be appended to name
1411 flavor_data (dict): Flavor dict
1414 name (str): New flavor name to be used
1418 fl
= self
.nova
.flavors
.list()
1419 fl_names
= [f
.name
for f
in fl
]
1421 while name
in fl_names
:
1423 name
= flavor_data
["name"] + "-" + str(name_suffix
)
1427 def _process_extended_config_of_flavor(
1428 self
, extended
: dict, extra_specs
: dict
1430 """Process the extended dict to fill up extra_specs.
1433 extended (dict): Keeping the extra specification of flavor
1434 extra_specs (dict) Dict to be filled to be used during flavor creation
1439 "mem-quota": "memory",
1441 "disk-io-quota": "disk_io",
1449 "PREFER_LARGE": "any",
1453 "cpu-pinning-policy": "hw:cpu_policy",
1454 "cpu-thread-pinning-policy": "hw:cpu_thread_policy",
1455 "mem-policy": "hw:numa_mempolicy",
1458 numas
= extended
.get("numas")
1460 self
._process
_numa
_parameters
_of
_flavor
(numas
, extra_specs
)
1462 for quota
, item
in quotas
.items():
1463 if quota
in extended
.keys():
1464 self
.process_resource_quota(extended
.get(quota
), item
, extra_specs
)
1466 # Set the mempage size as specified in the descriptor
1467 if extended
.get("mempage-size"):
1468 if extended
["mempage-size"] in page_sizes
.keys():
1469 extra_specs
["hw:mem_page_size"] = page_sizes
[extended
["mempage-size"]]
1471 # Normally, validations in NBI should not allow to this condition.
1473 "Invalid mempage-size %s. Will be ignored",
1474 extended
.get("mempage-size"),
1477 for policy
, hw_policy
in policies
.items():
1478 if extended
.get(policy
):
1479 extra_specs
[hw_policy
] = extended
[policy
].lower()
1482 def _get_flavor_details(flavor_data
: dict) -> Tuple
:
1483 """Returns the details of flavor
1485 flavor_data (dict): Dictionary that includes required flavor details
1488 ram, vcpus, extra_specs, extended (tuple): Main items of required flavor
1492 flavor_data
.get("ram", 64),
1493 flavor_data
.get("vcpus", 1),
1495 flavor_data
.get("extended"),
1498 def new_flavor(self
, flavor_data
: dict, change_name_if_used
: bool = True) -> str:
1499 """Adds a tenant flavor to openstack VIM.
1500 if change_name_if_used is True, it will change name in case of conflict,
1501 because it is not supported name repetition.
1504 flavor_data (dict): Flavor details to be processed
1505 change_name_if_used (bool): Change name in case of conflict
1508 flavor_id (str): flavor identifier
1511 self
.logger
.debug("Adding flavor '%s'", str(flavor_data
))
1517 name
= flavor_data
["name"]
1518 while retry
< max_retries
:
1521 self
._reload
_connection
()
1523 if change_name_if_used
:
1524 name
= self
._change
_flavor
_name
(name
, name_suffix
, flavor_data
)
1526 ram
, vcpus
, extra_specs
, extended
= self
._get
_flavor
_details
(
1530 self
._process
_extended
_config
_of
_flavor
(extended
, extra_specs
)
1534 new_flavor
= self
.nova
.flavors
.create(
1538 disk
=flavor_data
.get("disk", 0),
1539 ephemeral
=flavor_data
.get("ephemeral", 0),
1540 swap
=flavor_data
.get("swap", 0),
1541 is_public
=flavor_data
.get("is_public", True),
1546 new_flavor
.set_keys(extra_specs
)
1548 return new_flavor
.id
1550 except nvExceptions
.Conflict
as e
:
1551 if change_name_if_used
and retry
< max_retries
:
1554 self
._format
_exception
(e
)
1557 ksExceptions
.ClientException
,
1558 nvExceptions
.ClientException
,
1562 self
._format
_exception
(e
)
1564 def delete_flavor(self
, flavor_id
):
1565 """Deletes a tenant flavor from openstack VIM. Returns the old flavor_id"""
1567 self
._reload
_connection
()
1568 self
.nova
.flavors
.delete(flavor_id
)
1571 # except nvExceptions.BadRequest as e:
1573 nvExceptions
.NotFound
,
1574 ksExceptions
.ClientException
,
1575 nvExceptions
.ClientException
,
1578 self
._format
_exception
(e
)
1580 def new_image(self
, image_dict
):
1582 Adds a tenant image to VIM. imge_dict is a dictionary with:
1584 disk_format: qcow2, vhd, vmdk, raw (by default), ...
1585 location: path or URI
1586 public: "yes" or "no"
1587 metadata: metadata of the image
1588 Returns the image_id
1593 while retry
< max_retries
:
1596 self
._reload
_connection
()
1598 # determine format http://docs.openstack.org/developer/glance/formats.html
1599 if "disk_format" in image_dict
:
1600 disk_format
= image_dict
["disk_format"]
1601 else: # autodiscover based on extension
1602 if image_dict
["location"].endswith(".qcow2"):
1603 disk_format
= "qcow2"
1604 elif image_dict
["location"].endswith(".vhd"):
1606 elif image_dict
["location"].endswith(".vmdk"):
1607 disk_format
= "vmdk"
1608 elif image_dict
["location"].endswith(".vdi"):
1610 elif image_dict
["location"].endswith(".iso"):
1612 elif image_dict
["location"].endswith(".aki"):
1614 elif image_dict
["location"].endswith(".ari"):
1616 elif image_dict
["location"].endswith(".ami"):
1622 "new_image: '%s' loading from '%s'",
1624 image_dict
["location"],
1626 if self
.vim_type
== "VIO":
1627 container_format
= "bare"
1628 if "container_format" in image_dict
:
1629 container_format
= image_dict
["container_format"]
1631 new_image
= self
.glance
.images
.create(
1632 name
=image_dict
["name"],
1633 container_format
=container_format
,
1634 disk_format
=disk_format
,
1637 new_image
= self
.glance
.images
.create(name
=image_dict
["name"])
1639 if image_dict
["location"].startswith("http"):
1640 # TODO there is not a method to direct download. It must be downloaded locally with requests
1641 raise vimconn
.VimConnNotImplemented("Cannot create image from URL")
1643 with
open(image_dict
["location"]) as fimage
:
1644 self
.glance
.images
.upload(new_image
.id, fimage
)
1645 # new_image = self.glancev1.images.create(name=image_dict["name"], is_public=
1646 # image_dict.get("public","yes")=="yes",
1647 # container_format="bare", data=fimage, disk_format=disk_format)
1649 metadata_to_load
= image_dict
.get("metadata")
1651 # TODO location is a reserved word for current openstack versions. fixed for VIO please check
1653 if self
.vim_type
== "VIO":
1654 metadata_to_load
["upload_location"] = image_dict
["location"]
1656 metadata_to_load
["location"] = image_dict
["location"]
1658 self
.glance
.images
.update(new_image
.id, **metadata_to_load
)
1662 nvExceptions
.Conflict
,
1663 ksExceptions
.ClientException
,
1664 nvExceptions
.ClientException
,
1666 self
._format
_exception
(e
)
1669 gl1Exceptions
.HTTPException
,
1670 gl1Exceptions
.CommunicationError
,
1673 if retry
== max_retries
:
1676 self
._format
_exception
(e
)
1677 except IOError as e
: # can not open the file
1678 raise vimconn
.VimConnConnectionException(
1679 "{}: {} for {}".format(type(e
).__name
__, e
, image_dict
["location"]),
1680 http_code
=vimconn
.HTTP_Bad_Request
,
1683 def delete_image(self
, image_id
):
1684 """Deletes a tenant image from openstack VIM. Returns the old id"""
1686 self
._reload
_connection
()
1687 self
.glance
.images
.delete(image_id
)
1691 nvExceptions
.NotFound
,
1692 ksExceptions
.ClientException
,
1693 nvExceptions
.ClientException
,
1694 gl1Exceptions
.CommunicationError
,
1695 gl1Exceptions
.HTTPNotFound
,
1697 ) as e
: # TODO remove
1698 self
._format
_exception
(e
)
1700 def get_image_id_from_path(self
, path
):
1701 """Get the image id from image path in the VIM database. Returns the image_id"""
1703 self
._reload
_connection
()
1704 images
= self
.glance
.images
.list()
1706 for image
in images
:
1707 if image
.metadata
.get("location") == path
:
1710 raise vimconn
.VimConnNotFoundException(
1711 "image with location '{}' not found".format(path
)
1714 ksExceptions
.ClientException
,
1715 nvExceptions
.ClientException
,
1716 gl1Exceptions
.CommunicationError
,
1719 self
._format
_exception
(e
)
1721 def get_image_list(self
, filter_dict
={}):
1722 """Obtain tenant images from VIM
1726 checksum: image checksum
1727 Returns the image list of dictionaries:
1728 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1731 self
.logger
.debug("Getting image list from VIM filter: '%s'", str(filter_dict
))
1734 self
._reload
_connection
()
1735 # filter_dict_os = filter_dict.copy()
1736 # First we filter by the available filter fields: name, id. The others are removed.
1737 image_list
= self
.glance
.images
.list()
1740 for image
in image_list
:
1742 if filter_dict
.get("name") and image
["name"] != filter_dict
["name"]:
1745 if filter_dict
.get("id") and image
["id"] != filter_dict
["id"]:
1749 filter_dict
.get("checksum")
1750 and image
["checksum"] != filter_dict
["checksum"]
1754 filtered_list
.append(image
.copy())
1755 except gl1Exceptions
.HTTPNotFound
:
1758 return filtered_list
1760 ksExceptions
.ClientException
,
1761 nvExceptions
.ClientException
,
1762 gl1Exceptions
.CommunicationError
,
1765 self
._format
_exception
(e
)
1767 def __wait_for_vm(self
, vm_id
, status
):
1768 """wait until vm is in the desired status and return True.
1769 If the VM gets in ERROR status, return false.
1770 If the timeout is reached generate an exception"""
1772 while elapsed_time
< server_timeout
:
1773 vm_status
= self
.nova
.servers
.get(vm_id
).status
1775 if vm_status
== status
:
1778 if vm_status
== "ERROR":
1784 # if we exceeded the timeout rollback
1785 if elapsed_time
>= server_timeout
:
1786 raise vimconn
.VimConnException(
1787 "Timeout waiting for instance " + vm_id
+ " to get " + status
,
1788 http_code
=vimconn
.HTTP_Request_Timeout
,
1791 def _get_openstack_availablity_zones(self
):
1793 Get from openstack availability zones available
1797 openstack_availability_zone
= self
.nova
.availability_zones
.list()
1798 openstack_availability_zone
= [
1800 for zone
in openstack_availability_zone
1801 if zone
.zoneName
!= "internal"
1804 return openstack_availability_zone
1808 def _set_availablity_zones(self
):
1810 Set vim availablity zone
1813 if "availability_zone" in self
.config
:
1814 vim_availability_zones
= self
.config
.get("availability_zone")
1816 if isinstance(vim_availability_zones
, str):
1817 self
.availability_zone
= [vim_availability_zones
]
1818 elif isinstance(vim_availability_zones
, list):
1819 self
.availability_zone
= vim_availability_zones
1821 self
.availability_zone
= self
._get
_openstack
_availablity
_zones
()
1823 def _get_vm_availability_zone(
1824 self
, availability_zone_index
, availability_zone_list
1827 Return thge availability zone to be used by the created VM.
1828 :return: The VIM availability zone to be used or None
1830 if availability_zone_index
is None:
1831 if not self
.config
.get("availability_zone"):
1833 elif isinstance(self
.config
.get("availability_zone"), str):
1834 return self
.config
["availability_zone"]
1836 # TODO consider using a different parameter at config for default AV and AV list match
1837 return self
.config
["availability_zone"][0]
1839 vim_availability_zones
= self
.availability_zone
1840 # check if VIM offer enough availability zones describe in the VNFD
1841 if vim_availability_zones
and len(availability_zone_list
) <= len(
1842 vim_availability_zones
1844 # check if all the names of NFV AV match VIM AV names
1845 match_by_index
= False
1846 for av
in availability_zone_list
:
1847 if av
not in vim_availability_zones
:
1848 match_by_index
= True
1852 return vim_availability_zones
[availability_zone_index
]
1854 return availability_zone_list
[availability_zone_index
]
1856 raise vimconn
.VimConnConflictException(
1857 "No enough availability zones at VIM for this deployment"
1860 def _prepare_port_dict_security_groups(self
, net
: dict, port_dict
: dict) -> None:
1861 """Fill up the security_groups in the port_dict.
1864 net (dict): Network details
1865 port_dict (dict): Port details
1869 self
.config
.get("security_groups")
1870 and net
.get("port_security") is not False
1871 and not self
.config
.get("no_port_security_extension")
1873 if not self
.security_groups_id
:
1874 self
._get
_ids
_from
_name
()
1876 port_dict
["security_groups"] = self
.security_groups_id
1878 def _prepare_port_dict_binding(self
, net
: dict, port_dict
: dict) -> None:
1879 """Fill up the network binding depending on network type in the port_dict.
1882 net (dict): Network details
1883 port_dict (dict): Port details
1886 if not net
.get("type"):
1887 raise vimconn
.VimConnException("Type is missing in the network details.")
1889 if net
["type"] == "virtual":
1893 elif net
["type"] == "VF" or net
["type"] == "SR-IOV":
1894 port_dict
["binding:vnic_type"] = "direct"
1896 # VIO specific Changes
1897 if self
.vim_type
== "VIO":
1898 # Need to create port with port_security_enabled = False and no-security-groups
1899 port_dict
["port_security_enabled"] = False
1900 port_dict
["provider_security_groups"] = []
1901 port_dict
["security_groups"] = []
1904 # For PT PCI-PASSTHROUGH
1905 port_dict
["binding:vnic_type"] = "direct-physical"
1908 def _set_fixed_ip(new_port
: dict, net
: dict) -> None:
1909 """Set the "ip" parameter in net dictionary.
1912 new_port (dict): New created port
1913 net (dict): Network details
1916 fixed_ips
= new_port
["port"].get("fixed_ips")
1919 net
["ip"] = fixed_ips
[0].get("ip_address")
1924 def _prepare_port_dict_mac_ip_addr(net
: dict, port_dict
: dict) -> None:
1925 """Fill up the mac_address and fixed_ips in port_dict.
1928 net (dict): Network details
1929 port_dict (dict): Port details
1932 if net
.get("mac_address"):
1933 port_dict
["mac_address"] = net
["mac_address"]
1935 if net
.get("ip_address"):
1936 port_dict
["fixed_ips"] = [{"ip_address": net
["ip_address"]}]
1937 # TODO add "subnet_id": <subnet_id>
1939 def _create_new_port(self
, port_dict
: dict, created_items
: dict, net
: dict) -> Dict
:
1940 """Create new port using neutron.
1943 port_dict (dict): Port details
1944 created_items (dict): All created items
1945 net (dict): Network details
1948 new_port (dict): New created port
1951 new_port
= self
.neutron
.create_port({"port": port_dict
})
1952 created_items
["port:" + str(new_port
["port"]["id"])] = True
1953 net
["mac_adress"] = new_port
["port"]["mac_address"]
1954 net
["vim_id"] = new_port
["port"]["id"]
1959 self
, net
: dict, name
: str, created_items
: dict
1960 ) -> Tuple
[dict, dict]:
1961 """Create port using net details.
1964 net (dict): Network details
1965 name (str): Name to be used as network name if net dict does not include name
1966 created_items (dict): All created items
1969 new_port, port New created port, port dictionary
1974 "network_id": net
["net_id"],
1975 "name": net
.get("name"),
1976 "admin_state_up": True,
1979 if not port_dict
["name"]:
1980 port_dict
["name"] = name
1982 self
._prepare
_port
_dict
_security
_groups
(net
, port_dict
)
1984 self
._prepare
_port
_dict
_binding
(net
, port_dict
)
1986 vimconnector
._prepare
_port
_dict
_mac
_ip
_addr
(net
, port_dict
)
1988 new_port
= self
._create
_new
_port
(port_dict
, created_items
, net
)
1990 vimconnector
._set
_fixed
_ip
(new_port
, net
)
1992 port
= {"port-id": new_port
["port"]["id"]}
1994 if float(self
.nova
.api_version
.get_string()) >= 2.32:
1995 port
["tag"] = new_port
["port"]["name"]
1997 return new_port
, port
1999 def _prepare_network_for_vminstance(
2003 created_items
: dict,
2005 external_network
: list,
2006 no_secured_ports
: list,
2008 """Create port and fill up net dictionary for new VM instance creation.
2011 name (str): Name of network
2012 net_list (list): List of networks
2013 created_items (dict): All created items belongs to a VM
2014 net_list_vim (list): List of ports
2015 external_network (list): List of external-networks
2016 no_secured_ports (list): Port security disabled ports
2019 self
._reload
_connection
()
2021 for net
in net_list
:
2022 # Skip non-connected iface
2023 if not net
.get("net_id"):
2026 new_port
, port
= self
._create
_port
(net
, name
, created_items
)
2028 net_list_vim
.append(port
)
2030 if net
.get("floating_ip", False):
2031 net
["exit_on_floating_ip_error"] = True
2032 external_network
.append(net
)
2034 elif net
["use"] == "mgmt" and self
.config
.get("use_floating_ip"):
2035 net
["exit_on_floating_ip_error"] = False
2036 external_network
.append(net
)
2037 net
["floating_ip"] = self
.config
.get("use_floating_ip")
2039 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic
2040 # is dropped. As a workaround we wait until the VM is active and then disable the port-security
2041 if net
.get("port_security") is False and not self
.config
.get(
2042 "no_port_security_extension"
2044 no_secured_ports
.append(
2046 new_port
["port"]["id"],
2047 net
.get("port_security_disable_strategy"),
2051 def _prepare_persistent_root_volumes(
2056 base_disk_index
: int,
2057 block_device_mapping
: dict,
2058 existing_vim_volumes
: list,
2059 created_items
: dict,
2061 """Prepare persistent root volumes for new VM instance.
2064 name (str): Name of VM instance
2065 vm_av_zone (list): List of availability zones
2066 disk (dict): Disk details
2067 base_disk_index (int): Disk index
2068 block_device_mapping (dict): Block device details
2069 existing_vim_volumes (list): Existing disk details
2070 created_items (dict): All created items belongs to VM
2073 boot_volume_id (str): ID of boot volume
2076 # Disk may include only vim_volume_id or only vim_id."
2077 # Use existing persistent root volume finding with volume_id or vim_id
2078 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
2080 if disk
.get(key_id
):
2081 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
2082 existing_vim_volumes
.append({"id": disk
[key_id
]})
2085 # Create persistent root volume
2086 volume
= self
.cinder
.volumes
.create(
2088 name
=name
+ "vd" + chr(base_disk_index
),
2089 imageRef
=disk
["image_id"],
2090 # Make sure volume is in the same AZ as the VM to be attached to
2091 availability_zone
=vm_av_zone
,
2093 boot_volume_id
= volume
.id
2094 created_items
["volume:" + str(volume
.id)] = True
2095 block_device_mapping
["vd" + chr(base_disk_index
)] = volume
.id
2097 return boot_volume_id
2099 def _prepare_non_root_persistent_volumes(
2104 block_device_mapping
: dict,
2105 base_disk_index
: int,
2106 existing_vim_volumes
: list,
2107 created_items
: dict,
2109 """Prepare persistent volumes for new VM instance.
2112 name (str): Name of VM instance
2113 disk (dict): Disk details
2114 vm_av_zone (list): List of availability zones
2115 block_device_mapping (dict): Block device details
2116 base_disk_index (int): Disk index
2117 existing_vim_volumes (list): Existing disk details
2118 created_items (dict): All created items belongs to VM
2120 # Non-root persistent volumes
2121 # Disk may include only vim_volume_id or only vim_id."
2122 key_id
= "vim_volume_id" if "vim_volume_id" in disk
.keys() else "vim_id"
2124 if disk
.get(key_id
):
2125 # Use existing persistent volume
2126 block_device_mapping
["vd" + chr(base_disk_index
)] = disk
[key_id
]
2127 existing_vim_volumes
.append({"id": disk
[key_id
]})
2130 # Create persistent volume
2131 volume
= self
.cinder
.volumes
.create(
2133 name
=name
+ "vd" + chr(base_disk_index
),
2134 # Make sure volume is in the same AZ as the VM to be attached to
2135 availability_zone
=vm_av_zone
,
2137 created_items
["volume:" + str(volume
.id)] = True
2138 block_device_mapping
["vd" + chr(base_disk_index
)] = volume
.id
2140 def _wait_for_created_volumes_availability(
2141 self
, elapsed_time
: int, created_items
: dict
2143 """Wait till created volumes become available.
2146 elapsed_time (int): Passed time while waiting
2147 created_items (dict): All created items belongs to VM
2150 elapsed_time (int): Time spent while waiting
2154 while elapsed_time
< volume_timeout
:
2155 for created_item
in created_items
:
2156 v
, _
, volume_id
= created_item
.partition(":")
2158 if self
.cinder
.volumes
.get(volume_id
).status
!= "available":
2161 # All ready: break from while
2169 def _wait_for_existing_volumes_availability(
2170 self
, elapsed_time
: int, existing_vim_volumes
: list
2172 """Wait till existing volumes become available.
2175 elapsed_time (int): Passed time while waiting
2176 existing_vim_volumes (list): Existing volume details
2179 elapsed_time (int): Time spent while waiting
2183 while elapsed_time
< volume_timeout
:
2184 for volume
in existing_vim_volumes
:
2185 if self
.cinder
.volumes
.get(volume
["id"]).status
!= "available":
2187 else: # all ready: break from while
2195 def _prepare_disk_for_vminstance(
2198 existing_vim_volumes
: list,
2199 created_items
: dict,
2201 disk_list
: list = None,
2203 """Prepare all volumes for new VM instance.
2206 name (str): Name of Instance
2207 existing_vim_volumes (list): List of existing volumes
2208 created_items (dict): All created items belongs to VM
2209 vm_av_zone (list): VM availability zone
2210 disk_list (list): List of disks
2213 # Create additional volumes in case these are present in disk_list
2214 base_disk_index
= ord("b")
2215 boot_volume_id
= None
2218 block_device_mapping
= {}
2219 for disk
in disk_list
:
2220 if "image_id" in disk
:
2221 # Root persistent volume
2222 base_disk_index
= ord("a")
2223 boot_volume_id
= self
._prepare
_persistent
_root
_volumes
(
2225 vm_av_zone
=vm_av_zone
,
2227 base_disk_index
=base_disk_index
,
2228 block_device_mapping
=block_device_mapping
,
2229 existing_vim_volumes
=existing_vim_volumes
,
2230 created_items
=created_items
,
2233 # Non-root persistent volume
2234 self
._prepare
_non
_root
_persistent
_volumes
(
2237 vm_av_zone
=vm_av_zone
,
2238 block_device_mapping
=block_device_mapping
,
2239 base_disk_index
=base_disk_index
,
2240 existing_vim_volumes
=existing_vim_volumes
,
2241 created_items
=created_items
,
2243 base_disk_index
+= 1
2245 # Wait until created volumes are with status available
2246 elapsed_time
= self
._wait
_for
_created
_volumes
_availability
(
2247 elapsed_time
, created_items
2249 # Wait until existing volumes in vim are with status available
2250 elapsed_time
= self
._wait
_for
_existing
_volumes
_availability
(
2251 elapsed_time
, existing_vim_volumes
2253 # If we exceeded the timeout rollback
2254 if elapsed_time
>= volume_timeout
:
2255 raise vimconn
.VimConnException(
2256 "Timeout creating volumes for instance " + name
,
2257 http_code
=vimconn
.HTTP_Request_Timeout
,
2260 self
.cinder
.volumes
.set_bootable(boot_volume_id
, True)
2262 def _find_the_external_network_for_floating_ip(self
):
2263 """Get the external network ip in order to create floating IP.
2266 pool_id (str): External network pool ID
2270 # Find the external network
2271 external_nets
= list()
2273 for net
in self
.neutron
.list_networks()["networks"]:
2274 if net
["router:external"]:
2275 external_nets
.append(net
)
2277 if len(external_nets
) == 0:
2278 raise vimconn
.VimConnException(
2279 "Cannot create floating_ip automatically since "
2280 "no external network is present",
2281 http_code
=vimconn
.HTTP_Conflict
,
2284 if len(external_nets
) > 1:
2285 raise vimconn
.VimConnException(
2286 "Cannot create floating_ip automatically since "
2287 "multiple external networks are present",
2288 http_code
=vimconn
.HTTP_Conflict
,
2292 return external_nets
[0].get("id")
2294 def _neutron_create_float_ip(self
, param
: dict, created_items
: dict) -> None:
2295 """Trigger neutron to create a new floating IP using external network ID.
2298 param (dict): Input parameters to create a floating IP
2299 created_items (dict): All created items belongs to new VM instance
2306 self
.logger
.debug("Creating floating IP")
2307 new_floating_ip
= self
.neutron
.create_floatingip(param
)
2308 free_floating_ip
= new_floating_ip
["floatingip"]["id"]
2309 created_items
["floating_ip:" + str(free_floating_ip
)] = True
2311 except Exception as e
:
2312 raise vimconn
.VimConnException(
2313 type(e
).__name
__ + ": Cannot create new floating_ip " + str(e
),
2314 http_code
=vimconn
.HTTP_Conflict
,
2317 def _create_floating_ip(
2318 self
, floating_network
: dict, server
: object, created_items
: dict
2320 """Get the available Pool ID and create a new floating IP.
2323 floating_network (dict): Dict including external network ID
2324 server (object): Server object
2325 created_items (dict): All created items belongs to new VM instance
2329 # Pool_id is available
2331 isinstance(floating_network
["floating_ip"], str)
2332 and floating_network
["floating_ip"].lower() != "true"
2334 pool_id
= floating_network
["floating_ip"]
2338 pool_id
= self
._find
_the
_external
_network
_for
_floating
_ip
()
2342 "floating_network_id": pool_id
,
2343 "tenant_id": server
.tenant_id
,
2347 self
._neutron
_create
_float
_ip
(param
, created_items
)
2349 def _find_floating_ip(
2353 floating_network
: dict,
2355 """Find the available free floating IPs if there are.
2358 server (object): Server object
2359 floating_ips (list): List of floating IPs
2360 floating_network (dict): Details of floating network such as ID
2363 free_floating_ip (str): Free floating ip address
2366 for fip
in floating_ips
:
2367 if fip
.get("port_id") or fip
.get("tenant_id") != server
.tenant_id
:
2370 if isinstance(floating_network
["floating_ip"], str):
2371 if fip
.get("floating_network_id") != floating_network
["floating_ip"]:
2376 def _assign_floating_ip(
2377 self
, free_floating_ip
: str, floating_network
: dict
2379 """Assign the free floating ip address to port.
2382 free_floating_ip (str): Floating IP to be assigned
2383 floating_network (dict): ID of floating network
2386 fip (dict) (dict): Floating ip details
2389 # The vim_id key contains the neutron.port_id
2390 self
.neutron
.update_floatingip(
2392 {"floatingip": {"port_id": floating_network
["vim_id"]}},
2394 # For race condition ensure not re-assigned to other VM after 5 seconds
2397 return self
.neutron
.show_floatingip(free_floating_ip
)
2399 def _get_free_floating_ip(
2400 self
, server
: object, floating_network
: dict
2402 """Get the free floating IP address.
2405 server (object): Server Object
2406 floating_network (dict): Floating network details
2409 free_floating_ip (str): Free floating ip addr
2413 floating_ips
= self
.neutron
.list_floatingips().get("floatingips", ())
2416 random
.shuffle(floating_ips
)
2418 return self
._find
_floating
_ip
(server
, floating_ips
, floating_network
)
2420 def _prepare_external_network_for_vminstance(
2422 external_network
: list,
2424 created_items
: dict,
2425 vm_start_time
: float,
2427 """Assign floating IP address for VM instance.
2430 external_network (list): ID of External network
2431 server (object): Server Object
2432 created_items (dict): All created items belongs to new VM instance
2433 vm_start_time (float): Time as a floating point number expressed in seconds since the epoch, in UTC
2439 for floating_network
in external_network
:
2442 floating_ip_retries
= 3
2443 # In case of RO in HA there can be conflicts, two RO trying to assign same floating IP, so retry
2446 free_floating_ip
= self
._get
_free
_floating
_ip
(
2447 server
, floating_network
2450 if not free_floating_ip
:
2451 self
._create
_floating
_ip
(
2452 floating_network
, server
, created_items
2456 # For race condition ensure not already assigned
2457 fip
= self
.neutron
.show_floatingip(free_floating_ip
)
2459 if fip
["floatingip"].get("port_id"):
2462 # Assign floating ip
2463 fip
= self
._assign
_floating
_ip
(
2464 free_floating_ip
, floating_network
2467 if fip
["floatingip"]["port_id"] != floating_network
["vim_id"]:
2468 self
.logger
.warning(
2469 "floating_ip {} re-assigned to other port".format(
2476 "Assigned floating_ip {} to VM {}".format(
2477 free_floating_ip
, server
.id
2483 except Exception as e
:
2484 # Openstack need some time after VM creation to assign an IP. So retry if fails
2485 vm_status
= self
.nova
.servers
.get(server
.id).status
2487 if vm_status
not in ("ACTIVE", "ERROR"):
2488 if time
.time() - vm_start_time
< server_timeout
:
2491 elif floating_ip_retries
> 0:
2492 floating_ip_retries
-= 1
2495 raise vimconn
.VimConnException(
2496 "Cannot create floating_ip: {} {}".format(
2499 http_code
=vimconn
.HTTP_Conflict
,
2502 except Exception as e
:
2503 if not floating_network
["exit_on_floating_ip_error"]:
2504 self
.logger
.error("Cannot create floating_ip. %s", str(e
))
2509 def _update_port_security_for_vminstance(
2511 no_secured_ports
: list,
2514 """Updates the port security according to no_secured_ports list.
2517 no_secured_ports (list): List of ports that security will be disabled
2518 server (object): Server Object
2524 # Wait until the VM is active and then disable the port-security
2525 if no_secured_ports
:
2526 self
.__wait
_for
_vm
(server
.id, "ACTIVE")
2528 for port
in no_secured_ports
:
2530 "port": {"port_security_enabled": False, "security_groups": None}
2533 if port
[1] == "allow-address-pairs":
2535 "port": {"allowed_address_pairs": [{"ip_address": "0.0.0.0/0"}]}
2539 self
.neutron
.update_port(port
[0], port_update
)
2542 raise vimconn
.VimConnException(
2543 "It was not possible to disable port security for port {}".format(
2555 affinity_group_list
: list,
2559 availability_zone_index
=None,
2560 availability_zone_list
=None,
2562 """Adds a VM instance to VIM.
2565 name (str): name of VM
2566 description (str): description
2567 start (bool): indicates if VM must start or boot in pause mode. Ignored
2568 image_id (str) image uuid
2569 flavor_id (str) flavor uuid
2570 affinity_group_list (list): list of affinity groups, each one is a dictionary.Ignore if empty.
2571 net_list (list): list of interfaces, each one is a dictionary with:
2572 name: name of network
2573 net_id: network uuid to connect
2574 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
2575 model: interface model, ignored #TODO
2576 mac_address: used for SR-IOV ifaces #TODO for other types
2577 use: 'data', 'bridge', 'mgmt'
2578 type: 'virtual', 'PCI-PASSTHROUGH'('PF'), 'SR-IOV'('VF'), 'VFnotShared'
2579 vim_id: filled/added by this function
2580 floating_ip: True/False (or it can be None)
2581 port_security: True/False
2582 cloud_config (dict): (optional) dictionary with:
2583 key-pairs: (optional) list of strings with the public key to be inserted to the default user
2584 users: (optional) list of users to be inserted, each item is a dict with:
2585 name: (mandatory) user name,
2586 key-pairs: (optional) list of strings with the public key to be inserted to the user
2587 user-data: (optional) string is a text script to be passed directly to cloud-init
2588 config-files: (optional). List of files to be transferred. Each item is a dict with:
2589 dest: (mandatory) string with the destination absolute path
2590 encoding: (optional, by default text). Can be one of:
2591 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
2592 content : (mandatory) string with the content of the file
2593 permissions: (optional) string with file permissions, typically octal notation '0644'
2594 owner: (optional) file owner, string with the format 'owner:group'
2595 boot-data-drive: boolean to indicate if user-data must be passed using a boot drive (hard disk)
2596 disk_list: (optional) list with additional disks to the VM. Each item is a dict with:
2597 image_id: (optional). VIM id of an existing image. If not provided an empty disk must be mounted
2598 size: (mandatory) string with the size of the disk in GB
2599 vim_id: (optional) should use this existing volume id
2600 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
2601 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
2602 availability_zone_index is None
2603 #TODO ip, security groups
2606 A tuple with the instance identifier and created_items or raises an exception on error
2607 created_items can be None or a dictionary where this method can include key-values that will be passed to
2608 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
2609 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
2613 "new_vminstance input: image='%s' flavor='%s' nics='%s'",
2623 # list of external networks to be connected to instance, later on used to create floating_ip
2624 external_network
= []
2625 # List of ports with port-security disabled
2626 no_secured_ports
= []
2627 block_device_mapping
= None
2628 existing_vim_volumes
= []
2629 server_group_id
= None
2630 scheduller_hints
= {}
2632 # Check the Openstack Connection
2633 self
._reload
_connection
()
2635 # Prepare network list
2636 self
._prepare
_network
_for
_vminstance
(
2639 created_items
=created_items
,
2640 net_list_vim
=net_list_vim
,
2641 external_network
=external_network
,
2642 no_secured_ports
=no_secured_ports
,
2646 config_drive
, userdata
= self
._create
_user
_data
(cloud_config
)
2648 # Get availability Zone
2649 vm_av_zone
= self
._get
_vm
_availability
_zone
(
2650 availability_zone_index
, availability_zone_list
2655 self
._prepare
_disk
_for
_vminstance
(
2657 existing_vim_volumes
=existing_vim_volumes
,
2658 created_items
=created_items
,
2659 vm_av_zone
=vm_av_zone
,
2660 disk_list
=disk_list
,
2663 if affinity_group_list
:
2664 # Only first id on the list will be used. Openstack restriction
2665 server_group_id
= affinity_group_list
[0]["affinity_group_id"]
2666 scheduller_hints
["group"] = server_group_id
2669 "nova.servers.create({}, {}, {}, nics={}, security_groups={}, "
2670 "availability_zone={}, key_name={}, userdata={}, config_drive={}, "
2671 "block_device_mapping={}, server_group={})".format(
2676 self
.config
.get("security_groups"),
2678 self
.config
.get("keypair"),
2681 block_device_mapping
,
2687 server
= self
.nova
.servers
.create(
2692 security_groups
=self
.config
.get("security_groups"),
2693 # TODO remove security_groups in future versions. Already at neutron port
2694 availability_zone
=vm_av_zone
,
2695 key_name
=self
.config
.get("keypair"),
2697 config_drive
=config_drive
,
2698 block_device_mapping
=block_device_mapping
,
2699 scheduler_hints
=scheduller_hints
,
2702 vm_start_time
= time
.time()
2704 self
._update
_port
_security
_for
_vminstance
(no_secured_ports
, server
)
2706 self
._prepare
_external
_network
_for
_vminstance
(
2707 external_network
=external_network
,
2709 created_items
=created_items
,
2710 vm_start_time
=vm_start_time
,
2713 return server
.id, created_items
2715 except Exception as e
:
2718 server_id
= server
.id
2721 self
.delete_vminstance(server_id
, created_items
)
2723 except Exception as e2
:
2724 self
.logger
.error("new_vminstance rollback fail {}".format(e2
))
2726 self
._format
_exception
(e
)
2728 def get_vminstance(self
, vm_id
):
2729 """Returns the VM instance information from VIM"""
2730 # self.logger.debug("Getting VM from VIM")
2732 self
._reload
_connection
()
2733 server
= self
.nova
.servers
.find(id=vm_id
)
2734 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
2736 return server
.to_dict()
2738 ksExceptions
.ClientException
,
2739 nvExceptions
.ClientException
,
2740 nvExceptions
.NotFound
,
2743 self
._format
_exception
(e
)
2745 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
2747 Get a console for the virtual machine
2749 vm_id: uuid of the VM
2750 console_type, can be:
2751 "novnc" (by default), "xvpvnc" for VNC types,
2752 "rdp-html5" for RDP types, "spice-html5" for SPICE types
2753 Returns dict with the console parameters:
2754 protocol: ssh, ftp, http, https, ...
2755 server: usually ip address
2756 port: the http, ssh, ... port
2757 suffix: extra text, e.g. the http path and query string
2759 self
.logger
.debug("Getting VM CONSOLE from VIM")
2762 self
._reload
_connection
()
2763 server
= self
.nova
.servers
.find(id=vm_id
)
2765 if console_type
is None or console_type
== "novnc":
2766 console_dict
= server
.get_vnc_console("novnc")
2767 elif console_type
== "xvpvnc":
2768 console_dict
= server
.get_vnc_console(console_type
)
2769 elif console_type
== "rdp-html5":
2770 console_dict
= server
.get_rdp_console(console_type
)
2771 elif console_type
== "spice-html5":
2772 console_dict
= server
.get_spice_console(console_type
)
2774 raise vimconn
.VimConnException(
2775 "console type '{}' not allowed".format(console_type
),
2776 http_code
=vimconn
.HTTP_Bad_Request
,
2779 console_dict1
= console_dict
.get("console")
2782 console_url
= console_dict1
.get("url")
2786 protocol_index
= console_url
.find("//")
2788 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
2791 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
2796 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
2798 -vimconn
.HTTP_Internal_Server_Error
,
2799 "Unexpected response from VIM",
2803 "protocol": console_url
[0:protocol_index
],
2804 "server": console_url
[protocol_index
+ 2 : port_index
],
2805 "port": console_url
[port_index
:suffix_index
],
2806 "suffix": console_url
[suffix_index
+ 1 :],
2811 raise vimconn
.VimConnUnexpectedResponse("Unexpected response from VIM")
2813 nvExceptions
.NotFound
,
2814 ksExceptions
.ClientException
,
2815 nvExceptions
.ClientException
,
2816 nvExceptions
.BadRequest
,
2819 self
._format
_exception
(e
)
2821 def _delete_ports_by_id_wth_neutron(self
, k_id
: str) -> None:
2822 """Neutron delete ports by id.
2824 k_id (str): Port id in the VIM
2827 port_dict
= self
.neutron
.list_ports()
2828 existing_ports
= [port
["id"] for port
in port_dict
["ports"] if port_dict
]
2830 if k_id
in existing_ports
:
2831 self
.neutron
.delete_port(k_id
)
2833 except Exception as e
:
2834 self
.logger
.error("Error deleting port: {}: {}".format(type(e
).__name
__, e
))
2836 def _delete_volumes_by_id_wth_cinder(
2837 self
, k
: str, k_id
: str, volumes_to_hold
: list, created_items
: dict
2839 """Cinder delete volume by id.
2841 k (str): Full item name in created_items
2842 k_id (str): ID of floating ip in VIM
2843 volumes_to_hold (list): Volumes not to delete
2844 created_items (dict): All created items belongs to VM
2847 if k_id
in volumes_to_hold
:
2850 if self
.cinder
.volumes
.get(k_id
).status
!= "available":
2854 self
.cinder
.volumes
.delete(k_id
)
2855 created_items
[k
] = None
2857 except Exception as e
:
2859 "Error deleting volume: {}: {}".format(type(e
).__name
__, e
)
2862 def _delete_floating_ip_by_id(self
, k
: str, k_id
: str, created_items
: dict) -> None:
2863 """Neutron delete floating ip by id.
2865 k (str): Full item name in created_items
2866 k_id (str): ID of floating ip in VIM
2867 created_items (dict): All created items belongs to VM
2870 self
.neutron
.delete_floatingip(k_id
)
2871 created_items
[k
] = None
2873 except Exception as e
:
2875 "Error deleting floating ip: {}: {}".format(type(e
).__name
__, e
)
2879 def _get_item_name_id(k
: str) -> Tuple
[str, str]:
2880 k_item
, _
, k_id
= k
.partition(":")
2883 def _delete_vm_ports_attached_to_network(self
, created_items
: dict) -> None:
2884 """Delete VM ports attached to the networks before deleting virtual machine.
2886 created_items (dict): All created items belongs to VM
2889 for k
, v
in created_items
.items():
2890 if not v
: # skip already deleted
2894 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2895 if k_item
== "port":
2896 self
._delete
_ports
_by
_id
_wth
_neutron
(k_id
)
2898 except Exception as e
:
2900 "Error deleting port: {}: {}".format(type(e
).__name
__, e
)
2903 def _delete_created_items(
2904 self
, created_items
: dict, volumes_to_hold
: list, keep_waiting
: bool
2906 """Delete Volumes and floating ip if they exist in created_items."""
2907 for k
, v
in created_items
.items():
2908 if not v
: # skip already deleted
2912 k_item
, k_id
= self
._get
_item
_name
_id
(k
)
2914 if k_item
== "volume":
2915 unavailable_vol
= self
._delete
_volumes
_by
_id
_wth
_cinder
(
2916 k
, k_id
, volumes_to_hold
, created_items
2922 elif k_item
== "floating_ip":
2923 self
._delete
_floating
_ip
_by
_id
(k
, k_id
, created_items
)
2925 except Exception as e
:
2926 self
.logger
.error("Error deleting {}: {}".format(k
, e
))
2930 def delete_vminstance(
2931 self
, vm_id
: str, created_items
: dict = None, volumes_to_hold
: list = None
2933 """Removes a VM instance from VIM. Returns the old identifier.
2935 vm_id (str): Identifier of VM instance
2936 created_items (dict): All created items belongs to VM
2937 volumes_to_hold (list): Volumes_to_hold
2939 if created_items
is None:
2941 if volumes_to_hold
is None:
2942 volumes_to_hold
= []
2945 self
._reload
_connection
()
2947 # Delete VM ports attached to the networks before the virtual machine
2949 self
._delete
_vm
_ports
_attached
_to
_network
(created_items
)
2952 self
.nova
.servers
.delete(vm_id
)
2954 # Although having detached, volumes should have in active status before deleting.
2955 # We ensure in this loop
2959 while keep_waiting
and elapsed_time
< volume_timeout
:
2960 keep_waiting
= False
2962 # Delete volumes and floating IP.
2963 keep_waiting
= self
._delete
_created
_items
(
2964 created_items
, volumes_to_hold
, keep_waiting
2972 nvExceptions
.NotFound
,
2973 ksExceptions
.ClientException
,
2974 nvExceptions
.ClientException
,
2977 self
._format
_exception
(e
)
2979 def refresh_vms_status(self
, vm_list
):
2980 """Get the status of the virtual machines and their interfaces/ports
2981 Params: the list of VM identifiers
2982 Returns a dictionary with:
2983 vm_id: #VIM id of this Virtual Machine
2984 status: #Mandatory. Text with one of:
2985 # DELETED (not found at vim)
2986 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2987 # OTHER (Vim reported other status not understood)
2988 # ERROR (VIM indicates an ERROR status)
2989 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
2990 # CREATING (on building process), ERROR
2991 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
2993 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2994 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2996 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2997 mac_address: #Text format XX:XX:XX:XX:XX:XX
2998 vim_net_id: #network id where this interface is connected
2999 vim_interface_id: #interface/port VIM id
3000 ip_address: #null, or text with IPv4, IPv6 address
3001 compute_node: #identification of compute node where PF,VF interface is allocated
3002 pci: #PCI address of the NIC that hosts the PF,VF
3003 vlan: #physical VLAN used for VF
3007 "refresh_vms status: Getting tenant VM instance information from VIM"
3010 for vm_id
in vm_list
:
3014 vm_vim
= self
.get_vminstance(vm_id
)
3016 if vm_vim
["status"] in vmStatus2manoFormat
:
3017 vm
["status"] = vmStatus2manoFormat
[vm_vim
["status"]]
3019 vm
["status"] = "OTHER"
3020 vm
["error_msg"] = "VIM status reported " + vm_vim
["status"]
3022 vm_vim
.pop("OS-EXT-SRV-ATTR:user_data", None)
3023 vm_vim
.pop("user_data", None)
3024 vm
["vim_info"] = self
.serialize(vm_vim
)
3026 vm
["interfaces"] = []
3027 if vm_vim
.get("fault"):
3028 vm
["error_msg"] = str(vm_vim
["fault"])
3032 self
._reload
_connection
()
3033 port_dict
= self
.neutron
.list_ports(device_id
=vm_id
)
3035 for port
in port_dict
["ports"]:
3037 interface
["vim_info"] = self
.serialize(port
)
3038 interface
["mac_address"] = port
.get("mac_address")
3039 interface
["vim_net_id"] = port
["network_id"]
3040 interface
["vim_interface_id"] = port
["id"]
3041 # check if OS-EXT-SRV-ATTR:host is there,
3042 # in case of non-admin credentials, it will be missing
3044 if vm_vim
.get("OS-EXT-SRV-ATTR:host"):
3045 interface
["compute_node"] = vm_vim
["OS-EXT-SRV-ATTR:host"]
3047 interface
["pci"] = None
3049 # check if binding:profile is there,
3050 # in case of non-admin credentials, it will be missing
3051 if port
.get("binding:profile"):
3052 if port
["binding:profile"].get("pci_slot"):
3053 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting
3055 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
3056 # CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2) assuming there are 2 ports per nic
3057 pci
= port
["binding:profile"]["pci_slot"]
3058 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
3059 interface
["pci"] = pci
3061 interface
["vlan"] = None
3063 if port
.get("binding:vif_details"):
3064 interface
["vlan"] = port
["binding:vif_details"].get("vlan")
3066 # Get vlan from network in case not present in port for those old openstacks and cases where
3067 # it is needed vlan at PT
3068 if not interface
["vlan"]:
3069 # if network is of type vlan and port is of type direct (sr-iov) then set vlan id
3070 network
= self
.neutron
.show_network(port
["network_id"])
3073 network
["network"].get("provider:network_type")
3076 # and port.get("binding:vnic_type") in ("direct", "direct-physical"):
3077 interface
["vlan"] = network
["network"].get(
3078 "provider:segmentation_id"
3082 # look for floating ip address
3084 floating_ip_dict
= self
.neutron
.list_floatingips(
3088 if floating_ip_dict
.get("floatingips"):
3090 floating_ip_dict
["floatingips"][0].get(
3091 "floating_ip_address"
3097 for subnet
in port
["fixed_ips"]:
3098 ips
.append(subnet
["ip_address"])
3100 interface
["ip_address"] = ";".join(ips
)
3101 vm
["interfaces"].append(interface
)
3102 except Exception as e
:
3104 "Error getting vm interface information {}: {}".format(
3109 except vimconn
.VimConnNotFoundException
as e
:
3110 self
.logger
.error("Exception getting vm status: %s", str(e
))
3111 vm
["status"] = "DELETED"
3112 vm
["error_msg"] = str(e
)
3113 except vimconn
.VimConnException
as e
:
3114 self
.logger
.error("Exception getting vm status: %s", str(e
))
3115 vm
["status"] = "VIM_ERROR"
3116 vm
["error_msg"] = str(e
)
3122 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
3123 """Send and action over a VM instance from VIM
3124 Returns None or the console dict if the action was successfully sent to the VIM
3126 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
3129 self
._reload
_connection
()
3130 server
= self
.nova
.servers
.find(id=vm_id
)
3132 if "start" in action_dict
:
3133 if action_dict
["start"] == "rebuild":
3136 if server
.status
== "PAUSED":
3138 elif server
.status
== "SUSPENDED":
3140 elif server
.status
== "SHUTOFF":
3144 "ERROR : Instance is not in SHUTOFF/PAUSE/SUSPEND state"
3146 raise vimconn
.VimConnException(
3147 "Cannot 'start' instance while it is in active state",
3148 http_code
=vimconn
.HTTP_Bad_Request
,
3151 elif "pause" in action_dict
:
3153 elif "resume" in action_dict
:
3155 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
3156 self
.logger
.debug("server status %s", server
.status
)
3157 if server
.status
== "ACTIVE":
3160 self
.logger
.debug("ERROR: VM is not in Active state")
3161 raise vimconn
.VimConnException(
3162 "VM is not in active state, stop operation is not allowed",
3163 http_code
=vimconn
.HTTP_Bad_Request
,
3165 elif "forceOff" in action_dict
:
3166 server
.stop() # TODO
3167 elif "terminate" in action_dict
:
3169 elif "createImage" in action_dict
:
3170 server
.create_image()
3171 # "path":path_schema,
3172 # "description":description_schema,
3173 # "name":name_schema,
3174 # "metadata":metadata_schema,
3175 # "imageRef": id_schema,
3176 # "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
3177 elif "rebuild" in action_dict
:
3178 server
.rebuild(server
.image
["id"])
3179 elif "reboot" in action_dict
:
3180 server
.reboot() # reboot_type="SOFT"
3181 elif "console" in action_dict
:
3182 console_type
= action_dict
["console"]
3184 if console_type
is None or console_type
== "novnc":
3185 console_dict
= server
.get_vnc_console("novnc")
3186 elif console_type
== "xvpvnc":
3187 console_dict
= server
.get_vnc_console(console_type
)
3188 elif console_type
== "rdp-html5":
3189 console_dict
= server
.get_rdp_console(console_type
)
3190 elif console_type
== "spice-html5":
3191 console_dict
= server
.get_spice_console(console_type
)
3193 raise vimconn
.VimConnException(
3194 "console type '{}' not allowed".format(console_type
),
3195 http_code
=vimconn
.HTTP_Bad_Request
,
3199 console_url
= console_dict
["console"]["url"]
3201 protocol_index
= console_url
.find("//")
3203 console_url
[protocol_index
+ 2 :].find("/") + protocol_index
+ 2
3206 console_url
[protocol_index
+ 2 : suffix_index
].find(":")
3211 if protocol_index
< 0 or port_index
< 0 or suffix_index
< 0:
3212 raise vimconn
.VimConnException(
3213 "Unexpected response from VIM " + str(console_dict
)
3217 "protocol": console_url
[0:protocol_index
],
3218 "server": console_url
[protocol_index
+ 2 : port_index
],
3219 "port": int(console_url
[port_index
+ 1 : suffix_index
]),
3220 "suffix": console_url
[suffix_index
+ 1 :],
3223 return console_dict2
3225 raise vimconn
.VimConnException(
3226 "Unexpected response from VIM " + str(console_dict
)
3231 ksExceptions
.ClientException
,
3232 nvExceptions
.ClientException
,
3233 nvExceptions
.NotFound
,
3236 self
._format
_exception
(e
)
3237 # TODO insert exception vimconn.HTTP_Unauthorized
3239 # ###### VIO Specific Changes #########
3240 def _generate_vlanID(self
):
3242 Method to get unused vlanID
3250 networks
= self
.get_network_list()
3252 for net
in networks
:
3253 if net
.get("provider:segmentation_id"):
3254 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3256 used_vlanIDs
= set(usedVlanIDs
)
3258 # find unused VLAN ID
3259 for vlanID_range
in self
.config
.get("dataplane_net_vlan_range"):
3261 start_vlanid
, end_vlanid
= map(
3262 int, vlanID_range
.replace(" ", "").split("-")
3265 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3266 if vlanID
not in used_vlanIDs
:
3268 except Exception as exp
:
3269 raise vimconn
.VimConnException(
3270 "Exception {} occurred while generating VLAN ID.".format(exp
)
3273 raise vimconn
.VimConnConflictException(
3274 "Unable to create the SRIOV VLAN network. All given Vlan IDs {} are in use.".format(
3275 self
.config
.get("dataplane_net_vlan_range")
3279 def _generate_multisegment_vlanID(self
):
3281 Method to get unused vlanID
3289 networks
= self
.get_network_list()
3290 for net
in networks
:
3291 if net
.get("provider:network_type") == "vlan" and net
.get(
3292 "provider:segmentation_id"
3294 usedVlanIDs
.append(net
.get("provider:segmentation_id"))
3295 elif net
.get("segments"):
3296 for segment
in net
.get("segments"):
3297 if segment
.get("provider:network_type") == "vlan" and segment
.get(
3298 "provider:segmentation_id"
3300 usedVlanIDs
.append(segment
.get("provider:segmentation_id"))
3302 used_vlanIDs
= set(usedVlanIDs
)
3304 # find unused VLAN ID
3305 for vlanID_range
in self
.config
.get("multisegment_vlan_range"):
3307 start_vlanid
, end_vlanid
= map(
3308 int, vlanID_range
.replace(" ", "").split("-")
3311 for vlanID
in range(start_vlanid
, end_vlanid
+ 1):
3312 if vlanID
not in used_vlanIDs
:
3314 except Exception as exp
:
3315 raise vimconn
.VimConnException(
3316 "Exception {} occurred while generating VLAN ID.".format(exp
)
3319 raise vimconn
.VimConnConflictException(
3320 "Unable to create the VLAN segment. All VLAN IDs {} are in use.".format(
3321 self
.config
.get("multisegment_vlan_range")
3325 def _validate_vlan_ranges(self
, input_vlan_range
, text_vlan_range
):
3327 Method to validate user given vlanID ranges
3331 for vlanID_range
in input_vlan_range
:
3332 vlan_range
= vlanID_range
.replace(" ", "")
3334 vlanID_pattern
= r
"(\d)*-(\d)*$"
3335 match_obj
= re
.match(vlanID_pattern
, vlan_range
)
3337 raise vimconn
.VimConnConflictException(
3338 "Invalid VLAN range for {}: {}.You must provide "
3339 "'{}' in format [start_ID - end_ID].".format(
3340 text_vlan_range
, vlanID_range
, text_vlan_range
3344 start_vlanid
, end_vlanid
= map(int, vlan_range
.split("-"))
3345 if start_vlanid
<= 0:
3346 raise vimconn
.VimConnConflictException(
3347 "Invalid VLAN range for {}: {}. Start ID can not be zero. For VLAN "
3348 "networks valid IDs are 1 to 4094 ".format(
3349 text_vlan_range
, vlanID_range
3353 if end_vlanid
> 4094:
3354 raise vimconn
.VimConnConflictException(
3355 "Invalid VLAN range for {}: {}. End VLAN ID can not be "
3356 "greater than 4094. For VLAN networks valid IDs are 1 to 4094 ".format(
3357 text_vlan_range
, vlanID_range
3361 if start_vlanid
> end_vlanid
:
3362 raise vimconn
.VimConnConflictException(
3363 "Invalid VLAN range for {}: {}. You must provide '{}'"
3364 " in format start_ID - end_ID and start_ID < end_ID ".format(
3365 text_vlan_range
, vlanID_range
, text_vlan_range
3369 # NOT USED FUNCTIONS
3371 def new_external_port(self
, port_data
):
3372 """Adds a external port to VIM
3373 Returns the port identifier"""
3374 # TODO openstack if needed
3376 -vimconn
.HTTP_Internal_Server_Error
,
3377 "osconnector.new_external_port() not implemented",
3380 def connect_port_network(self
, port_id
, network_id
, admin
=False):
3381 """Connects a external port to a network
3382 Returns status code of the VIM response"""
3383 # TODO openstack if needed
3385 -vimconn
.HTTP_Internal_Server_Error
,
3386 "osconnector.connect_port_network() not implemented",
3389 def new_user(self
, user_name
, user_passwd
, tenant_id
=None):
3390 """Adds a new user to openstack VIM
3391 Returns the user identifier"""
3392 self
.logger
.debug("osconnector: Adding a new user to VIM")
3395 self
._reload
_connection
()
3396 user
= self
.keystone
.users
.create(
3397 user_name
, password
=user_passwd
, default_project
=tenant_id
3399 # self.keystone.tenants.add_user(self.k_creds["username"], #role)
3402 except ksExceptions
.ConnectionError
as e
:
3403 error_value
= -vimconn
.HTTP_Bad_Request
3407 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3409 except ksExceptions
.ClientException
as e
: # TODO remove
3410 error_value
= -vimconn
.HTTP_Bad_Request
3414 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3417 # TODO insert exception vimconn.HTTP_Unauthorized
3418 # if reaching here is because an exception
3419 self
.logger
.debug("new_user " + error_text
)
3421 return error_value
, error_text
3423 def delete_user(self
, user_id
):
3424 """Delete a user from openstack VIM
3425 Returns the user identifier"""
3427 print("osconnector: Deleting a user from VIM")
3430 self
._reload
_connection
()
3431 self
.keystone
.users
.delete(user_id
)
3434 except ksExceptions
.ConnectionError
as e
:
3435 error_value
= -vimconn
.HTTP_Bad_Request
3439 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3441 except ksExceptions
.NotFound
as e
:
3442 error_value
= -vimconn
.HTTP_Not_Found
3446 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3448 except ksExceptions
.ClientException
as e
: # TODO remove
3449 error_value
= -vimconn
.HTTP_Bad_Request
3453 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3456 # TODO insert exception vimconn.HTTP_Unauthorized
3457 # if reaching here is because an exception
3458 self
.logger
.debug("delete_tenant " + error_text
)
3460 return error_value
, error_text
3462 def get_hosts_info(self
):
3463 """Get the information of deployed hosts
3464 Returns the hosts content"""
3466 print("osconnector: Getting Host info from VIM")
3470 self
._reload
_connection
()
3471 hypervisors
= self
.nova
.hypervisors
.list()
3473 for hype
in hypervisors
:
3474 h_list
.append(hype
.to_dict())
3476 return 1, {"hosts": h_list
}
3477 except nvExceptions
.NotFound
as e
:
3478 error_value
= -vimconn
.HTTP_Not_Found
3479 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3480 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
3481 error_value
= -vimconn
.HTTP_Bad_Request
3485 + (str(e
) if len(e
.args
) == 0 else str(e
.args
[0]))
3488 # TODO insert exception vimconn.HTTP_Unauthorized
3489 # if reaching here is because an exception
3490 self
.logger
.debug("get_hosts_info " + error_text
)
3492 return error_value
, error_text
3494 def get_hosts(self
, vim_tenant
):
3495 """Get the hosts and deployed instances
3496 Returns the hosts content"""
3497 r
, hype_dict
= self
.get_hosts_info()
3502 hypervisors
= hype_dict
["hosts"]
3505 servers
= self
.nova
.servers
.list()
3506 for hype
in hypervisors
:
3507 for server
in servers
:
3509 server
.to_dict()["OS-EXT-SRV-ATTR:hypervisor_hostname"]
3510 == hype
["hypervisor_hostname"]
3513 hype
["vm"].append(server
.id)
3515 hype
["vm"] = [server
.id]
3518 except nvExceptions
.NotFound
as e
:
3519 error_value
= -vimconn
.HTTP_Not_Found
3520 error_text
= str(e
) if len(e
.args
) == 0 else str(e
.args
[0])
3521 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
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("get_hosts " + error_text
)
3533 return error_value
, error_text
3535 def new_classification(self
, name
, ctype
, definition
):
3537 "Adding a new (Traffic) Classification to VIM, named %s", name
3542 self
._reload
_connection
()
3544 if ctype
not in supportedClassificationTypes
:
3545 raise vimconn
.VimConnNotSupportedException(
3546 "OpenStack VIM connector does not support provided "
3547 "Classification Type {}, supported ones are: {}".format(
3548 ctype
, supportedClassificationTypes
3552 if not self
._validate
_classification
(ctype
, definition
):
3553 raise vimconn
.VimConnException(
3554 "Incorrect Classification definition for the type specified."
3557 classification_dict
= definition
3558 classification_dict
["name"] = name
3559 new_class
= self
.neutron
.create_sfc_flow_classifier(
3560 {"flow_classifier": classification_dict
}
3563 return new_class
["flow_classifier"]["id"]
3565 neExceptions
.ConnectionFailed
,
3566 ksExceptions
.ClientException
,
3567 neExceptions
.NeutronException
,
3570 self
.logger
.error("Creation of Classification failed.")
3571 self
._format
_exception
(e
)
3573 def get_classification(self
, class_id
):
3574 self
.logger
.debug(" Getting Classification %s from VIM", class_id
)
3575 filter_dict
= {"id": class_id
}
3576 class_list
= self
.get_classification_list(filter_dict
)
3578 if len(class_list
) == 0:
3579 raise vimconn
.VimConnNotFoundException(
3580 "Classification '{}' not found".format(class_id
)
3582 elif len(class_list
) > 1:
3583 raise vimconn
.VimConnConflictException(
3584 "Found more than one Classification with this criteria"
3587 classification
= class_list
[0]
3589 return classification
3591 def get_classification_list(self
, filter_dict
={}):
3593 "Getting Classifications from VIM filter: '%s'", str(filter_dict
)
3597 filter_dict_os
= filter_dict
.copy()
3598 self
._reload
_connection
()
3600 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3601 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3603 classification_dict
= self
.neutron
.list_sfc_flow_classifiers(
3606 classification_list
= classification_dict
["flow_classifiers"]
3607 self
.__classification
_os
2mano
(classification_list
)
3609 return classification_list
3611 neExceptions
.ConnectionFailed
,
3612 ksExceptions
.ClientException
,
3613 neExceptions
.NeutronException
,
3616 self
._format
_exception
(e
)
3618 def delete_classification(self
, class_id
):
3619 self
.logger
.debug("Deleting Classification '%s' from VIM", class_id
)
3622 self
._reload
_connection
()
3623 self
.neutron
.delete_sfc_flow_classifier(class_id
)
3627 neExceptions
.ConnectionFailed
,
3628 neExceptions
.NeutronException
,
3629 ksExceptions
.ClientException
,
3630 neExceptions
.NeutronException
,
3633 self
._format
_exception
(e
)
3635 def new_sfi(self
, name
, ingress_ports
, egress_ports
, sfc_encap
=True):
3637 "Adding a new Service Function Instance to VIM, named '%s'", name
3642 self
._reload
_connection
()
3648 if len(ingress_ports
) != 1:
3649 raise vimconn
.VimConnNotSupportedException(
3650 "OpenStack VIM connector can only have 1 ingress port per SFI"
3653 if len(egress_ports
) != 1:
3654 raise vimconn
.VimConnNotSupportedException(
3655 "OpenStack VIM connector can only have 1 egress port per SFI"
3660 "ingress": ingress_ports
[0],
3661 "egress": egress_ports
[0],
3662 "service_function_parameters": {"correlation": correlation
},
3664 new_sfi
= self
.neutron
.create_sfc_port_pair({"port_pair": sfi_dict
})
3666 return new_sfi
["port_pair"]["id"]
3668 neExceptions
.ConnectionFailed
,
3669 ksExceptions
.ClientException
,
3670 neExceptions
.NeutronException
,
3675 self
.neutron
.delete_sfc_port_pair(new_sfi
["port_pair"]["id"])
3678 "Creation of Service Function Instance failed, with "
3679 "subsequent deletion failure as well."
3682 self
._format
_exception
(e
)
3684 def get_sfi(self
, sfi_id
):
3685 self
.logger
.debug("Getting Service Function Instance %s from VIM", sfi_id
)
3686 filter_dict
= {"id": sfi_id
}
3687 sfi_list
= self
.get_sfi_list(filter_dict
)
3689 if len(sfi_list
) == 0:
3690 raise vimconn
.VimConnNotFoundException(
3691 "Service Function Instance '{}' not found".format(sfi_id
)
3693 elif len(sfi_list
) > 1:
3694 raise vimconn
.VimConnConflictException(
3695 "Found more than one Service Function Instance with this criteria"
3702 def get_sfi_list(self
, filter_dict
={}):
3704 "Getting Service Function Instances from VIM filter: '%s'", str(filter_dict
)
3708 self
._reload
_connection
()
3709 filter_dict_os
= filter_dict
.copy()
3711 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3712 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3714 sfi_dict
= self
.neutron
.list_sfc_port_pairs(**filter_dict_os
)
3715 sfi_list
= sfi_dict
["port_pairs"]
3716 self
.__sfi
_os
2mano
(sfi_list
)
3720 neExceptions
.ConnectionFailed
,
3721 ksExceptions
.ClientException
,
3722 neExceptions
.NeutronException
,
3725 self
._format
_exception
(e
)
3727 def delete_sfi(self
, sfi_id
):
3728 self
.logger
.debug("Deleting Service Function Instance '%s' from VIM", sfi_id
)
3731 self
._reload
_connection
()
3732 self
.neutron
.delete_sfc_port_pair(sfi_id
)
3736 neExceptions
.ConnectionFailed
,
3737 neExceptions
.NeutronException
,
3738 ksExceptions
.ClientException
,
3739 neExceptions
.NeutronException
,
3742 self
._format
_exception
(e
)
3744 def new_sf(self
, name
, sfis
, sfc_encap
=True):
3745 self
.logger
.debug("Adding a new Service Function to VIM, named '%s'", name
)
3749 self
._reload
_connection
()
3750 # correlation = None
3752 # correlation = "nsh"
3754 for instance
in sfis
:
3755 sfi
= self
.get_sfi(instance
)
3757 if sfi
.get("sfc_encap") != sfc_encap
:
3758 raise vimconn
.VimConnNotSupportedException(
3759 "OpenStack VIM connector requires all SFIs of the "
3760 "same SF to share the same SFC Encapsulation"
3763 sf_dict
= {"name": name
, "port_pairs": sfis
}
3764 new_sf
= self
.neutron
.create_sfc_port_pair_group(
3765 {"port_pair_group": sf_dict
}
3768 return new_sf
["port_pair_group"]["id"]
3770 neExceptions
.ConnectionFailed
,
3771 ksExceptions
.ClientException
,
3772 neExceptions
.NeutronException
,
3777 self
.neutron
.delete_sfc_port_pair_group(
3778 new_sf
["port_pair_group"]["id"]
3782 "Creation of Service Function failed, with "
3783 "subsequent deletion failure as well."
3786 self
._format
_exception
(e
)
3788 def get_sf(self
, sf_id
):
3789 self
.logger
.debug("Getting Service Function %s from VIM", sf_id
)
3790 filter_dict
= {"id": sf_id
}
3791 sf_list
= self
.get_sf_list(filter_dict
)
3793 if len(sf_list
) == 0:
3794 raise vimconn
.VimConnNotFoundException(
3795 "Service Function '{}' not found".format(sf_id
)
3797 elif len(sf_list
) > 1:
3798 raise vimconn
.VimConnConflictException(
3799 "Found more than one Service Function with this criteria"
3806 def get_sf_list(self
, filter_dict
={}):
3808 "Getting Service Function from VIM filter: '%s'", str(filter_dict
)
3812 self
._reload
_connection
()
3813 filter_dict_os
= filter_dict
.copy()
3815 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3816 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3818 sf_dict
= self
.neutron
.list_sfc_port_pair_groups(**filter_dict_os
)
3819 sf_list
= sf_dict
["port_pair_groups"]
3820 self
.__sf
_os
2mano
(sf_list
)
3824 neExceptions
.ConnectionFailed
,
3825 ksExceptions
.ClientException
,
3826 neExceptions
.NeutronException
,
3829 self
._format
_exception
(e
)
3831 def delete_sf(self
, sf_id
):
3832 self
.logger
.debug("Deleting Service Function '%s' from VIM", sf_id
)
3835 self
._reload
_connection
()
3836 self
.neutron
.delete_sfc_port_pair_group(sf_id
)
3840 neExceptions
.ConnectionFailed
,
3841 neExceptions
.NeutronException
,
3842 ksExceptions
.ClientException
,
3843 neExceptions
.NeutronException
,
3846 self
._format
_exception
(e
)
3848 def new_sfp(self
, name
, classifications
, sfs
, sfc_encap
=True, spi
=None):
3849 self
.logger
.debug("Adding a new Service Function Path to VIM, named '%s'", name
)
3853 self
._reload
_connection
()
3854 # In networking-sfc the MPLS encapsulation is legacy
3855 # should be used when no full SFC Encapsulation is intended
3856 correlation
= "mpls"
3863 "flow_classifiers": classifications
,
3864 "port_pair_groups": sfs
,
3865 "chain_parameters": {"correlation": correlation
},
3869 sfp_dict
["chain_id"] = spi
3871 new_sfp
= self
.neutron
.create_sfc_port_chain({"port_chain": sfp_dict
})
3873 return new_sfp
["port_chain"]["id"]
3875 neExceptions
.ConnectionFailed
,
3876 ksExceptions
.ClientException
,
3877 neExceptions
.NeutronException
,
3882 self
.neutron
.delete_sfc_port_chain(new_sfp
["port_chain"]["id"])
3885 "Creation of Service Function Path failed, with "
3886 "subsequent deletion failure as well."
3889 self
._format
_exception
(e
)
3891 def get_sfp(self
, sfp_id
):
3892 self
.logger
.debug(" Getting Service Function Path %s from VIM", sfp_id
)
3894 filter_dict
= {"id": sfp_id
}
3895 sfp_list
= self
.get_sfp_list(filter_dict
)
3897 if len(sfp_list
) == 0:
3898 raise vimconn
.VimConnNotFoundException(
3899 "Service Function Path '{}' not found".format(sfp_id
)
3901 elif len(sfp_list
) > 1:
3902 raise vimconn
.VimConnConflictException(
3903 "Found more than one Service Function Path with this criteria"
3910 def get_sfp_list(self
, filter_dict
={}):
3912 "Getting Service Function Paths from VIM filter: '%s'", str(filter_dict
)
3916 self
._reload
_connection
()
3917 filter_dict_os
= filter_dict
.copy()
3919 if self
.api_version3
and "tenant_id" in filter_dict_os
:
3920 filter_dict_os
["project_id"] = filter_dict_os
.pop("tenant_id")
3922 sfp_dict
= self
.neutron
.list_sfc_port_chains(**filter_dict_os
)
3923 sfp_list
= sfp_dict
["port_chains"]
3924 self
.__sfp
_os
2mano
(sfp_list
)
3928 neExceptions
.ConnectionFailed
,
3929 ksExceptions
.ClientException
,
3930 neExceptions
.NeutronException
,
3933 self
._format
_exception
(e
)
3935 def delete_sfp(self
, sfp_id
):
3936 self
.logger
.debug("Deleting Service Function Path '%s' from VIM", sfp_id
)
3939 self
._reload
_connection
()
3940 self
.neutron
.delete_sfc_port_chain(sfp_id
)
3944 neExceptions
.ConnectionFailed
,
3945 neExceptions
.NeutronException
,
3946 ksExceptions
.ClientException
,
3947 neExceptions
.NeutronException
,
3950 self
._format
_exception
(e
)
3952 def refresh_sfps_status(self
, sfp_list
):
3953 """Get the status of the service function path
3954 Params: the list of sfp identifiers
3955 Returns a dictionary with:
3956 vm_id: #VIM id of this service function path
3957 status: #Mandatory. Text with one of:
3958 # DELETED (not found at vim)
3959 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
3960 # OTHER (Vim reported other status not understood)
3961 # ERROR (VIM indicates an ERROR status)
3963 # CREATING (on building process)
3964 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
3965 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)F
3969 "refresh_sfps status: Getting tenant SFP information from VIM"
3972 for sfp_id
in sfp_list
:
3976 sfp_vim
= self
.get_sfp(sfp_id
)
3979 sfp
["status"] = vmStatus2manoFormat
["ACTIVE"]
3981 sfp
["status"] = "OTHER"
3982 sfp
["error_msg"] = "VIM status reported " + sfp
["status"]
3984 sfp
["vim_info"] = self
.serialize(sfp_vim
)
3986 if sfp_vim
.get("fault"):
3987 sfp
["error_msg"] = str(sfp_vim
["fault"])
3988 except vimconn
.VimConnNotFoundException
as e
:
3989 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3990 sfp
["status"] = "DELETED"
3991 sfp
["error_msg"] = str(e
)
3992 except vimconn
.VimConnException
as e
:
3993 self
.logger
.error("Exception getting sfp status: %s", str(e
))
3994 sfp
["status"] = "VIM_ERROR"
3995 sfp
["error_msg"] = str(e
)
3997 sfp_dict
[sfp_id
] = sfp
4001 def refresh_sfis_status(self
, sfi_list
):
4002 """Get the status of the service function instances
4003 Params: the list of sfi identifiers
4004 Returns a dictionary with:
4005 vm_id: #VIM id of this service function instance
4006 status: #Mandatory. Text with one of:
4007 # DELETED (not found at vim)
4008 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4009 # OTHER (Vim reported other status not understood)
4010 # ERROR (VIM indicates an ERROR status)
4012 # CREATING (on building process)
4013 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4014 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4018 "refresh_sfis status: Getting tenant sfi information from VIM"
4021 for sfi_id
in sfi_list
:
4025 sfi_vim
= self
.get_sfi(sfi_id
)
4028 sfi
["status"] = vmStatus2manoFormat
["ACTIVE"]
4030 sfi
["status"] = "OTHER"
4031 sfi
["error_msg"] = "VIM status reported " + sfi
["status"]
4033 sfi
["vim_info"] = self
.serialize(sfi_vim
)
4035 if sfi_vim
.get("fault"):
4036 sfi
["error_msg"] = str(sfi_vim
["fault"])
4037 except vimconn
.VimConnNotFoundException
as e
:
4038 self
.logger
.error("Exception getting sfi status: %s", str(e
))
4039 sfi
["status"] = "DELETED"
4040 sfi
["error_msg"] = str(e
)
4041 except vimconn
.VimConnException
as e
:
4042 self
.logger
.error("Exception getting sfi status: %s", str(e
))
4043 sfi
["status"] = "VIM_ERROR"
4044 sfi
["error_msg"] = str(e
)
4046 sfi_dict
[sfi_id
] = sfi
4050 def refresh_sfs_status(self
, sf_list
):
4051 """Get the status of the service functions
4052 Params: the list of sf identifiers
4053 Returns a dictionary with:
4054 vm_id: #VIM id of this service function
4055 status: #Mandatory. Text with one of:
4056 # DELETED (not found at vim)
4057 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4058 # OTHER (Vim reported other status not understood)
4059 # ERROR (VIM indicates an ERROR status)
4061 # CREATING (on building process)
4062 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4063 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4066 self
.logger
.debug("refresh_sfs status: Getting tenant sf information from VIM")
4068 for sf_id
in sf_list
:
4072 sf_vim
= self
.get_sf(sf_id
)
4075 sf
["status"] = vmStatus2manoFormat
["ACTIVE"]
4077 sf
["status"] = "OTHER"
4078 sf
["error_msg"] = "VIM status reported " + sf_vim
["status"]
4080 sf
["vim_info"] = self
.serialize(sf_vim
)
4082 if sf_vim
.get("fault"):
4083 sf
["error_msg"] = str(sf_vim
["fault"])
4084 except vimconn
.VimConnNotFoundException
as e
:
4085 self
.logger
.error("Exception getting sf status: %s", str(e
))
4086 sf
["status"] = "DELETED"
4087 sf
["error_msg"] = str(e
)
4088 except vimconn
.VimConnException
as e
:
4089 self
.logger
.error("Exception getting sf status: %s", str(e
))
4090 sf
["status"] = "VIM_ERROR"
4091 sf
["error_msg"] = str(e
)
4097 def refresh_classifications_status(self
, classification_list
):
4098 """Get the status of the classifications
4099 Params: the list of classification identifiers
4100 Returns a dictionary with:
4101 vm_id: #VIM id of this classifier
4102 status: #Mandatory. Text with one of:
4103 # DELETED (not found at vim)
4104 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
4105 # OTHER (Vim reported other status not understood)
4106 # ERROR (VIM indicates an ERROR status)
4108 # CREATING (on building process)
4109 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
4110 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
4112 classification_dict
= {}
4114 "refresh_classifications status: Getting tenant classification information from VIM"
4117 for classification_id
in classification_list
:
4121 classification_vim
= self
.get_classification(classification_id
)
4123 if classification_vim
:
4124 classification
["status"] = vmStatus2manoFormat
["ACTIVE"]
4126 classification
["status"] = "OTHER"
4127 classification
["error_msg"] = (
4128 "VIM status reported " + classification
["status"]
4131 classification
["vim_info"] = self
.serialize(classification_vim
)
4133 if classification_vim
.get("fault"):
4134 classification
["error_msg"] = str(classification_vim
["fault"])
4135 except vimconn
.VimConnNotFoundException
as e
:
4136 self
.logger
.error("Exception getting classification status: %s", str(e
))
4137 classification
["status"] = "DELETED"
4138 classification
["error_msg"] = str(e
)
4139 except vimconn
.VimConnException
as e
:
4140 self
.logger
.error("Exception getting classification status: %s", str(e
))
4141 classification
["status"] = "VIM_ERROR"
4142 classification
["error_msg"] = str(e
)
4144 classification_dict
[classification_id
] = classification
4146 return classification_dict
4148 def new_affinity_group(self
, affinity_group_data
):
4149 """Adds a server group to VIM
4150 affinity_group_data contains a dictionary with information, keys:
4151 name: name in VIM for the server group
4152 type: affinity or anti-affinity
4153 scope: Only nfvi-node allowed
4154 Returns the server group identifier"""
4155 self
.logger
.debug("Adding Server Group '%s'", str(affinity_group_data
))
4158 name
= affinity_group_data
["name"]
4159 policy
= affinity_group_data
["type"]
4161 self
._reload
_connection
()
4162 new_server_group
= self
.nova
.server_groups
.create(name
, policy
)
4164 return new_server_group
.id
4166 ksExceptions
.ClientException
,
4167 nvExceptions
.ClientException
,
4171 self
._format
_exception
(e
)
4173 def get_affinity_group(self
, affinity_group_id
):
4174 """Obtain server group details from the VIM. Returns the server group detais as a dict"""
4175 self
.logger
.debug("Getting flavor '%s'", affinity_group_id
)
4177 self
._reload
_connection
()
4178 server_group
= self
.nova
.server_groups
.find(id=affinity_group_id
)
4180 return server_group
.to_dict()
4182 nvExceptions
.NotFound
,
4183 nvExceptions
.ClientException
,
4184 ksExceptions
.ClientException
,
4187 self
._format
_exception
(e
)
4189 def delete_affinity_group(self
, affinity_group_id
):
4190 """Deletes a server group from the VIM. Returns the old affinity_group_id"""
4191 self
.logger
.debug("Getting server group '%s'", affinity_group_id
)
4193 self
._reload
_connection
()
4194 self
.nova
.server_groups
.delete(affinity_group_id
)
4196 return affinity_group_id
4198 nvExceptions
.NotFound
,
4199 ksExceptions
.ClientException
,
4200 nvExceptions
.ClientException
,
4203 self
._format
_exception
(e
)
4205 def get_vdu_state(self
, vm_id
):
4207 Getting the state of a vdu
4209 vm_id: ID of an instance
4211 self
.logger
.debug("Getting the status of VM")
4212 self
.logger
.debug("VIM VM ID %s", vm_id
)
4213 self
._reload
_connection
()
4214 server
= self
.nova
.servers
.find(id=vm_id
)
4215 server_dict
= server
.to_dict()
4217 server_dict
["status"],
4218 server_dict
["flavor"]["id"],
4219 server_dict
["OS-EXT-SRV-ATTR:host"],
4220 server_dict
["OS-EXT-AZ:availability_zone"],
4222 self
.logger
.debug("vdu_data %s", vdu_data
)
4225 def check_compute_availability(self
, host
, server_flavor_details
):
4226 self
._reload
_connection
()
4227 hypervisor_search
= self
.nova
.hypervisors
.search(
4228 hypervisor_match
=host
, servers
=True
4230 for hypervisor
in hypervisor_search
:
4231 hypervisor_id
= hypervisor
.to_dict()["id"]
4232 hypervisor_details
= self
.nova
.hypervisors
.get(hypervisor
=hypervisor_id
)
4233 hypervisor_dict
= hypervisor_details
.to_dict()
4234 hypervisor_temp
= json
.dumps(hypervisor_dict
)
4235 hypervisor_json
= json
.loads(hypervisor_temp
)
4236 resources_available
= [
4237 hypervisor_json
["free_ram_mb"],
4238 hypervisor_json
["disk_available_least"],
4239 hypervisor_json
["vcpus"] - hypervisor_json
["vcpus_used"],
4241 compute_available
= all(
4242 x
> y
for x
, y
in zip(resources_available
, server_flavor_details
)
4244 if compute_available
:
4247 def check_availability_zone(
4248 self
, old_az
, server_flavor_details
, old_host
, host
=None
4250 self
._reload
_connection
()
4251 az_check
= {"zone_check": False, "compute_availability": None}
4252 aggregates_list
= self
.nova
.aggregates
.list()
4253 for aggregate
in aggregates_list
:
4254 aggregate_details
= aggregate
.to_dict()
4255 aggregate_temp
= json
.dumps(aggregate_details
)
4256 aggregate_json
= json
.loads(aggregate_temp
)
4257 if aggregate_json
["availability_zone"] == old_az
:
4258 hosts_list
= aggregate_json
["hosts"]
4259 if host
is not None:
4260 if host
in hosts_list
:
4261 az_check
["zone_check"] = True
4262 available_compute_id
= self
.check_compute_availability(
4263 host
, server_flavor_details
4265 if available_compute_id
is not None:
4266 az_check
["compute_availability"] = available_compute_id
4268 for check_host
in hosts_list
:
4269 if check_host
!= old_host
:
4270 available_compute_id
= self
.check_compute_availability(
4271 check_host
, server_flavor_details
4273 if available_compute_id
is not None:
4274 az_check
["zone_check"] = True
4275 az_check
["compute_availability"] = available_compute_id
4278 az_check
["zone_check"] = True
4281 def migrate_instance(self
, vm_id
, compute_host
=None):
4285 vm_id: ID of an instance
4286 compute_host: Host to migrate the vdu to
4288 self
._reload
_connection
()
4290 instance_state
= self
.get_vdu_state(vm_id
)
4291 server_flavor_id
= instance_state
[1]
4292 server_hypervisor_name
= instance_state
[2]
4293 server_availability_zone
= instance_state
[3]
4295 server_flavor
= self
.nova
.flavors
.find(id=server_flavor_id
).to_dict()
4296 server_flavor_details
= [
4297 server_flavor
["ram"],
4298 server_flavor
["disk"],
4299 server_flavor
["vcpus"],
4301 if compute_host
== server_hypervisor_name
:
4302 raise vimconn
.VimConnException(
4303 "Unable to migrate instance '{}' to the same host '{}'".format(
4306 http_code
=vimconn
.HTTP_Bad_Request
,
4308 az_status
= self
.check_availability_zone(
4309 server_availability_zone
,
4310 server_flavor_details
,
4311 server_hypervisor_name
,
4314 availability_zone_check
= az_status
["zone_check"]
4315 available_compute_id
= az_status
.get("compute_availability")
4317 if availability_zone_check
is False:
4318 raise vimconn
.VimConnException(
4319 "Unable to migrate instance '{}' to a different availability zone".format(
4322 http_code
=vimconn
.HTTP_Bad_Request
,
4324 if available_compute_id
is not None:
4325 self
.nova
.servers
.live_migrate(
4327 host
=available_compute_id
,
4328 block_migration
=True,
4329 disk_over_commit
=False,
4332 changed_compute_host
= ""
4333 if state
== "MIGRATING":
4334 vm_state
= self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4335 changed_compute_host
= self
.get_vdu_state(vm_id
)[2]
4336 if vm_state
and changed_compute_host
== available_compute_id
:
4338 "Instance '{}' migrated to the new compute host '{}'".format(
4339 vm_id
, changed_compute_host
4342 return state
, available_compute_id
4344 raise vimconn
.VimConnException(
4345 "Migration Failed. Instance '{}' not moved to the new host {}".format(
4346 vm_id
, available_compute_id
4348 http_code
=vimconn
.HTTP_Bad_Request
,
4351 raise vimconn
.VimConnException(
4352 "Compute '{}' not available or does not have enough resources to migrate the instance".format(
4353 available_compute_id
4355 http_code
=vimconn
.HTTP_Bad_Request
,
4358 nvExceptions
.BadRequest
,
4359 nvExceptions
.ClientException
,
4360 nvExceptions
.NotFound
,
4362 self
._format
_exception
(e
)
4364 def resize_instance(self
, vm_id
, new_flavor_id
):
4366 For resizing the vm based on the given
4369 vm_id : ID of an instance
4370 new_flavor_id : Flavor id to be resized
4371 Return the status of a resized instance
4373 self
._reload
_connection
()
4374 self
.logger
.debug("resize the flavor of an instance")
4375 instance_status
, old_flavor_id
, compute_host
, az
= self
.get_vdu_state(vm_id
)
4376 old_flavor_disk
= self
.nova
.flavors
.find(id=old_flavor_id
).to_dict()["disk"]
4377 new_flavor_disk
= self
.nova
.flavors
.find(id=new_flavor_id
).to_dict()["disk"]
4379 if instance_status
== "ACTIVE" or instance_status
== "SHUTOFF":
4380 if old_flavor_disk
> new_flavor_disk
:
4381 raise nvExceptions
.BadRequest(
4383 message
="Server disk resize failed. Resize to lower disk flavor is not allowed",
4386 self
.nova
.servers
.resize(server
=vm_id
, flavor
=new_flavor_id
)
4387 vm_state
= self
.__wait
_for
_vm
(vm_id
, "VERIFY_RESIZE")
4389 instance_resized_status
= self
.confirm_resize(vm_id
)
4390 return instance_resized_status
4392 raise nvExceptions
.BadRequest(
4394 message
="Cannot 'resize' vm_state is in ERROR",
4398 self
.logger
.debug("ERROR : Instance is not in ACTIVE or SHUTOFF state")
4399 raise nvExceptions
.BadRequest(
4401 message
="Cannot 'resize' instance while it is in vm_state resized",
4404 nvExceptions
.BadRequest
,
4405 nvExceptions
.ClientException
,
4406 nvExceptions
.NotFound
,
4408 self
._format
_exception
(e
)
4410 def confirm_resize(self
, vm_id
):
4412 Confirm the resize of an instance
4414 vm_id: ID of an instance
4416 self
._reload
_connection
()
4417 self
.nova
.servers
.confirm_resize(server
=vm_id
)
4418 if self
.get_vdu_state(vm_id
)[0] == "VERIFY_RESIZE":
4419 self
.__wait
_for
_vm
(vm_id
, "ACTIVE")
4420 instance_status
= self
.get_vdu_state(vm_id
)[0]
4421 return instance_status