1 # -*- coding: utf-8 -*-
4 # Copyright 2017 xFlow Research Pvt. Ltd
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: saboor.ahmad@xflowresearch.com
25 AWS-connector implements all the methods to interact with AWS using the BOTO client
28 __author__
= "Saboor Ahmad"
29 __date__
= "10-Apr-2017"
31 from osm_ro
import vimconn
42 class vimconnector(vimconn
.vimconnector
):
43 def __init__(self
, uuid
, name
, tenant_id
, tenant_name
, url
, url_admin
=None, user
=None, passwd
=None, log_level
=None,
44 config
={}, persistent_info
={}):
45 """ Params: uuid - id asigned to this VIM
46 name - name assigned to this VIM, can be used for logging
47 tenant_id - ID to be used for tenant
48 tenant_name - name of tenant to be used VIM tenant to be used
49 url_admin - optional, url used for administrative tasks
50 user - credentials of the VIM user
51 passwd - credentials of the VIM user
52 log_level - if must use a different log_level than the general one
53 config - dictionary with misc VIM information
54 region_name - name of region to deploy the instances
55 vpc_cidr_block - default CIDR block for VPC
56 security_groups - default security group to specify this instance
57 persistent_info - dict where the class can store information that will be available among class
58 destroy/creation cycles. This info is unique per VIM/credential. At first call it will contain an
59 empty dict. Useful to store login/tokens information for speed up communication
62 vimconn
.vimconnector
.__init
__(self
, uuid
, name
, tenant_id
, tenant_name
, url
, url_admin
, user
, passwd
, log_level
,
63 config
, persistent_info
)
65 self
.persistent_info
= persistent_info
68 self
.a_creds
['aws_access_key_id'] = user
70 raise vimconn
.vimconnAuthException("Username is not specified")
72 self
.a_creds
['aws_secret_access_key'] = passwd
74 raise vimconn
.vimconnAuthException("Password is not specified")
75 if 'region_name' in config
:
76 self
.region
= config
.get('region_name')
78 raise vimconn
.vimconnException("AWS region_name is not specified at config")
84 self
.account_id
= None
86 self
.vpc_id
= self
.get_tenant_list()[0]['id']
87 # we take VPC CIDR block if specified, otherwise we use the default CIDR
88 # block suggested by AWS while creating instance
89 self
.vpc_cidr_block
= '10.0.0.0/24'
92 self
.vpc_id
= tenant_id
93 if 'vpc_cidr_block' in config
:
94 self
.vpc_cidr_block
= config
['vpc_cidr_block']
96 self
.security_groups
= None
97 if 'security_groups' in config
:
98 self
.security_groups
= config
['security_groups']
101 if 'key_pair' in config
:
102 self
.key_pair
= config
['key_pair']
104 self
.flavor_info
= None
105 if 'flavor_info' in config
:
106 flavor_data
= config
.get('flavor_info')
107 if isinstance(flavor_data
, str):
109 if flavor_data
[0] == "@": # read from a file
110 with
open(flavor_data
[1:], 'r') as stream
:
111 self
.flavor_info
= yaml
.load(stream
, Loader
=yaml
.Loader
)
113 self
.flavor_info
= yaml
.load(flavor_data
, Loader
=yaml
.Loader
)
114 except yaml
.YAMLError
as e
:
115 self
.flavor_info
= None
116 raise vimconn
.vimconnException("Bad format at file '{}': {}".format(flavor_data
[1:], e
))
118 raise vimconn
.vimconnException("Error reading file '{}': {}".format(flavor_data
[1:], e
))
119 elif isinstance(flavor_data
, dict):
120 self
.flavor_info
= flavor_data
122 self
.logger
= logging
.getLogger('openmano.vim.aws')
124 self
.logger
.setLevel(getattr(logging
, log_level
))
126 def __setitem__(self
, index
, value
):
127 """Params: index - name of value of set
131 self
.a_creds
['aws_access_key_id'] = value
132 elif index
== 'passwd':
133 self
.a_creds
['aws_secret_access_key'] = value
134 elif index
== 'region':
137 vimconn
.vimconnector
.__setitem
__(self
, index
, value
)
139 def _reload_connection(self
):
140 """Returns: sets boto.EC2 and boto.VPC connection to work with AWS services
144 self
.conn
= boto
.ec2
.connect_to_region(self
.region
, aws_access_key_id
=self
.a_creds
['aws_access_key_id'],
145 aws_secret_access_key
=self
.a_creds
['aws_secret_access_key'])
146 self
.conn_vpc
= boto
.vpc
.connect_to_region(self
.region
, aws_access_key_id
=self
.a_creds
['aws_access_key_id'],
147 aws_secret_access_key
=self
.a_creds
['aws_secret_access_key'])
148 # client = boto3.client("sts", aws_access_key_id=self.a_creds['aws_access_key_id'], aws_secret_access_key=self.a_creds['aws_secret_access_key'])
149 # self.account_id = client.get_caller_identity()["Account"]
150 except Exception as e
:
151 self
.format_vimconn_exception(e
)
153 def format_vimconn_exception(self
, e
):
154 """Params: an Exception object
155 Returns: Raises the exception 'e' passed in mehtod parameters
160 raise vimconn
.vimconnConnectionException(type(e
).__name
__ + ": " + str(e
))
162 def get_availability_zones_list(self
):
163 """Obtain AvailabilityZones from AWS
167 self
._reload
_connection
()
169 for az
in self
.conn
.get_all_zones():
170 az_list
.append(az
.name
)
172 except Exception as e
:
173 self
.format_vimconn_exception(e
)
175 def get_tenant_list(self
, filter_dict
={}):
176 """Obtain tenants of VIM
177 filter_dict dictionary that can contain the following keys:
178 name: filter by tenant name
179 id: filter by tenant uuid/id
181 Returns the tenant list of dictionaries, and empty list if no tenant match all the filers:
182 [{'name':'<name>, 'id':'<id>, ...}, ...]
186 self
._reload
_connection
()
189 if filter_dict
!= {}:
190 if 'id' in filter_dict
:
191 vpc_ids
.append(filter_dict
['id'])
192 tfilters
['name'] = filter_dict
['id']
193 tenants
= self
.conn_vpc
.get_all_vpcs(vpc_ids
, tfilters
)
195 for tenant
in tenants
:
196 tenant_list
.append({'id': str(tenant
.id), 'name': str(tenant
.id), 'status': str(tenant
.state
),
197 'cidr_block': str(tenant
.cidr_block
)})
199 except Exception as e
:
200 self
.format_vimconn_exception(e
)
202 def new_tenant(self
, tenant_name
, tenant_description
):
203 """Adds a new tenant to VIM with this name and description, this is done using admin_url if provided
204 "tenant_name": string max lenght 64
205 "tenant_description": string max length 256
206 returns the tenant identifier or raise exception
209 self
.logger
.debug("Adding a new VPC")
211 self
._reload
_connection
()
212 vpc
= self
.conn_vpc
.create_vpc(self
.vpc_cidr_block
)
213 self
.conn_vpc
.modify_vpc_attribute(vpc
.id, enable_dns_support
=True)
214 self
.conn_vpc
.modify_vpc_attribute(vpc
.id, enable_dns_hostnames
=True)
216 gateway
= self
.conn_vpc
.create_internet_gateway()
217 self
.conn_vpc
.attach_internet_gateway(gateway
.id, vpc
.id)
218 route_table
= self
.conn_vpc
.create_route_table(vpc
.id)
219 self
.conn_vpc
.create_route(route_table
.id, '0.0.0.0/0', gateway
.id)
221 self
.vpc_data
[vpc
.id] = {'gateway': gateway
.id, 'route_table': route_table
.id,
222 'subnets': self
.subnet_sizes(len(self
.get_availability_zones_list()),
223 self
.vpc_cidr_block
)}
225 except Exception as e
:
226 self
.format_vimconn_exception(e
)
228 def delete_tenant(self
, tenant_id
):
229 """Delete a tenant from VIM
230 tenant_id: returned VIM tenant_id on "new_tenant"
231 Returns None on success. Raises and exception of failure. If tenant is not found raises vimconnNotFoundException
234 self
.logger
.debug("Deleting specified VPC")
236 self
._reload
_connection
()
237 vpc
= self
.vpc_data
.get(tenant_id
)
238 if 'gateway' in vpc
and 'route_table' in vpc
:
239 gateway_id
, route_table_id
= vpc
['gateway'], vpc
['route_table']
240 self
.conn_vpc
.detach_internet_gateway(gateway_id
, tenant_id
)
241 self
.conn_vpc
.delete_vpc(tenant_id
)
242 self
.conn_vpc
.delete_route(route_table_id
, '0.0.0.0/0')
244 self
.conn_vpc
.delete_vpc(tenant_id
)
245 except Exception as e
:
246 self
.format_vimconn_exception(e
)
248 def subnet_sizes(self
, availability_zones
, cidr
):
249 """Calcualtes possible subnets given CIDR value of VPC
252 if availability_zones
!= 2 and availability_zones
!= 3:
253 self
.logger
.debug("Number of AZs should be 2 or 3")
254 raise vimconn
.vimconnNotSupportedException("Number of AZs should be 2 or 3")
256 netmasks
= ('255.255.252.0', '255.255.254.0', '255.255.255.0', '255.255.255.128')
257 ip
= netaddr
.IPNetwork(cidr
)
260 if str(mask
) not in netmasks
:
261 self
.logger
.debug("Netmask " + str(mask
) + " not found")
262 raise vimconn
.vimconnNotFoundException("Netmask " + str(mask
) + " not found")
264 if availability_zones
== 2:
265 for n
, netmask
in enumerate(netmasks
):
266 if str(mask
) == netmask
:
267 subnets
= list(ip
.subnet(n
+ 24))
269 for n
, netmask
in enumerate(netmasks
):
270 if str(mask
) == netmask
:
271 pub_net
= list(ip
.subnet(n
+ 24))
272 pri_subs
= pub_net
[1:]
273 pub_mask
= pub_net
[0].netmask
274 pub_split
= list(ip
.subnet(26)) if (str(pub_mask
) == '255.255.255.0') else list(ip
.subnet(27))
275 pub_subs
= pub_split
[:3]
276 subnets
= pub_subs
+ pri_subs
278 return map(str, subnets
)
280 def new_network(self
, net_name
, net_type
, ip_profile
=None, shared
=False, provider_network_profile
=None):
281 """Adds a tenant network to VIM
283 'net_name': name of the network
285 'bridge': overlay isolated network
286 'data': underlay E-LAN network for Passthrough and SRIOV interfaces
287 'ptp': underlay E-LINE network for Passthrough and SRIOV interfaces.
288 'ip_profile': is a dict containing the IP parameters of the network (Currently only IPv4 is implemented)
289 'ip-version': can be one of ["IPv4","IPv6"]
290 'subnet-address': ip_prefix_schema, that is X.X.X.X/Y
291 'gateway-address': (Optional) ip_schema, that is X.X.X.X
292 'dns-address': (Optional) ip_schema,
293 'dhcp': (Optional) dict containing
294 'enabled': {"type": "boolean"},
295 'start-address': ip_schema, first IP to grant
296 'count': number of IPs to grant.
297 'shared': if this network can be seen/use by other tenants/organization
298 Returns a tuple with the network identifier and created_items, or raises an exception on error
299 created_items can be None or a dictionary where this method can include key-values that will be passed to
300 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
301 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
305 self
.logger
.debug("Adding a subnet to VPC")
308 self
._reload
_connection
()
311 if self
.vpc_data
.get(vpc_id
, None):
312 cidr_block
= list(set(self
.vpc_data
[vpc_id
]['subnets']) - set(self
.get_network_details({'tenant_id': vpc_id
}, detail
='cidr_block')))[0]
314 vpc
= self
.get_tenant_list({'id': vpc_id
})[0]
315 subnet_list
= self
.subnet_sizes(len(self
.get_availability_zones_list()), vpc
['cidr_block'])
316 cidr_block
= list(set(subnet_list
) - set(self
.get_network_details({'tenant_id': vpc
['id']}, detail
='cidr_block')))[0]
317 subnet
= self
.conn_vpc
.create_subnet(vpc_id
, cidr_block
)
318 return subnet
.id, created_items
319 except Exception as e
:
320 self
.format_vimconn_exception(e
)
322 def get_network_details(self
, filters
, detail
):
323 """Get specified details related to a subnet
326 subnet_list
= self
.get_network_list(filters
)
327 for net
in subnet_list
:
328 detail_list
.append(net
[detail
])
331 def get_network_list(self
, filter_dict
={}):
332 """Obtain tenant networks of VIM
334 'filter_dict' (optional) contains entries to return only networks that matches ALL entries:
335 name: string => returns only networks with this name
336 id: string => returns networks with this VIM id, this imply returns one network at most
337 shared: boolean >= returns only networks that are (or are not) shared
338 tenant_id: sting => returns only networks that belong to this tenant/project
339 ,#(not used yet) admin_state_up: boolean => returns only networks that are (or are not) in admin state active
340 #(not used yet) status: 'ACTIVE','ERROR',... => filter networks that are on this status
341 Returns the network list of dictionaries. each dictionary contains:
342 'id': (mandatory) VIM network id
343 'name': (mandatory) VIM network name
344 'status': (mandatory) can be 'ACTIVE', 'INACTIVE', 'DOWN', 'BUILD', 'ERROR', 'VIM_ERROR', 'OTHER'
345 'error_msg': (optional) text that explains the ERROR status
346 other VIM specific fields: (optional) whenever possible using the same naming of filter_dict param
347 List can be empty if no network map the filter_dict. Raise an exception only upon VIM connectivity,
348 authorization, or some other unspecific error
351 self
.logger
.debug("Getting all subnets from VIM")
353 self
._reload
_connection
()
355 if filter_dict
!= {}:
356 if 'tenant_id' in filter_dict
:
357 tfilters
['vpcId'] = filter_dict
['tenant_id']
358 subnets
= self
.conn_vpc
.get_all_subnets(subnet_ids
=filter_dict
.get('name', None), filters
=tfilters
)
362 {'id': str(net
.id), 'name': str(net
.id), 'status': str(net
.state
), 'vpc_id': str(net
.vpc_id
),
363 'cidr_block': str(net
.cidr_block
), 'type': 'bridge'})
365 except Exception as e
:
366 self
.format_vimconn_exception(e
)
368 def get_network(self
, net_id
):
369 """Obtain network details from the 'net_id' VIM network
370 Return a dict that contains:
371 'id': (mandatory) VIM network id, that is, net_id
372 'name': (mandatory) VIM network name
373 'status': (mandatory) can be 'ACTIVE', 'INACTIVE', 'DOWN', 'BUILD', 'ERROR', 'VIM_ERROR', 'OTHER'
374 'error_msg': (optional) text that explains the ERROR status
375 other VIM specific fields: (optional) whenever possible using the same naming of filter_dict param
376 Raises an exception upon error or when network is not found
379 self
.logger
.debug("Getting Subnet from VIM")
381 self
._reload
_connection
()
382 subnet
= self
.conn_vpc
.get_all_subnets(net_id
)[0]
383 return {'id': str(subnet
.id), 'name': str(subnet
.id), 'status': str(subnet
.state
),
384 'vpc_id': str(subnet
.vpc_id
), 'cidr_block': str(subnet
.cidr_block
)}
385 except Exception as e
:
386 self
.format_vimconn_exception(e
)
388 def delete_network(self
, net_id
, created_items
=None):
390 Removes a tenant network from VIM and its associated elements
391 :param net_id: VIM identifier of the network, provided by method new_network
392 :param created_items: dictionary with extra items to be deleted. provided by method new_network
393 Returns the network identifier or raises an exception upon error or when network is not found
396 self
.logger
.debug("Deleting subnet from VIM")
398 self
._reload
_connection
()
399 self
.logger
.debug("DELETING NET_ID: " + str(net_id
))
400 self
.conn_vpc
.delete_subnet(net_id
)
402 except Exception as e
:
403 self
.format_vimconn_exception(e
)
405 def refresh_nets_status(self
, net_list
):
406 """Get the status of the networks
408 'net_list': a list with the VIM network id to be get the status
409 Returns a dictionary with:
410 'net_id': #VIM id of this network
411 status: #Mandatory. Text with one of:
412 # DELETED (not found at vim)
413 # VIM_ERROR (Cannot connect to VIM, authentication problems, VIM response error, ...)
414 # OTHER (Vim reported other status not understood)
415 # ERROR (VIM indicates an ERROR status)
416 # ACTIVE, INACTIVE, DOWN (admin down),
417 # BUILD (on building process)
418 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
419 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
423 self
._reload
_connection
()
426 for net_id
in net_list
:
430 subnet
= self
.conn_vpc
.get_all_subnets(net_id
)[0]
431 if subnet
.state
== "pending":
432 subnet_dict
['status'] = "BUILD"
433 elif subnet
.state
== "available":
434 subnet_dict
['status'] = 'ACTIVE'
436 subnet_dict
['status'] = 'ERROR'
437 subnet_dict
['error_msg'] = ''
438 except Exception as e
:
439 subnet_dict
['status'] = 'DELETED'
440 subnet_dict
['error_msg'] = 'Network not found'
443 subnet_dict
['vim_info'] = yaml
.safe_dump(subnet
, default_flow_style
=True, width
=256)
444 except yaml
.YAMLError
as e
:
445 subnet_dict
['vim_info'] = str(subnet
)
446 dict_entry
[net_id
] = subnet_dict
448 except Exception as e
:
449 self
.format_vimconn_exception(e
)
451 def get_flavor(self
, flavor_id
):
452 """Obtain flavor details from the VIM
453 Returns the flavor dict details {'id':<>, 'name':<>, other vim specific }
454 Raises an exception upon error or if not found
457 self
.logger
.debug("Getting instance type")
459 if flavor_id
in self
.flavor_info
:
460 return self
.flavor_info
[flavor_id
]
462 raise vimconn
.vimconnNotFoundException("Cannot find flavor with this flavor ID/Name")
463 except Exception as e
:
464 self
.format_vimconn_exception(e
)
466 def get_flavor_id_from_data(self
, flavor_dict
):
467 """Obtain flavor id that match the flavor description
469 'flavor_dict': dictionary that contains:
470 'disk': main hard disk in GB
472 'vcpus': number of virtual cpus
473 #todo: complete parameters for EPA
474 Returns the flavor_id or raises a vimconnNotFoundException
477 self
.logger
.debug("Getting flavor id from data")
480 for key
, values
in self
.flavor_info
.items():
481 if (values
["ram"], values
["cpus"], values
["disk"]) == (
482 flavor_dict
["ram"], flavor_dict
["vcpus"], flavor_dict
["disk"]):
483 flavor
= (key
, values
)
485 elif (values
["ram"], values
["cpus"], values
["disk"]) >= (
486 flavor_dict
["ram"], flavor_dict
["vcpus"], flavor_dict
["disk"]):
488 flavor
= (key
, values
)
490 if (flavor
[1]["ram"], flavor
[1]["cpus"], flavor
[1]["disk"]) >= (
491 values
["ram"], values
["cpus"], values
["disk"]):
492 flavor
= (key
, values
)
495 raise vimconn
.vimconnNotFoundException("Cannot find flavor with this flavor ID/Name")
496 except Exception as e
:
497 self
.format_vimconn_exception(e
)
499 def new_image(self
, image_dict
):
500 """ Adds a tenant image to VIM
502 name (string) - The name of the AMI. Valid only for EBS-based images.
503 description (string) - The description of the AMI.
504 image_location (string) - Full path to your AMI manifest in Amazon S3 storage. Only used for S3-based AMI’s.
505 architecture (string) - The architecture of the AMI. Valid choices are: * i386 * x86_64
506 kernel_id (string) - The ID of the kernel with which to launch the instances
507 root_device_name (string) - The root device name (e.g. /dev/sdh)
508 block_device_map (boto.ec2.blockdevicemapping.BlockDeviceMapping) - A BlockDeviceMapping data structure describing the EBS volumes associated with the Image.
509 virtualization_type (string) - The virutalization_type of the image. Valid choices are: * paravirtual * hvm
510 sriov_net_support (string) - Advanced networking support. Valid choices are: * simple
511 snapshot_id (string) - A snapshot ID for the snapshot to be used as root device for the image. Mutually exclusive with block_device_map, requires root_device_name
512 delete_root_volume_on_termination (bool) - Whether to delete the root volume of the image after instance termination. Only applies when creating image from snapshot_id. Defaults to False. Note that leaving volumes behind after instance termination is not free
513 Returns: image_id - image ID of the newly created image
517 self
._reload
_connection
()
518 image_location
= image_dict
.get('image_location', None)
520 image_location
= str(self
.account_id
) + str(image_location
)
522 image_id
= self
.conn
.register_image(image_dict
.get('name', None), image_dict
.get('description', None),
523 image_location
, image_dict
.get('architecture', None),
524 image_dict
.get('kernel_id', None),
525 image_dict
.get('root_device_name', None),
526 image_dict
.get('block_device_map', None),
527 image_dict
.get('virtualization_type', None),
528 image_dict
.get('sriov_net_support', None),
529 image_dict
.get('snapshot_id', None),
530 image_dict
.get('delete_root_volume_on_termination', None))
532 except Exception as e
:
533 self
.format_vimconn_exception(e
)
535 def delete_image(self
, image_id
):
536 """Deletes a tenant image from VIM
537 Returns the image_id if image is deleted or raises an exception on error"""
540 self
._reload
_connection
()
541 self
.conn
.deregister_image(image_id
)
543 except Exception as e
:
544 self
.format_vimconn_exception(e
)
546 def get_image_id_from_path(self
, path
):
548 Params: path - location of the image
549 Returns: image_id - ID of the matching image
551 self
._reload
_connection
()
555 tokens
= path
.split('/')
556 filters
['owner_id'] = tokens
[0]
557 filters
['name'] = '/'.join(tokens
[1:])
558 image
= self
.conn
.get_all_images(filters
=filters
)[0]
560 except Exception as e
:
561 self
.format_vimconn_exception(e
)
563 def get_image_list(self
, filter_dict
={}):
564 """Obtain tenant images from VIM
568 checksum: image checksum
570 Returns the image list of dictionaries:
571 [{<the fields at Filter_dict plus some VIM specific>}, ...]
575 self
.logger
.debug("Getting image list from VIM")
577 self
._reload
_connection
()
580 if 'id' in filter_dict
:
581 image_id
= filter_dict
['id']
582 if 'name' in filter_dict
:
583 filters
['name'] = filter_dict
['name']
584 if 'location' in filter_dict
:
585 filters
['location'] = filter_dict
['location']
586 # filters['image_type'] = 'machine'
587 # filter_dict['owner_id'] = self.account_id
588 images
= self
.conn
.get_all_images(image_id
, filters
=filters
)
591 image_list
.append({'id': str(image
.id), 'name': str(image
.name
), 'status': str(image
.state
),
592 'owner': str(image
.owner_id
), 'location': str(image
.location
),
593 'is_public': str(image
.is_public
), 'architecture': str(image
.architecture
),
594 'platform': str(image
.platform
)})
596 except Exception as e
:
597 self
.format_vimconn_exception(e
)
599 def new_vminstance(self
, name
, description
, start
, image_id
, flavor_id
, net_list
, cloud_config
=None,
600 disk_list
=None, availability_zone_index
=None, availability_zone_list
=None):
601 """Create a new VM/instance in AWS
604 start: (boolean) indicates if VM must start or created in pause mode.
605 image_id - image ID in AWS
606 flavor_id - instance type ID in AWS
609 net_id - subnet_id from AWS
610 vpci - (optional) virtual vPCI address to assign at the VM. Can be ignored depending on VIM capabilities
611 model: (optional and only have sense for type==virtual) interface model: virtio, e1000, ...
612 mac_address: (optional) mac address to assign to this interface
613 type: (mandatory) can be one of:
614 virtual, in this case always connected to a network of type 'net_type=bridge'
615 'PCI-PASSTHROUGH' or 'PF' (passthrough): depending on VIM capabilities it can be connected to a data/ptp network ot it
616 can created unconnected
617 'SR-IOV' or 'VF' (SRIOV with VLAN tag): same as PF for network connectivity.
618 VFnotShared - (SRIOV without VLAN tag) same as PF for network connectivity. VF where no other VFs
619 are allocated on the same physical NIC
620 bw': (optional) only for PF/VF/VFnotShared. Minimal Bandwidth required for the interface in GBPS
621 port_security': (optional) If False it must avoid any traffic filtering at this interface. If missing or True, it must apply the default VIM behaviour
622 vim_id': must be filled/added by this method with the VIM identifier generated by the VIM for this interface. 'net_list' is modified
623 elastic_ip - True/False to define if an elastic_ip is required
624 cloud_config': (optional) dictionary with:
625 key-pairs': (optional) list of strings with the public key to be inserted to the default user
626 users': (optional) list of users to be inserted, each item is a dict with:
627 name': (mandatory) user name,
628 key-pairs': (optional) list of strings with the public key to be inserted to the user
629 user-data': (optional) string is a text script to be passed directly to cloud-init
630 config-files': (optional). List of files to be transferred. Each item is a dict with:
631 dest': (mandatory) string with the destination absolute path
632 encoding': (optional, by default text). Can be one of:
633 b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
634 content' (mandatory): string with the content of the file
635 permissions': (optional) string with file permissions, typically octal notation '0644'
636 owner: (optional) file owner, string with the format 'owner:group'
637 boot-data-drive: boolean to indicate if user-data must be passed using a boot drive (hard disk)
641 disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
642 image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
643 size': (mandatory) string with the size of the disk in GB
644 Returns a tuple with the instance identifier and created_items or raises an exception on error
645 created_items can be None or a dictionary where this method can include key-values that will be passed to
646 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
647 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
651 self
.logger
.debug("Creating a new VM instance")
653 self
._reload
_connection
()
655 _
, userdata
= self
._create
_user
_data
(cloud_config
)
658 reservation
= self
.conn
.run_instances(
660 key_name
=self
.key_pair
,
661 instance_type
=flavor_id
,
662 security_groups
=self
.security_groups
,
666 for index
, subnet
in enumerate(net_list
):
667 net_intr
= boto
.ec2
.networkinterface
.NetworkInterfaceSpecification(subnet_id
=subnet
.get('net_id'),
669 associate_public_ip_address
=True)
671 if subnet
.get('elastic_ip'):
672 eip
= self
.conn
.allocate_address()
673 self
.conn
.associate_address(allocation_id
=eip
.allocation_id
, network_interface_id
=net_intr
.id)
676 reservation
= self
.conn
.run_instances(
678 key_name
=self
.key_pair
,
679 instance_type
=flavor_id
,
680 security_groups
=self
.security_groups
,
681 network_interfaces
=boto
.ec2
.networkinterface
.NetworkInterfaceCollection(net_intr
),
687 self
.conn
.attach_network_interface(
688 network_interface_id
=boto
.ec2
.networkinterface
.NetworkInterfaceCollection(net_intr
),
689 instance_id
=instance
.id, device_index
=0)
693 net_list
[index
]['vim_id'] = reservation
.instances
[0].interfaces
[index
].id
695 instance
= reservation
.instances
[0]
696 return instance
.id, None
697 except Exception as e
:
698 self
.format_vimconn_exception(e
)
700 def get_vminstance(self
, vm_id
):
701 """Returns the VM instance information from VIM"""
704 self
._reload
_connection
()
705 reservation
= self
.conn
.get_all_instances(vm_id
)
706 return reservation
[0].instances
[0].__dict
__
707 except Exception as e
:
708 self
.format_vimconn_exception(e
)
710 def delete_vminstance(self
, vm_id
, created_items
=None):
711 """Removes a VM instance from VIM
712 Returns the instance identifier"""
715 self
._reload
_connection
()
716 self
.logger
.debug("DELETING VM_ID: " + str(vm_id
))
717 self
.conn
.terminate_instances(vm_id
)
719 except Exception as e
:
720 self
.format_vimconn_exception(e
)
722 def refresh_vms_status(self
, vm_list
):
723 """ Get the status of the virtual machines and their interfaces/ports
724 Params: the list of VM identifiers
725 Returns a dictionary with:
726 vm_id: #VIM id of this Virtual Machine
727 status: #Mandatory. Text with one of:
728 # DELETED (not found at vim)
729 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
730 # OTHER (Vim reported other status not understood)
731 # ERROR (VIM indicates an ERROR status)
732 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
733 # BUILD (on building process), ERROR
734 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
736 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
737 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
738 interfaces: list with interface info. Each item a dictionary with:
739 vim_interface_id - The ID of the ENI.
740 vim_net_id - The ID of the VPC subnet.
741 mac_address - The MAC address of the interface.
742 ip_address - The IP address of the interface within the subnet.
744 self
.logger
.debug("Getting VM instance information from VIM")
746 self
._reload
_connection
()
747 reservation
= self
.conn
.get_all_instances(vm_list
)[0]
750 for instance
in reservation
.instances
:
752 if instance
.state
in ("pending"):
753 instance_dict
['status'] = "BUILD"
754 elif instance
.state
in ("available", "running", "up"):
755 instance_dict
['status'] = 'ACTIVE'
757 instance_dict
['status'] = 'ERROR'
758 instance_dict
['error_msg'] = ""
759 instance_dict
['interfaces'] = []
761 for interface
in instance
.interfaces
:
762 interface_dict
['vim_interface_id'] = interface
.id
763 interface_dict
['vim_net_id'] = interface
.subnet_id
764 interface_dict
['mac_address'] = interface
.mac_address
765 if hasattr(interface
, 'publicIp') and interface
.publicIp
!= None:
766 interface_dict
['ip_address'] = interface
.publicIp
+ ";" + interface
.private_ip_address
768 interface_dict
['ip_address'] = interface
.private_ip_address
769 instance_dict
['interfaces'].append(interface_dict
)
770 except Exception as e
:
771 self
.logger
.error("Exception getting vm status: %s", str(e
), exc_info
=True)
772 instance_dict
['status'] = "DELETED"
773 instance_dict
['error_msg'] = str(e
)
776 instance_dict
['vim_info'] = yaml
.safe_dump(instance
, default_flow_style
=True, width
=256)
777 except yaml
.YAMLError
as e
:
778 # self.logger.error("Exception getting vm status: %s", str(e), exc_info=True)
779 instance_dict
['vim_info'] = str(instance
)
780 instances
[instance
.id] = instance_dict
782 except Exception as e
:
783 self
.logger
.error("Exception getting vm status: %s", str(e
), exc_info
=True)
784 self
.format_vimconn_exception(e
)
786 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
787 """Send and action over a VM instance from VIM
788 Returns the vm_id if the action was successfully sent to the VIM"""
790 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
792 self
._reload
_connection
()
793 if "start" in action_dict
:
794 self
.conn
.start_instances(vm_id
)
795 elif "stop" in action_dict
or "stop" in action_dict
:
796 self
.conn
.stop_instances(vm_id
)
797 elif "terminate" in action_dict
:
798 self
.conn
.terminate_instances(vm_id
)
799 elif "reboot" in action_dict
:
800 self
.conn
.reboot_instances(vm_id
)
802 except Exception as e
:
803 self
.format_vimconn_exception(e
)