blob: 7cf5e883881ec51476105f05e7af25a24ace906f [file] [log] [blame]
tierno7edb6752016-03-21 17:37:52 +01001# -*- coding: utf-8 -*-
2
3##
tierno92021022018-09-12 16:29:23 +02004# Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U.
tierno7edb6752016-03-21 17:37:52 +01005# This file is part of openmano
6# All Rights Reserved.
7#
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
11#
12# http://www.apache.org/licenses/LICENSE-2.0
13#
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
18# under the License.
tierno7edb6752016-03-21 17:37:52 +010019##
20
tierno1ec592d2020-06-16 15:29:47 +000021"""
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +000022osconnector implements all the methods to interact with openstack using the python-neutronclient.
23
24For the VNF forwarding graph, The OpenStack VIM connector calls the
25networking-sfc Neutron extension methods, whose resources are mapped
26to 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)
tierno1ec592d2020-06-16 15:29:47 +000031"""
tierno7edb6752016-03-21 17:37:52 +010032
tierno72774862020-05-04 11:44:15 +000033from osm_ro_plugin import vimconn
tierno69b590e2018-03-13 18:52:23 +010034# import json
tiernoae4a8d12016-07-08 12:30:39 +020035import logging
garciadeblas9f8456e2016-09-05 05:02:59 +020036import netaddr
montesmoreno0c8def02016-12-22 12:16:23 +000037import time
tierno36c0b172017-01-12 18:32:28 +010038import yaml
garciadeblas2299e3b2017-01-26 14:35:55 +000039import random
kate721d79b2017-06-24 04:21:38 -070040import re
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +000041import copy
Anderson Bravalheri0446cd52018-08-17 15:26:19 +010042from pprint import pformat
tierno7edb6752016-03-21 17:37:52 +010043
tiernob5cef372017-06-19 15:52:22 +020044from novaclient import client as nClient, exceptions as nvExceptions
45from keystoneauth1.identity import v2, v3
46from keystoneauth1 import session
tierno7edb6752016-03-21 17:37:52 +010047import keystoneclient.exceptions as ksExceptions
tiernof716aea2017-06-21 18:01:40 +020048import keystoneclient.v3.client as ksClient_v3
49import keystoneclient.v2_0.client as ksClient_v2
tiernob5cef372017-06-19 15:52:22 +020050from glanceclient import client as glClient
tierno7edb6752016-03-21 17:37:52 +010051import glanceclient.exc as gl1Exceptions
tierno1ec592d2020-06-16 15:29:47 +000052from cinderclient import client as cClient
53from http.client import HTTPException # TODO py3 check that this base exception matches python2 httplib.HTTPException
tiernob5cef372017-06-19 15:52:22 +020054from neutronclient.neutron import client as neClient
tierno7edb6752016-03-21 17:37:52 +010055from neutronclient.common import exceptions as neExceptions
56from requests.exceptions import ConnectionError
57
tierno1ec592d2020-06-16 15:29:47 +000058__author__ = "Alfonso Tierno, Gerardo Garcia, Pablo Montes, xFlow Research, Igor D.C., Eduardo Sousa"
59__date__ = "$22-sep-2017 23:59:59$"
tierno40e1bce2017-08-09 09:12:04 +020060
61"""contain the openstack virtual machine status to openmano status"""
tierno1ec592d2020-06-16 15:29:47 +000062vmStatus2manoFormat = {'ACTIVE': 'ACTIVE',
63 'PAUSED': 'PAUSED',
64 'SUSPENDED': 'SUSPENDED',
65 'SHUTOFF': 'INACTIVE',
66 'BUILD': 'BUILD',
67 'ERROR': 'ERROR',
68 'DELETED': 'DELETED'
69 }
70netStatus2manoFormat = {'ACTIVE': 'ACTIVE',
71 'PAUSED': 'PAUSED',
72 'INACTIVE': 'INACTIVE',
73 'BUILD': 'BUILD',
74 'ERROR': 'ERROR',
75 'DELETED': 'DELETED'
76 }
tierno7edb6752016-03-21 17:37:52 +010077
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +000078supportedClassificationTypes = ['legacy_flow_classifier']
79
tierno1ec592d2020-06-16 15:29:47 +000080# global var to have a timeout creating and deleting volumes
garciadeblas64b39c52020-05-21 08:07:25 +000081volume_timeout = 1800
82server_timeout = 1800
montesmoreno0c8def02016-12-22 12:16:23 +000083
Anderson Bravalheri0446cd52018-08-17 15:26:19 +010084
85class SafeDumper(yaml.SafeDumper):
86 def represent_data(self, data):
87 # Openstack APIs use custom subclasses of dict and YAML safe dumper
88 # is designed to not handle that (reference issue 142 of pyyaml)
89 if isinstance(data, dict) and data.__class__ != dict:
90 # A simple solution is to convert those items back to dicts
91 data = dict(data.items())
92
93 return super(SafeDumper, self).represent_data(data)
94
95
tierno72774862020-05-04 11:44:15 +000096class vimconnector(vimconn.VimConnector):
tiernob3d36742017-03-03 23:51:05 +010097 def __init__(self, uuid, name, tenant_id, tenant_name, url, url_admin=None, user=None, passwd=None,
98 log_level=None, config={}, persistent_info={}):
tierno1ec592d2020-06-16 15:29:47 +000099 """using common constructor parameters. In this case
tierno7edb6752016-03-21 17:37:52 +0100100 'url' is the keystone authorization url,
101 'url_admin' is not use
tierno1ec592d2020-06-16 15:29:47 +0000102 """
tiernof716aea2017-06-21 18:01:40 +0200103 api_version = config.get('APIversion')
104 if api_version and api_version not in ('v3.3', 'v2.0', '2', '3'):
tierno72774862020-05-04 11:44:15 +0000105 raise vimconn.VimConnException("Invalid value '{}' for config:APIversion. "
tiernof716aea2017-06-21 18:01:40 +0200106 "Allowed values are 'v3.3', 'v2.0', '2' or '3'".format(api_version))
kate721d79b2017-06-24 04:21:38 -0700107 vim_type = config.get('vim_type')
108 if vim_type and vim_type not in ('vio', 'VIO'):
tierno72774862020-05-04 11:44:15 +0000109 raise vimconn.VimConnException("Invalid value '{}' for config:vim_type."
tierno1ec592d2020-06-16 15:29:47 +0000110 "Allowed values are 'vio' or 'VIO'".format(vim_type))
kate721d79b2017-06-24 04:21:38 -0700111
112 if config.get('dataplane_net_vlan_range') is not None:
tierno1ec592d2020-06-16 15:29:47 +0000113 # validate vlan ranges provided by user
garciadeblasebd66722019-01-31 16:01:31 +0000114 self._validate_vlan_ranges(config.get('dataplane_net_vlan_range'), 'dataplane_net_vlan_range')
115
116 if config.get('multisegment_vlan_range') is not None:
tierno1ec592d2020-06-16 15:29:47 +0000117 # validate vlan ranges provided by user
garciadeblasebd66722019-01-31 16:01:31 +0000118 self._validate_vlan_ranges(config.get('multisegment_vlan_range'), 'multisegment_vlan_range')
kate721d79b2017-06-24 04:21:38 -0700119
tierno72774862020-05-04 11:44:15 +0000120 vimconn.VimConnector.__init__(self, uuid, name, tenant_id, tenant_name, url, url_admin, user, passwd, log_level,
tiernob5cef372017-06-19 15:52:22 +0200121 config)
tiernob3d36742017-03-03 23:51:05 +0100122
tierno4d1ce222018-04-06 10:41:06 +0200123 if self.config.get("insecure") and self.config.get("ca_cert"):
tierno72774862020-05-04 11:44:15 +0000124 raise vimconn.VimConnException("options insecure and ca_cert are mutually exclusive")
tierno4d1ce222018-04-06 10:41:06 +0200125 self.verify = True
126 if self.config.get("insecure"):
127 self.verify = False
128 if self.config.get("ca_cert"):
129 self.verify = self.config.get("ca_cert")
tierno4d1ce222018-04-06 10:41:06 +0200130
tierno7edb6752016-03-21 17:37:52 +0100131 if not url:
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +0000132 raise TypeError('url param can not be NoneType')
tiernob5cef372017-06-19 15:52:22 +0200133 self.persistent_info = persistent_info
mirabal29356312017-07-27 12:21:22 +0200134 self.availability_zone = persistent_info.get('availability_zone', None)
tiernob5cef372017-06-19 15:52:22 +0200135 self.session = persistent_info.get('session', {'reload_client': True})
tiernoa05b65a2019-02-01 12:30:27 +0000136 self.my_tenant_id = self.session.get('my_tenant_id')
tiernob5cef372017-06-19 15:52:22 +0200137 self.nova = self.session.get('nova')
138 self.neutron = self.session.get('neutron')
139 self.cinder = self.session.get('cinder')
140 self.glance = self.session.get('glance')
tierno1beea862018-07-11 15:47:37 +0200141 # self.glancev1 = self.session.get('glancev1')
tiernof716aea2017-06-21 18:01:40 +0200142 self.keystone = self.session.get('keystone')
143 self.api_version3 = self.session.get('api_version3')
kate721d79b2017-06-24 04:21:38 -0700144 self.vim_type = self.config.get("vim_type")
145 if self.vim_type:
146 self.vim_type = self.vim_type.upper()
147 if self.config.get("use_internal_endpoint"):
148 self.endpoint_type = "internalURL"
149 else:
150 self.endpoint_type = None
montesmoreno0c8def02016-12-22 12:16:23 +0000151
garciadeblasa0a356e2019-12-18 09:32:09 +0100152 logging.getLogger('urllib3').setLevel(logging.WARNING)
153 logging.getLogger('keystoneauth').setLevel(logging.WARNING)
154 logging.getLogger('novaclient').setLevel(logging.WARNING)
tierno73ad9e42016-09-12 18:11:11 +0200155 self.logger = logging.getLogger('openmano.vim.openstack')
kate721d79b2017-06-24 04:21:38 -0700156
tiernoa05b65a2019-02-01 12:30:27 +0000157 # allow security_groups to be a list or a single string
158 if isinstance(self.config.get('security_groups'), str):
159 self.config['security_groups'] = [self.config['security_groups']]
160 self.security_groups_id = None
161
tierno1ec592d2020-06-16 15:29:47 +0000162 # ###### VIO Specific Changes #########
kate721d79b2017-06-24 04:21:38 -0700163 if self.vim_type == "VIO":
164 self.logger = logging.getLogger('openmano.vim.vio')
165
tiernofe789902016-09-29 14:20:44 +0000166 if log_level:
tierno1ec592d2020-06-16 15:29:47 +0000167 self.logger.setLevel(getattr(logging, log_level))
tiernof716aea2017-06-21 18:01:40 +0200168
169 def __getitem__(self, index):
170 """Get individuals parameters.
171 Throw KeyError"""
172 if index == 'project_domain_id':
173 return self.config.get("project_domain_id")
174 elif index == 'user_domain_id':
175 return self.config.get("user_domain_id")
176 else:
tierno72774862020-05-04 11:44:15 +0000177 return vimconn.VimConnector.__getitem__(self, index)
tiernof716aea2017-06-21 18:01:40 +0200178
179 def __setitem__(self, index, value):
180 """Set individuals parameters and it is marked as dirty so to force connection reload.
181 Throw KeyError"""
182 if index == 'project_domain_id':
183 self.config["project_domain_id"] = value
184 elif index == 'user_domain_id':
tierno1ec592d2020-06-16 15:29:47 +0000185 self.config["user_domain_id"] = value
tiernof716aea2017-06-21 18:01:40 +0200186 else:
tierno72774862020-05-04 11:44:15 +0000187 vimconn.VimConnector.__setitem__(self, index, value)
tiernob5cef372017-06-19 15:52:22 +0200188 self.session['reload_client'] = True
tiernof716aea2017-06-21 18:01:40 +0200189
Anderson Bravalheri0446cd52018-08-17 15:26:19 +0100190 def serialize(self, value):
191 """Serialization of python basic types.
192
193 In the case value is not serializable a message will be logged and a
194 simple representation of the data that cannot be converted back to
195 python is returned.
196 """
tierno7d782ef2019-10-04 12:56:31 +0000197 if isinstance(value, str):
Anderson Bravalheri0446cd52018-08-17 15:26:19 +0100198 return value
199
200 try:
201 return yaml.dump(value, Dumper=SafeDumper,
202 default_flow_style=True, width=256)
203 except yaml.representer.RepresenterError:
tierno1ec592d2020-06-16 15:29:47 +0000204 self.logger.debug('The following entity cannot be serialized in YAML:\n\n%s\n\n', pformat(value),
205 exc_info=True)
206 return str(value)
Anderson Bravalheri0446cd52018-08-17 15:26:19 +0100207
tierno7edb6752016-03-21 17:37:52 +0100208 def _reload_connection(self):
tierno1ec592d2020-06-16 15:29:47 +0000209 """Called before any operation, it check if credentials has changed
tierno7edb6752016-03-21 17:37:52 +0100210 Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
tierno1ec592d2020-06-16 15:29:47 +0000211 """
212 # TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
tiernob5cef372017-06-19 15:52:22 +0200213 if self.session['reload_client']:
tiernof716aea2017-06-21 18:01:40 +0200214 if self.config.get('APIversion'):
215 self.api_version3 = self.config['APIversion'] == 'v3.3' or self.config['APIversion'] == '3'
216 else: # get from ending auth_url that end with v3 or with v2.0
tierno1ec592d2020-06-16 15:29:47 +0000217 self.api_version3 = self.url.endswith("/v3") or self.url.endswith("/v3/")
tiernof716aea2017-06-21 18:01:40 +0200218 self.session['api_version3'] = self.api_version3
219 if self.api_version3:
tierno3cb8dc32017-10-24 18:13:19 +0200220 if self.config.get('project_domain_id') or self.config.get('project_domain_name'):
221 project_domain_id_default = None
222 else:
223 project_domain_id_default = 'default'
224 if self.config.get('user_domain_id') or self.config.get('user_domain_name'):
225 user_domain_id_default = None
226 else:
227 user_domain_id_default = 'default'
tiernof716aea2017-06-21 18:01:40 +0200228 auth = v3.Password(auth_url=self.url,
tiernob5cef372017-06-19 15:52:22 +0200229 username=self.user,
230 password=self.passwd,
231 project_name=self.tenant_name,
232 project_id=self.tenant_id,
tierno3cb8dc32017-10-24 18:13:19 +0200233 project_domain_id=self.config.get('project_domain_id', project_domain_id_default),
234 user_domain_id=self.config.get('user_domain_id', user_domain_id_default),
235 project_domain_name=self.config.get('project_domain_name'),
236 user_domain_name=self.config.get('user_domain_name'))
ahmadsa95baa272016-11-30 09:14:11 +0500237 else:
tiernof716aea2017-06-21 18:01:40 +0200238 auth = v2.Password(auth_url=self.url,
tiernob5cef372017-06-19 15:52:22 +0200239 username=self.user,
240 password=self.passwd,
241 tenant_name=self.tenant_name,
242 tenant_id=self.tenant_id)
tierno4d1ce222018-04-06 10:41:06 +0200243 sess = session.Session(auth=auth, verify=self.verify)
tierno1ec592d2020-06-16 15:29:47 +0000244 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
245 # Titanium cloud and StarlingX
fatollahy40c6a3f2019-02-19 12:53:40 +0000246 region_name = self.config.get('region_name')
tiernof716aea2017-06-21 18:01:40 +0200247 if self.api_version3:
tierno1ec592d2020-06-16 15:29:47 +0000248 self.keystone = ksClient_v3.Client(session=sess, endpoint_type=self.endpoint_type,
249 region_name=region_name)
tiernof716aea2017-06-21 18:01:40 +0200250 else:
kate721d79b2017-06-24 04:21:38 -0700251 self.keystone = ksClient_v2.Client(session=sess, endpoint_type=self.endpoint_type)
tiernof716aea2017-06-21 18:01:40 +0200252 self.session['keystone'] = self.keystone
montesmoreno9317d302017-08-16 12:48:23 +0200253 # In order to enable microversion functionality an explicit microversion must be specified in 'config'.
254 # This implementation approach is due to the warning message in
255 # https://developer.openstack.org/api-guide/compute/microversions.html
256 # where it is stated that microversion backwards compatibility is not guaranteed and clients should
257 # always require an specific microversion.
258 # To be able to use 'device role tagging' functionality define 'microversion: 2.32' in datacenter config
259 version = self.config.get("microversion")
260 if not version:
261 version = "2.1"
tierno1ec592d2020-06-16 15:29:47 +0000262 # addedd region_name to keystone, nova, neutron and cinder to support distributed cloud for Wind River
263 # Titanium cloud and StarlingX
264 self.nova = self.session['nova'] = nClient.Client(str(version), session=sess,
265 endpoint_type=self.endpoint_type, region_name=region_name)
266 self.neutron = self.session['neutron'] = neClient.Client('2.0', session=sess,
267 endpoint_type=self.endpoint_type,
268 region_name=region_name)
269 self.cinder = self.session['cinder'] = cClient.Client(2, session=sess, endpoint_type=self.endpoint_type,
270 region_name=region_name)
tiernoa05b65a2019-02-01 12:30:27 +0000271 try:
272 self.my_tenant_id = self.session['my_tenant_id'] = sess.get_project_id()
tierno1ec592d2020-06-16 15:29:47 +0000273 except Exception:
tiernoa05b65a2019-02-01 12:30:27 +0000274 self.logger.error("Cannot get project_id from session", exc_info=True)
kate721d79b2017-06-24 04:21:38 -0700275 if self.endpoint_type == "internalURL":
276 glance_service_id = self.keystone.services.list(name="glance")[0].id
277 glance_endpoint = self.keystone.endpoints.list(glance_service_id, interface="internal")[0].url
278 else:
279 glance_endpoint = None
280 self.glance = self.session['glance'] = glClient.Client(2, session=sess, endpoint=glance_endpoint)
tiernoa05b65a2019-02-01 12:30:27 +0000281 # using version 1 of glance client in new_image()
tierno1beea862018-07-11 15:47:37 +0200282 # self.glancev1 = self.session['glancev1'] = glClient.Client('1', session=sess,
283 # endpoint=glance_endpoint)
tiernob5cef372017-06-19 15:52:22 +0200284 self.session['reload_client'] = False
285 self.persistent_info['session'] = self.session
mirabal29356312017-07-27 12:21:22 +0200286 # add availablity zone info inside self.persistent_info
287 self._set_availablity_zones()
288 self.persistent_info['availability_zone'] = self.availability_zone
tiernoa05b65a2019-02-01 12:30:27 +0000289 self.security_groups_id = None # force to get again security_groups_ids next time they are needed
ahmadsa95baa272016-11-30 09:14:11 +0500290
tierno7edb6752016-03-21 17:37:52 +0100291 def __net_os2mano(self, net_list_dict):
tierno1ec592d2020-06-16 15:29:47 +0000292 """Transform the net openstack format to mano format
293 net_list_dict can be a list of dict or a single dict"""
tierno7edb6752016-03-21 17:37:52 +0100294 if type(net_list_dict) is dict:
tierno1ec592d2020-06-16 15:29:47 +0000295 net_list_ = (net_list_dict,)
tierno7edb6752016-03-21 17:37:52 +0100296 elif type(net_list_dict) is list:
tierno1ec592d2020-06-16 15:29:47 +0000297 net_list_ = net_list_dict
tierno7edb6752016-03-21 17:37:52 +0100298 else:
299 raise TypeError("param net_list_dict must be a list or a dictionary")
300 for net in net_list_:
301 if net.get('provider:network_type') == "vlan":
tierno1ec592d2020-06-16 15:29:47 +0000302 net['type'] = 'data'
tierno7edb6752016-03-21 17:37:52 +0100303 else:
tierno1ec592d2020-06-16 15:29:47 +0000304 net['type'] = 'bridge'
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +0200305
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +0000306 def __classification_os2mano(self, class_list_dict):
307 """Transform the openstack format (Flow Classifier) to mano format
308 (Classification) class_list_dict can be a list of dict or a single dict
309 """
310 if isinstance(class_list_dict, dict):
311 class_list_ = [class_list_dict]
312 elif isinstance(class_list_dict, list):
313 class_list_ = class_list_dict
314 else:
tierno1ec592d2020-06-16 15:29:47 +0000315 raise TypeError("param class_list_dict must be a list or a dictionary")
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +0000316 for classification in class_list_:
317 id = classification.pop('id')
318 name = classification.pop('name')
319 description = classification.pop('description')
320 project_id = classification.pop('project_id')
321 tenant_id = classification.pop('tenant_id')
322 original_classification = copy.deepcopy(classification)
323 classification.clear()
324 classification['ctype'] = 'legacy_flow_classifier'
325 classification['definition'] = original_classification
326 classification['id'] = id
327 classification['name'] = name
328 classification['description'] = description
329 classification['project_id'] = project_id
330 classification['tenant_id'] = tenant_id
331
332 def __sfi_os2mano(self, sfi_list_dict):
333 """Transform the openstack format (Port Pair) to mano format (SFI)
334 sfi_list_dict can be a list of dict or a single dict
335 """
336 if isinstance(sfi_list_dict, dict):
337 sfi_list_ = [sfi_list_dict]
338 elif isinstance(sfi_list_dict, list):
339 sfi_list_ = sfi_list_dict
340 else:
341 raise TypeError(
342 "param sfi_list_dict must be a list or a dictionary")
343 for sfi in sfi_list_:
344 sfi['ingress_ports'] = []
345 sfi['egress_ports'] = []
346 if sfi.get('ingress'):
347 sfi['ingress_ports'].append(sfi['ingress'])
348 if sfi.get('egress'):
349 sfi['egress_ports'].append(sfi['egress'])
350 del sfi['ingress']
351 del sfi['egress']
352 params = sfi.get('service_function_parameters')
353 sfc_encap = False
354 if params:
355 correlation = params.get('correlation')
356 if correlation:
357 sfc_encap = True
358 sfi['sfc_encap'] = sfc_encap
359 del sfi['service_function_parameters']
360
361 def __sf_os2mano(self, sf_list_dict):
362 """Transform the openstack format (Port Pair Group) to mano format (SF)
363 sf_list_dict can be a list of dict or a single dict
364 """
365 if isinstance(sf_list_dict, dict):
366 sf_list_ = [sf_list_dict]
367 elif isinstance(sf_list_dict, list):
368 sf_list_ = sf_list_dict
369 else:
370 raise TypeError(
371 "param sf_list_dict must be a list or a dictionary")
372 for sf in sf_list_:
373 del sf['port_pair_group_parameters']
374 sf['sfis'] = sf['port_pairs']
375 del sf['port_pairs']
376
377 def __sfp_os2mano(self, sfp_list_dict):
378 """Transform the openstack format (Port Chain) to mano format (SFP)
379 sfp_list_dict can be a list of dict or a single dict
380 """
381 if isinstance(sfp_list_dict, dict):
382 sfp_list_ = [sfp_list_dict]
383 elif isinstance(sfp_list_dict, list):
384 sfp_list_ = sfp_list_dict
385 else:
386 raise TypeError(
387 "param sfp_list_dict must be a list or a dictionary")
388 for sfp in sfp_list_:
389 params = sfp.pop('chain_parameters')
390 sfc_encap = False
391 if params:
392 correlation = params.get('correlation')
393 if correlation:
394 sfc_encap = True
395 sfp['sfc_encap'] = sfc_encap
396 sfp['spi'] = sfp.pop('chain_id')
397 sfp['classifications'] = sfp.pop('flow_classifiers')
398 sfp['service_functions'] = sfp.pop('port_pair_groups')
399
400 # placeholder for now; read TODO note below
401 def _validate_classification(self, type, definition):
402 # only legacy_flow_classifier Type is supported at this point
403 return True
404 # TODO(igordcard): this method should be an abstract method of an
405 # abstract Classification class to be implemented by the specific
406 # Types. Also, abstract vimconnector should call the validation
407 # method before the implemented VIM connectors are called.
408
tiernoae4a8d12016-07-08 12:30:39 +0200409 def _format_exception(self, exception):
tierno69647792020-03-05 16:45:48 +0000410 """Transform a keystone, nova, neutron exception into a vimconn exception discovering the cause"""
tiernode12f782019-04-05 12:46:42 +0000411
tierno69647792020-03-05 16:45:48 +0000412 message_error = str(exception)
tiernode12f782019-04-05 12:46:42 +0000413
414 if isinstance(exception, (neExceptions.NetworkNotFoundClient, nvExceptions.NotFound, ksExceptions.NotFound,
415 gl1Exceptions.HTTPNotFound)):
tierno72774862020-05-04 11:44:15 +0000416 raise vimconn.VimConnNotFoundException(type(exception).__name__ + ": " + message_error)
shashankjain3c83a212018-10-04 13:05:46 +0530417 elif isinstance(exception, (HTTPException, gl1Exceptions.HTTPException, gl1Exceptions.CommunicationError,
tierno69647792020-03-05 16:45:48 +0000418 ConnectionError, ksExceptions.ConnectionError, neExceptions.ConnectionFailed)):
tierno72774862020-05-04 11:44:15 +0000419 raise vimconn.VimConnConnectionException(type(exception).__name__ + ": " + message_error)
tierno69647792020-03-05 16:45:48 +0000420 elif isinstance(exception, (KeyError, nvExceptions.BadRequest, ksExceptions.BadRequest)):
tierno72774862020-05-04 11:44:15 +0000421 raise vimconn.VimConnException(type(exception).__name__ + ": " + message_error)
anwarsc76a3ee2018-10-04 14:05:32 +0530422 elif isinstance(exception, (nvExceptions.ClientException, ksExceptions.ClientException,
423 neExceptions.NeutronException)):
tierno72774862020-05-04 11:44:15 +0000424 raise vimconn.VimConnUnexpectedResponse(type(exception).__name__ + ": " + message_error)
tiernoae4a8d12016-07-08 12:30:39 +0200425 elif isinstance(exception, nvExceptions.Conflict):
tierno72774862020-05-04 11:44:15 +0000426 raise vimconn.VimConnConflictException(type(exception).__name__ + ": " + message_error)
427 elif isinstance(exception, vimconn.VimConnException):
tierno41a69812018-02-16 14:34:33 +0100428 raise exception
tiernof716aea2017-06-21 18:01:40 +0200429 else: # ()
tiernode12f782019-04-05 12:46:42 +0000430 self.logger.error("General Exception " + message_error, exc_info=True)
tierno72774862020-05-04 11:44:15 +0000431 raise vimconn.VimConnConnectionException(type(exception).__name__ + ": " + message_error)
tiernoae4a8d12016-07-08 12:30:39 +0200432
tiernoa05b65a2019-02-01 12:30:27 +0000433 def _get_ids_from_name(self):
434 """
435 Obtain ids from name of tenant and security_groups. Store at self .security_groups_id"
436 :return: None
437 """
438 # get tenant_id if only tenant_name is supplied
439 self._reload_connection()
440 if not self.my_tenant_id:
tierno72774862020-05-04 11:44:15 +0000441 raise vimconn.VimConnConnectionException("Error getting tenant information from name={} id={}".
tiernoa05b65a2019-02-01 12:30:27 +0000442 format(self.tenant_name, self.tenant_id))
443 if self.config.get('security_groups') and not self.security_groups_id:
444 # convert from name to id
445 neutron_sg_list = self.neutron.list_security_groups(tenant_id=self.my_tenant_id)["security_groups"]
446
447 self.security_groups_id = []
448 for sg in self.config.get('security_groups'):
449 for neutron_sg in neutron_sg_list:
450 if sg in (neutron_sg["id"], neutron_sg["name"]):
451 self.security_groups_id.append(neutron_sg["id"])
452 break
453 else:
454 self.security_groups_id = None
tierno72774862020-05-04 11:44:15 +0000455 raise vimconn.VimConnConnectionException("Not found security group {} for this tenant".format(sg))
tiernoa05b65a2019-02-01 12:30:27 +0000456
tierno5509c2e2019-07-04 16:23:20 +0000457 def check_vim_connectivity(self):
458 # just get network list to check connectivity and credentials
459 self.get_network_list(filter_dict={})
460
tiernoae4a8d12016-07-08 12:30:39 +0200461 def get_tenant_list(self, filter_dict={}):
tierno1ec592d2020-06-16 15:29:47 +0000462 """Obtain tenants of VIM
tiernoae4a8d12016-07-08 12:30:39 +0200463 filter_dict can contain the following keys:
464 name: filter by tenant name
465 id: filter by tenant uuid/id
466 <other VIM specific>
467 Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
tierno1ec592d2020-06-16 15:29:47 +0000468 """
ahmadsa95baa272016-11-30 09:14:11 +0500469 self.logger.debug("Getting tenants from VIM filter: '%s'", str(filter_dict))
tiernoae4a8d12016-07-08 12:30:39 +0200470 try:
471 self._reload_connection()
tiernof716aea2017-06-21 18:01:40 +0200472 if self.api_version3:
473 project_class_list = self.keystone.projects.list(name=filter_dict.get("name"))
ahmadsa95baa272016-11-30 09:14:11 +0500474 else:
tiernof716aea2017-06-21 18:01:40 +0200475 project_class_list = self.keystone.tenants.findall(**filter_dict)
tierno1ec592d2020-06-16 15:29:47 +0000476 project_list = []
ahmadsa95baa272016-11-30 09:14:11 +0500477 for project in project_class_list:
tiernof716aea2017-06-21 18:01:40 +0200478 if filter_dict.get('id') and filter_dict["id"] != project.id:
479 continue
ahmadsa95baa272016-11-30 09:14:11 +0500480 project_list.append(project.to_dict())
481 return project_list
tiernof716aea2017-06-21 18:01:40 +0200482 except (ksExceptions.ConnectionError, ksExceptions.ClientException, ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +0200483 self._format_exception(e)
484
485 def new_tenant(self, tenant_name, tenant_description):
tierno1ec592d2020-06-16 15:29:47 +0000486 """Adds a new tenant to openstack VIM. Returns the tenant identifier"""
tiernoae4a8d12016-07-08 12:30:39 +0200487 self.logger.debug("Adding a new tenant name: %s", tenant_name)
488 try:
489 self._reload_connection()
tiernof716aea2017-06-21 18:01:40 +0200490 if self.api_version3:
491 project = self.keystone.projects.create(tenant_name, self.config.get("project_domain_id", "default"),
492 description=tenant_description, is_domain=False)
ahmadsa95baa272016-11-30 09:14:11 +0500493 else:
tiernof716aea2017-06-21 18:01:40 +0200494 project = self.keystone.tenants.create(tenant_name, tenant_description)
ahmadsa95baa272016-11-30 09:14:11 +0500495 return project.id
tierno1ec592d2020-06-16 15:29:47 +0000496 except (ksExceptions.ConnectionError, ksExceptions.ClientException, ksExceptions.BadRequest, ConnectionError)\
497 as e:
tiernoae4a8d12016-07-08 12:30:39 +0200498 self._format_exception(e)
499
500 def delete_tenant(self, tenant_id):
tierno1ec592d2020-06-16 15:29:47 +0000501 """Delete a tenant from openstack VIM. Returns the old tenant identifier"""
tiernoae4a8d12016-07-08 12:30:39 +0200502 self.logger.debug("Deleting tenant %s from VIM", tenant_id)
503 try:
504 self._reload_connection()
tiernof716aea2017-06-21 18:01:40 +0200505 if self.api_version3:
ahmadsa95baa272016-11-30 09:14:11 +0500506 self.keystone.projects.delete(tenant_id)
507 else:
508 self.keystone.tenants.delete(tenant_id)
tiernoae4a8d12016-07-08 12:30:39 +0200509 return tenant_id
tierno1ec592d2020-06-16 15:29:47 +0000510 except (ksExceptions.ConnectionError, ksExceptions.ClientException, ksExceptions.NotFound, ConnectionError)\
511 as e:
tiernoae4a8d12016-07-08 12:30:39 +0200512 self._format_exception(e)
ahmadsa95baa272016-11-30 09:14:11 +0500513
tierno6869ae72020-01-09 17:37:34 +0000514 def new_network(self, net_name, net_type, ip_profile=None, shared=False, provider_network_profile=None):
garciadeblasebd66722019-01-31 16:01:31 +0000515 """Adds a tenant network to VIM
516 Params:
517 'net_name': name of the network
518 'net_type': one of:
519 'bridge': overlay isolated network
520 'data': underlay E-LAN network for Passthrough and SRIOV interfaces
521 'ptp': underlay E-LINE network for Passthrough and SRIOV interfaces.
522 'ip_profile': is a dict containing the IP parameters of the network
523 'ip_version': can be "IPv4" or "IPv6" (Currently only IPv4 is implemented)
524 'subnet_address': ip_prefix_schema, that is X.X.X.X/Y
525 'gateway_address': (Optional) ip_schema, that is X.X.X.X
526 'dns_address': (Optional) comma separated list of ip_schema, e.g. X.X.X.X[,X,X,X,X]
527 'dhcp_enabled': True or False
528 'dhcp_start_address': ip_schema, first IP to grant
529 'dhcp_count': number of IPs to grant.
530 'shared': if this network can be seen/use by other tenants/organization
garciadeblas4af0d542020-02-18 16:01:13 +0100531 'provider_network_profile': (optional) contains {segmentation-id: vlan, network-type: vlan|vxlan,
532 physical-network: physnet-label}
garciadeblasebd66722019-01-31 16:01:31 +0000533 Returns a tuple with the network identifier and created_items, or raises an exception on error
534 created_items can be None or a dictionary where this method can include key-values that will be passed to
535 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
536 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
537 as not present.
538 """
tiernoae4a8d12016-07-08 12:30:39 +0200539 self.logger.debug("Adding a new network to VIM name '%s', type '%s'", net_name, net_type)
garciadeblasebd66722019-01-31 16:01:31 +0000540 # self.logger.debug(">>>>>>>>>>>>>>>>>> IP profile %s", str(ip_profile))
kbsuba85c54d2019-10-17 16:30:32 +0000541
tierno7edb6752016-03-21 17:37:52 +0100542 try:
kbsuba85c54d2019-10-17 16:30:32 +0000543 vlan = None
544 if provider_network_profile:
545 vlan = provider_network_profile.get("segmentation-id")
garciadeblasedca7b32016-09-29 14:01:52 +0000546 new_net = None
garciadeblasebd66722019-01-31 16:01:31 +0000547 created_items = {}
tierno7edb6752016-03-21 17:37:52 +0100548 self._reload_connection()
549 network_dict = {'name': net_name, 'admin_state_up': True}
tierno6869ae72020-01-09 17:37:34 +0000550 if net_type in ("data", "ptp"):
551 provider_physical_network = None
552 if provider_network_profile and provider_network_profile.get("physical-network"):
553 provider_physical_network = provider_network_profile.get("physical-network")
554 # provider-network must be one of the dataplane_physcial_netowrk if this is a list. If it is string
555 # or not declared, just ignore the checking
556 if isinstance(self.config.get('dataplane_physical_net'), (tuple, list)) and \
557 provider_physical_network not in self.config['dataplane_physical_net']:
tierno72774862020-05-04 11:44:15 +0000558 raise vimconn.VimConnConflictException(
tierno6869ae72020-01-09 17:37:34 +0000559 "Invalid parameter 'provider-network:physical-network' for network creation. '{}' is not "
560 "one of the declared list at VIM_config:dataplane_physical_net".format(
561 provider_physical_network))
562 if not provider_physical_network: # use the default dataplane_physical_net
563 provider_physical_network = self.config.get('dataplane_physical_net')
564 # if it is non empty list, use the first value. If it is a string use the value directly
565 if isinstance(provider_physical_network, (tuple, list)) and provider_physical_network:
566 provider_physical_network = provider_physical_network[0]
567
568 if not provider_physical_network:
tierno72774862020-05-04 11:44:15 +0000569 raise vimconn.VimConnConflictException("You must provide a 'dataplane_physical_net' at VIM_config "
tierno6869ae72020-01-09 17:37:34 +0000570 "for creating underlay networks. or use the NS instantiation"
571 " parameter provider-network:physical-network for the VLD")
572
garciadeblasebd66722019-01-31 16:01:31 +0000573 if not self.config.get('multisegment_support'):
tierno6869ae72020-01-09 17:37:34 +0000574 network_dict["provider:physical_network"] = provider_physical_network
garciadeblas4af0d542020-02-18 16:01:13 +0100575 if provider_network_profile and "network-type" in provider_network_profile:
576 network_dict["provider:network_type"] = provider_network_profile["network-type"]
577 else:
tierno1ec592d2020-06-16 15:29:47 +0000578 network_dict["provider:network_type"] = self.config.get('dataplane_network_type', 'vlan')
tierno6869ae72020-01-09 17:37:34 +0000579 if vlan:
580 network_dict["provider:segmentation_id"] = vlan
garciadeblasebd66722019-01-31 16:01:31 +0000581 else:
tierno6869ae72020-01-09 17:37:34 +0000582 # Multi-segment case
garciadeblasebd66722019-01-31 16:01:31 +0000583 segment_list = []
tierno6869ae72020-01-09 17:37:34 +0000584 segment1_dict = {
585 "provider:physical_network": '',
586 "provider:network_type": 'vxlan'
587 }
garciadeblasebd66722019-01-31 16:01:31 +0000588 segment_list.append(segment1_dict)
tierno6869ae72020-01-09 17:37:34 +0000589 segment2_dict = {
590 "provider:physical_network": provider_physical_network,
591 "provider:network_type": "vlan"
592 }
593 if vlan:
594 segment2_dict["provider:segmentation_id"] = vlan
595 elif self.config.get('multisegment_vlan_range'):
garciadeblasebd66722019-01-31 16:01:31 +0000596 vlanID = self._generate_multisegment_vlanID()
597 segment2_dict["provider:segmentation_id"] = vlanID
598 # else
tierno72774862020-05-04 11:44:15 +0000599 # raise vimconn.VimConnConflictException(
tierno1ec592d2020-06-16 15:29:47 +0000600 # "You must provide 'multisegment_vlan_range' at config dict before creating a multisegment
601 # network")
garciadeblasebd66722019-01-31 16:01:31 +0000602 segment_list.append(segment2_dict)
603 network_dict["segments"] = segment_list
kate721d79b2017-06-24 04:21:38 -0700604
tierno6869ae72020-01-09 17:37:34 +0000605 # VIO Specific Changes. It needs a concrete VLAN
606 if self.vim_type == "VIO" and vlan is None:
607 if self.config.get('dataplane_net_vlan_range') is None:
tierno72774862020-05-04 11:44:15 +0000608 raise vimconn.VimConnConflictException(
tierno6869ae72020-01-09 17:37:34 +0000609 "You must provide 'dataplane_net_vlan_range' in format [start_ID - end_ID] at VIM_config "
610 "for creating underlay networks")
611 network_dict["provider:segmentation_id"] = self._generate_vlanID()
kate721d79b2017-06-24 04:21:38 -0700612
garciadeblasebd66722019-01-31 16:01:31 +0000613 network_dict["shared"] = shared
anwarsff168192019-05-06 11:23:07 +0530614 if self.config.get("disable_network_port_security"):
615 network_dict["port_security_enabled"] = False
tierno1ec592d2020-06-16 15:29:47 +0000616 new_net = self.neutron.create_network({'network': network_dict})
garciadeblasebd66722019-01-31 16:01:31 +0000617 # print new_net
618 # create subnetwork, even if there is no profile
garciadeblas9f8456e2016-09-05 05:02:59 +0200619 if not ip_profile:
620 ip_profile = {}
tierno41a69812018-02-16 14:34:33 +0100621 if not ip_profile.get('subnet_address'):
tierno1ec592d2020-06-16 15:29:47 +0000622 # Fake subnet is required
garciadeblas2299e3b2017-01-26 14:35:55 +0000623 subnet_rand = random.randint(0, 255)
624 ip_profile['subnet_address'] = "192.168.{}.0/24".format(subnet_rand)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +0000625 if 'ip_version' not in ip_profile:
garciadeblas9f8456e2016-09-05 05:02:59 +0200626 ip_profile['ip_version'] = "IPv4"
garciadeblasebd66722019-01-31 16:01:31 +0000627 subnet = {"name": net_name+"-subnet",
tierno1ec592d2020-06-16 15:29:47 +0000628 "network_id": new_net["network"]["id"],
629 "ip_version": 4 if ip_profile['ip_version'] == "IPv4" else 6,
630 "cidr": ip_profile['subnet_address']
631 }
tiernoa1fb4462017-06-30 12:25:50 +0200632 # Gateway should be set to None if not needed. Otherwise openstack assigns one by default
tierno41a69812018-02-16 14:34:33 +0100633 if ip_profile.get('gateway_address'):
tierno55d234c2018-07-04 18:29:21 +0200634 subnet['gateway_ip'] = ip_profile['gateway_address']
635 else:
636 subnet['gateway_ip'] = None
garciadeblasedca7b32016-09-29 14:01:52 +0000637 if ip_profile.get('dns_address'):
tierno455612d2017-05-30 16:40:10 +0200638 subnet['dns_nameservers'] = ip_profile['dns_address'].split(";")
garciadeblas9f8456e2016-09-05 05:02:59 +0200639 if 'dhcp_enabled' in ip_profile:
tierno41a69812018-02-16 14:34:33 +0100640 subnet['enable_dhcp'] = False if \
tierno1ec592d2020-06-16 15:29:47 +0000641 ip_profile['dhcp_enabled'] == "false" or ip_profile['dhcp_enabled'] is False else True
tierno41a69812018-02-16 14:34:33 +0100642 if ip_profile.get('dhcp_start_address'):
tiernoa1fb4462017-06-30 12:25:50 +0200643 subnet['allocation_pools'] = []
garciadeblas9f8456e2016-09-05 05:02:59 +0200644 subnet['allocation_pools'].append(dict())
645 subnet['allocation_pools'][0]['start'] = ip_profile['dhcp_start_address']
tierno41a69812018-02-16 14:34:33 +0100646 if ip_profile.get('dhcp_count'):
tierno1ec592d2020-06-16 15:29:47 +0000647 # parts = ip_profile['dhcp_start_address'].split('.')
648 # ip_int = (int(parts[0]) << 24) + (int(parts[1]) << 16) + (int(parts[2]) << 8) + int(parts[3])
garciadeblas9f8456e2016-09-05 05:02:59 +0200649 ip_int = int(netaddr.IPAddress(ip_profile['dhcp_start_address']))
garciadeblas21d795b2016-09-29 17:31:46 +0200650 ip_int += ip_profile['dhcp_count'] - 1
garciadeblas9f8456e2016-09-05 05:02:59 +0200651 ip_str = str(netaddr.IPAddress(ip_int))
652 subnet['allocation_pools'][0]['end'] = ip_str
tierno1ec592d2020-06-16 15:29:47 +0000653 # self.logger.debug(">>>>>>>>>>>>>>>>>> Subnet: %s", str(subnet))
654 self.neutron.create_subnet({"subnet": subnet})
garciadeblasebd66722019-01-31 16:01:31 +0000655
656 if net_type == "data" and self.config.get('multisegment_support'):
657 if self.config.get('l2gw_support'):
658 l2gw_list = self.neutron.list_l2_gateways().get("l2_gateways", ())
659 for l2gw in l2gw_list:
tierno1ec592d2020-06-16 15:29:47 +0000660 l2gw_conn = {
661 "l2_gateway_id": l2gw["id"],
662 "network_id": new_net["network"]["id"],
663 "segmentation_id": str(vlanID),
664 }
garciadeblasebd66722019-01-31 16:01:31 +0000665 new_l2gw_conn = self.neutron.create_l2_gateway_connection({"l2_gateway_connection": l2gw_conn})
666 created_items["l2gwconn:" + str(new_l2gw_conn["l2_gateway_connection"]["id"])] = True
667 return new_net["network"]["id"], created_items
tierno41a69812018-02-16 14:34:33 +0100668 except Exception as e:
tierno1ec592d2020-06-16 15:29:47 +0000669 # delete l2gw connections (if any) before deleting the network
garciadeblasebd66722019-01-31 16:01:31 +0000670 for k, v in created_items.items():
671 if not v: # skip already deleted
672 continue
673 try:
674 k_item, _, k_id = k.partition(":")
675 if k_item == "l2gwconn":
676 self.neutron.delete_l2_gateway_connection(k_id)
677 except Exception as e2:
678 self.logger.error("Error deleting l2 gateway connection: {}: {}".format(type(e2).__name__, e2))
garciadeblasedca7b32016-09-29 14:01:52 +0000679 if new_net:
680 self.neutron.delete_network(new_net['network']['id'])
tiernoae4a8d12016-07-08 12:30:39 +0200681 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +0100682
683 def get_network_list(self, filter_dict={}):
tierno1ec592d2020-06-16 15:29:47 +0000684 """Obtain tenant networks of VIM
tierno7edb6752016-03-21 17:37:52 +0100685 Filter_dict can be:
686 name: network name
687 id: network uuid
688 shared: boolean
689 tenant_id: tenant
690 admin_state_up: boolean
691 status: 'ACTIVE'
692 Returns the network list of dictionaries
tierno1ec592d2020-06-16 15:29:47 +0000693 """
tiernoae4a8d12016-07-08 12:30:39 +0200694 self.logger.debug("Getting network from VIM filter: '%s'", str(filter_dict))
tierno7edb6752016-03-21 17:37:52 +0100695 try:
696 self._reload_connection()
tierno69b590e2018-03-13 18:52:23 +0100697 filter_dict_os = filter_dict.copy()
698 if self.api_version3 and "tenant_id" in filter_dict_os:
tierno1ec592d2020-06-16 15:29:47 +0000699 filter_dict_os['project_id'] = filter_dict_os.pop('tenant_id') # TODO check
tierno69b590e2018-03-13 18:52:23 +0100700 net_dict = self.neutron.list_networks(**filter_dict_os)
tierno00e3df72017-11-29 17:20:13 +0100701 net_list = net_dict["networks"]
tierno7edb6752016-03-21 17:37:52 +0100702 self.__net_os2mano(net_list)
tiernoae4a8d12016-07-08 12:30:39 +0200703 return net_list
tierno1ec592d2020-06-16 15:29:47 +0000704 except (neExceptions.ConnectionFailed, ksExceptions.ClientException, neExceptions.NeutronException,
705 ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +0200706 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +0100707
tiernoae4a8d12016-07-08 12:30:39 +0200708 def get_network(self, net_id):
tierno1ec592d2020-06-16 15:29:47 +0000709 """Obtain details of network from VIM
710 Returns the network information from a network id"""
tiernoae4a8d12016-07-08 12:30:39 +0200711 self.logger.debug(" Getting tenant network %s from VIM", net_id)
tierno1ec592d2020-06-16 15:29:47 +0000712 filter_dict = {"id": net_id}
tiernoae4a8d12016-07-08 12:30:39 +0200713 net_list = self.get_network_list(filter_dict)
tierno1ec592d2020-06-16 15:29:47 +0000714 if len(net_list) == 0:
tierno72774862020-05-04 11:44:15 +0000715 raise vimconn.VimConnNotFoundException("Network '{}' not found".format(net_id))
tierno1ec592d2020-06-16 15:29:47 +0000716 elif len(net_list) > 1:
tierno72774862020-05-04 11:44:15 +0000717 raise vimconn.VimConnConflictException("Found more than one network with this criteria")
tierno7edb6752016-03-21 17:37:52 +0100718 net = net_list[0]
tierno1ec592d2020-06-16 15:29:47 +0000719 subnets = []
720 for subnet_id in net.get("subnets", ()):
tierno7edb6752016-03-21 17:37:52 +0100721 try:
722 subnet = self.neutron.show_subnet(subnet_id)
723 except Exception as e:
tiernoae4a8d12016-07-08 12:30:39 +0200724 self.logger.error("osconnector.get_network(): Error getting subnet %s %s" % (net_id, str(e)))
725 subnet = {"id": subnet_id, "fault": str(e)}
tierno7edb6752016-03-21 17:37:52 +0100726 subnets.append(subnet)
727 net["subnets"] = subnets
Pablo Montes Moreno51e553b2017-03-23 16:39:12 +0100728 net["encapsulation"] = net.get('provider:network_type')
Anderson Bravalheri0fb70282018-12-16 19:28:37 +0000729 net["encapsulation_type"] = net.get('provider:network_type')
Pablo Montes Moreno3fbff9b2017-03-08 11:28:15 +0100730 net["segmentation_id"] = net.get('provider:segmentation_id')
Anderson Bravalheri0fb70282018-12-16 19:28:37 +0000731 net["encapsulation_id"] = net.get('provider:segmentation_id')
tiernoae4a8d12016-07-08 12:30:39 +0200732 return net
tierno7edb6752016-03-21 17:37:52 +0100733
garciadeblasebd66722019-01-31 16:01:31 +0000734 def delete_network(self, net_id, created_items=None):
735 """
736 Removes a tenant network from VIM and its associated elements
737 :param net_id: VIM identifier of the network, provided by method new_network
738 :param created_items: dictionary with extra items to be deleted. provided by method new_network
739 Returns the network identifier or raises an exception upon error or when network is not found
740 """
tiernoae4a8d12016-07-08 12:30:39 +0200741 self.logger.debug("Deleting network '%s' from VIM", net_id)
tierno1ec592d2020-06-16 15:29:47 +0000742 if created_items is None:
garciadeblasebd66722019-01-31 16:01:31 +0000743 created_items = {}
tierno7edb6752016-03-21 17:37:52 +0100744 try:
745 self._reload_connection()
tierno1ec592d2020-06-16 15:29:47 +0000746 # delete l2gw connections (if any) before deleting the network
garciadeblasebd66722019-01-31 16:01:31 +0000747 for k, v in created_items.items():
748 if not v: # skip already deleted
749 continue
750 try:
751 k_item, _, k_id = k.partition(":")
752 if k_item == "l2gwconn":
753 self.neutron.delete_l2_gateway_connection(k_id)
754 except Exception as e:
755 self.logger.error("Error deleting l2 gateway connection: {}: {}".format(type(e).__name__, e))
tierno1ec592d2020-06-16 15:29:47 +0000756 # delete VM ports attached to this networks before the network
tierno7edb6752016-03-21 17:37:52 +0100757 ports = self.neutron.list_ports(network_id=net_id)
758 for p in ports['ports']:
759 try:
760 self.neutron.delete_port(p["id"])
761 except Exception as e:
tiernoae4a8d12016-07-08 12:30:39 +0200762 self.logger.error("Error deleting port %s: %s", p["id"], str(e))
tierno7edb6752016-03-21 17:37:52 +0100763 self.neutron.delete_network(net_id)
tiernoae4a8d12016-07-08 12:30:39 +0200764 return net_id
765 except (neExceptions.ConnectionFailed, neExceptions.NetworkNotFoundClient, neExceptions.NeutronException,
tierno8e995ce2016-09-22 08:13:00 +0000766 ksExceptions.ClientException, neExceptions.NeutronException, ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +0200767 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +0100768
tiernoae4a8d12016-07-08 12:30:39 +0200769 def refresh_nets_status(self, net_list):
tierno1ec592d2020-06-16 15:29:47 +0000770 """Get the status of the networks
tiernoae4a8d12016-07-08 12:30:39 +0200771 Params: the list of network identifiers
772 Returns a dictionary with:
773 net_id: #VIM id of this network
774 status: #Mandatory. Text with one of:
775 # DELETED (not found at vim)
Anderson Bravalheri0446cd52018-08-17 15:26:19 +0100776 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
tiernoae4a8d12016-07-08 12:30:39 +0200777 # OTHER (Vim reported other status not understood)
778 # ERROR (VIM indicates an ERROR status)
Anderson Bravalheri0446cd52018-08-17 15:26:19 +0100779 # ACTIVE, INACTIVE, DOWN (admin down),
tiernoae4a8d12016-07-08 12:30:39 +0200780 # BUILD (on building process)
781 #
Anderson Bravalheri0446cd52018-08-17 15:26:19 +0100782 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
tiernoae4a8d12016-07-08 12:30:39 +0200783 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
784
tierno1ec592d2020-06-16 15:29:47 +0000785 """
786 net_dict = {}
tiernoae4a8d12016-07-08 12:30:39 +0200787 for net_id in net_list:
788 net = {}
789 try:
790 net_vim = self.get_network(net_id)
791 if net_vim['status'] in netStatus2manoFormat:
tierno1ec592d2020-06-16 15:29:47 +0000792 net["status"] = netStatus2manoFormat[net_vim['status']]
tiernoae4a8d12016-07-08 12:30:39 +0200793 else:
794 net["status"] = "OTHER"
795 net["error_msg"] = "VIM status reported " + net_vim['status']
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +0000796
tierno8e995ce2016-09-22 08:13:00 +0000797 if net['status'] == "ACTIVE" and not net_vim['admin_state_up']:
tiernoae4a8d12016-07-08 12:30:39 +0200798 net['status'] = 'DOWN'
Anderson Bravalheri0446cd52018-08-17 15:26:19 +0100799
800 net['vim_info'] = self.serialize(net_vim)
801
tierno1ec592d2020-06-16 15:29:47 +0000802 if net_vim.get('fault'): # TODO
tiernoae4a8d12016-07-08 12:30:39 +0200803 net['error_msg'] = str(net_vim['fault'])
tierno72774862020-05-04 11:44:15 +0000804 except vimconn.VimConnNotFoundException as e:
tiernoae4a8d12016-07-08 12:30:39 +0200805 self.logger.error("Exception getting net status: %s", str(e))
806 net['status'] = "DELETED"
807 net['error_msg'] = str(e)
tierno72774862020-05-04 11:44:15 +0000808 except vimconn.VimConnException as e:
tiernoae4a8d12016-07-08 12:30:39 +0200809 self.logger.error("Exception getting net status: %s", str(e))
810 net['status'] = "VIM_ERROR"
811 net['error_msg'] = str(e)
812 net_dict[net_id] = net
813 return net_dict
814
815 def get_flavor(self, flavor_id):
tierno1ec592d2020-06-16 15:29:47 +0000816 """Obtain flavor details from the VIM. Returns the flavor dict details"""
tiernoae4a8d12016-07-08 12:30:39 +0200817 self.logger.debug("Getting flavor '%s'", flavor_id)
tierno7edb6752016-03-21 17:37:52 +0100818 try:
819 self._reload_connection()
820 flavor = self.nova.flavors.find(id=flavor_id)
tierno1ec592d2020-06-16 15:29:47 +0000821 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
tiernoae4a8d12016-07-08 12:30:39 +0200822 return flavor.to_dict()
tierno1ec592d2020-06-16 15:29:47 +0000823 except (nvExceptions.NotFound, nvExceptions.ClientException, ksExceptions.ClientException,
824 ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +0200825 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +0100826
tiernocf157a82017-01-30 14:07:06 +0100827 def get_flavor_id_from_data(self, flavor_dict):
828 """Obtain flavor id that match the flavor description
829 Returns the flavor_id or raises a vimconnNotFoundException
tiernoe26fc7a2017-05-30 14:43:03 +0200830 flavor_dict: contains the required ram, vcpus, disk
831 If 'use_existing_flavors' is set to True at config, the closer flavor that provides same or more ram, vcpus
832 and disk is returned. Otherwise a flavor with exactly same ram, vcpus and disk is returned or a
833 vimconnNotFoundException is raised
tiernocf157a82017-01-30 14:07:06 +0100834 """
tiernoe26fc7a2017-05-30 14:43:03 +0200835 exact_match = False if self.config.get('use_existing_flavors') else True
tiernocf157a82017-01-30 14:07:06 +0100836 try:
837 self._reload_connection()
tiernoe26fc7a2017-05-30 14:43:03 +0200838 flavor_candidate_id = None
839 flavor_candidate_data = (10000, 10000, 10000)
840 flavor_target = (flavor_dict["ram"], flavor_dict["vcpus"], flavor_dict["disk"])
841 # numa=None
anwarsae5f52c2019-04-22 10:35:27 +0530842 extended = flavor_dict.get("extended", {})
843 if extended:
tierno1ec592d2020-06-16 15:29:47 +0000844 # TODO
tierno72774862020-05-04 11:44:15 +0000845 raise vimconn.VimConnNotFoundException("Flavor with EPA still not implemented")
tiernocf157a82017-01-30 14:07:06 +0100846 # if len(numas) > 1:
tierno72774862020-05-04 11:44:15 +0000847 # raise vimconn.VimConnNotFoundException("Cannot find any flavor with more than one numa")
tiernocf157a82017-01-30 14:07:06 +0100848 # numa=numas[0]
849 # numas = extended.get("numas")
850 for flavor in self.nova.flavors.list():
851 epa = flavor.get_keys()
852 if epa:
853 continue
tiernoe26fc7a2017-05-30 14:43:03 +0200854 # TODO
855 flavor_data = (flavor.ram, flavor.vcpus, flavor.disk)
856 if flavor_data == flavor_target:
857 return flavor.id
858 elif not exact_match and flavor_target < flavor_data < flavor_candidate_data:
859 flavor_candidate_id = flavor.id
860 flavor_candidate_data = flavor_data
861 if not exact_match and flavor_candidate_id:
862 return flavor_candidate_id
tierno1ec592d2020-06-16 15:29:47 +0000863 raise vimconn.VimConnNotFoundException("Cannot find any flavor matching '{}'".format(flavor_dict))
864 except (nvExceptions.NotFound, nvExceptions.ClientException, ksExceptions.ClientException,
865 ConnectionError) as e:
tiernocf157a82017-01-30 14:07:06 +0100866 self._format_exception(e)
867
anwarsae5f52c2019-04-22 10:35:27 +0530868 def process_resource_quota(self, quota, prefix, extra_specs):
869 """
870 :param prefix:
borsatti8a2dda32019-12-18 15:08:57 +0000871 :param extra_specs:
anwarsae5f52c2019-04-22 10:35:27 +0530872 :return:
873 """
874 if 'limit' in quota:
875 extra_specs["quota:" + prefix + "_limit"] = quota['limit']
876 if 'reserve' in quota:
877 extra_specs["quota:" + prefix + "_reservation"] = quota['reserve']
878 if 'shares' in quota:
879 extra_specs["quota:" + prefix + "_shares_level"] = "custom"
880 extra_specs["quota:" + prefix + "_shares_share"] = quota['shares']
881
tiernoae4a8d12016-07-08 12:30:39 +0200882 def new_flavor(self, flavor_data, change_name_if_used=True):
tierno1ec592d2020-06-16 15:29:47 +0000883 """Adds a tenant flavor to openstack VIM
884 if change_name_if_used is True, it will change name in case of conflict, because it is not supported name
885 repetition
tierno7edb6752016-03-21 17:37:52 +0100886 Returns the flavor identifier
tierno1ec592d2020-06-16 15:29:47 +0000887 """
tiernoae4a8d12016-07-08 12:30:39 +0200888 self.logger.debug("Adding flavor '%s'", str(flavor_data))
tierno1ec592d2020-06-16 15:29:47 +0000889 retry = 0
890 max_retries = 3
tierno7edb6752016-03-21 17:37:52 +0100891 name_suffix = 0
anwarsc76a3ee2018-10-04 14:05:32 +0530892 try:
tierno1ec592d2020-06-16 15:29:47 +0000893 name = flavor_data['name']
894 while retry < max_retries:
895 retry += 1
anwarsc76a3ee2018-10-04 14:05:32 +0530896 try:
897 self._reload_connection()
898 if change_name_if_used:
tierno1ec592d2020-06-16 15:29:47 +0000899 # get used names
900 fl_names = []
901 fl = self.nova.flavors.list()
anwarsc76a3ee2018-10-04 14:05:32 +0530902 for f in fl:
903 fl_names.append(f.name)
904 while name in fl_names:
905 name_suffix += 1
906 name = flavor_data['name']+"-" + str(name_suffix)
kate721d79b2017-06-24 04:21:38 -0700907
tierno1ec592d2020-06-16 15:29:47 +0000908 ram = flavor_data.get('ram', 64)
909 vcpus = flavor_data.get('vcpus', 1)
910 extra_specs = {}
tierno7edb6752016-03-21 17:37:52 +0100911
anwarsc76a3ee2018-10-04 14:05:32 +0530912 extended = flavor_data.get("extended")
913 if extended:
tierno1ec592d2020-06-16 15:29:47 +0000914 numas = extended.get("numas")
anwarsc76a3ee2018-10-04 14:05:32 +0530915 if numas:
916 numa_nodes = len(numas)
917 if numa_nodes > 1:
918 return -1, "Can not add flavor with more than one numa"
anwarsae5f52c2019-04-22 10:35:27 +0530919 extra_specs["hw:numa_nodes"] = str(numa_nodes)
920 extra_specs["hw:mem_page_size"] = "large"
921 extra_specs["hw:cpu_policy"] = "dedicated"
922 extra_specs["hw:numa_mempolicy"] = "strict"
anwarsc76a3ee2018-10-04 14:05:32 +0530923 if self.vim_type == "VIO":
anwarsae5f52c2019-04-22 10:35:27 +0530924 extra_specs["vmware:extra_config"] = '{"numa.nodeAffinity":"0"}'
925 extra_specs["vmware:latency_sensitivity_level"] = "high"
anwarsc76a3ee2018-10-04 14:05:32 +0530926 for numa in numas:
tierno1ec592d2020-06-16 15:29:47 +0000927 # overwrite ram and vcpus
928 # check if key 'memory' is present in numa else use ram value at flavor
anwarsc76a3ee2018-10-04 14:05:32 +0530929 if 'memory' in numa:
930 ram = numa['memory']*1024
tierno1ec592d2020-06-16 15:29:47 +0000931 # See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/
932 # implemented/virt-driver-cpu-thread-pinning.html
garciadeblasfa35a722019-04-11 19:15:49 +0200933 extra_specs["hw:cpu_sockets"] = 1
anwarsc76a3ee2018-10-04 14:05:32 +0530934 if 'paired-threads' in numa:
935 vcpus = numa['paired-threads']*2
tierno1ec592d2020-06-16 15:29:47 +0000936 # cpu_thread_policy "require" implies that the compute node must have an
937 # STM architecture
anwarsae5f52c2019-04-22 10:35:27 +0530938 extra_specs["hw:cpu_thread_policy"] = "require"
939 extra_specs["hw:cpu_policy"] = "dedicated"
anwarsc76a3ee2018-10-04 14:05:32 +0530940 elif 'cores' in numa:
941 vcpus = numa['cores']
tierno1ec592d2020-06-16 15:29:47 +0000942 # cpu_thread_policy "prefer" implies that the host must not have an SMT
943 # architecture, or a non-SMT architecture will be emulated
anwarsae5f52c2019-04-22 10:35:27 +0530944 extra_specs["hw:cpu_thread_policy"] = "isolate"
945 extra_specs["hw:cpu_policy"] = "dedicated"
anwarsc76a3ee2018-10-04 14:05:32 +0530946 elif 'threads' in numa:
947 vcpus = numa['threads']
tierno1ec592d2020-06-16 15:29:47 +0000948 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT
949 # architecture
anwarsae5f52c2019-04-22 10:35:27 +0530950 extra_specs["hw:cpu_thread_policy"] = "prefer"
951 extra_specs["hw:cpu_policy"] = "dedicated"
anwarsc76a3ee2018-10-04 14:05:32 +0530952 # for interface in numa.get("interfaces",() ):
953 # if interface["dedicated"]=="yes":
tierno1ec592d2020-06-16 15:29:47 +0000954 # raise vimconn.VimConnException("Passthrough interfaces are not supported
955 # for the openstack connector", http_code=vimconn.HTTP_Service_Unavailable)
956 # #TODO, add the key 'pci_passthrough:alias"="<label at config>:<number ifaces>"'
957 # when a way to connect it is available
anwarsae5f52c2019-04-22 10:35:27 +0530958 elif extended.get("cpu-quota"):
959 self.process_resource_quota(extended.get("cpu-quota"), "cpu", extra_specs)
960 if extended.get("mem-quota"):
961 self.process_resource_quota(extended.get("mem-quota"), "memory", extra_specs)
962 if extended.get("vif-quota"):
963 self.process_resource_quota(extended.get("vif-quota"), "vif", extra_specs)
964 if extended.get("disk-io-quota"):
965 self.process_resource_quota(extended.get("disk-io-quota"), "disk_io", extra_specs)
tierno1ec592d2020-06-16 15:29:47 +0000966 # create flavor
967 new_flavor = self.nova.flavors.create(name,
968 ram,
969 vcpus,
970 flavor_data.get('disk', 0),
971 is_public=flavor_data.get('is_public', True)
972 )
973 # add metadata
anwarsae5f52c2019-04-22 10:35:27 +0530974 if extra_specs:
975 new_flavor.set_keys(extra_specs)
anwarsc76a3ee2018-10-04 14:05:32 +0530976 return new_flavor.id
977 except nvExceptions.Conflict as e:
978 if change_name_if_used and retry < max_retries:
979 continue
980 self._format_exception(e)
tierno1ec592d2020-06-16 15:29:47 +0000981 # except nvExceptions.BadRequest as e:
anwarsc76a3ee2018-10-04 14:05:32 +0530982 except (ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError, KeyError) as e:
983 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +0100984
tierno1ec592d2020-06-16 15:29:47 +0000985 def delete_flavor(self, flavor_id):
986 """Deletes a tenant flavor from openstack VIM. Returns the old flavor_id
987 """
tiernoae4a8d12016-07-08 12:30:39 +0200988 try:
989 self._reload_connection()
990 self.nova.flavors.delete(flavor_id)
991 return flavor_id
tierno1ec592d2020-06-16 15:29:47 +0000992 # except nvExceptions.BadRequest as e:
993 except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException,
994 ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +0200995 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +0100996
tierno1ec592d2020-06-16 15:29:47 +0000997 def new_image(self, image_dict):
998 """
tiernoae4a8d12016-07-08 12:30:39 +0200999 Adds a tenant image to VIM. imge_dict is a dictionary with:
1000 name: name
1001 disk_format: qcow2, vhd, vmdk, raw (by default), ...
1002 location: path or URI
1003 public: "yes" or "no"
1004 metadata: metadata of the image
1005 Returns the image_id
tierno1ec592d2020-06-16 15:29:47 +00001006 """
1007 retry = 0
1008 max_retries = 3
1009 while retry < max_retries:
1010 retry += 1
tierno7edb6752016-03-21 17:37:52 +01001011 try:
1012 self._reload_connection()
tierno1ec592d2020-06-16 15:29:47 +00001013 # determine format http://docs.openstack.org/developer/glance/formats.html
tierno7edb6752016-03-21 17:37:52 +01001014 if "disk_format" in image_dict:
tierno1ec592d2020-06-16 15:29:47 +00001015 disk_format = image_dict["disk_format"]
1016 else: # autodiscover based on extension
tierno1beea862018-07-11 15:47:37 +02001017 if image_dict['location'].endswith(".qcow2"):
tierno1ec592d2020-06-16 15:29:47 +00001018 disk_format = "qcow2"
tierno1beea862018-07-11 15:47:37 +02001019 elif image_dict['location'].endswith(".vhd"):
tierno1ec592d2020-06-16 15:29:47 +00001020 disk_format = "vhd"
tierno1beea862018-07-11 15:47:37 +02001021 elif image_dict['location'].endswith(".vmdk"):
tierno1ec592d2020-06-16 15:29:47 +00001022 disk_format = "vmdk"
tierno1beea862018-07-11 15:47:37 +02001023 elif image_dict['location'].endswith(".vdi"):
tierno1ec592d2020-06-16 15:29:47 +00001024 disk_format = "vdi"
tierno1beea862018-07-11 15:47:37 +02001025 elif image_dict['location'].endswith(".iso"):
tierno1ec592d2020-06-16 15:29:47 +00001026 disk_format = "iso"
tierno1beea862018-07-11 15:47:37 +02001027 elif image_dict['location'].endswith(".aki"):
tierno1ec592d2020-06-16 15:29:47 +00001028 disk_format = "aki"
tierno1beea862018-07-11 15:47:37 +02001029 elif image_dict['location'].endswith(".ari"):
tierno1ec592d2020-06-16 15:29:47 +00001030 disk_format = "ari"
tierno1beea862018-07-11 15:47:37 +02001031 elif image_dict['location'].endswith(".ami"):
tierno1ec592d2020-06-16 15:29:47 +00001032 disk_format = "ami"
tierno7edb6752016-03-21 17:37:52 +01001033 else:
tierno1ec592d2020-06-16 15:29:47 +00001034 disk_format = "raw"
tiernoae4a8d12016-07-08 12:30:39 +02001035 self.logger.debug("new_image: '%s' loading from '%s'", image_dict['name'], image_dict['location'])
shashankjain3c83a212018-10-04 13:05:46 +05301036 if self.vim_type == "VIO":
1037 container_format = "bare"
1038 if 'container_format' in image_dict:
1039 container_format = image_dict['container_format']
1040 new_image = self.glance.images.create(name=image_dict['name'], container_format=container_format,
1041 disk_format=disk_format)
1042 else:
1043 new_image = self.glance.images.create(name=image_dict['name'])
tierno1beea862018-07-11 15:47:37 +02001044 if image_dict['location'].startswith("http"):
1045 # TODO there is not a method to direct download. It must be downloaded locally with requests
tierno72774862020-05-04 11:44:15 +00001046 raise vimconn.VimConnNotImplemented("Cannot create image from URL")
tierno1ec592d2020-06-16 15:29:47 +00001047 else: # local path
tierno7edb6752016-03-21 17:37:52 +01001048 with open(image_dict['location']) as fimage:
tierno1beea862018-07-11 15:47:37 +02001049 self.glance.images.upload(new_image.id, fimage)
tierno1ec592d2020-06-16 15:29:47 +00001050 # new_image = self.glancev1.images.create(name=image_dict['name'], is_public=
1051 # image_dict.get('public',"yes")=="yes",
tierno1beea862018-07-11 15:47:37 +02001052 # container_format="bare", data=fimage, disk_format=disk_format)
tierno7edb6752016-03-21 17:37:52 +01001053 metadata_to_load = image_dict.get('metadata')
tierno1ec592d2020-06-16 15:29:47 +00001054 # TODO location is a reserved word for current openstack versions. fixed for VIO please check
1055 # for openstack
shashankjain3c83a212018-10-04 13:05:46 +05301056 if self.vim_type == "VIO":
1057 metadata_to_load['upload_location'] = image_dict['location']
1058 else:
1059 metadata_to_load['location'] = image_dict['location']
tierno1beea862018-07-11 15:47:37 +02001060 self.glance.images.update(new_image.id, **metadata_to_load)
tiernoae4a8d12016-07-08 12:30:39 +02001061 return new_image.id
1062 except (nvExceptions.Conflict, ksExceptions.ClientException, nvExceptions.ClientException) as e:
1063 self._format_exception(e)
tierno8e995ce2016-09-22 08:13:00 +00001064 except (HTTPException, gl1Exceptions.HTTPException, gl1Exceptions.CommunicationError, ConnectionError) as e:
tierno1ec592d2020-06-16 15:29:47 +00001065 if retry == max_retries:
tiernoae4a8d12016-07-08 12:30:39 +02001066 continue
1067 self._format_exception(e)
tierno1ec592d2020-06-16 15:29:47 +00001068 except IOError as e: # can not open the file
1069 raise vimconn.VimConnConnectionException("{}: {} for {}".format(type(e).__name__, e,
1070 image_dict['location']),
tiernoae4a8d12016-07-08 12:30:39 +02001071 http_code=vimconn.HTTP_Bad_Request)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001072
tiernoae4a8d12016-07-08 12:30:39 +02001073 def delete_image(self, image_id):
tierno1ec592d2020-06-16 15:29:47 +00001074 """Deletes a tenant image from openstack VIM. Returns the old id
1075 """
tiernoae4a8d12016-07-08 12:30:39 +02001076 try:
1077 self._reload_connection()
tierno1beea862018-07-11 15:47:37 +02001078 self.glance.images.delete(image_id)
tiernoae4a8d12016-07-08 12:30:39 +02001079 return image_id
tierno1ec592d2020-06-16 15:29:47 +00001080 except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException,
1081 gl1Exceptions.CommunicationError, gl1Exceptions.HTTPNotFound, ConnectionError) as e: # TODO remove
tiernoae4a8d12016-07-08 12:30:39 +02001082 self._format_exception(e)
1083
1084 def get_image_id_from_path(self, path):
tierno1ec592d2020-06-16 15:29:47 +00001085 """Get the image id from image path in the VIM database. Returns the image_id"""
tiernoae4a8d12016-07-08 12:30:39 +02001086 try:
1087 self._reload_connection()
tierno1beea862018-07-11 15:47:37 +02001088 images = self.glance.images.list()
tiernoae4a8d12016-07-08 12:30:39 +02001089 for image in images:
tierno1ec592d2020-06-16 15:29:47 +00001090 if image.metadata.get("location") == path:
tiernoae4a8d12016-07-08 12:30:39 +02001091 return image.id
tierno1ec592d2020-06-16 15:29:47 +00001092 raise vimconn.VimConnNotFoundException("image with location '{}' not found".format(path))
1093 except (ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError,
1094 ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +02001095 self._format_exception(e)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001096
garciadeblasb69fa9f2016-09-28 12:04:10 +02001097 def get_image_list(self, filter_dict={}):
tierno1ec592d2020-06-16 15:29:47 +00001098 """Obtain tenant images from VIM
garciadeblasb69fa9f2016-09-28 12:04:10 +02001099 Filter_dict can be:
1100 id: image id
1101 name: image name
1102 checksum: image checksum
1103 Returns the image list of dictionaries:
1104 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1105 List can be empty
tierno1ec592d2020-06-16 15:29:47 +00001106 """
garciadeblasb69fa9f2016-09-28 12:04:10 +02001107 self.logger.debug("Getting image list from VIM filter: '%s'", str(filter_dict))
1108 try:
1109 self._reload_connection()
tierno1ec592d2020-06-16 15:29:47 +00001110 # filter_dict_os = filter_dict.copy()
1111 # First we filter by the available filter fields: name, id. The others are removed.
tierno1beea862018-07-11 15:47:37 +02001112 image_list = self.glance.images.list()
garciadeblasb69fa9f2016-09-28 12:04:10 +02001113 filtered_list = []
1114 for image in image_list:
tierno3cb8dc32017-10-24 18:13:19 +02001115 try:
tierno1beea862018-07-11 15:47:37 +02001116 if filter_dict.get("name") and image["name"] != filter_dict["name"]:
1117 continue
1118 if filter_dict.get("id") and image["id"] != filter_dict["id"]:
1119 continue
1120 if filter_dict.get("checksum") and image["checksum"] != filter_dict["checksum"]:
1121 continue
1122
1123 filtered_list.append(image.copy())
tierno3cb8dc32017-10-24 18:13:19 +02001124 except gl1Exceptions.HTTPNotFound:
1125 pass
garciadeblasb69fa9f2016-09-28 12:04:10 +02001126 return filtered_list
tierno1ec592d2020-06-16 15:29:47 +00001127 except (ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError,
1128 ConnectionError) as e:
garciadeblasb69fa9f2016-09-28 12:04:10 +02001129 self._format_exception(e)
1130
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001131 def __wait_for_vm(self, vm_id, status):
1132 """wait until vm is in the desired status and return True.
1133 If the VM gets in ERROR status, return false.
1134 If the timeout is reached generate an exception"""
1135 elapsed_time = 0
1136 while elapsed_time < server_timeout:
1137 vm_status = self.nova.servers.get(vm_id).status
1138 if vm_status == status:
1139 return True
1140 if vm_status == 'ERROR':
1141 return False
tierno1df468d2018-07-06 14:25:16 +02001142 time.sleep(5)
1143 elapsed_time += 5
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001144
1145 # if we exceeded the timeout rollback
1146 if elapsed_time >= server_timeout:
tierno72774862020-05-04 11:44:15 +00001147 raise vimconn.VimConnException('Timeout waiting for instance ' + vm_id + ' to get ' + status,
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001148 http_code=vimconn.HTTP_Request_Timeout)
1149
mirabal29356312017-07-27 12:21:22 +02001150 def _get_openstack_availablity_zones(self):
1151 """
1152 Get from openstack availability zones available
1153 :return:
1154 """
1155 try:
1156 openstack_availability_zone = self.nova.availability_zones.list()
1157 openstack_availability_zone = [str(zone.zoneName) for zone in openstack_availability_zone
1158 if zone.zoneName != 'internal']
1159 return openstack_availability_zone
tierno1ec592d2020-06-16 15:29:47 +00001160 except Exception:
mirabal29356312017-07-27 12:21:22 +02001161 return None
1162
1163 def _set_availablity_zones(self):
1164 """
1165 Set vim availablity zone
1166 :return:
1167 """
1168
1169 if 'availability_zone' in self.config:
1170 vim_availability_zones = self.config.get('availability_zone')
1171 if isinstance(vim_availability_zones, str):
1172 self.availability_zone = [vim_availability_zones]
1173 elif isinstance(vim_availability_zones, list):
1174 self.availability_zone = vim_availability_zones
1175 else:
1176 self.availability_zone = self._get_openstack_availablity_zones()
1177
tierno5a3273c2017-08-29 11:43:46 +02001178 def _get_vm_availability_zone(self, availability_zone_index, availability_zone_list):
mirabal29356312017-07-27 12:21:22 +02001179 """
tierno5a3273c2017-08-29 11:43:46 +02001180 Return thge availability zone to be used by the created VM.
1181 :return: The VIM availability zone to be used or None
mirabal29356312017-07-27 12:21:22 +02001182 """
tierno5a3273c2017-08-29 11:43:46 +02001183 if availability_zone_index is None:
1184 if not self.config.get('availability_zone'):
1185 return None
1186 elif isinstance(self.config.get('availability_zone'), str):
1187 return self.config['availability_zone']
1188 else:
1189 # TODO consider using a different parameter at config for default AV and AV list match
1190 return self.config['availability_zone'][0]
mirabal29356312017-07-27 12:21:22 +02001191
tierno5a3273c2017-08-29 11:43:46 +02001192 vim_availability_zones = self.availability_zone
1193 # check if VIM offer enough availability zones describe in the VNFD
1194 if vim_availability_zones and len(availability_zone_list) <= len(vim_availability_zones):
1195 # check if all the names of NFV AV match VIM AV names
1196 match_by_index = False
1197 for av in availability_zone_list:
1198 if av not in vim_availability_zones:
1199 match_by_index = True
1200 break
1201 if match_by_index:
1202 return vim_availability_zones[availability_zone_index]
1203 else:
1204 return availability_zone_list[availability_zone_index]
mirabal29356312017-07-27 12:21:22 +02001205 else:
tierno72774862020-05-04 11:44:15 +00001206 raise vimconn.VimConnConflictException("No enough availability zones at VIM for this deployment")
mirabal29356312017-07-27 12:21:22 +02001207
tierno5a3273c2017-08-29 11:43:46 +02001208 def new_vminstance(self, name, description, start, image_id, flavor_id, net_list, cloud_config=None, disk_list=None,
1209 availability_zone_index=None, availability_zone_list=None):
tierno98e909c2017-10-14 13:27:03 +02001210 """Adds a VM instance to VIM
tierno7edb6752016-03-21 17:37:52 +01001211 Params:
1212 start: indicates if VM must start or boot in pause mode. Ignored
1213 image_id,flavor_id: iamge and flavor uuid
1214 net_list: list of interfaces, each one is a dictionary with:
1215 name:
1216 net_id: network uuid to connect
1217 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
1218 model: interface model, ignored #TODO
1219 mac_address: used for SR-IOV ifaces #TODO for other types
1220 use: 'data', 'bridge', 'mgmt'
tierno66eba6e2017-11-10 17:09:18 +01001221 type: 'virtual', 'PCI-PASSTHROUGH'('PF'), 'SR-IOV'('VF'), 'VFnotShared'
tierno7edb6752016-03-21 17:37:52 +01001222 vim_id: filled/added by this function
ahmadsaf853d452016-12-22 11:33:47 +05001223 floating_ip: True/False (or it can be None)
tierno41a69812018-02-16 14:34:33 +01001224 'cloud_config': (optional) dictionary with:
tierno1d213f42020-04-24 14:02:51 +00001225 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
1226 'users': (optional) list of users to be inserted, each item is a dict with:
1227 'name': (mandatory) user name,
1228 'key-pairs': (optional) list of strings with the public key to be inserted to the user
1229 'user-data': (optional) string is a text script to be passed directly to cloud-init
1230 'config-files': (optional). List of files to be transferred. Each item is a dict with:
1231 'dest': (mandatory) string with the destination absolute path
1232 'encoding': (optional, by default text). Can be one of:
1233 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
1234 'content' (mandatory): string with the content of the file
1235 'permissions': (optional) string with file permissions, typically octal notation '0644'
1236 'owner': (optional) file owner, string with the format 'owner:group'
1237 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
mirabal29356312017-07-27 12:21:22 +02001238 'disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
1239 'image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
1240 'size': (mandatory) string with the size of the disk in GB
tierno1df468d2018-07-06 14:25:16 +02001241 'vim_id' (optional) should use this existing volume id
tierno5a3273c2017-08-29 11:43:46 +02001242 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
1243 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
1244 availability_zone_index is None
tierno7edb6752016-03-21 17:37:52 +01001245 #TODO ip, security groups
tierno98e909c2017-10-14 13:27:03 +02001246 Returns a tuple with the instance identifier and created_items or raises an exception on error
1247 created_items can be None or a dictionary where this method can include key-values that will be passed to
1248 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
1249 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
1250 as not present.
1251 """
tierno1ec592d2020-06-16 15:29:47 +00001252 self.logger.debug("new_vminstance input: image='%s' flavor='%s' nics='%s'", image_id, flavor_id, str(net_list))
tierno7edb6752016-03-21 17:37:52 +01001253 try:
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001254 server = None
tierno98e909c2017-10-14 13:27:03 +02001255 created_items = {}
tiernob0b9dab2017-10-14 14:25:20 +02001256 # metadata = {}
tierno98e909c2017-10-14 13:27:03 +02001257 net_list_vim = []
tierno1ec592d2020-06-16 15:29:47 +00001258 external_network = []
1259 # ^list of external networks to be connected to instance, later on used to create floating_ip
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001260 no_secured_ports = [] # List of port-is with port-security disabled
tierno7edb6752016-03-21 17:37:52 +01001261 self._reload_connection()
tiernob0b9dab2017-10-14 14:25:20 +02001262 # metadata_vpci = {} # For a specific neutron plugin
tiernob84cbdc2017-07-07 14:30:30 +02001263 block_device_mapping = None
tiernoa05b65a2019-02-01 12:30:27 +00001264
tierno7edb6752016-03-21 17:37:52 +01001265 for net in net_list:
tierno98e909c2017-10-14 13:27:03 +02001266 if not net.get("net_id"): # skip non connected iface
tierno7edb6752016-03-21 17:37:52 +01001267 continue
Pablo Montes Moreno3be0b2a2017-03-30 13:22:15 +02001268
tiernoa05b65a2019-02-01 12:30:27 +00001269 port_dict = {
Pablo Montes Moreno3be0b2a2017-03-30 13:22:15 +02001270 "network_id": net["net_id"],
1271 "name": net.get("name"),
1272 "admin_state_up": True
1273 }
tiernoa05b65a2019-02-01 12:30:27 +00001274 if self.config.get("security_groups") and net.get("port_security") is not False and \
1275 not self.config.get("no_port_security_extension"):
1276 if not self.security_groups_id:
1277 self._get_ids_from_name()
1278 port_dict["security_groups"] = self.security_groups_id
1279
tierno1ec592d2020-06-16 15:29:47 +00001280 if net["type"] == "virtual":
tiernob0b9dab2017-10-14 14:25:20 +02001281 pass
1282 # if "vpci" in net:
1283 # metadata_vpci[ net["net_id"] ] = [[ net["vpci"], "" ]]
tierno66eba6e2017-11-10 17:09:18 +01001284 elif net["type"] == "VF" or net["type"] == "SR-IOV": # for VF
tiernob0b9dab2017-10-14 14:25:20 +02001285 # if "vpci" in net:
1286 # if "VF" not in metadata_vpci:
1287 # metadata_vpci["VF"]=[]
1288 # metadata_vpci["VF"].append([ net["vpci"], "" ])
tierno1ec592d2020-06-16 15:29:47 +00001289 port_dict["binding:vnic_type"] = "direct"
tiernob0b9dab2017-10-14 14:25:20 +02001290 # VIO specific Changes
kate721d79b2017-06-24 04:21:38 -07001291 if self.vim_type == "VIO":
tiernob0b9dab2017-10-14 14:25:20 +02001292 # Need to create port with port_security_enabled = False and no-security-groups
tierno1ec592d2020-06-16 15:29:47 +00001293 port_dict["port_security_enabled"] = False
1294 port_dict["provider_security_groups"] = []
1295 port_dict["security_groups"] = []
tierno66eba6e2017-11-10 17:09:18 +01001296 else: # For PT PCI-PASSTHROUGH
tiernob0b9dab2017-10-14 14:25:20 +02001297 # if "vpci" in net:
1298 # if "PF" not in metadata_vpci:
1299 # metadata_vpci["PF"]=[]
1300 # metadata_vpci["PF"].append([ net["vpci"], "" ])
tierno1ec592d2020-06-16 15:29:47 +00001301 port_dict["binding:vnic_type"] = "direct-physical"
Pablo Montes Moreno3be0b2a2017-03-30 13:22:15 +02001302 if not port_dict["name"]:
tierno1ec592d2020-06-16 15:29:47 +00001303 port_dict["name"] = name
Pablo Montes Moreno3be0b2a2017-03-30 13:22:15 +02001304 if net.get("mac_address"):
tierno1ec592d2020-06-16 15:29:47 +00001305 port_dict["mac_address"] = net["mac_address"]
tierno41a69812018-02-16 14:34:33 +01001306 if net.get("ip_address"):
1307 port_dict["fixed_ips"] = [{'ip_address': net["ip_address"]}]
1308 # TODO add 'subnet_id': <subnet_id>
tierno1ec592d2020-06-16 15:29:47 +00001309 new_port = self.neutron.create_port({"port": port_dict})
tierno00e3df72017-11-29 17:20:13 +01001310 created_items["port:" + str(new_port["port"]["id"])] = True
Pablo Montes Moreno3be0b2a2017-03-30 13:22:15 +02001311 net["mac_adress"] = new_port["port"]["mac_address"]
1312 net["vim_id"] = new_port["port"]["id"]
tiernob84cbdc2017-07-07 14:30:30 +02001313 # if try to use a network without subnetwork, it will return a emtpy list
1314 fixed_ips = new_port["port"].get("fixed_ips")
1315 if fixed_ips:
1316 net["ip"] = fixed_ips[0].get("ip_address")
1317 else:
1318 net["ip"] = None
montesmoreno994a29d2017-08-22 11:23:06 +02001319
1320 port = {"port-id": new_port["port"]["id"]}
1321 if float(self.nova.api_version.get_string()) >= 2.32:
1322 port["tag"] = new_port["port"]["name"]
1323 net_list_vim.append(port)
Pablo Montes Moreno3be0b2a2017-03-30 13:22:15 +02001324
ahmadsaf853d452016-12-22 11:33:47 +05001325 if net.get('floating_ip', False):
tiernof8383b82017-01-18 15:49:48 +01001326 net['exit_on_floating_ip_error'] = True
ahmadsaf853d452016-12-22 11:33:47 +05001327 external_network.append(net)
tiernof8383b82017-01-18 15:49:48 +01001328 elif net['use'] == 'mgmt' and self.config.get('use_floating_ip'):
1329 net['exit_on_floating_ip_error'] = False
1330 external_network.append(net)
tierno326fd5e2018-02-22 11:58:59 +01001331 net['floating_ip'] = self.config.get('use_floating_ip')
tiernof8383b82017-01-18 15:49:48 +01001332
tierno1ec592d2020-06-16 15:29:47 +00001333 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic
1334 # is dropped.
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001335 # As a workaround we wait until the VM is active and then disable the port-security
tierno1ec592d2020-06-16 15:29:47 +00001336 if net.get("port_security") is False and not self.config.get("no_port_security_extension"):
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001337 no_secured_ports.append(new_port["port"]["id"])
1338
tiernob0b9dab2017-10-14 14:25:20 +02001339 # if metadata_vpci:
1340 # metadata = {"pci_assignement": json.dumps(metadata_vpci)}
1341 # if len(metadata["pci_assignement"]) >255:
1342 # #limit the metadata size
1343 # #metadata["pci_assignement"] = metadata["pci_assignement"][0:255]
1344 # self.logger.warn("Metadata deleted since it exceeds the expected length (255) ")
1345 # metadata = {}
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001346
tiernob0b9dab2017-10-14 14:25:20 +02001347 self.logger.debug("name '%s' image_id '%s'flavor_id '%s' net_list_vim '%s' description '%s'",
1348 name, image_id, flavor_id, str(net_list_vim), description)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001349
tierno98e909c2017-10-14 13:27:03 +02001350 # cloud config
tierno0a1437e2017-10-02 00:17:43 +02001351 config_drive, userdata = self._create_user_data(cloud_config)
montesmoreno0c8def02016-12-22 12:16:23 +00001352
tierno98e909c2017-10-14 13:27:03 +02001353 # Create additional volumes in case these are present in disk_list
montesmoreno0c8def02016-12-22 12:16:23 +00001354 base_disk_index = ord('b')
tierno1df468d2018-07-06 14:25:16 +02001355 if disk_list:
tiernob84cbdc2017-07-07 14:30:30 +02001356 block_device_mapping = {}
montesmoreno0c8def02016-12-22 12:16:23 +00001357 for disk in disk_list:
tierno1df468d2018-07-06 14:25:16 +02001358 if disk.get('vim_id'):
1359 block_device_mapping['_vd' + chr(base_disk_index)] = disk['vim_id']
montesmoreno0c8def02016-12-22 12:16:23 +00001360 else:
tierno1df468d2018-07-06 14:25:16 +02001361 if 'image_id' in disk:
1362 volume = self.cinder.volumes.create(size=disk['size'], name=name + '_vd' +
1363 chr(base_disk_index), imageRef=disk['image_id'])
1364 else:
1365 volume = self.cinder.volumes.create(size=disk['size'], name=name + '_vd' +
1366 chr(base_disk_index))
1367 created_items["volume:" + str(volume.id)] = True
1368 block_device_mapping['_vd' + chr(base_disk_index)] = volume.id
montesmoreno0c8def02016-12-22 12:16:23 +00001369 base_disk_index += 1
1370
tierno1df468d2018-07-06 14:25:16 +02001371 # Wait until created volumes are with status available
montesmoreno0c8def02016-12-22 12:16:23 +00001372 elapsed_time = 0
tierno1df468d2018-07-06 14:25:16 +02001373 while elapsed_time < volume_timeout:
1374 for created_item in created_items:
1375 v, _, volume_id = created_item.partition(":")
1376 if v == 'volume':
1377 if self.cinder.volumes.get(volume_id).status != 'available':
1378 break
1379 else: # all ready: break from while
1380 break
1381 time.sleep(5)
1382 elapsed_time += 5
tiernob0b9dab2017-10-14 14:25:20 +02001383 # If we exceeded the timeout rollback
montesmoreno0c8def02016-12-22 12:16:23 +00001384 if elapsed_time >= volume_timeout:
tierno72774862020-05-04 11:44:15 +00001385 raise vimconn.VimConnException('Timeout creating volumes for instance ' + name,
montesmoreno0c8def02016-12-22 12:16:23 +00001386 http_code=vimconn.HTTP_Request_Timeout)
mirabal29356312017-07-27 12:21:22 +02001387 # get availability Zone
tierno5a3273c2017-08-29 11:43:46 +02001388 vm_av_zone = self._get_vm_availability_zone(availability_zone_index, availability_zone_list)
montesmoreno0c8def02016-12-22 12:16:23 +00001389
tiernob0b9dab2017-10-14 14:25:20 +02001390 self.logger.debug("nova.servers.create({}, {}, {}, nics={}, security_groups={}, "
mirabal29356312017-07-27 12:21:22 +02001391 "availability_zone={}, key_name={}, userdata={}, config_drive={}, "
tiernob0b9dab2017-10-14 14:25:20 +02001392 "block_device_mapping={})".format(name, image_id, flavor_id, net_list_vim,
tiernoa05b65a2019-02-01 12:30:27 +00001393 self.config.get("security_groups"), vm_av_zone,
1394 self.config.get('keypair'), userdata, config_drive,
1395 block_device_mapping))
tiernob0b9dab2017-10-14 14:25:20 +02001396 server = self.nova.servers.create(name, image_id, flavor_id, nics=net_list_vim,
tiernoa05b65a2019-02-01 12:30:27 +00001397 security_groups=self.config.get("security_groups"),
1398 # TODO remove security_groups in future versions. Already at neutron port
mirabal29356312017-07-27 12:21:22 +02001399 availability_zone=vm_av_zone,
montesmoreno0c8def02016-12-22 12:16:23 +00001400 key_name=self.config.get('keypair'),
1401 userdata=userdata,
tiernob84cbdc2017-07-07 14:30:30 +02001402 config_drive=config_drive,
1403 block_device_mapping=block_device_mapping
montesmoreno0c8def02016-12-22 12:16:23 +00001404 ) # , description=description)
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001405
tierno326fd5e2018-02-22 11:58:59 +01001406 vm_start_time = time.time()
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001407 # Previously mentioned workaround to wait until the VM is active and then disable the port-security
1408 if no_secured_ports:
1409 self.__wait_for_vm(server.id, 'ACTIVE')
1410
1411 for port_id in no_secured_ports:
1412 try:
tierno4d1ce222018-04-06 10:41:06 +02001413 self.neutron.update_port(port_id,
1414 {"port": {"port_security_enabled": False, "security_groups": None}})
tierno1ec592d2020-06-16 15:29:47 +00001415 except Exception:
tierno72774862020-05-04 11:44:15 +00001416 raise vimconn.VimConnException("It was not possible to disable port security for port {}".format(
tierno4d1ce222018-04-06 10:41:06 +02001417 port_id))
tierno98e909c2017-10-14 13:27:03 +02001418 # print "DONE :-)", server
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001419
tierno4d1ce222018-04-06 10:41:06 +02001420 # pool_id = None
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001421 if external_network:
tierno98e909c2017-10-14 13:27:03 +02001422 floating_ips = self.neutron.list_floatingips().get("floatingips", ())
ahmadsaf853d452016-12-22 11:33:47 +05001423 for floating_network in external_network:
tiernof8383b82017-01-18 15:49:48 +01001424 try:
tiernof8383b82017-01-18 15:49:48 +01001425 assigned = False
tierno98e909c2017-10-14 13:27:03 +02001426 while not assigned:
tiernof8383b82017-01-18 15:49:48 +01001427 if floating_ips:
1428 ip = floating_ips.pop(0)
tierno326fd5e2018-02-22 11:58:59 +01001429 if ip.get("port_id", False) or ip.get('tenant_id') != server.tenant_id:
1430 continue
1431 if isinstance(floating_network['floating_ip'], str):
1432 if ip.get("floating_network_id") != floating_network['floating_ip']:
1433 continue
tierno7d782ef2019-10-04 12:56:31 +00001434 free_floating_ip = ip["id"]
tiernof8383b82017-01-18 15:49:48 +01001435 else:
tiernocb3cca22018-05-31 15:08:52 +02001436 if isinstance(floating_network['floating_ip'], str) and \
tierno1ec592d2020-06-16 15:29:47 +00001437 floating_network['floating_ip'].lower() != "true":
tierno326fd5e2018-02-22 11:58:59 +01001438 pool_id = floating_network['floating_ip']
1439 else:
tierno4d1ce222018-04-06 10:41:06 +02001440 # Find the external network
tierno326fd5e2018-02-22 11:58:59 +01001441 external_nets = list()
1442 for net in self.neutron.list_networks()['networks']:
1443 if net['router:external']:
tierno1ec592d2020-06-16 15:29:47 +00001444 external_nets.append(net)
tiernof8383b82017-01-18 15:49:48 +01001445
tierno326fd5e2018-02-22 11:58:59 +01001446 if len(external_nets) == 0:
tierno1ec592d2020-06-16 15:29:47 +00001447 raise vimconn.VimConnException(
1448 "Cannot create floating_ip automatically since no external network is present",
1449 http_code=vimconn.HTTP_Conflict)
tierno326fd5e2018-02-22 11:58:59 +01001450 if len(external_nets) > 1:
tierno1ec592d2020-06-16 15:29:47 +00001451 raise vimconn.VimConnException(
1452 "Cannot create floating_ip automatically since multiple external networks are"
1453 " present", http_code=vimconn.HTTP_Conflict)
tiernof8383b82017-01-18 15:49:48 +01001454
tierno326fd5e2018-02-22 11:58:59 +01001455 pool_id = external_nets[0].get('id')
tiernof8383b82017-01-18 15:49:48 +01001456 param = {'floatingip': {'floating_network_id': pool_id, 'tenant_id': server.tenant_id}}
ahmadsaf853d452016-12-22 11:33:47 +05001457 try:
tierno4d1ce222018-04-06 10:41:06 +02001458 # self.logger.debug("Creating floating IP")
tiernof8383b82017-01-18 15:49:48 +01001459 new_floating_ip = self.neutron.create_floatingip(param)
tierno7d782ef2019-10-04 12:56:31 +00001460 free_floating_ip = new_floating_ip['floatingip']['id']
ahmadsaf853d452016-12-22 11:33:47 +05001461 except Exception as e:
tierno72774862020-05-04 11:44:15 +00001462 raise vimconn.VimConnException(type(e).__name__ + ": Cannot create new floating_ip " +
tierno326fd5e2018-02-22 11:58:59 +01001463 str(e), http_code=vimconn.HTTP_Conflict)
1464
tierno326fd5e2018-02-22 11:58:59 +01001465 while not assigned:
1466 try:
tierno7d782ef2019-10-04 12:56:31 +00001467 # the vim_id key contains the neutron.port_id
1468 self.neutron.update_floatingip(free_floating_ip,
1469 {"floatingip": {"port_id": floating_network["vim_id"]}})
1470 # Using nove is deprecated on nova client 10.0
tierno326fd5e2018-02-22 11:58:59 +01001471 assigned = True
1472 except Exception as e:
tierno4d1ce222018-04-06 10:41:06 +02001473 # openstack need some time after VM creation to asign an IP. So retry if fails
tierno326fd5e2018-02-22 11:58:59 +01001474 vm_status = self.nova.servers.get(server.id).status
1475 if vm_status != 'ACTIVE' and vm_status != 'ERROR':
1476 if time.time() - vm_start_time < server_timeout:
1477 time.sleep(5)
1478 continue
tierno72774862020-05-04 11:44:15 +00001479 raise vimconn.VimConnException(
tierno4d1ce222018-04-06 10:41:06 +02001480 "Cannot create floating_ip: {} {}".format(type(e).__name__, e),
1481 http_code=vimconn.HTTP_Conflict)
tierno326fd5e2018-02-22 11:58:59 +01001482
tiernof8383b82017-01-18 15:49:48 +01001483 except Exception as e:
1484 if not floating_network['exit_on_floating_ip_error']:
tierno7d782ef2019-10-04 12:56:31 +00001485 self.logger.warning("Cannot create floating_ip. %s", str(e))
tiernof8383b82017-01-18 15:49:48 +01001486 continue
tiernof8383b82017-01-18 15:49:48 +01001487 raise
montesmoreno2a1fc4e2017-01-09 16:46:04 +00001488
tierno98e909c2017-10-14 13:27:03 +02001489 return server.id, created_items
tierno1ec592d2020-06-16 15:29:47 +00001490 # except nvExceptions.NotFound as e:
1491 # error_value=-vimconn.HTTP_Not_Found
1492 # error_text= "vm instance %s not found" % vm_id
1493 # except TypeError as e:
1494 # raise vimconn.VimConnException(type(e).__name__ + ": "+ str(e), http_code=vimconn.HTTP_Bad_Request)
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001495
1496 except Exception as e:
tierno98e909c2017-10-14 13:27:03 +02001497 server_id = None
1498 if server:
1499 server_id = server.id
1500 try:
1501 self.delete_vminstance(server_id, created_items)
1502 except Exception as e2:
1503 self.logger.error("new_vminstance rollback fail {}".format(e2))
Pablo Montes Moreno6a7785b2017-07-03 10:44:30 +02001504
tiernoae4a8d12016-07-08 12:30:39 +02001505 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +01001506
tierno1ec592d2020-06-16 15:29:47 +00001507 def get_vminstance(self, vm_id):
1508 """Returns the VM instance information from VIM"""
1509 # self.logger.debug("Getting VM from VIM")
tierno7edb6752016-03-21 17:37:52 +01001510 try:
1511 self._reload_connection()
1512 server = self.nova.servers.find(id=vm_id)
tierno1ec592d2020-06-16 15:29:47 +00001513 # TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
tiernoae4a8d12016-07-08 12:30:39 +02001514 return server.to_dict()
tierno1ec592d2020-06-16 15:29:47 +00001515 except (ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.NotFound,
1516 ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +02001517 self._format_exception(e)
1518
tierno1ec592d2020-06-16 15:29:47 +00001519 def get_vminstance_console(self, vm_id, console_type="vnc"):
1520 """
tierno7edb6752016-03-21 17:37:52 +01001521 Get a console for the virtual machine
1522 Params:
1523 vm_id: uuid of the VM
1524 console_type, can be:
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001525 "novnc" (by default), "xvpvnc" for VNC types,
tierno7edb6752016-03-21 17:37:52 +01001526 "rdp-html5" for RDP types, "spice-html5" for SPICE types
tiernoae4a8d12016-07-08 12:30:39 +02001527 Returns dict with the console parameters:
1528 protocol: ssh, ftp, http, https, ...
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001529 server: usually ip address
1530 port: the http, ssh, ... port
1531 suffix: extra text, e.g. the http path and query string
tierno1ec592d2020-06-16 15:29:47 +00001532 """
tiernoae4a8d12016-07-08 12:30:39 +02001533 self.logger.debug("Getting VM CONSOLE from VIM")
tierno7edb6752016-03-21 17:37:52 +01001534 try:
1535 self._reload_connection()
1536 server = self.nova.servers.find(id=vm_id)
tierno1ec592d2020-06-16 15:29:47 +00001537 if console_type is None or console_type == "novnc":
tierno7edb6752016-03-21 17:37:52 +01001538 console_dict = server.get_vnc_console("novnc")
1539 elif console_type == "xvpvnc":
1540 console_dict = server.get_vnc_console(console_type)
1541 elif console_type == "rdp-html5":
1542 console_dict = server.get_rdp_console(console_type)
1543 elif console_type == "spice-html5":
1544 console_dict = server.get_spice_console(console_type)
1545 else:
tierno1ec592d2020-06-16 15:29:47 +00001546 raise vimconn.VimConnException("console type '{}' not allowed".format(console_type),
1547 http_code=vimconn.HTTP_Bad_Request)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001548
tierno7edb6752016-03-21 17:37:52 +01001549 console_dict1 = console_dict.get("console")
1550 if console_dict1:
1551 console_url = console_dict1.get("url")
1552 if console_url:
tierno1ec592d2020-06-16 15:29:47 +00001553 # parse console_url
tierno7edb6752016-03-21 17:37:52 +01001554 protocol_index = console_url.find("//")
1555 suffix_index = console_url[protocol_index+2:].find("/") + protocol_index+2
1556 port_index = console_url[protocol_index+2:suffix_index].find(":") + protocol_index+2
tierno1ec592d2020-06-16 15:29:47 +00001557 if protocol_index < 0 or port_index < 0 or suffix_index < 0:
tierno7edb6752016-03-21 17:37:52 +01001558 return -vimconn.HTTP_Internal_Server_Error, "Unexpected response from VIM"
tierno1ec592d2020-06-16 15:29:47 +00001559 console_dict = {"protocol": console_url[0:protocol_index],
1560 "server": console_url[protocol_index+2:port_index],
1561 "port": console_url[port_index:suffix_index],
1562 "suffix": console_url[suffix_index+1:]
1563 }
tierno7edb6752016-03-21 17:37:52 +01001564 protocol_index += 2
tiernoae4a8d12016-07-08 12:30:39 +02001565 return console_dict
tierno72774862020-05-04 11:44:15 +00001566 raise vimconn.VimConnUnexpectedResponse("Unexpected response from VIM")
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001567
tierno1ec592d2020-06-16 15:29:47 +00001568 except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException,
1569 nvExceptions.BadRequest, ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +02001570 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +01001571
tierno98e909c2017-10-14 13:27:03 +02001572 def delete_vminstance(self, vm_id, created_items=None):
tierno1ec592d2020-06-16 15:29:47 +00001573 """Removes a VM instance from VIM. Returns the old identifier
1574 """
1575 # print "osconnector: Getting VM from VIM"
1576 if created_items is None:
tierno98e909c2017-10-14 13:27:03 +02001577 created_items = {}
tierno7edb6752016-03-21 17:37:52 +01001578 try:
1579 self._reload_connection()
tierno98e909c2017-10-14 13:27:03 +02001580 # delete VM ports attached to this networks before the virtual machine
1581 for k, v in created_items.items():
1582 if not v: # skip already deleted
1583 continue
tierno7edb6752016-03-21 17:37:52 +01001584 try:
tiernoad6bdd42018-01-10 10:43:46 +01001585 k_item, _, k_id = k.partition(":")
1586 if k_item == "port":
1587 self.neutron.delete_port(k_id)
tierno7edb6752016-03-21 17:37:52 +01001588 except Exception as e:
tierno00e3df72017-11-29 17:20:13 +01001589 self.logger.error("Error deleting port: {}: {}".format(type(e).__name__, e))
montesmoreno0c8def02016-12-22 12:16:23 +00001590
tierno98e909c2017-10-14 13:27:03 +02001591 # #commented because detaching the volumes makes the servers.delete not work properly ?!?
1592 # #dettach volumes attached
1593 # server = self.nova.servers.get(vm_id)
1594 # volumes_attached_dict = server._info['os-extended-volumes:volumes_attached'] #volume['id']
1595 # #for volume in volumes_attached_dict:
1596 # # self.cinder.volumes.detach(volume['id'])
montesmoreno0c8def02016-12-22 12:16:23 +00001597
tierno98e909c2017-10-14 13:27:03 +02001598 if vm_id:
1599 self.nova.servers.delete(vm_id)
montesmoreno0c8def02016-12-22 12:16:23 +00001600
tierno98e909c2017-10-14 13:27:03 +02001601 # delete volumes. Although having detached, they should have in active status before deleting
1602 # we ensure in this loop
montesmoreno0c8def02016-12-22 12:16:23 +00001603 keep_waiting = True
1604 elapsed_time = 0
1605 while keep_waiting and elapsed_time < volume_timeout:
1606 keep_waiting = False
tierno98e909c2017-10-14 13:27:03 +02001607 for k, v in created_items.items():
1608 if not v: # skip already deleted
1609 continue
1610 try:
tiernoad6bdd42018-01-10 10:43:46 +01001611 k_item, _, k_id = k.partition(":")
1612 if k_item == "volume":
1613 if self.cinder.volumes.get(k_id).status != 'available':
tierno98e909c2017-10-14 13:27:03 +02001614 keep_waiting = True
1615 else:
tiernoad6bdd42018-01-10 10:43:46 +01001616 self.cinder.volumes.delete(k_id)
tierno98e909c2017-10-14 13:27:03 +02001617 except Exception as e:
tierno00e3df72017-11-29 17:20:13 +01001618 self.logger.error("Error deleting volume: {}: {}".format(type(e).__name__, e))
montesmoreno0c8def02016-12-22 12:16:23 +00001619 if keep_waiting:
1620 time.sleep(1)
1621 elapsed_time += 1
tierno98e909c2017-10-14 13:27:03 +02001622 return None
tierno1ec592d2020-06-16 15:29:47 +00001623 except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException,
1624 ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +02001625 self._format_exception(e)
tierno7edb6752016-03-21 17:37:52 +01001626
tiernoae4a8d12016-07-08 12:30:39 +02001627 def refresh_vms_status(self, vm_list):
tierno1ec592d2020-06-16 15:29:47 +00001628 """Get the status of the virtual machines and their interfaces/ports
tiernoae4a8d12016-07-08 12:30:39 +02001629 Params: the list of VM identifiers
1630 Returns a dictionary with:
1631 vm_id: #VIM id of this Virtual Machine
1632 status: #Mandatory. Text with one of:
1633 # DELETED (not found at vim)
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001634 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
tiernoae4a8d12016-07-08 12:30:39 +02001635 # OTHER (Vim reported other status not understood)
1636 # ERROR (VIM indicates an ERROR status)
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001637 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
tiernoae4a8d12016-07-08 12:30:39 +02001638 # CREATING (on building process), ERROR
1639 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
1640 #
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001641 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
tiernoae4a8d12016-07-08 12:30:39 +02001642 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1643 interfaces:
1644 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1645 mac_address: #Text format XX:XX:XX:XX:XX:XX
1646 vim_net_id: #network id where this interface is connected
1647 vim_interface_id: #interface/port VIM id
1648 ip_address: #null, or text with IPv4, IPv6 address
tierno867ffe92017-03-27 12:50:34 +02001649 compute_node: #identification of compute node where PF,VF interface is allocated
1650 pci: #PCI address of the NIC that hosts the PF,VF
1651 vlan: #physical VLAN used for VF
tierno1ec592d2020-06-16 15:29:47 +00001652 """
1653 vm_dict = {}
tiernoae4a8d12016-07-08 12:30:39 +02001654 self.logger.debug("refresh_vms status: Getting tenant VM instance information from VIM")
1655 for vm_id in vm_list:
tierno1ec592d2020-06-16 15:29:47 +00001656 vm = {}
tiernoae4a8d12016-07-08 12:30:39 +02001657 try:
1658 vm_vim = self.get_vminstance(vm_id)
1659 if vm_vim['status'] in vmStatus2manoFormat:
tierno1ec592d2020-06-16 15:29:47 +00001660 vm['status'] = vmStatus2manoFormat[vm_vim['status']]
tierno7edb6752016-03-21 17:37:52 +01001661 else:
tierno1ec592d2020-06-16 15:29:47 +00001662 vm['status'] = "OTHER"
tiernoae4a8d12016-07-08 12:30:39 +02001663 vm['error_msg'] = "VIM status reported " + vm_vim['status']
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001664
1665 vm['vim_info'] = self.serialize(vm_vim)
1666
tiernoae4a8d12016-07-08 12:30:39 +02001667 vm["interfaces"] = []
1668 if vm_vim.get('fault'):
1669 vm['error_msg'] = str(vm_vim['fault'])
tierno1ec592d2020-06-16 15:29:47 +00001670 # get interfaces
tierno7edb6752016-03-21 17:37:52 +01001671 try:
tiernoae4a8d12016-07-08 12:30:39 +02001672 self._reload_connection()
tiernob42fd9b2018-06-20 10:44:32 +02001673 port_dict = self.neutron.list_ports(device_id=vm_id)
tiernoae4a8d12016-07-08 12:30:39 +02001674 for port in port_dict["ports"]:
tierno1ec592d2020-06-16 15:29:47 +00001675 interface = {}
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001676 interface['vim_info'] = self.serialize(port)
tiernoae4a8d12016-07-08 12:30:39 +02001677 interface["mac_address"] = port.get("mac_address")
1678 interface["vim_net_id"] = port["network_id"]
1679 interface["vim_interface_id"] = port["id"]
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001680 # check if OS-EXT-SRV-ATTR:host is there,
Mike Marchetti5b9da422017-05-02 15:35:47 -04001681 # in case of non-admin credentials, it will be missing
1682 if vm_vim.get('OS-EXT-SRV-ATTR:host'):
1683 interface["compute_node"] = vm_vim['OS-EXT-SRV-ATTR:host']
tierno867ffe92017-03-27 12:50:34 +02001684 interface["pci"] = None
Mike Marchetti5b9da422017-05-02 15:35:47 -04001685
Anderson Bravalheri0446cd52018-08-17 15:26:19 +01001686 # check if binding:profile is there,
Mike Marchetti5b9da422017-05-02 15:35:47 -04001687 # in case of non-admin credentials, it will be missing
1688 if port.get('binding:profile'):
1689 if port['binding:profile'].get('pci_slot'):
tierno1ec592d2020-06-16 15:29:47 +00001690 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting
1691 # the slot to 0x00
Mike Marchetti5b9da422017-05-02 15:35:47 -04001692 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
1693 # CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2) assuming there are 2 ports per nic
1694 pci = port['binding:profile']['pci_slot']
1695 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
1696 interface["pci"] = pci
tierno867ffe92017-03-27 12:50:34 +02001697 interface["vlan"] = None
tierno1dfe9932020-06-18 08:50:10 +00001698 if port.get('binding:vif_details'):
1699 interface["vlan"] = port['binding:vif_details'].get('vlan')
1700 # Get vlan from network in case not present in port for those old openstacks and cases where
1701 # it is needed vlan at PT
1702 if not interface["vlan"]:
1703 # if network is of type vlan and port is of type direct (sr-iov) then set vlan id
1704 network = self.neutron.show_network(port["network_id"])
1705 if network['network'].get('provider:network_type') == 'vlan':
1706 # and port.get("binding:vnic_type") in ("direct", "direct-physical"):
1707 interface["vlan"] = network['network'].get('provider:segmentation_id')
tierno1ec592d2020-06-16 15:29:47 +00001708 ips = []
1709 # look for floating ip address
tiernob42fd9b2018-06-20 10:44:32 +02001710 try:
1711 floating_ip_dict = self.neutron.list_floatingips(port_id=port["id"])
1712 if floating_ip_dict.get("floatingips"):
tierno1ec592d2020-06-16 15:29:47 +00001713 ips.append(floating_ip_dict["floatingips"][0].get("floating_ip_address"))
tiernob42fd9b2018-06-20 10:44:32 +02001714 except Exception:
1715 pass
tierno7edb6752016-03-21 17:37:52 +01001716
tiernoae4a8d12016-07-08 12:30:39 +02001717 for subnet in port["fixed_ips"]:
1718 ips.append(subnet["ip_address"])
1719 interface["ip_address"] = ";".join(ips)
1720 vm["interfaces"].append(interface)
1721 except Exception as e:
tiernob42fd9b2018-06-20 10:44:32 +02001722 self.logger.error("Error getting vm interface information {}: {}".format(type(e).__name__, e),
1723 exc_info=True)
tierno72774862020-05-04 11:44:15 +00001724 except vimconn.VimConnNotFoundException as e:
tiernoae4a8d12016-07-08 12:30:39 +02001725 self.logger.error("Exception getting vm status: %s", str(e))
1726 vm['status'] = "DELETED"
1727 vm['error_msg'] = str(e)
tierno72774862020-05-04 11:44:15 +00001728 except vimconn.VimConnException as e:
tiernoae4a8d12016-07-08 12:30:39 +02001729 self.logger.error("Exception getting vm status: %s", str(e))
1730 vm['status'] = "VIM_ERROR"
1731 vm['error_msg'] = str(e)
1732 vm_dict[vm_id] = vm
1733 return vm_dict
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001734
tierno98e909c2017-10-14 13:27:03 +02001735 def action_vminstance(self, vm_id, action_dict, created_items={}):
tierno1ec592d2020-06-16 15:29:47 +00001736 """Send and action over a VM instance from VIM
1737 Returns None or the console dict if the action was successfully sent to the VIM"""
tiernoae4a8d12016-07-08 12:30:39 +02001738 self.logger.debug("Action over VM '%s': %s", vm_id, str(action_dict))
tierno7edb6752016-03-21 17:37:52 +01001739 try:
1740 self._reload_connection()
1741 server = self.nova.servers.find(id=vm_id)
1742 if "start" in action_dict:
tierno1ec592d2020-06-16 15:29:47 +00001743 if action_dict["start"] == "rebuild":
tierno7edb6752016-03-21 17:37:52 +01001744 server.rebuild()
1745 else:
tierno1ec592d2020-06-16 15:29:47 +00001746 if server.status == "PAUSED":
tierno7edb6752016-03-21 17:37:52 +01001747 server.unpause()
tierno1ec592d2020-06-16 15:29:47 +00001748 elif server.status == "SUSPENDED":
tierno7edb6752016-03-21 17:37:52 +01001749 server.resume()
tierno1ec592d2020-06-16 15:29:47 +00001750 elif server.status == "SHUTOFF":
tierno7edb6752016-03-21 17:37:52 +01001751 server.start()
1752 elif "pause" in action_dict:
1753 server.pause()
1754 elif "resume" in action_dict:
1755 server.resume()
1756 elif "shutoff" in action_dict or "shutdown" in action_dict:
1757 server.stop()
1758 elif "forceOff" in action_dict:
tierno1ec592d2020-06-16 15:29:47 +00001759 server.stop() # TODO
tierno7edb6752016-03-21 17:37:52 +01001760 elif "terminate" in action_dict:
1761 server.delete()
1762 elif "createImage" in action_dict:
1763 server.create_image()
tierno1ec592d2020-06-16 15:29:47 +00001764 # "path":path_schema,
1765 # "description":description_schema,
1766 # "name":name_schema,
1767 # "metadata":metadata_schema,
1768 # "imageRef": id_schema,
1769 # "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
tierno7edb6752016-03-21 17:37:52 +01001770 elif "rebuild" in action_dict:
1771 server.rebuild(server.image['id'])
1772 elif "reboot" in action_dict:
tierno1ec592d2020-06-16 15:29:47 +00001773 server.reboot() # reboot_type='SOFT'
tierno7edb6752016-03-21 17:37:52 +01001774 elif "console" in action_dict:
1775 console_type = action_dict["console"]
tierno1ec592d2020-06-16 15:29:47 +00001776 if console_type is None or console_type == "novnc":
tierno7edb6752016-03-21 17:37:52 +01001777 console_dict = server.get_vnc_console("novnc")
1778 elif console_type == "xvpvnc":
1779 console_dict = server.get_vnc_console(console_type)
1780 elif console_type == "rdp-html5":
1781 console_dict = server.get_rdp_console(console_type)
1782 elif console_type == "spice-html5":
1783 console_dict = server.get_spice_console(console_type)
1784 else:
tierno72774862020-05-04 11:44:15 +00001785 raise vimconn.VimConnException("console type '{}' not allowed".format(console_type),
tiernoae4a8d12016-07-08 12:30:39 +02001786 http_code=vimconn.HTTP_Bad_Request)
tierno7edb6752016-03-21 17:37:52 +01001787 try:
1788 console_url = console_dict["console"]["url"]
tierno1ec592d2020-06-16 15:29:47 +00001789 # parse console_url
tierno7edb6752016-03-21 17:37:52 +01001790 protocol_index = console_url.find("//")
1791 suffix_index = console_url[protocol_index+2:].find("/") + protocol_index+2
1792 port_index = console_url[protocol_index+2:suffix_index].find(":") + protocol_index+2
tierno1ec592d2020-06-16 15:29:47 +00001793 if protocol_index < 0 or port_index < 0 or suffix_index < 0:
tierno72774862020-05-04 11:44:15 +00001794 raise vimconn.VimConnException("Unexpected response from VIM " + str(console_dict))
tierno1ec592d2020-06-16 15:29:47 +00001795 console_dict2 = {"protocol": console_url[0:protocol_index],
1796 "server": console_url[protocol_index+2: port_index],
1797 "port": int(console_url[port_index+1: suffix_index]),
1798 "suffix": console_url[suffix_index+1:]
1799 }
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001800 return console_dict2
tierno1ec592d2020-06-16 15:29:47 +00001801 except Exception:
tierno72774862020-05-04 11:44:15 +00001802 raise vimconn.VimConnException("Unexpected response from VIM " + str(console_dict))
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001803
tierno98e909c2017-10-14 13:27:03 +02001804 return None
tierno1ec592d2020-06-16 15:29:47 +00001805 except (ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.NotFound,
1806 ConnectionError) as e:
tiernoae4a8d12016-07-08 12:30:39 +02001807 self._format_exception(e)
tierno1ec592d2020-06-16 15:29:47 +00001808 # TODO insert exception vimconn.HTTP_Unauthorized
tiernoae4a8d12016-07-08 12:30:39 +02001809
tierno1ec592d2020-06-16 15:29:47 +00001810 # ###### VIO Specific Changes #########
garciadeblasebd66722019-01-31 16:01:31 +00001811 def _generate_vlanID(self):
kate721d79b2017-06-24 04:21:38 -07001812 """
1813 Method to get unused vlanID
1814 Args:
1815 None
1816 Returns:
1817 vlanID
1818 """
tierno1ec592d2020-06-16 15:29:47 +00001819 # Get used VLAN IDs
kate721d79b2017-06-24 04:21:38 -07001820 usedVlanIDs = []
1821 networks = self.get_network_list()
1822 for net in networks:
1823 if net.get('provider:segmentation_id'):
1824 usedVlanIDs.append(net.get('provider:segmentation_id'))
1825 used_vlanIDs = set(usedVlanIDs)
1826
tierno1ec592d2020-06-16 15:29:47 +00001827 # find unused VLAN ID
kate721d79b2017-06-24 04:21:38 -07001828 for vlanID_range in self.config.get('dataplane_net_vlan_range'):
1829 try:
tierno1ec592d2020-06-16 15:29:47 +00001830 start_vlanid, end_vlanid = map(int, vlanID_range.replace(" ", "").split("-"))
tierno7d782ef2019-10-04 12:56:31 +00001831 for vlanID in range(start_vlanid, end_vlanid + 1):
kate721d79b2017-06-24 04:21:38 -07001832 if vlanID not in used_vlanIDs:
1833 return vlanID
1834 except Exception as exp:
tierno72774862020-05-04 11:44:15 +00001835 raise vimconn.VimConnException("Exception {} occurred while generating VLAN ID.".format(exp))
kate721d79b2017-06-24 04:21:38 -07001836 else:
tierno1ec592d2020-06-16 15:29:47 +00001837 raise vimconn.VimConnConflictException(
1838 "Unable to create the SRIOV VLAN network. All given Vlan IDs {} are in use.".format(
1839 self.config.get('dataplane_net_vlan_range')))
kate721d79b2017-06-24 04:21:38 -07001840
garciadeblasebd66722019-01-31 16:01:31 +00001841 def _generate_multisegment_vlanID(self):
1842 """
1843 Method to get unused vlanID
1844 Args:
1845 None
1846 Returns:
1847 vlanID
1848 """
tierno6869ae72020-01-09 17:37:34 +00001849 # Get used VLAN IDs
garciadeblasebd66722019-01-31 16:01:31 +00001850 usedVlanIDs = []
1851 networks = self.get_network_list()
1852 for net in networks:
1853 if net.get('provider:network_type') == "vlan" and net.get('provider:segmentation_id'):
1854 usedVlanIDs.append(net.get('provider:segmentation_id'))
1855 elif net.get('segments'):
1856 for segment in net.get('segments'):
1857 if segment.get('provider:network_type') == "vlan" and segment.get('provider:segmentation_id'):
1858 usedVlanIDs.append(segment.get('provider:segmentation_id'))
1859 used_vlanIDs = set(usedVlanIDs)
1860
tierno6869ae72020-01-09 17:37:34 +00001861 # find unused VLAN ID
garciadeblasebd66722019-01-31 16:01:31 +00001862 for vlanID_range in self.config.get('multisegment_vlan_range'):
1863 try:
tierno6869ae72020-01-09 17:37:34 +00001864 start_vlanid, end_vlanid = map(int, vlanID_range.replace(" ", "").split("-"))
tierno7d782ef2019-10-04 12:56:31 +00001865 for vlanID in range(start_vlanid, end_vlanid + 1):
garciadeblasebd66722019-01-31 16:01:31 +00001866 if vlanID not in used_vlanIDs:
1867 return vlanID
1868 except Exception as exp:
tierno72774862020-05-04 11:44:15 +00001869 raise vimconn.VimConnException("Exception {} occurred while generating VLAN ID.".format(exp))
garciadeblasebd66722019-01-31 16:01:31 +00001870 else:
tierno1ec592d2020-06-16 15:29:47 +00001871 raise vimconn.VimConnConflictException(
1872 "Unable to create the VLAN segment. All VLAN IDs {} are in use.".format(
1873 self.config.get('multisegment_vlan_range')))
garciadeblasebd66722019-01-31 16:01:31 +00001874
1875 def _validate_vlan_ranges(self, input_vlan_range, text_vlan_range):
kate721d79b2017-06-24 04:21:38 -07001876 """
1877 Method to validate user given vlanID ranges
1878 Args: None
1879 Returns: None
1880 """
garciadeblasebd66722019-01-31 16:01:31 +00001881 for vlanID_range in input_vlan_range:
kate721d79b2017-06-24 04:21:38 -07001882 vlan_range = vlanID_range.replace(" ", "")
tierno1ec592d2020-06-16 15:29:47 +00001883 # validate format
kate721d79b2017-06-24 04:21:38 -07001884 vlanID_pattern = r'(\d)*-(\d)*$'
1885 match_obj = re.match(vlanID_pattern, vlan_range)
1886 if not match_obj:
tierno1ec592d2020-06-16 15:29:47 +00001887 raise vimconn.VimConnConflictException(
1888 "Invalid VLAN range for {}: {}.You must provide '{}' in format [start_ID - end_ID].".format(
1889 text_vlan_range, vlanID_range, text_vlan_range))
kate721d79b2017-06-24 04:21:38 -07001890
tierno1ec592d2020-06-16 15:29:47 +00001891 start_vlanid, end_vlanid = map(int, vlan_range.split("-"))
1892 if start_vlanid <= 0:
1893 raise vimconn.VimConnConflictException(
1894 "Invalid VLAN range for {}: {}. Start ID can not be zero. For VLAN "
1895 "networks valid IDs are 1 to 4094 ".format(text_vlan_range, vlanID_range))
1896 if end_vlanid > 4094:
1897 raise vimconn.VimConnConflictException(
1898 "Invalid VLAN range for {}: {}. End VLAN ID can not be greater than 4094. For VLAN "
1899 "networks valid IDs are 1 to 4094 ".format(text_vlan_range, vlanID_range))
kate721d79b2017-06-24 04:21:38 -07001900
1901 if start_vlanid > end_vlanid:
tierno1ec592d2020-06-16 15:29:47 +00001902 raise vimconn.VimConnConflictException(
1903 "Invalid VLAN range for {}: {}. You must provide '{}' in format start_ID - end_ID and "
garciadeblasebd66722019-01-31 16:01:31 +00001904 "start_ID < end_ID ".format(text_vlan_range, vlanID_range, text_vlan_range))
kate721d79b2017-06-24 04:21:38 -07001905
tierno1ec592d2020-06-16 15:29:47 +00001906 # NOT USED FUNCTIONS
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001907
tiernoae4a8d12016-07-08 12:30:39 +02001908 def new_external_port(self, port_data):
tierno1ec592d2020-06-16 15:29:47 +00001909 """Adds a external port to VIM
1910 Returns the port identifier"""
1911 # TODO openstack if needed
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001912 return -vimconn.HTTP_Internal_Server_Error, "osconnector.new_external_port() not implemented"
1913
tiernoae4a8d12016-07-08 12:30:39 +02001914 def connect_port_network(self, port_id, network_id, admin=False):
tierno1ec592d2020-06-16 15:29:47 +00001915 """Connects a external port to a network
1916 Returns status code of the VIM response"""
1917 # TODO openstack if needed
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001918 return -vimconn.HTTP_Internal_Server_Error, "osconnector.connect_port_network() not implemented"
1919
tiernoae4a8d12016-07-08 12:30:39 +02001920 def new_user(self, user_name, user_passwd, tenant_id=None):
tierno1ec592d2020-06-16 15:29:47 +00001921 """Adds a new user to openstack VIM
1922 Returns the user identifier"""
tiernoae4a8d12016-07-08 12:30:39 +02001923 self.logger.debug("osconnector: Adding a new user to VIM")
1924 try:
1925 self._reload_connection()
tierno1ec592d2020-06-16 15:29:47 +00001926 user = self.keystone.users.create(user_name, password=user_passwd, default_project=tenant_id)
1927 # self.keystone.tenants.add_user(self.k_creds["username"], #role)
tiernoae4a8d12016-07-08 12:30:39 +02001928 return user.id
1929 except ksExceptions.ConnectionError as e:
tierno1ec592d2020-06-16 15:29:47 +00001930 error_value = -vimconn.HTTP_Bad_Request
1931 error_text = type(e).__name__ + ": " + (str(e) if len(e.args) == 0 else str(e.args[0]))
1932 except ksExceptions.ClientException as e: # TODO remove
1933 error_value = -vimconn.HTTP_Bad_Request
1934 error_text = type(e).__name__ + ": " + (str(e) if len(e.args) == 0 else str(e.args[0]))
1935 # TODO insert exception vimconn.HTTP_Unauthorized
1936 # if reaching here is because an exception
tierno9c5c8322018-03-23 15:44:03 +01001937 self.logger.debug("new_user " + error_text)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001938 return error_value, error_text
tiernoae4a8d12016-07-08 12:30:39 +02001939
1940 def delete_user(self, user_id):
tierno1ec592d2020-06-16 15:29:47 +00001941 """Delete a user from openstack VIM
1942 Returns the user identifier"""
tiernoae4a8d12016-07-08 12:30:39 +02001943 if self.debug:
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001944 print("osconnector: Deleting a user from VIM")
tiernoae4a8d12016-07-08 12:30:39 +02001945 try:
1946 self._reload_connection()
1947 self.keystone.users.delete(user_id)
1948 return 1, user_id
1949 except ksExceptions.ConnectionError as e:
tierno1ec592d2020-06-16 15:29:47 +00001950 error_value = -vimconn.HTTP_Bad_Request
1951 error_text = type(e).__name__ + ": " + (str(e) if len(e.args) == 0 else str(e.args[0]))
tiernoae4a8d12016-07-08 12:30:39 +02001952 except ksExceptions.NotFound as e:
tierno1ec592d2020-06-16 15:29:47 +00001953 error_value = -vimconn.HTTP_Not_Found
1954 error_text = type(e).__name__ + ": " + (str(e) if len(e.args) == 0 else str(e.args[0]))
1955 except ksExceptions.ClientException as e: # TODO remove
1956 error_value = -vimconn.HTTP_Bad_Request
1957 error_text = type(e).__name__ + ": " + (str(e) if len(e.args) == 0 else str(e.args[0]))
1958 # TODO insert exception vimconn.HTTP_Unauthorized
1959 # if reaching here is because an exception
1960 self.logger.debug("delete_tenant " + error_text)
tiernoae4a8d12016-07-08 12:30:39 +02001961 return error_value, error_text
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001962
tierno7edb6752016-03-21 17:37:52 +01001963 def get_hosts_info(self):
tierno1ec592d2020-06-16 15:29:47 +00001964 """Get the information of deployed hosts
1965 Returns the hosts content"""
tierno7edb6752016-03-21 17:37:52 +01001966 if self.debug:
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001967 print("osconnector: Getting Host info from VIM")
tierno7edb6752016-03-21 17:37:52 +01001968 try:
tierno1ec592d2020-06-16 15:29:47 +00001969 h_list = []
tierno7edb6752016-03-21 17:37:52 +01001970 self._reload_connection()
1971 hypervisors = self.nova.hypervisors.list()
1972 for hype in hypervisors:
tierno1ec592d2020-06-16 15:29:47 +00001973 h_list.append(hype.to_dict())
1974 return 1, {"hosts": h_list}
tierno7edb6752016-03-21 17:37:52 +01001975 except nvExceptions.NotFound as e:
tierno1ec592d2020-06-16 15:29:47 +00001976 error_value = -vimconn.HTTP_Not_Found
1977 error_text = (str(e) if len(e.args) == 0 else str(e.args[0]))
tierno7edb6752016-03-21 17:37:52 +01001978 except (ksExceptions.ClientException, nvExceptions.ClientException) as e:
tierno1ec592d2020-06-16 15:29:47 +00001979 error_value = -vimconn.HTTP_Bad_Request
1980 error_text = type(e).__name__ + ": " + (str(e) if len(e.args) == 0 else str(e.args[0]))
1981 # TODO insert exception vimconn.HTTP_Unauthorized
1982 # if reaching here is because an exception
tierno9c5c8322018-03-23 15:44:03 +01001983 self.logger.debug("get_hosts_info " + error_text)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00001984 return error_value, error_text
tierno7edb6752016-03-21 17:37:52 +01001985
1986 def get_hosts(self, vim_tenant):
tierno1ec592d2020-06-16 15:29:47 +00001987 """Get the hosts and deployed instances
1988 Returns the hosts content"""
tierno7edb6752016-03-21 17:37:52 +01001989 r, hype_dict = self.get_hosts_info()
tierno1ec592d2020-06-16 15:29:47 +00001990 if r < 0:
tierno7edb6752016-03-21 17:37:52 +01001991 return r, hype_dict
1992 hypervisors = hype_dict["hosts"]
1993 try:
1994 servers = self.nova.servers.list()
1995 for hype in hypervisors:
1996 for server in servers:
tierno1ec592d2020-06-16 15:29:47 +00001997 if server.to_dict()['OS-EXT-SRV-ATTR:hypervisor_hostname'] == hype['hypervisor_hostname']:
tierno7edb6752016-03-21 17:37:52 +01001998 if 'vm' in hype:
1999 hype['vm'].append(server.id)
2000 else:
2001 hype['vm'] = [server.id]
2002 return 1, hype_dict
2003 except nvExceptions.NotFound as e:
tierno1ec592d2020-06-16 15:29:47 +00002004 error_value = -vimconn.HTTP_Not_Found
2005 error_text = (str(e) if len(e.args) == 0 else str(e.args[0]))
tierno7edb6752016-03-21 17:37:52 +01002006 except (ksExceptions.ClientException, nvExceptions.ClientException) as e:
tierno1ec592d2020-06-16 15:29:47 +00002007 error_value = -vimconn.HTTP_Bad_Request
2008 error_text = type(e).__name__ + ": " + (str(e) if len(e.args) == 0 else str(e.args[0]))
2009 # TODO insert exception vimconn.HTTP_Unauthorized
2010 # if reaching here is because an exception
tierno9c5c8322018-03-23 15:44:03 +01002011 self.logger.debug("get_hosts " + error_text)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002012 return error_value, error_text
tierno7edb6752016-03-21 17:37:52 +01002013
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002014 def new_classification(self, name, ctype, definition):
tierno7d782ef2019-10-04 12:56:31 +00002015 self.logger.debug('Adding a new (Traffic) Classification to VIM, named %s', name)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002016 try:
2017 new_class = None
2018 self._reload_connection()
2019 if ctype not in supportedClassificationTypes:
tierno72774862020-05-04 11:44:15 +00002020 raise vimconn.VimConnNotSupportedException(
tierno1ec592d2020-06-16 15:29:47 +00002021 'OpenStack VIM connector does not support provided Classification Type {}, supported ones are: '
2022 '{}'.format(ctype, supportedClassificationTypes))
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002023 if not self._validate_classification(ctype, definition):
tierno72774862020-05-04 11:44:15 +00002024 raise vimconn.VimConnException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002025 'Incorrect Classification definition '
2026 'for the type specified.')
2027 classification_dict = definition
2028 classification_dict['name'] = name
tierno7edb6752016-03-21 17:37:52 +01002029
Igor D.Ccaadc442017-11-06 12:48:48 +00002030 new_class = self.neutron.create_sfc_flow_classifier(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002031 {'flow_classifier': classification_dict})
2032 return new_class['flow_classifier']['id']
2033 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2034 neExceptions.NeutronException, ConnectionError) as e:
2035 self.logger.error(
2036 'Creation of Classification failed.')
2037 self._format_exception(e)
2038
2039 def get_classification(self, class_id):
2040 self.logger.debug(" Getting Classification %s from VIM", class_id)
2041 filter_dict = {"id": class_id}
2042 class_list = self.get_classification_list(filter_dict)
2043 if len(class_list) == 0:
tierno72774862020-05-04 11:44:15 +00002044 raise vimconn.VimConnNotFoundException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002045 "Classification '{}' not found".format(class_id))
2046 elif len(class_list) > 1:
tierno72774862020-05-04 11:44:15 +00002047 raise vimconn.VimConnConflictException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002048 "Found more than one Classification with this criteria")
2049 classification = class_list[0]
2050 return classification
2051
2052 def get_classification_list(self, filter_dict={}):
2053 self.logger.debug("Getting Classifications from VIM filter: '%s'",
2054 str(filter_dict))
2055 try:
tierno69b590e2018-03-13 18:52:23 +01002056 filter_dict_os = filter_dict.copy()
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002057 self._reload_connection()
tierno69b590e2018-03-13 18:52:23 +01002058 if self.api_version3 and "tenant_id" in filter_dict_os:
2059 filter_dict_os['project_id'] = filter_dict_os.pop('tenant_id')
Igor D.Ccaadc442017-11-06 12:48:48 +00002060 classification_dict = self.neutron.list_sfc_flow_classifiers(
tierno69b590e2018-03-13 18:52:23 +01002061 **filter_dict_os)
2062 classification_list = classification_dict["flow_classifiers"]
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002063 self.__classification_os2mano(classification_list)
2064 return classification_list
2065 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2066 neExceptions.NeutronException, ConnectionError) as e:
2067 self._format_exception(e)
2068
2069 def delete_classification(self, class_id):
2070 self.logger.debug("Deleting Classification '%s' from VIM", class_id)
2071 try:
2072 self._reload_connection()
Igor D.Ccaadc442017-11-06 12:48:48 +00002073 self.neutron.delete_sfc_flow_classifier(class_id)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002074 return class_id
2075 except (neExceptions.ConnectionFailed, neExceptions.NeutronException,
2076 ksExceptions.ClientException, neExceptions.NeutronException,
2077 ConnectionError) as e:
2078 self._format_exception(e)
2079
2080 def new_sfi(self, name, ingress_ports, egress_ports, sfc_encap=True):
tierno7d782ef2019-10-04 12:56:31 +00002081 self.logger.debug("Adding a new Service Function Instance to VIM, named '%s'", name)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002082 try:
2083 new_sfi = None
2084 self._reload_connection()
2085 correlation = None
2086 if sfc_encap:
Igor D.Ccaadc442017-11-06 12:48:48 +00002087 correlation = 'nsh'
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002088 if len(ingress_ports) != 1:
tierno72774862020-05-04 11:44:15 +00002089 raise vimconn.VimConnNotSupportedException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002090 "OpenStack VIM connector can only have "
2091 "1 ingress port per SFI")
2092 if len(egress_ports) != 1:
tierno72774862020-05-04 11:44:15 +00002093 raise vimconn.VimConnNotSupportedException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002094 "OpenStack VIM connector can only have "
2095 "1 egress port per SFI")
2096 sfi_dict = {'name': name,
2097 'ingress': ingress_ports[0],
2098 'egress': egress_ports[0],
2099 'service_function_parameters': {
2100 'correlation': correlation}}
Igor D.Ccaadc442017-11-06 12:48:48 +00002101 new_sfi = self.neutron.create_sfc_port_pair({'port_pair': sfi_dict})
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002102 return new_sfi['port_pair']['id']
2103 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2104 neExceptions.NeutronException, ConnectionError) as e:
2105 if new_sfi:
2106 try:
Igor D.Ccaadc442017-11-06 12:48:48 +00002107 self.neutron.delete_sfc_port_pair(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002108 new_sfi['port_pair']['id'])
2109 except Exception:
2110 self.logger.error(
2111 'Creation of Service Function Instance failed, with '
2112 'subsequent deletion failure as well.')
2113 self._format_exception(e)
2114
2115 def get_sfi(self, sfi_id):
tierno7d782ef2019-10-04 12:56:31 +00002116 self.logger.debug('Getting Service Function Instance %s from VIM', sfi_id)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002117 filter_dict = {"id": sfi_id}
2118 sfi_list = self.get_sfi_list(filter_dict)
2119 if len(sfi_list) == 0:
tierno72774862020-05-04 11:44:15 +00002120 raise vimconn.VimConnNotFoundException("Service Function Instance '{}' not found".format(sfi_id))
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002121 elif len(sfi_list) > 1:
tierno72774862020-05-04 11:44:15 +00002122 raise vimconn.VimConnConflictException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002123 'Found more than one Service Function Instance '
2124 'with this criteria')
2125 sfi = sfi_list[0]
2126 return sfi
2127
2128 def get_sfi_list(self, filter_dict={}):
tierno7d782ef2019-10-04 12:56:31 +00002129 self.logger.debug("Getting Service Function Instances from VIM filter: '%s'", str(filter_dict))
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002130 try:
2131 self._reload_connection()
tierno69b590e2018-03-13 18:52:23 +01002132 filter_dict_os = filter_dict.copy()
2133 if self.api_version3 and "tenant_id" in filter_dict_os:
2134 filter_dict_os['project_id'] = filter_dict_os.pop('tenant_id')
2135 sfi_dict = self.neutron.list_sfc_port_pairs(**filter_dict_os)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002136 sfi_list = sfi_dict["port_pairs"]
2137 self.__sfi_os2mano(sfi_list)
2138 return sfi_list
2139 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2140 neExceptions.NeutronException, ConnectionError) as e:
2141 self._format_exception(e)
2142
2143 def delete_sfi(self, sfi_id):
2144 self.logger.debug("Deleting Service Function Instance '%s' "
2145 "from VIM", sfi_id)
2146 try:
2147 self._reload_connection()
Igor D.Ccaadc442017-11-06 12:48:48 +00002148 self.neutron.delete_sfc_port_pair(sfi_id)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002149 return sfi_id
2150 except (neExceptions.ConnectionFailed, neExceptions.NeutronException,
2151 ksExceptions.ClientException, neExceptions.NeutronException,
2152 ConnectionError) as e:
2153 self._format_exception(e)
2154
2155 def new_sf(self, name, sfis, sfc_encap=True):
tierno7d782ef2019-10-04 12:56:31 +00002156 self.logger.debug("Adding a new Service Function to VIM, named '%s'", name)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002157 try:
2158 new_sf = None
2159 self._reload_connection()
tierno9c5c8322018-03-23 15:44:03 +01002160 # correlation = None
2161 # if sfc_encap:
2162 # correlation = 'nsh'
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002163 for instance in sfis:
2164 sfi = self.get_sfi(instance)
Igor D.Ccaadc442017-11-06 12:48:48 +00002165 if sfi.get('sfc_encap') != sfc_encap:
tierno72774862020-05-04 11:44:15 +00002166 raise vimconn.VimConnNotSupportedException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002167 "OpenStack VIM connector requires all SFIs of the "
2168 "same SF to share the same SFC Encapsulation")
2169 sf_dict = {'name': name,
2170 'port_pairs': sfis}
Igor D.Ccaadc442017-11-06 12:48:48 +00002171 new_sf = self.neutron.create_sfc_port_pair_group({
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002172 'port_pair_group': sf_dict})
2173 return new_sf['port_pair_group']['id']
2174 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2175 neExceptions.NeutronException, ConnectionError) as e:
2176 if new_sf:
2177 try:
Igor D.Ccaadc442017-11-06 12:48:48 +00002178 self.neutron.delete_sfc_port_pair_group(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002179 new_sf['port_pair_group']['id'])
2180 except Exception:
2181 self.logger.error(
2182 'Creation of Service Function failed, with '
2183 'subsequent deletion failure as well.')
2184 self._format_exception(e)
2185
2186 def get_sf(self, sf_id):
2187 self.logger.debug("Getting Service Function %s from VIM", sf_id)
2188 filter_dict = {"id": sf_id}
2189 sf_list = self.get_sf_list(filter_dict)
2190 if len(sf_list) == 0:
tierno72774862020-05-04 11:44:15 +00002191 raise vimconn.VimConnNotFoundException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002192 "Service Function '{}' not found".format(sf_id))
2193 elif len(sf_list) > 1:
tierno72774862020-05-04 11:44:15 +00002194 raise vimconn.VimConnConflictException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002195 "Found more than one Service Function with this criteria")
2196 sf = sf_list[0]
2197 return sf
2198
2199 def get_sf_list(self, filter_dict={}):
2200 self.logger.debug("Getting Service Function from VIM filter: '%s'",
2201 str(filter_dict))
2202 try:
2203 self._reload_connection()
tierno69b590e2018-03-13 18:52:23 +01002204 filter_dict_os = filter_dict.copy()
2205 if self.api_version3 and "tenant_id" in filter_dict_os:
2206 filter_dict_os['project_id'] = filter_dict_os.pop('tenant_id')
2207 sf_dict = self.neutron.list_sfc_port_pair_groups(**filter_dict_os)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002208 sf_list = sf_dict["port_pair_groups"]
2209 self.__sf_os2mano(sf_list)
2210 return sf_list
2211 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2212 neExceptions.NeutronException, ConnectionError) as e:
2213 self._format_exception(e)
2214
2215 def delete_sf(self, sf_id):
2216 self.logger.debug("Deleting Service Function '%s' from VIM", sf_id)
2217 try:
2218 self._reload_connection()
Igor D.Ccaadc442017-11-06 12:48:48 +00002219 self.neutron.delete_sfc_port_pair_group(sf_id)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002220 return sf_id
2221 except (neExceptions.ConnectionFailed, neExceptions.NeutronException,
2222 ksExceptions.ClientException, neExceptions.NeutronException,
2223 ConnectionError) as e:
2224 self._format_exception(e)
2225
2226 def new_sfp(self, name, classifications, sfs, sfc_encap=True, spi=None):
tierno7d782ef2019-10-04 12:56:31 +00002227 self.logger.debug("Adding a new Service Function Path to VIM, named '%s'", name)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002228 try:
2229 new_sfp = None
2230 self._reload_connection()
Igor D.Ccaadc442017-11-06 12:48:48 +00002231 # In networking-sfc the MPLS encapsulation is legacy
2232 # should be used when no full SFC Encapsulation is intended
schillinge981df9a2019-01-24 09:25:11 +01002233 correlation = 'mpls'
Igor D.Ccaadc442017-11-06 12:48:48 +00002234 if sfc_encap:
2235 correlation = 'nsh'
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002236 sfp_dict = {'name': name,
2237 'flow_classifiers': classifications,
2238 'port_pair_groups': sfs,
2239 'chain_parameters': {'correlation': correlation}}
2240 if spi:
2241 sfp_dict['chain_id'] = spi
Igor D.Ccaadc442017-11-06 12:48:48 +00002242 new_sfp = self.neutron.create_sfc_port_chain({'port_chain': sfp_dict})
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002243 return new_sfp["port_chain"]["id"]
2244 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2245 neExceptions.NeutronException, ConnectionError) as e:
2246 if new_sfp:
2247 try:
Igor D.Ccaadc442017-11-06 12:48:48 +00002248 self.neutron.delete_sfc_port_chain(new_sfp['port_chain']['id'])
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002249 except Exception:
2250 self.logger.error(
2251 'Creation of Service Function Path failed, with '
2252 'subsequent deletion failure as well.')
2253 self._format_exception(e)
2254
2255 def get_sfp(self, sfp_id):
2256 self.logger.debug(" Getting Service Function Path %s from VIM", sfp_id)
2257 filter_dict = {"id": sfp_id}
2258 sfp_list = self.get_sfp_list(filter_dict)
2259 if len(sfp_list) == 0:
tierno72774862020-05-04 11:44:15 +00002260 raise vimconn.VimConnNotFoundException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002261 "Service Function Path '{}' not found".format(sfp_id))
2262 elif len(sfp_list) > 1:
tierno72774862020-05-04 11:44:15 +00002263 raise vimconn.VimConnConflictException(
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002264 "Found more than one Service Function Path with this criteria")
2265 sfp = sfp_list[0]
2266 return sfp
2267
2268 def get_sfp_list(self, filter_dict={}):
tierno7d782ef2019-10-04 12:56:31 +00002269 self.logger.debug("Getting Service Function Paths from VIM filter: '%s'", str(filter_dict))
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002270 try:
2271 self._reload_connection()
tierno69b590e2018-03-13 18:52:23 +01002272 filter_dict_os = filter_dict.copy()
2273 if self.api_version3 and "tenant_id" in filter_dict_os:
2274 filter_dict_os['project_id'] = filter_dict_os.pop('tenant_id')
2275 sfp_dict = self.neutron.list_sfc_port_chains(**filter_dict_os)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002276 sfp_list = sfp_dict["port_chains"]
2277 self.__sfp_os2mano(sfp_list)
2278 return sfp_list
2279 except (neExceptions.ConnectionFailed, ksExceptions.ClientException,
2280 neExceptions.NeutronException, ConnectionError) as e:
2281 self._format_exception(e)
2282
2283 def delete_sfp(self, sfp_id):
tierno7d782ef2019-10-04 12:56:31 +00002284 self.logger.debug("Deleting Service Function Path '%s' from VIM", sfp_id)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002285 try:
2286 self._reload_connection()
Igor D.Ccaadc442017-11-06 12:48:48 +00002287 self.neutron.delete_sfc_port_chain(sfp_id)
Igor Duarte Cardoso3cf9bcd2017-08-14 16:39:34 +00002288 return sfp_id
2289 except (neExceptions.ConnectionFailed, neExceptions.NeutronException,
2290 ksExceptions.ClientException, neExceptions.NeutronException,
2291 ConnectionError) as e:
2292 self._format_exception(e)
borsatti8a2dda32019-12-18 15:08:57 +00002293
borsatti8a2dda32019-12-18 15:08:57 +00002294 def refresh_sfps_status(self, sfp_list):
tierno1ec592d2020-06-16 15:29:47 +00002295 """Get the status of the service function path
borsatti8a2dda32019-12-18 15:08:57 +00002296 Params: the list of sfp identifiers
2297 Returns a dictionary with:
2298 vm_id: #VIM id of this service function path
2299 status: #Mandatory. Text with one of:
2300 # DELETED (not found at vim)
2301 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2302 # OTHER (Vim reported other status not understood)
2303 # ERROR (VIM indicates an ERROR status)
2304 # ACTIVE,
2305 # CREATING (on building process)
2306 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2307 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)F
tierno1ec592d2020-06-16 15:29:47 +00002308 """
2309 sfp_dict = {}
borsatti8a2dda32019-12-18 15:08:57 +00002310 self.logger.debug("refresh_sfps status: Getting tenant SFP information from VIM")
2311 for sfp_id in sfp_list:
tierno1ec592d2020-06-16 15:29:47 +00002312 sfp = {}
borsatti8a2dda32019-12-18 15:08:57 +00002313 try:
2314 sfp_vim = self.get_sfp(sfp_id)
2315 if sfp_vim['spi']:
tierno1ec592d2020-06-16 15:29:47 +00002316 sfp['status'] = vmStatus2manoFormat['ACTIVE']
borsatti8a2dda32019-12-18 15:08:57 +00002317 else:
tierno1ec592d2020-06-16 15:29:47 +00002318 sfp['status'] = "OTHER"
2319 sfp['error_msg'] = "VIM status reported " + sfp['status']
borsatti8a2dda32019-12-18 15:08:57 +00002320
2321 sfp['vim_info'] = self.serialize(sfp_vim)
2322
2323 if sfp_vim.get('fault'):
2324 sfp['error_msg'] = str(sfp_vim['fault'])
2325
tierno72774862020-05-04 11:44:15 +00002326 except vimconn.VimConnNotFoundException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002327 self.logger.error("Exception getting sfp status: %s", str(e))
2328 sfp['status'] = "DELETED"
2329 sfp['error_msg'] = str(e)
tierno72774862020-05-04 11:44:15 +00002330 except vimconn.VimConnException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002331 self.logger.error("Exception getting sfp status: %s", str(e))
2332 sfp['status'] = "VIM_ERROR"
2333 sfp['error_msg'] = str(e)
2334 sfp_dict[sfp_id] = sfp
2335 return sfp_dict
2336
borsatti8a2dda32019-12-18 15:08:57 +00002337 def refresh_sfis_status(self, sfi_list):
tierno1ec592d2020-06-16 15:29:47 +00002338 """Get the status of the service function instances
borsatti8a2dda32019-12-18 15:08:57 +00002339 Params: the list of sfi identifiers
2340 Returns a dictionary with:
2341 vm_id: #VIM id of this service function instance
2342 status: #Mandatory. Text with one of:
2343 # DELETED (not found at vim)
2344 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2345 # OTHER (Vim reported other status not understood)
2346 # ERROR (VIM indicates an ERROR status)
2347 # ACTIVE,
2348 # CREATING (on building process)
2349 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2350 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
tierno1ec592d2020-06-16 15:29:47 +00002351 """
2352 sfi_dict = {}
borsatti8a2dda32019-12-18 15:08:57 +00002353 self.logger.debug("refresh_sfis status: Getting tenant sfi information from VIM")
2354 for sfi_id in sfi_list:
tierno1ec592d2020-06-16 15:29:47 +00002355 sfi = {}
borsatti8a2dda32019-12-18 15:08:57 +00002356 try:
2357 sfi_vim = self.get_sfi(sfi_id)
2358 if sfi_vim:
tierno1ec592d2020-06-16 15:29:47 +00002359 sfi['status'] = vmStatus2manoFormat['ACTIVE']
borsatti8a2dda32019-12-18 15:08:57 +00002360 else:
tierno1ec592d2020-06-16 15:29:47 +00002361 sfi['status'] = "OTHER"
2362 sfi['error_msg'] = "VIM status reported " + sfi['status']
borsatti8a2dda32019-12-18 15:08:57 +00002363
2364 sfi['vim_info'] = self.serialize(sfi_vim)
2365
2366 if sfi_vim.get('fault'):
2367 sfi['error_msg'] = str(sfi_vim['fault'])
2368
tierno72774862020-05-04 11:44:15 +00002369 except vimconn.VimConnNotFoundException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002370 self.logger.error("Exception getting sfi status: %s", str(e))
2371 sfi['status'] = "DELETED"
2372 sfi['error_msg'] = str(e)
tierno72774862020-05-04 11:44:15 +00002373 except vimconn.VimConnException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002374 self.logger.error("Exception getting sfi status: %s", str(e))
2375 sfi['status'] = "VIM_ERROR"
2376 sfi['error_msg'] = str(e)
2377 sfi_dict[sfi_id] = sfi
2378 return sfi_dict
2379
borsatti8a2dda32019-12-18 15:08:57 +00002380 def refresh_sfs_status(self, sf_list):
tierno1ec592d2020-06-16 15:29:47 +00002381 """Get the status of the service functions
borsatti8a2dda32019-12-18 15:08:57 +00002382 Params: the list of sf identifiers
2383 Returns a dictionary with:
2384 vm_id: #VIM id of this service function
2385 status: #Mandatory. Text with one of:
2386 # DELETED (not found at vim)
2387 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2388 # OTHER (Vim reported other status not understood)
2389 # ERROR (VIM indicates an ERROR status)
2390 # ACTIVE,
2391 # CREATING (on building process)
2392 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2393 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
tierno1ec592d2020-06-16 15:29:47 +00002394 """
2395 sf_dict = {}
borsatti8a2dda32019-12-18 15:08:57 +00002396 self.logger.debug("refresh_sfs status: Getting tenant sf information from VIM")
2397 for sf_id in sf_list:
tierno1ec592d2020-06-16 15:29:47 +00002398 sf = {}
borsatti8a2dda32019-12-18 15:08:57 +00002399 try:
2400 sf_vim = self.get_sf(sf_id)
2401 if sf_vim:
tierno1ec592d2020-06-16 15:29:47 +00002402 sf['status'] = vmStatus2manoFormat['ACTIVE']
borsatti8a2dda32019-12-18 15:08:57 +00002403 else:
tierno1ec592d2020-06-16 15:29:47 +00002404 sf['status'] = "OTHER"
2405 sf['error_msg'] = "VIM status reported " + sf_vim['status']
borsatti8a2dda32019-12-18 15:08:57 +00002406
2407 sf['vim_info'] = self.serialize(sf_vim)
2408
2409 if sf_vim.get('fault'):
2410 sf['error_msg'] = str(sf_vim['fault'])
2411
tierno72774862020-05-04 11:44:15 +00002412 except vimconn.VimConnNotFoundException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002413 self.logger.error("Exception getting sf status: %s", str(e))
2414 sf['status'] = "DELETED"
2415 sf['error_msg'] = str(e)
tierno72774862020-05-04 11:44:15 +00002416 except vimconn.VimConnException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002417 self.logger.error("Exception getting sf status: %s", str(e))
2418 sf['status'] = "VIM_ERROR"
2419 sf['error_msg'] = str(e)
2420 sf_dict[sf_id] = sf
2421 return sf_dict
2422
borsatti8a2dda32019-12-18 15:08:57 +00002423 def refresh_classifications_status(self, classification_list):
tierno1ec592d2020-06-16 15:29:47 +00002424 """Get the status of the classifications
borsatti8a2dda32019-12-18 15:08:57 +00002425 Params: the list of classification identifiers
2426 Returns a dictionary with:
2427 vm_id: #VIM id of this classifier
2428 status: #Mandatory. Text with one of:
2429 # DELETED (not found at vim)
2430 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2431 # OTHER (Vim reported other status not understood)
2432 # ERROR (VIM indicates an ERROR status)
2433 # ACTIVE,
2434 # CREATING (on building process)
2435 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2436 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
tierno1ec592d2020-06-16 15:29:47 +00002437 """
2438 classification_dict = {}
borsatti8a2dda32019-12-18 15:08:57 +00002439 self.logger.debug("refresh_classifications status: Getting tenant classification information from VIM")
2440 for classification_id in classification_list:
tierno1ec592d2020-06-16 15:29:47 +00002441 classification = {}
borsatti8a2dda32019-12-18 15:08:57 +00002442 try:
2443 classification_vim = self.get_classification(classification_id)
2444 if classification_vim:
tierno1ec592d2020-06-16 15:29:47 +00002445 classification['status'] = vmStatus2manoFormat['ACTIVE']
borsatti8a2dda32019-12-18 15:08:57 +00002446 else:
tierno1ec592d2020-06-16 15:29:47 +00002447 classification['status'] = "OTHER"
2448 classification['error_msg'] = "VIM status reported " + classification['status']
borsatti8a2dda32019-12-18 15:08:57 +00002449
2450 classification['vim_info'] = self.serialize(classification_vim)
2451
2452 if classification_vim.get('fault'):
2453 classification['error_msg'] = str(classification_vim['fault'])
2454
tierno72774862020-05-04 11:44:15 +00002455 except vimconn.VimConnNotFoundException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002456 self.logger.error("Exception getting classification status: %s", str(e))
2457 classification['status'] = "DELETED"
2458 classification['error_msg'] = str(e)
tierno72774862020-05-04 11:44:15 +00002459 except vimconn.VimConnException as e:
borsatti8a2dda32019-12-18 15:08:57 +00002460 self.logger.error("Exception getting classification status: %s", str(e))
2461 classification['status'] = "VIM_ERROR"
2462 classification['error_msg'] = str(e)
2463 classification_dict[classification_id] = classification
2464 return classification_dict