1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
5 # This file is part of openmano
8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
9 # not use this file except in compliance with the License. You may obtain
10 # a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 # License for the specific language governing permissions and limitations
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact with: nfvlabs@tid.es
25 osconnector implements all the methods to interact with openstack using the python-client.
27 __author__
="Alfonso Tierno, Gerardo Garcia"
28 __date__
="$22-jun-2014 11:19:29$"
35 from novaclient
import client
as nClient
, exceptions
as nvExceptions
36 import keystoneclient
.v2_0
.client
as ksClient
37 import keystoneclient
.exceptions
as ksExceptions
38 import glanceclient
.v2
.client
as glClient
39 import glanceclient
.client
as gl1Client
40 import glanceclient
.exc
as gl1Exceptions
41 from httplib
import HTTPException
42 from neutronclient
.neutron
import client
as neClient
43 from neutronclient
.common
import exceptions
as neExceptions
44 from requests
.exceptions
import ConnectionError
46 '''contain the openstack virtual machine status to openmano status'''
47 vmStatus2manoFormat
={'ACTIVE':'ACTIVE',
49 'SUSPENDED': 'SUSPENDED',
52 'ERROR':'ERROR','DELETED':'DELETED'
54 netStatus2manoFormat
={'ACTIVE':'ACTIVE','PAUSED':'PAUSED','INACTIVE':'INACTIVE','BUILD':'BUILD','ERROR':'ERROR','DELETED':'DELETED'
57 class vimconnector(vimconn
.vimconnector
):
58 def __init__(self
, uuid
, name
, tenant_id
, tenant_name
, url
, url_admin
=None, user
=None, passwd
=None, log_level
="DEBUG", config
={}):
59 '''using common constructor parameters. In this case
60 'url' is the keystone authorization url,
61 'url_admin' is not use
63 vimconn
.vimconnector
.__init
__(self
, uuid
, name
, tenant_id
, tenant_name
, url
, url_admin
, user
, passwd
, log_level
, config
)
68 raise TypeError, 'url param can not be NoneType'
69 self
.k_creds
['auth_url'] = url
70 self
.n_creds
['auth_url'] = url
72 self
.k_creds
['tenant_name'] = tenant_name
73 self
.n_creds
['project_id'] = tenant_name
75 self
.k_creds
['tenant_id'] = tenant_id
76 self
.n_creds
['tenant_id'] = tenant_id
78 self
.k_creds
['username'] = user
79 self
.n_creds
['username'] = user
81 self
.k_creds
['password'] = passwd
82 self
.n_creds
['api_key'] = passwd
83 self
.reload_client
= True
84 self
.logger
= logging
.getLogger('mano.vim.openstack')
86 def __setitem__(self
,index
, value
):
87 '''Set individuals parameters
88 Throw TypeError, KeyError
90 if index
=='tenant_id':
91 self
.reload_client
=True
92 self
.tenant_id
= value
94 self
.k_creds
['tenant_id'] = value
95 self
.n_creds
['tenant_id'] = value
97 del self
.k_creds
['tenant_name']
98 del self
.n_creds
['project_id']
99 elif index
=='tenant_name':
100 self
.reload_client
=True
101 self
.tenant_name
= value
103 self
.k_creds
['tenant_name'] = value
104 self
.n_creds
['project_id'] = value
106 del self
.k_creds
['tenant_name']
107 del self
.n_creds
['project_id']
109 self
.reload_client
=True
112 self
.k_creds
['username'] = value
113 self
.n_creds
['username'] = value
115 del self
.k_creds
['username']
116 del self
.n_creds
['username']
117 elif index
=='passwd':
118 self
.reload_client
=True
121 self
.k_creds
['password'] = value
122 self
.n_creds
['api_key'] = value
124 del self
.k_creds
['password']
125 del self
.n_creds
['api_key']
127 self
.reload_client
=True
130 self
.k_creds
['auth_url'] = value
131 self
.n_creds
['auth_url'] = value
133 raise TypeError, 'url param can not be NoneType'
135 vimconn
.vimconnector
.__setitem
__(self
,index
, value
)
137 def _reload_connection(self
):
138 '''Called before any operation, it check if credentials has changed
139 Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
141 #TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
142 if self
.reload_client
:
144 if len(self
.n_creds
) <4:
145 raise ksExceptions
.ClientException("Not enough parameters to connect to openstack")
146 self
.nova
= nClient
.Client(2, **self
.n_creds
)
147 self
.keystone
= ksClient
.Client(**self
.k_creds
)
148 self
.glance_endpoint
= self
.keystone
.service_catalog
.url_for(service_type
='image', endpoint_type
='publicURL')
149 self
.glance
= glClient
.Client(self
.glance_endpoint
, token
=self
.keystone
.auth_token
, **self
.k_creds
) #TODO check k_creds vs n_creds
150 self
.ne_endpoint
=self
.keystone
.service_catalog
.url_for(service_type
='network', endpoint_type
='publicURL')
151 self
.neutron
= neClient
.Client('2.0', endpoint_url
=self
.ne_endpoint
, token
=self
.keystone
.auth_token
, **self
.k_creds
)
152 self
.reload_client
= False
154 def __net_os2mano(self
, net_list_dict
):
155 '''Transform the net openstack format to mano format
156 net_list_dict can be a list of dict or a single dict'''
157 if type(net_list_dict
) is dict:
158 net_list_
=(net_list_dict
,)
159 elif type(net_list_dict
) is list:
160 net_list_
=net_list_dict
162 raise TypeError("param net_list_dict must be a list or a dictionary")
163 for net
in net_list_
:
164 if net
.get('provider:network_type') == "vlan":
171 def _format_exception(self
, exception
):
172 '''Transform a keystone, nova, neutron exception into a vimconn exception'''
173 if isinstance(exception
, (HTTPException
, gl1Exceptions
.HTTPException
, gl1Exceptions
.CommunicationError
,
174 ConnectionError
, ksExceptions
.ConnectionError
, neExceptions
.ConnectionFailed
,
175 neClient
.exceptions
.ConnectionFailed
)):
176 raise vimconn
.vimconnConnectionException(type(exception
).__name
__ + ": " + str(exception
))
177 elif isinstance(exception
, (nvExceptions
.ClientException
, ksExceptions
.ClientException
,
178 neExceptions
.NeutronException
, nvExceptions
.BadRequest
)):
179 raise vimconn
.vimconnUnexpectedResponse(type(exception
).__name
__ + ": " + str(exception
))
180 elif isinstance(exception
, (neExceptions
.NetworkNotFoundClient
, nvExceptions
.NotFound
)):
181 raise vimconn
.vimconnNotFoundException(type(exception
).__name
__ + ": " + str(exception
))
182 elif isinstance(exception
, nvExceptions
.Conflict
):
183 raise vimconn
.vimconnConflictException(type(exception
).__name
__ + ": " + str(exception
))
185 raise vimconn
.vimconnConnectionException(type(exception
).__name
__ + ": " + str(exception
))
187 def get_tenant_list(self
, filter_dict
={}):
188 '''Obtain tenants of VIM
189 filter_dict can contain the following keys:
190 name: filter by tenant name
191 id: filter by tenant uuid/id
193 Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
195 self
.logger
.debug("Getting tenant from VIM filter: '%s'", str(filter_dict
))
197 self
._reload
_connection
()
198 tenant_class_list
=self
.keystone
.tenants
.findall(**filter_dict
)
200 for tenant
in tenant_class_list
:
201 tenant_list
.append(tenant
.to_dict())
203 except (ksExceptions
.ConnectionError
, ksExceptions
.ClientException
) as e
:
204 self
._format
_exception
(e
)
206 def new_tenant(self
, tenant_name
, tenant_description
):
207 '''Adds a new tenant to openstack VIM. Returns the tenant identifier'''
208 self
.logger
.debug("Adding a new tenant name: %s", tenant_name
)
210 self
._reload
_connection
()
211 tenant
=self
.keystone
.tenants
.create(tenant_name
, tenant_description
)
213 except (ksExceptions
.ConnectionError
, ksExceptions
.ClientException
) as e
:
214 self
._format
_exception
(e
)
216 def delete_tenant(self
, tenant_id
):
217 '''Delete a tenant from openstack VIM. Returns the old tenant identifier'''
218 self
.logger
.debug("Deleting tenant %s from VIM", tenant_id
)
220 self
._reload
_connection
()
221 self
.keystone
.tenants
.delete(tenant_id
)
223 except (ksExceptions
.ConnectionError
, ksExceptions
.ClientException
) as e
:
224 self
._format
_exception
(e
)
226 def new_network(self
,net_name
,net_type
, shared
=False, cidr
=None, vlan
=None):
227 '''Adds a tenant network to VIM. Returns the network identifier'''
228 self
.logger
.debug("Adding a new network to VIM name '%s', type '%s'", net_name
, net_type
)
230 self
._reload
_connection
()
231 network_dict
= {'name': net_name
, 'admin_state_up': True}
232 if net_type
=="data" or net_type
=="ptp":
233 if self
.config
.get('dataplane_physical_net') == None:
234 raise vimconn
.vimconnConflictException("You must provide a 'dataplane_physical_net' at config value before creating sriov network")
235 network_dict
["provider:physical_network"] = self
.config
['dataplane_physical_net'] #"physnet_sriov" #TODO physical
236 network_dict
["provider:network_type"] = "vlan"
238 network_dict
["provider:network_type"] = vlan
239 network_dict
["shared"]=shared
240 new_net
=self
.neutron
.create_network({'network':network_dict
})
242 #create fake subnetwork
244 cidr
="192.168.111.0/24"
245 subnet
={"name":net_name
+"-subnet",
246 "network_id": new_net
["network"]["id"],
250 self
.neutron
.create_subnet({"subnet": subnet
} )
251 return new_net
["network"]["id"]
252 except (neExceptions
.ConnectionFailed
, ksExceptions
.ClientException
, neExceptions
.NeutronException
) as e
:
253 self
._format
_exception
(e
)
255 def get_network_list(self
, filter_dict
={}):
256 '''Obtain tenant networks of VIM
262 admin_state_up: boolean
264 Returns the network list of dictionaries
266 self
.logger
.debug("Getting network from VIM filter: '%s'", str(filter_dict
))
268 self
._reload
_connection
()
269 net_dict
=self
.neutron
.list_networks(**filter_dict
)
270 net_list
=net_dict
["networks"]
271 self
.__net
_os
2mano
(net_list
)
273 except (neExceptions
.ConnectionFailed
, neClient
.exceptions
.ConnectionFailed
, ksExceptions
.ClientException
, neExceptions
.NeutronException
) as e
:
274 self
._format
_exception
(e
)
276 def get_network(self
, net_id
):
277 '''Obtain details of network from VIM
278 Returns the network information from a network id'''
279 self
.logger
.debug(" Getting tenant network %s from VIM", net_id
)
280 filter_dict
={"id": net_id
}
281 net_list
= self
.get_network_list(filter_dict
)
283 raise vimconn
.vimconnNotFoundException("Network '{}' not found".format(net_id
))
284 elif len(net_list
)>1:
285 raise vimconn
.vimconnConflictException("Found more than one network with this criteria")
288 for subnet_id
in net
.get("subnets", () ):
290 subnet
= self
.neutron
.show_subnet(subnet_id
)
291 except Exception as e
:
292 self
.logger
.error("osconnector.get_network(): Error getting subnet %s %s" % (net_id
, str(e
)))
293 subnet
= {"id": subnet_id
, "fault": str(e
)}
294 subnets
.append(subnet
)
295 net
["subnets"] = subnets
298 def delete_network(self
, net_id
):
299 '''Deletes a tenant network from VIM. Returns the old network identifier'''
300 self
.logger
.debug("Deleting network '%s' from VIM", net_id
)
302 self
._reload
_connection
()
303 #delete VM ports attached to this networks before the network
304 ports
= self
.neutron
.list_ports(network_id
=net_id
)
305 for p
in ports
['ports']:
307 self
.neutron
.delete_port(p
["id"])
308 except Exception as e
:
309 self
.logger
.error("Error deleting port %s: %s", p
["id"], str(e
))
310 self
.neutron
.delete_network(net_id
)
312 except (neExceptions
.ConnectionFailed
, neExceptions
.NetworkNotFoundClient
, neExceptions
.NeutronException
,
313 neClient
.exceptions
.ConnectionFailed
, ksExceptions
.ClientException
, neExceptions
.NeutronException
) as e
:
314 self
._format
_exception
(e
)
316 def refresh_nets_status(self
, net_list
):
317 '''Get the status of the networks
318 Params: the list of network identifiers
319 Returns a dictionary with:
320 net_id: #VIM id of this network
321 status: #Mandatory. Text with one of:
322 # DELETED (not found at vim)
323 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
324 # OTHER (Vim reported other status not understood)
325 # ERROR (VIM indicates an ERROR status)
326 # ACTIVE, INACTIVE, DOWN (admin down),
327 # BUILD (on building process)
329 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
330 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
334 for net_id
in net_list
:
337 net_vim
= self
.get_network(net_id
)
338 if net_vim
['status'] in netStatus2manoFormat
:
339 net
["status"] = netStatus2manoFormat
[ net_vim
['status'] ]
341 net
["status"] = "OTHER"
342 net
["error_msg"] = "VIM status reported " + net_vim
['status']
344 if net
['status'] == "ACIVE" and not net_vim
['admin_state_up']:
345 net
['status'] = 'DOWN'
346 net
['vim_info'] = yaml
.safe_dump(net_vim
)
347 if net_vim
.get('fault'): #TODO
348 net
['error_msg'] = str(net_vim
['fault'])
349 except vimconn
.vimconnNotFoundException
as e
:
350 self
.logger
.error("Exception getting net status: %s", str(e
))
351 net
['status'] = "DELETED"
352 net
['error_msg'] = str(e
)
353 except vimconn
.vimconnException
as e
:
354 self
.logger
.error("Exception getting net status: %s", str(e
))
355 net
['status'] = "VIM_ERROR"
356 net
['error_msg'] = str(e
)
357 net_dict
[net_id
] = net
360 def get_flavor(self
, flavor_id
):
361 '''Obtain flavor details from the VIM. Returns the flavor dict details'''
362 self
.logger
.debug("Getting flavor '%s'", flavor_id
)
364 self
._reload
_connection
()
365 flavor
= self
.nova
.flavors
.find(id=flavor_id
)
366 #TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
367 return flavor
.to_dict()
368 except (nvExceptions
.NotFound
, nvExceptions
.ClientException
, ksExceptions
.ClientException
) as e
:
369 self
._format
_exception
(e
)
371 def new_flavor(self
, flavor_data
, change_name_if_used
=True):
372 '''Adds a tenant flavor to openstack VIM
373 if change_name_if_used is True, it will change name in case of conflict, because it is not supported name repetition
374 Returns the flavor identifier
376 self
.logger
.debug("Adding flavor '%s'", str(flavor_data
))
380 name
=flavor_data
['name']
381 while retry
<max_retries
:
384 self
._reload
_connection
()
385 if change_name_if_used
:
388 fl
=self
.nova
.flavors
.list()
390 fl_names
.append(f
.name
)
391 while name
in fl_names
:
393 name
= flavor_data
['name']+"-" + str(name_suffix
)
395 ram
= flavor_data
.get('ram',64)
396 vcpus
= flavor_data
.get('vcpus',1)
399 extended
= flavor_data
.get("extended")
401 numas
=extended
.get("numas")
403 numa_nodes
= len(numas
)
405 return -1, "Can not add flavor with more than one numa"
406 numa_properties
= {"hw:numa_nodes":str(numa_nodes
)}
407 numa_properties
["hw:mem_page_size"] = "large"
408 numa_properties
["hw:cpu_policy"] = "dedicated"
409 numa_properties
["hw:numa_mempolicy"] = "strict"
411 #overwrite ram and vcpus
412 ram
= numa
['memory']*1024
413 if 'paired-threads' in numa
:
414 vcpus
= numa
['paired-threads']*2
415 numa_properties
["hw:cpu_threads_policy"] = "prefer"
416 elif 'cores' in numa
:
417 vcpus
= numa
['cores']
418 #numa_properties["hw:cpu_threads_policy"] = "prefer"
419 elif 'threads' in numa
:
420 vcpus
= numa
['threads']
421 numa_properties
["hw:cpu_policy"] = "isolated"
422 for interface
in numa
.get("interfaces",() ):
423 if interface
["dedicated"]=="yes":
424 raise vimconn
.vimconnException("Passthrough interfaces are not supported for the openstack connector", http_code
=vimconn
.HTTP_Service_Unavailable
)
425 #TODO, add the key 'pci_passthrough:alias"="<label at config>:<number ifaces>"' when a way to connect it is available
428 new_flavor
=self
.nova
.flavors
.create(name
,
431 flavor_data
.get('disk',1),
432 is_public
=flavor_data
.get('is_public', True)
436 new_flavor
.set_keys(numa_properties
)
438 except nvExceptions
.Conflict
as e
:
439 if change_name_if_used
and retry
< max_retries
:
441 self
._format
_exception
(e
)
442 #except nvExceptions.BadRequest as e:
443 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
, ConnectionError
) as e
:
444 self
._format
_exception
(e
)
446 def delete_flavor(self
,flavor_id
):
447 '''Deletes a tenant flavor from openstack VIM. Returns the old flavor_id
450 self
._reload
_connection
()
451 self
.nova
.flavors
.delete(flavor_id
)
453 #except nvExceptions.BadRequest as e:
454 except (nvExceptions
.NotFound
, ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
455 self
._format
_exception
(e
)
457 def new_image(self
,image_dict
):
459 Adds a tenant image to VIM. imge_dict is a dictionary with:
461 disk_format: qcow2, vhd, vmdk, raw (by default), ...
462 location: path or URI
463 public: "yes" or "no"
464 metadata: metadata of the image
467 #using version 1 of glance client
468 glancev1
= gl1Client
.Client('1',self
.glance_endpoint
, token
=self
.keystone
.auth_token
, **self
.k_creds
) #TODO check k_creds vs n_creds
471 while retry
<max_retries
:
474 self
._reload
_connection
()
475 #determine format http://docs.openstack.org/developer/glance/formats.html
476 if "disk_format" in image_dict
:
477 disk_format
=image_dict
["disk_format"]
478 else: #autodiscover base on extention
479 if image_dict
['location'][-6:]==".qcow2":
481 elif image_dict
['location'][-4:]==".vhd":
483 elif image_dict
['location'][-5:]==".vmdk":
485 elif image_dict
['location'][-4:]==".vdi":
487 elif image_dict
['location'][-4:]==".iso":
489 elif image_dict
['location'][-4:]==".aki":
491 elif image_dict
['location'][-4:]==".ari":
493 elif image_dict
['location'][-4:]==".ami":
497 self
.logger
.debug("new_image: '%s' loading from '%s'", image_dict
['name'], image_dict
['location'])
498 if image_dict
['location'][0:4]=="http":
499 new_image
= glancev1
.images
.create(name
=image_dict
['name'], is_public
=image_dict
.get('public',"yes")=="yes",
500 container_format
="bare", location
=image_dict
['location'], disk_format
=disk_format
)
502 with
open(image_dict
['location']) as fimage
:
503 new_image
= glancev1
.images
.create(name
=image_dict
['name'], is_public
=image_dict
.get('public',"yes")=="yes",
504 container_format
="bare", data
=fimage
, disk_format
=disk_format
)
505 #insert metadata. We cannot use 'new_image.properties.setdefault'
506 #because nova and glance are "INDEPENDENT" and we are using nova for reading metadata
507 new_image_nova
=self
.nova
.images
.find(id=new_image
.id)
508 new_image_nova
.metadata
.setdefault('location',image_dict
['location'])
509 metadata_to_load
= image_dict
.get('metadata')
511 for k
,v
in yaml
.load(metadata_to_load
).iteritems():
512 new_image_nova
.metadata
.setdefault(k
,v
)
514 except (nvExceptions
.Conflict
, ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
515 self
._format
_exception
(e
)
516 except (HTTPException
, gl1Exceptions
.HTTPException
, gl1Exceptions
.CommunicationError
) as e
:
517 if retry
==max_retries
:
519 self
._format
_exception
(e
)
520 except IOError as e
: #can not open the file
521 raise vimconn
.vimconnConnectionException(type(e
).__name
__ + ": " + str(e
)+ " for " + image_dict
['location'],
522 http_code
=vimconn
.HTTP_Bad_Request
)
524 def delete_image(self
, image_id
):
525 '''Deletes a tenant image from openstack VIM. Returns the old id
528 self
._reload
_connection
()
529 self
.nova
.images
.delete(image_id
)
531 except (nvExceptions
.NotFound
, ksExceptions
.ClientException
, nvExceptions
.ClientException
, gl1Exceptions
.CommunicationError
) as e
: #TODO remove
532 self
._format
_exception
(e
)
534 def get_image_id_from_path(self
, path
):
535 '''Get the image id from image path in the VIM database. Returns the image_id
538 self
._reload
_connection
()
539 images
= self
.nova
.images
.list()
541 if image
.metadata
.get("location")==path
:
543 raise vimconn
.vimconnNotFoundException("image with location '{}' not found".format( path
))
544 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
, gl1Exceptions
.CommunicationError
) as e
:
545 self
._format
_exception
(e
)
547 def new_vminstance(self
,name
,description
,start
,image_id
,flavor_id
,net_list
):
548 '''Adds a VM instance to VIM
550 start: indicates if VM must start or boot in pause mode. Ignored
551 image_id,flavor_id: iamge and flavor uuid
552 net_list: list of interfaces, each one is a dictionary with:
554 net_id: network uuid to connect
555 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
556 model: interface model, ignored #TODO
557 mac_address: used for SR-IOV ifaces #TODO for other types
558 use: 'data', 'bridge', 'mgmt'
559 type: 'virtual', 'PF', 'VF', 'VFnotShared'
560 vim_id: filled/added by this function
561 #TODO ip, security groups
562 Returns the instance identifier
564 self
.logger
.debug("Creating VM image '%s' flavor '%s' nics='%s'",image_id
, flavor_id
,str(net_list
))
568 self
._reload
_connection
()
569 metadata_vpci
={} #For a specific neutron plugin
571 if not net
.get("net_id"): #skip non connected iface
573 if net
["type"]=="virtual":
574 net_list_vim
.append({'net-id': net
["net_id"]})
576 metadata_vpci
[ net
["net_id"] ] = [[ net
["vpci"], "" ]]
577 elif net
["type"]=="PF":
578 self
.logger
.warn("new_vminstance: Warning, can not connect a passthrough interface ")
579 #TODO insert this when openstack consider passthrough ports as openstack neutron ports
582 if "VF" not in metadata_vpci
:
583 metadata_vpci
["VF"]=[]
584 metadata_vpci
["VF"].append([ net
["vpci"], "" ])
586 "network_id": net
["net_id"],
587 "name": net
.get("name"),
588 "binding:vnic_type": "direct",
589 "admin_state_up": True
591 if not port_dict
["name"]:
592 port_dict
["name"] = name
593 if net
.get("mac_address"):
594 port_dict
["mac_address"]=net
["mac_address"]
595 #TODO: manage having SRIOV without vlan tag
596 #if net["type"] == "VFnotShared"
597 # port_dict["vlan"]=0
598 new_port
= self
.neutron
.create_port({"port": port_dict
})
599 net
["mac_adress"] = new_port
["port"]["mac_address"]
600 net
["vim_id"] = new_port
["port"]["id"]
601 net
["ip"] = new_port
["port"].get("fixed_ips",[{}])[0].get("ip_address")
602 net_list_vim
.append({"port-id": new_port
["port"]["id"]})
604 metadata
= {"pci_assignement": json
.dumps(metadata_vpci
)}
605 if len(metadata
["pci_assignement"]) >255:
606 #limit the metadata size
607 #metadata["pci_assignement"] = metadata["pci_assignement"][0:255]
608 self
.logger
.warn("Metadata deleted since it exceeds the expected length (255) ")
611 self
.logger
.debug("name '%s' image_id '%s'flavor_id '%s' net_list_vim '%s' description '%s' metadata %s",
612 name
, image_id
, flavor_id
, str(net_list_vim
), description
, str(metadata
))
614 security_groups
= self
.config
.get('security_groups')
615 if type(security_groups
) is str:
616 security_groups
= ( security_groups
, )
617 server
= self
.nova
.servers
.create(name
, image_id
, flavor_id
, nics
=net_list_vim
, meta
=metadata
,
618 security_groups
= security_groups
,
619 availability_zone
= self
.config
.get('availability_zone'),
620 key_name
= self
.config
.get('keypair'),
621 ) #, description=description)
624 #print "DONE :-)", server
626 # #TODO server.add_floating_ip("10.95.87.209")
627 # #To look for a free floating_ip
628 # free_floating_ip = None
629 # for floating_ip in self.neutron.list_floatingips().get("floatingips", () ):
630 # if not floating_ip["port_id"]:
631 # free_floating_ip = floating_ip["floating_ip_address"]
633 # if free_floating_ip:
634 # server.add_floating_ip(free_floating_ip)
638 # except nvExceptions.NotFound as e:
639 # error_value=-vimconn.HTTP_Not_Found
640 # error_text= "vm instance %s not found" % vm_id
641 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
, ConnectionError
,
642 neClient
.exceptions
.ConnectionFailed
) as e
:
643 self
._format
_exception
(e
)
644 except TypeError as e
:
645 raise vimconn
.vimconnException(type(e
).__name
__ + ": "+ str(e
), http_code
=vimconn
.HTTP_Bad_Request
)
647 def get_vminstance(self
,vm_id
):
648 '''Returns the VM instance information from VIM'''
649 #self.logger.debug("Getting VM from VIM")
651 self
._reload
_connection
()
652 server
= self
.nova
.servers
.find(id=vm_id
)
653 #TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
654 return server
.to_dict()
655 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
, nvExceptions
.NotFound
) as e
:
656 self
._format
_exception
(e
)
658 def get_vminstance_console(self
,vm_id
, console_type
="vnc"):
660 Get a console for the virtual machine
662 vm_id: uuid of the VM
663 console_type, can be:
664 "novnc" (by default), "xvpvnc" for VNC types,
665 "rdp-html5" for RDP types, "spice-html5" for SPICE types
666 Returns dict with the console parameters:
667 protocol: ssh, ftp, http, https, ...
668 server: usually ip address
669 port: the http, ssh, ... port
670 suffix: extra text, e.g. the http path and query string
672 self
.logger
.debug("Getting VM CONSOLE from VIM")
674 self
._reload
_connection
()
675 server
= self
.nova
.servers
.find(id=vm_id
)
676 if console_type
== None or console_type
== "novnc":
677 console_dict
= server
.get_vnc_console("novnc")
678 elif console_type
== "xvpvnc":
679 console_dict
= server
.get_vnc_console(console_type
)
680 elif console_type
== "rdp-html5":
681 console_dict
= server
.get_rdp_console(console_type
)
682 elif console_type
== "spice-html5":
683 console_dict
= server
.get_spice_console(console_type
)
685 raise vimconn
.vimconnException("console type '{}' not allowed".format(console_type
), http_code
=vimconn
.HTTP_Bad_Request
)
687 console_dict1
= console_dict
.get("console")
689 console_url
= console_dict1
.get("url")
692 protocol_index
= console_url
.find("//")
693 suffix_index
= console_url
[protocol_index
+2:].find("/") + protocol_index
+2
694 port_index
= console_url
[protocol_index
+2:suffix_index
].find(":") + protocol_index
+2
695 if protocol_index
< 0 or port_index
<0 or suffix_index
<0:
696 return -vimconn
.HTTP_Internal_Server_Error
, "Unexpected response from VIM"
697 console_dict
={"protocol": console_url
[0:protocol_index
],
698 "server": console_url
[protocol_index
+2:port_index
],
699 "port": console_url
[port_index
:suffix_index
],
700 "suffix": console_url
[suffix_index
+1:]
704 raise vimconn
.vimconnUnexpectedResponse("Unexpected response from VIM")
706 except (nvExceptions
.NotFound
, ksExceptions
.ClientException
, nvExceptions
.ClientException
, nvExceptions
.BadRequest
) as e
:
707 self
._format
_exception
(e
)
709 def delete_vminstance(self
, vm_id
):
710 '''Removes a VM instance from VIM. Returns the old identifier
712 #print "osconnector: Getting VM from VIM"
714 self
._reload
_connection
()
715 #delete VM ports attached to this networks before the virtual machine
716 ports
= self
.neutron
.list_ports(device_id
=vm_id
)
717 for p
in ports
['ports']:
719 self
.neutron
.delete_port(p
["id"])
720 except Exception as e
:
721 self
.logger
.error("Error deleting port: " + type(e
).__name
__ + ": "+ str(e
))
722 self
.nova
.servers
.delete(vm_id
)
724 except (nvExceptions
.NotFound
, ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
725 self
._format
_exception
(e
)
726 #TODO insert exception vimconn.HTTP_Unauthorized
727 #if reaching here is because an exception
729 def refresh_vms_status(self
, vm_list
):
730 '''Get the status of the virtual machines and their interfaces/ports
731 Params: the list of VM identifiers
732 Returns a dictionary with:
733 vm_id: #VIM id of this Virtual Machine
734 status: #Mandatory. Text with one of:
735 # DELETED (not found at vim)
736 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
737 # OTHER (Vim reported other status not understood)
738 # ERROR (VIM indicates an ERROR status)
739 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
740 # CREATING (on building process), ERROR
741 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
743 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
744 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
746 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
747 mac_address: #Text format XX:XX:XX:XX:XX:XX
748 vim_net_id: #network id where this interface is connected
749 vim_interface_id: #interface/port VIM id
750 ip_address: #null, or text with IPv4, IPv6 address
753 self
.logger
.debug("refresh_vms status: Getting tenant VM instance information from VIM")
754 for vm_id
in vm_list
:
757 vm_vim
= self
.get_vminstance(vm_id
)
758 if vm_vim
['status'] in vmStatus2manoFormat
:
759 vm
['status'] = vmStatus2manoFormat
[ vm_vim
['status'] ]
761 vm
['status'] = "OTHER"
762 vm
['error_msg'] = "VIM status reported " + vm_vim
['status']
763 vm
['vim_info'] = yaml
.safe_dump(vm_vim
)
764 vm
["interfaces"] = []
765 if vm_vim
.get('fault'):
766 vm
['error_msg'] = str(vm_vim
['fault'])
769 self
._reload
_connection
()
770 port_dict
=self
.neutron
.list_ports(device_id
=vm_id
)
771 for port
in port_dict
["ports"]:
773 interface
['vim_info'] = yaml
.safe_dump(port
)
774 interface
["mac_address"] = port
.get("mac_address")
775 interface
["vim_net_id"] = port
["network_id"]
776 interface
["vim_interface_id"] = port
["id"]
778 #look for floating ip address
779 floating_ip_dict
= self
.neutron
.list_floatingips(port_id
=port
["id"])
780 if floating_ip_dict
.get("floatingips"):
781 ips
.append(floating_ip_dict
["floatingips"][0].get("floating_ip_address") )
783 for subnet
in port
["fixed_ips"]:
784 ips
.append(subnet
["ip_address"])
785 interface
["ip_address"] = ";".join(ips
)
786 vm
["interfaces"].append(interface
)
787 except Exception as e
:
788 self
.logger
.error("Error getting vm interface information " + type(e
).__name
__ + ": "+ str(e
))
789 except vimconn
.vimconnNotFoundException
as e
:
790 self
.logger
.error("Exception getting vm status: %s", str(e
))
791 vm
['status'] = "DELETED"
792 vm
['error_msg'] = str(e
)
793 except vimconn
.vimconnException
as e
:
794 self
.logger
.error("Exception getting vm status: %s", str(e
))
795 vm
['status'] = "VIM_ERROR"
796 vm
['error_msg'] = str(e
)
800 def action_vminstance(self
, vm_id
, action_dict
):
801 '''Send and action over a VM instance from VIM
802 Returns the vm_id if the action was successfully sent to the VIM'''
803 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
805 self
._reload
_connection
()
806 server
= self
.nova
.servers
.find(id=vm_id
)
807 if "start" in action_dict
:
808 if action_dict
["start"]=="rebuild":
811 if server
.status
=="PAUSED":
813 elif server
.status
=="SUSPENDED":
815 elif server
.status
=="SHUTOFF":
817 elif "pause" in action_dict
:
819 elif "resume" in action_dict
:
821 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
823 elif "forceOff" in action_dict
:
825 elif "terminate" in action_dict
:
827 elif "createImage" in action_dict
:
828 server
.create_image()
830 #"description":description_schema,
832 #"metadata":metadata_schema,
833 #"imageRef": id_schema,
834 #"disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
835 elif "rebuild" in action_dict
:
836 server
.rebuild(server
.image
['id'])
837 elif "reboot" in action_dict
:
838 server
.reboot() #reboot_type='SOFT'
839 elif "console" in action_dict
:
840 console_type
= action_dict
["console"]
841 if console_type
== None or console_type
== "novnc":
842 console_dict
= server
.get_vnc_console("novnc")
843 elif console_type
== "xvpvnc":
844 console_dict
= server
.get_vnc_console(console_type
)
845 elif console_type
== "rdp-html5":
846 console_dict
= server
.get_rdp_console(console_type
)
847 elif console_type
== "spice-html5":
848 console_dict
= server
.get_spice_console(console_type
)
850 raise vimconn
.vimconnException("console type '{}' not allowed".format(console_type
),
851 http_code
=vimconn
.HTTP_Bad_Request
)
853 console_url
= console_dict
["console"]["url"]
855 protocol_index
= console_url
.find("//")
856 suffix_index
= console_url
[protocol_index
+2:].find("/") + protocol_index
+2
857 port_index
= console_url
[protocol_index
+2:suffix_index
].find(":") + protocol_index
+2
858 if protocol_index
< 0 or port_index
<0 or suffix_index
<0:
859 raise vimconn
.vimconnException("Unexpected response from VIM " + str(console_dict
))
860 console_dict2
={"protocol": console_url
[0:protocol_index
],
861 "server": console_url
[protocol_index
+2 : port_index
],
862 "port": int(console_url
[port_index
+1 : suffix_index
]),
863 "suffix": console_url
[suffix_index
+1:]
866 except Exception as e
:
867 raise vimconn
.vimconnException("Unexpected response from VIM " + str(console_dict
))
870 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
, nvExceptions
.NotFound
) as e
:
871 self
._format
_exception
(e
)
872 #TODO insert exception vimconn.HTTP_Unauthorized
876 def new_external_port(self
, port_data
):
877 #TODO openstack if needed
878 '''Adds a external port to VIM'''
879 '''Returns the port identifier'''
880 return -vimconn
.HTTP_Internal_Server_Error
, "osconnector.new_external_port() not implemented"
882 def connect_port_network(self
, port_id
, network_id
, admin
=False):
883 #TODO openstack if needed
884 '''Connects a external port to a network'''
885 '''Returns status code of the VIM response'''
886 return -vimconn
.HTTP_Internal_Server_Error
, "osconnector.connect_port_network() not implemented"
888 def new_user(self
, user_name
, user_passwd
, tenant_id
=None):
889 '''Adds a new user to openstack VIM'''
890 '''Returns the user identifier'''
891 self
.logger
.debug("osconnector: Adding a new user to VIM")
893 self
._reload
_connection
()
894 user
=self
.keystone
.users
.create(user_name
, user_passwd
, tenant_id
=tenant_id
)
895 #self.keystone.tenants.add_user(self.k_creds["username"], #role)
897 except ksExceptions
.ConnectionError
as e
:
898 error_value
=-vimconn
.HTTP_Bad_Request
899 error_text
= type(e
).__name
__ + ": "+ (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
900 except ksExceptions
.ClientException
as e
: #TODO remove
901 error_value
=-vimconn
.HTTP_Bad_Request
902 error_text
= type(e
).__name
__ + ": "+ (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
903 #TODO insert exception vimconn.HTTP_Unauthorized
904 #if reaching here is because an exception
906 self
.logger
.debug("new_user " + error_text
)
907 return error_value
, error_text
909 def delete_user(self
, user_id
):
910 '''Delete a user from openstack VIM'''
911 '''Returns the user identifier'''
913 print "osconnector: Deleting a user from VIM"
915 self
._reload
_connection
()
916 self
.keystone
.users
.delete(user_id
)
918 except ksExceptions
.ConnectionError
as e
:
919 error_value
=-vimconn
.HTTP_Bad_Request
920 error_text
= type(e
).__name
__ + ": "+ (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
921 except ksExceptions
.NotFound
as e
:
922 error_value
=-vimconn
.HTTP_Not_Found
923 error_text
= type(e
).__name
__ + ": "+ (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
924 except ksExceptions
.ClientException
as e
: #TODO remove
925 error_value
=-vimconn
.HTTP_Bad_Request
926 error_text
= type(e
).__name
__ + ": "+ (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
927 #TODO insert exception vimconn.HTTP_Unauthorized
928 #if reaching here is because an exception
930 print "delete_tenant " + error_text
931 return error_value
, error_text
933 def get_hosts_info(self
):
934 '''Get the information of deployed hosts
935 Returns the hosts content'''
937 print "osconnector: Getting Host info from VIM"
940 self
._reload
_connection
()
941 hypervisors
= self
.nova
.hypervisors
.list()
942 for hype
in hypervisors
:
943 h_list
.append( hype
.to_dict() )
944 return 1, {"hosts":h_list
}
945 except nvExceptions
.NotFound
as e
:
946 error_value
=-vimconn
.HTTP_Not_Found
947 error_text
= (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
948 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
949 error_value
=-vimconn
.HTTP_Bad_Request
950 error_text
= type(e
).__name
__ + ": "+ (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
951 #TODO insert exception vimconn.HTTP_Unauthorized
952 #if reaching here is because an exception
954 print "get_hosts_info " + error_text
955 return error_value
, error_text
957 def get_hosts(self
, vim_tenant
):
958 '''Get the hosts and deployed instances
959 Returns the hosts content'''
960 r
, hype_dict
= self
.get_hosts_info()
963 hypervisors
= hype_dict
["hosts"]
965 servers
= self
.nova
.servers
.list()
966 for hype
in hypervisors
:
967 for server
in servers
:
968 if server
.to_dict()['OS-EXT-SRV-ATTR:hypervisor_hostname']==hype
['hypervisor_hostname']:
970 hype
['vm'].append(server
.id)
972 hype
['vm'] = [server
.id]
974 except nvExceptions
.NotFound
as e
:
975 error_value
=-vimconn
.HTTP_Not_Found
976 error_text
= (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
977 except (ksExceptions
.ClientException
, nvExceptions
.ClientException
) as e
:
978 error_value
=-vimconn
.HTTP_Bad_Request
979 error_text
= type(e
).__name
__ + ": "+ (str(e
) if len(e
.args
)==0 else str(e
.args
[0]))
980 #TODO insert exception vimconn.HTTP_Unauthorized
981 #if reaching here is because an exception
983 print "get_hosts " + error_text
984 return error_value
, error_text