1 # -*- coding: utf-8 -*-
3 # Licensed under the Apache License, Version 2.0 (the "License"); you may
4 # not use this file except in compliance with the License. You may obtain
5 # a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 # License for the specific language governing permissions and limitations
17 from osm_ro_plugin
import vimconn
23 from azure
.identity
import ClientSecretCredential
24 from azure
.mgmt
.resource
import ResourceManagementClient
25 from azure
.mgmt
.network
import NetworkManagementClient
26 from azure
.mgmt
.compute
import ComputeManagementClient
27 from azure
.mgmt
.compute
.models
import DiskCreateOption
28 from azure
.core
.exceptions
import ResourceNotFoundError
29 from azure
.profiles
import ProfileDefinition
30 from msrestazure
.azure_exceptions
import CloudError
31 from msrest
.exceptions
import AuthenticationError
32 import msrestazure
.tools
as azure_tools
33 from requests
.exceptions
import ConnectionError
35 from cryptography
.hazmat
.primitives
import serialization
as crypto_serialization
36 from cryptography
.hazmat
.primitives
.asymmetric
import rsa
37 from cryptography
.hazmat
.backends
import default_backend
as crypto_default_backend
39 __author__
= "Isabel Lloret, Sergio Gonzalez, Alfonso Tierno, Gerardo Garcia"
40 __date__
= "$18-apr-2019 23:59:59$"
43 if getenv("OSMRO_PDB_DEBUG"):
52 class vimconnector(vimconn
.VimConnector
):
54 # Translate azure provisioning state to OSM provision state
55 # The first three ones are the transitional status once a user initiated action has been requested
56 # Once the operation is complete, it will transition into the states Succeeded or Failed
57 # https://docs.microsoft.com/en-us/azure/virtual-machines/windows/states-lifecycle
58 provision_state2osm
= {
61 "Deleting": "INACTIVE",
62 "Succeeded": "ACTIVE",
66 # Translate azure power state to OSM provision state
68 "starting": "INACTIVE",
70 "stopping": "INACTIVE",
71 "stopped": "INACTIVE",
73 "deallocated": "BUILD",
74 "deallocating": "BUILD",
77 # TODO - review availability zones
78 AZURE_ZONES
= ["1", "2", "3"]
80 AZURE_COMPUTE_MGMT_CLIENT_API_VERSION
= "2021-03-01"
81 AZURE_COMPUTE_MGMT_PROFILE_TAG
= "azure.mgmt.compute.ComputeManagementClient"
82 AZURE_COMPUTE_MGMT_PROFILE
= ProfileDefinition(
84 AZURE_COMPUTE_MGMT_PROFILE_TAG
: {
85 None: AZURE_COMPUTE_MGMT_CLIENT_API_VERSION
,
86 "availability_sets": "2020-12-01",
87 "dedicated_host_groups": "2020-12-01",
88 "dedicated_hosts": "2020-12-01",
89 "disk_accesses": "2020-12-01",
90 "disk_encryption_sets": "2020-12-01",
91 "disk_restore_point": "2020-12-01",
92 "disks": "2020-12-01",
93 "galleries": "2020-09-30",
94 "gallery_application_versions": "2020-09-30",
95 "gallery_applications": "2020-09-30",
96 "gallery_image_versions": "2020-09-30",
97 "gallery_images": "2020-09-30",
98 "gallery_sharing_profile": "2020-09-30",
99 "images": "2020-12-01",
100 "log_analytics": "2020-12-01",
101 "operations": "2020-12-01",
102 "proximity_placement_groups": "2020-12-01",
103 "resource_skus": "2019-04-01",
104 "shared_galleries": "2020-09-30",
105 "shared_gallery_image_versions": "2020-09-30",
106 "shared_gallery_images": "2020-09-30",
107 "snapshots": "2020-12-01",
108 "ssh_public_keys": "2020-12-01",
109 "usage": "2020-12-01",
110 "virtual_machine_extension_images": "2020-12-01",
111 "virtual_machine_extensions": "2020-12-01",
112 "virtual_machine_images": "2020-12-01",
113 "virtual_machine_images_edge_zone": "2020-12-01",
114 "virtual_machine_run_commands": "2020-12-01",
115 "virtual_machine_scale_set_extensions": "2020-12-01",
116 "virtual_machine_scale_set_rolling_upgrades": "2020-12-01",
117 "virtual_machine_scale_set_vm_extensions": "2020-12-01",
118 "virtual_machine_scale_set_vm_run_commands": "2020-12-01",
119 "virtual_machine_scale_set_vms": "2020-12-01",
120 "virtual_machine_scale_sets": "2020-12-01",
121 "virtual_machine_sizes": "2020-12-01",
122 "virtual_machines": "2020-12-01",
125 AZURE_COMPUTE_MGMT_PROFILE_TAG
+ " osm",
128 AZURE_RESOURCE_MGMT_CLIENT_API_VERSION
= "2020-10-01"
129 AZURE_RESOURCE_MGMT_PROFILE_TAG
= (
130 "azure.mgmt.resource.resources.ResourceManagementClient"
132 AZURE_RESOURCE_MGMT_PROFILE
= ProfileDefinition(
134 AZURE_RESOURCE_MGMT_PROFILE_TAG
: {
135 None: AZURE_RESOURCE_MGMT_CLIENT_API_VERSION
,
138 AZURE_RESOURCE_MGMT_PROFILE_TAG
+ " osm",
141 AZURE_NETWORK_MGMT_CLIENT_API_VERSION
= "2020-11-01"
142 AZURE_NETWORK_MGMT_PROFILE_TAG
= "azure.mgmt.network.NetworkManagementClient"
143 AZURE_NETWORK_MGMT_PROFILE
= ProfileDefinition(
145 AZURE_NETWORK_MGMT_PROFILE_TAG
: {
146 None: AZURE_NETWORK_MGMT_CLIENT_API_VERSION
,
147 "firewall_policy_rule_groups": "2020-04-01",
148 "interface_endpoints": "2019-02-01",
149 "p2_svpn_server_configurations": "2019-07-01",
152 AZURE_NETWORK_MGMT_PROFILE_TAG
+ " osm",
170 Constructor of VIM. Raise an exception is some needed parameter is missing, but it must not do any connectivity
171 checking against the VIM
172 Using common constructor parameters.
173 In this case: config must include the following parameters:
174 subscription_id: assigned azure subscription identifier
175 region_name: current region for azure network
176 resource_group: used for all azure created resources
177 vnet_name: base vnet for azure, created networks will be subnets from this base network
178 config may also include the following parameter:
179 flavors_pattern: pattern that will be used to select a range of vm sizes, for example
180 "^((?!Standard_B).)*$" will filter out Standard_B range that is cheap but is very overused
181 "^Standard_B" will select a serie B maybe for test environment
183 vimconn
.VimConnector
.__init
__(
198 # Variable that indicates if client must be reloaded or initialized
199 self
.reload_client
= True
201 self
.vnet_address_space
= None
204 self
.logger
= logging
.getLogger("ro.vim.azure")
206 self
.logger
.setLevel(getattr(logging
, log_level
))
208 self
.tenant
= tenant_id
or tenant_name
210 # Store config to create azure subscription later
214 "tenant": tenant_id
or tenant_name
,
218 if "subscription_id" in config
:
219 self
._config
["subscription_id"] = config
.get("subscription_id")
220 # self.logger.debug("Setting subscription to: %s", self.config["subscription_id"])
222 raise vimconn
.VimConnException("Subscription not specified")
225 if "region_name" in config
:
226 self
.region
= config
.get("region_name")
228 raise vimconn
.VimConnException(
229 "Azure region_name is not specified at config"
233 if "resource_group" in config
:
234 self
.resource_group
= config
.get("resource_group")
236 raise vimconn
.VimConnException(
237 "Azure resource_group is not specified at config"
241 if "vnet_name" in config
:
242 self
.vnet_name
= config
["vnet_name"]
244 # TODO - not used, do anything about it?
246 self
.pub_key
= config
.get("pub_key")
248 # TODO - check default user for azure
250 self
._default
_admin
_user
= "azureuser"
252 # flavor pattern regex
253 if "flavors_pattern" in config
:
254 self
._config
["flavors_pattern"] = config
["flavors_pattern"]
256 def _reload_connection(self
):
258 Called before any operation, checks python azure clients
260 if self
.reload_client
:
261 self
.logger
.debug("reloading azure client")
264 self
.credentials
= ClientSecretCredential(
265 client_id
=self
._config
["user"],
266 client_secret
=self
._config
["passwd"],
267 tenant_id
=self
._config
["tenant"],
269 self
.conn
= ResourceManagementClient(
271 self
._config
["subscription_id"],
272 profile
=self
.AZURE_RESOURCE_MGMT_PROFILE
,
274 self
.conn_compute
= ComputeManagementClient(
276 self
._config
["subscription_id"],
277 profile
=self
.AZURE_COMPUTE_MGMT_PROFILE
,
279 self
.conn_vnet
= NetworkManagementClient(
281 self
._config
["subscription_id"],
282 profile
=self
.AZURE_NETWORK_MGMT_PROFILE
,
284 self
._check
_or
_create
_resource
_group
()
285 self
._check
_or
_create
_vnet
()
287 # Set to client created
288 self
.reload_client
= False
289 except Exception as e
:
290 self
._format
_vimconn
_exception
(e
)
292 def _get_resource_name_from_resource_id(self
, resource_id
):
294 Obtains resource_name from the azure complete identifier: resource_name will always be last item
297 resource
= str(resource_id
.split("/")[-1])
300 except Exception as e
:
301 raise vimconn
.VimConnException(
302 "Unable to get resource name from resource_id '{}' Error: '{}'".format(
307 def _get_location_from_resource_group(self
, resource_group_name
):
309 location
= self
.conn
.resource_groups
.get(resource_group_name
).location
313 raise vimconn
.VimConnNotFoundException(
314 "Location '{}' not found".format(resource_group_name
)
317 def _get_resource_group_name_from_resource_id(self
, resource_id
):
319 rg
= str(resource_id
.split("/")[4])
323 raise vimconn
.VimConnException(
324 "Unable to get resource group from invalid resource_id format '{}'".format(
329 def _get_net_name_from_resource_id(self
, resource_id
):
331 net_name
= str(resource_id
.split("/")[8])
335 raise vimconn
.VimConnException(
336 "Unable to get azure net_name from invalid resource_id format '{}'".format(
341 def _check_subnets_for_vm(self
, net_list
):
342 # All subnets must belong to the same resource group and vnet
343 # All subnets must belong to the same resource group anded vnet
345 self
._get
_resource
_group
_name
_from
_resource
_id
(net
["net_id"])
346 + self
._get
_net
_name
_from
_resource
_id
(net
["net_id"])
350 if len(rg_vnet
) != 1:
351 raise self
._format
_vimconn
_exception
(
352 "Azure VMs can only attach to subnets in same VNET"
355 def _format_vimconn_exception(self
, e
):
357 Transforms a generic or azure exception to a vimcommException
359 self
.logger
.error("Azure plugin error: {}".format(e
))
360 if isinstance(e
, vimconn
.VimConnException
):
362 elif isinstance(e
, AuthenticationError
):
363 raise vimconn
.VimConnAuthException(type(e
).__name
__ + ": " + str(e
))
364 elif isinstance(e
, ConnectionError
):
365 raise vimconn
.VimConnConnectionException(type(e
).__name
__ + ": " + str(e
))
367 # In case of generic error recreate client
368 self
.reload_client
= True
370 raise vimconn
.VimConnException(type(e
).__name
__ + ": " + str(e
))
372 def _check_or_create_resource_group(self
):
374 Creates the base resource group if it does not exist
377 rg_exists
= self
.conn
.resource_groups
.check_existence(self
.resource_group
)
380 self
.logger
.debug("create base rgroup: %s", self
.resource_group
)
381 self
.conn
.resource_groups
.create_or_update(
382 self
.resource_group
, {"location": self
.region
}
384 except Exception as e
:
385 self
._format
_vimconn
_exception
(e
)
387 def _check_or_create_vnet(self
):
389 Try to get existent base vnet, in case it does not exist it creates it
392 vnet
= self
.conn_vnet
.virtual_networks
.get(
393 self
.resource_group
, self
.vnet_name
395 self
.vnet_address_space
= vnet
.address_space
.address_prefixes
[0]
396 self
.vnet_id
= vnet
.id
399 except CloudError
as e
:
400 if e
.error
.error
and "notfound" in e
.error
.error
.lower():
402 # continue and create it
404 self
._format
_vimconn
_exception
(e
)
406 # if it does not exist, create it
409 "location": self
.region
,
410 "address_space": {"address_prefixes": ["10.0.0.0/8"]},
412 self
.vnet_address_space
= "10.0.0.0/8"
414 self
.logger
.debug("create base vnet: %s", self
.vnet_name
)
415 self
.conn_vnet
.virtual_networks
.begin_create_or_update(
416 self
.resource_group
, self
.vnet_name
, vnet_params
418 vnet
= self
.conn_vnet
.virtual_networks
.get(
419 self
.resource_group
, self
.vnet_name
421 self
.vnet_id
= vnet
.id
422 except Exception as e
:
423 self
._format
_vimconn
_exception
(e
)
431 provider_network_profile
=None,
434 Adds a tenant network to VIM
435 :param net_name: name of the network
436 :param net_type: not used for azure networks
437 :param ip_profile: is a dict containing the IP parameters of the network (Currently only IPv4 is implemented)
438 'ip-version': can be one of ['IPv4','IPv6']
439 'subnet-address': ip_prefix_schema, that is X.X.X.X/Y
440 'gateway-address': (Optional) ip_schema, that is X.X.X.X, not implemented for azure connector
441 'dns-address': (Optional) ip_schema, not implemented for azure connector
442 'dhcp': (Optional) dict containing, not implemented for azure connector
443 'enabled': {'type': 'boolean'},
444 'start-address': ip_schema, first IP to grant
445 'count': number of IPs to grant.
446 :param shared: Not allowed for Azure Connector
447 :param provider_network_profile: (optional) contains {segmentation-id: vlan, provider-network: vim_netowrk}
448 :return: a tuple with the network identifier and created_items, or raises an exception on error
449 created_items can be None or a dictionary where this method can include key-values that will be passed to
450 the method delete_network. Can be used to store created segments, created l2gw connections, etc.
451 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
454 return self
._new
_subnet
(net_name
, ip_profile
)
456 def _new_subnet(self
, net_name
, ip_profile
):
458 Adds a tenant network to VIM. It creates a new subnet at existing base vnet
459 :param net_name: subnet name
461 subnet-address: if it is not provided a subnet/24 in the default vnet is created,
462 otherwise it creates a subnet in the indicated address
463 :return: a tuple with the network identifier and created_items, or raises an exception on error
465 self
.logger
.debug("create subnet name %s, ip_profile %s", net_name
, ip_profile
)
466 self
._reload
_connection
()
468 if ip_profile
is None:
469 # get a non used vnet ip range /24 and allocate automatically inside the range self.vnet_address_space
470 used_subnets
= self
.get_network_list()
471 for ip_range
in netaddr
.IPNetwork(self
.vnet_address_space
).subnet(24):
472 for used_subnet
in used_subnets
:
473 subnet_range
= netaddr
.IPNetwork(used_subnet
["cidr_block"])
475 if subnet_range
in ip_range
or ip_range
in subnet_range
:
476 # this range overlaps with an existing subnet ip range. Breaks and look for another
479 ip_profile
= {"subnet_address": str(ip_range
)}
480 self
.logger
.debug("dinamically obtained ip_profile: %s", ip_range
)
483 raise vimconn
.VimConnException(
484 "Cannot find a non-used subnet range in {}".format(
485 self
.vnet_address_space
489 ip_profile
= {"subnet_address": ip_profile
["subnet_address"]}
492 # subnet_name = "{}-{}".format(net_name[:24], uuid4())
493 subnet_params
= {"address_prefix": ip_profile
["subnet_address"]}
494 # Assign a not duplicated net name
495 subnet_name
= self
._get
_unused
_subnet
_name
(net_name
)
497 self
.logger
.debug("creating subnet_name: {}".format(subnet_name
))
498 async_creation
= self
.conn_vnet
.subnets
.begin_create_or_update(
499 self
.resource_group
, self
.vnet_name
, subnet_name
, subnet_params
501 async_creation
.wait()
502 # TODO - do not wait here, check where it is used
503 self
.logger
.debug("created subnet_name: {}".format(subnet_name
))
505 return "{}/subnets/{}".format(self
.vnet_id
, subnet_name
), None
506 except Exception as e
:
507 self
._format
_vimconn
_exception
(e
)
509 def _get_unused_subnet_name(self
, subnet_name
):
511 Adds a prefix to the subnet_name with a number in case the indicated name is repeated
512 Checks subnets with the indicated name (without suffix) and adds a suffix with a number
514 all_subnets
= self
.conn_vnet
.subnets
.list(self
.resource_group
, self
.vnet_name
)
515 # Filter to subnets starting with the indicated name
517 filter(lambda subnet
: (subnet
.name
.startswith(subnet_name
)), all_subnets
)
519 net_names
= [str(subnet
.name
) for subnet
in subnets
]
521 # get the name with the first not used suffix
523 # name = subnet_name + "-" + str(name_suffix)
524 name
= subnet_name
# first subnet created will have no prefix
525 while name
in net_names
:
527 name
= subnet_name
+ "-" + str(name_suffix
)
531 def _create_nic(self
, net
, nic_name
, static_ip
=None, created_items
={}):
532 self
.logger
.debug("create nic name %s, net_name %s", nic_name
, net
)
533 self
._reload
_connection
()
535 subnet_id
= net
["net_id"]
536 location
= self
._get
_location
_from
_resource
_group
(self
.resource_group
)
538 net_ifz
= {"location": location
}
540 "name": nic_name
+ "-ipconfiguration",
541 "subnet": {"id": subnet_id
},
545 net_ip_config
["privateIPAddress"] = static_ip
546 net_ip_config
["privateIPAllocationMethod"] = "Static"
548 net_ifz
["ip_configurations"] = [net_ip_config
]
549 mac_address
= net
.get("mac_address")
552 net_ifz
["mac_address"] = mac_address
554 async_nic_creation
= (
555 self
.conn_vnet
.network_interfaces
.begin_create_or_update(
556 self
.resource_group
, nic_name
, net_ifz
559 nic_data
= async_nic_creation
.result()
560 created_items
[nic_data
.id] = True
561 self
.logger
.debug("created nic name %s", nic_name
)
563 public_ip
= net
.get("floating_ip")
565 public_ip_address_params
= {
566 "location": location
,
567 "public_ip_allocation_method": "Dynamic",
569 public_ip_name
= nic_name
+ "-public-ip"
571 self
.conn_vnet
.public_ip_addresses
.begin_create_or_update(
572 self
.resource_group
, public_ip_name
, public_ip_address_params
575 public_ip
= async_public_ip
.result()
576 self
.logger
.debug("created public IP: {}".format(public_ip
))
578 # Associate NIC to Public IP
579 nic_data
= self
.conn_vnet
.network_interfaces
.get(
580 self
.resource_group
, nic_name
583 nic_data
.ip_configurations
[0].public_ip_address
= public_ip
584 created_items
[public_ip
.id] = True
586 self
.conn_vnet
.network_interfaces
.begin_create_or_update(
587 self
.resource_group
, nic_name
, nic_data
590 except Exception as e
:
591 self
._format
_vimconn
_exception
(e
)
593 return nic_data
, created_items
595 def new_flavor(self
, flavor_data
):
597 It is not allowed to create new flavors in Azure, must always use an existing one
599 raise vimconn
.VimConnAuthException(
600 "It is not possible to create new flavors in AZURE"
603 def new_tenant(self
, tenant_name
, tenant_description
):
605 It is not allowed to create new tenants in azure
607 raise vimconn
.VimConnAuthException(
608 "It is not possible to create a TENANT in AZURE"
611 def new_image(self
, image_dict
):
613 It is not allowed to create new images in Azure, must always use an existing one
615 raise vimconn
.VimConnAuthException(
616 "It is not possible to create new images in AZURE"
619 def get_image_id_from_path(self
, path
):
620 """Get the image id from image path in the VIM database.
621 Returns the image_id or raises a vimconnNotFoundException
623 raise vimconn
.VimConnAuthException(
624 "It is not possible to obtain image from path in AZURE"
627 def get_image_list(self
, filter_dict
={}):
628 """Obtain tenant images from VIM
630 name: image name with the format: publisher:offer:sku:version
631 If some part of the name is provide ex: publisher:offer it will search all availables skus and version
632 for the provided publisher and offer
633 id: image uuid, currently not supported for azure
634 Returns the image list of dictionaries:
635 [{<the fields at Filter_dict plus some VIM specific>}, ...]
638 self
.logger
.debug("get_image_list filter {}".format(filter_dict
))
640 self
._reload
_connection
()
643 if filter_dict
.get("name"):
644 # name will have the format "publisher:offer:sku:version"
645 # publisher is required, offer sku and version will be searched if not provided
646 params
= filter_dict
["name"].split(":")
647 publisher
= params
[0]
650 offer_list
= self
._get
_offer
_list
(params
, publisher
)
652 for offer
in offer_list
:
654 sku_list
= self
._get
_sku
_list
(params
, publisher
, offer
)
657 # if version is defined get directly version, else list images
658 if len(params
) == 4 and params
[3]:
660 if version
== "latest":
661 image_list
= self
._get
_sku
_image
_list
(
662 publisher
, offer
, sku
664 image_list
= [image_list
[-1]]
666 image_list
= self
._get
_version
_image
_list
(
667 publisher
, offer
, sku
, version
670 image_list
= self
._get
_sku
_image
_list
(
671 publisher
, offer
, sku
674 raise vimconn
.VimConnAuthException(
675 "List images in Azure must include name param with at least publisher"
678 raise vimconn
.VimConnAuthException(
679 "List images in Azure must include name param with at"
684 except Exception as e
:
685 self
._format
_vimconn
_exception
(e
)
687 def _get_offer_list(self
, params
, publisher
):
689 Helper method to obtain offer list for defined publisher
691 if len(params
) >= 2 and params
[1]:
695 # get list of offers from azure
696 result_offers
= self
.conn_compute
.virtual_machine_images
.list_offers(
697 self
.region
, publisher
700 return [offer
.name
for offer
in result_offers
]
701 except CloudError
as e
:
702 # azure raises CloudError when not found
704 "error listing offers for publisher {}, Error: {}".format(
711 def _get_sku_list(self
, params
, publisher
, offer
):
713 Helper method to obtain sku list for defined publisher and offer
715 if len(params
) >= 3 and params
[2]:
719 # get list of skus from azure
720 result_skus
= self
.conn_compute
.virtual_machine_images
.list_skus(
721 self
.region
, publisher
, offer
724 return [sku
.name
for sku
in result_skus
]
725 except CloudError
as e
:
726 # azure raises CloudError when not found
728 "error listing skus for publisher {}, offer {}, Error: {}".format(
735 def _get_sku_image_list(self
, publisher
, offer
, sku
):
737 Helper method to obtain image list for publisher, offer and sku
741 result_images
= self
.conn_compute
.virtual_machine_images
.list(
742 self
.region
, publisher
, offer
, sku
744 for result_image
in result_images
:
747 "id": str(result_image
.id),
748 "name": ":".join([publisher
, offer
, sku
, result_image
.name
]),
751 except CloudError
as e
:
753 "error listing skus for publisher {}, offer {}, Error: {}".format(
761 def _get_version_image_list(self
, publisher
, offer
, sku
, version
):
764 result_image
= self
.conn_compute
.virtual_machine_images
.get(
765 self
.region
, publisher
, offer
, sku
, version
771 "id": str(result_image
.id),
772 "name": ":".join([publisher
, offer
, sku
, version
]),
775 except CloudError
as e
:
776 # azure gives CloudError when not found
778 "error listing images for publisher {}, offer {}, sku {}, version {} Error: {}".format(
779 publisher
, offer
, sku
, version
, e
786 def get_network_list(self
, filter_dict
={}):
787 """Obtain tenant networks of VIM
791 shared: boolean, not implemented in Azure
792 tenant_id: tenant, not used in Azure, all networks same tenants
793 admin_state_up: boolean, not implemented in Azure
794 status: 'ACTIVE', not implemented in Azure #
795 Returns the network list of dictionaries
797 # self.logger.debug("getting network list for vim, filter %s", filter_dict)
799 self
._reload
_connection
()
801 vnet
= self
.conn_vnet
.virtual_networks
.get(
802 self
.resource_group
, self
.vnet_name
806 for subnet
in vnet
.subnets
:
808 if filter_dict
.get("id") and str(subnet
.id) != filter_dict
["id"]:
812 filter_dict
.get("name")
813 and str(subnet
.name
) != filter_dict
["name"]
817 name
= self
._get
_resource
_name
_from
_resource
_id
(subnet
.id)
821 "id": str(subnet
.id),
823 "status": self
.provision_state2osm
[subnet
.provisioning_state
],
824 "cidr_block": str(subnet
.address_prefix
),
831 except Exception as e
:
832 self
._format
_vimconn
_exception
(e
)
844 availability_zone_index
=None,
845 availability_zone_list
=None,
848 "new vm instance name: %s, image_id: %s, flavor_id: %s, net_list: %s, cloud_config: %s, "
849 "disk_list: %s, availability_zone_index: %s, availability_zone_list: %s",
856 availability_zone_index
,
857 availability_zone_list
,
859 self
._reload
_connection
()
861 # Validate input data is valid
862 # The virtual machine name must have less or 64 characters and it can not have the following
863 # characters: (~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : ' " , < > / ?.)
864 vm_name
= self
._check
_vm
_name
(name
)
865 # Obtain vm unused name
866 vm_name
= self
._get
_unused
_vm
_name
(vm_name
)
868 # At least one network must be provided
870 raise vimconn
.VimConnException(
871 "At least one net must be provided to create a new VM"
874 # image_id are several fields of the image_id
875 image_reference
= self
._get
_image
_reference
(image_id
)
878 virtual_machine
= None
881 # Create nics for each subnet
882 self
._check
_subnets
_for
_vm
(net_list
)
885 for idx
, net
in enumerate(net_list
):
886 # Fault with subnet_id
887 # subnet_id=net["subnet_id"]
888 # subnet_id=net["net_id"]
889 nic_name
= vm_name
+ "-nic-" + str(idx
)
890 vm_nic
, nic_items
= self
._create
_nic
(
891 net
, nic_name
, net
.get("ip_address"), created_items
893 vm_nics
.append({"id": str(vm_nic
.id)})
894 net
["vim_id"] = vm_nic
.id
897 "location": self
.region
,
898 "os_profile": self
._build
_os
_profile
(vm_name
, cloud_config
, image_id
),
899 "hardware_profile": {"vm_size": flavor_id
},
900 "storage_profile": {"image_reference": image_reference
},
903 # If the machine has several networks one must be marked as primary
904 # As it is not indicated in the interface the first interface will be marked as primary
906 for idx
, vm_nic
in enumerate(vm_nics
):
908 vm_nics
[0]["Primary"] = True
910 vm_nics
[idx
]["Primary"] = False
912 vm_parameters
["network_profile"] = {"network_interfaces": vm_nics
}
914 # Obtain zone information
915 vm_zone
= self
._get
_vm
_zone
(availability_zone_index
, availability_zone_list
)
917 vm_parameters
["zones"] = [vm_zone
]
919 self
.logger
.debug("create vm name: %s", vm_name
)
920 creation_result
= self
.conn_compute
.virtual_machines
.begin_create_or_update(
921 self
.resource_group
, vm_name
, vm_parameters
, polling
=False
923 self
.logger
.debug("obtained creation result: %s", creation_result
)
924 virtual_machine
= creation_result
.result()
925 self
.logger
.debug("created vm name: %s", vm_name
)
927 """ Por ahora no hacer polling para ver si tarda menos
928 # Add disks if they are provided
930 for disk_index, disk in enumerate(disk_list):
932 "add disk size: %s, image: %s",
936 self._add_newvm_disk(
937 virtual_machine, vm_name, disk_index, disk, created_items
941 self.conn_compute.virtual_machines.start(self.resource_group, vm_name)
942 # start_result.wait()
945 return virtual_machine
.id, created_items
947 # run_command_parameters = {
948 # "command_id": "RunShellScript", # For linux, don't change it
950 # "date > /tmp/test.txt"
953 except Exception as e
:
954 # Rollback vm creacion
958 vm_id
= virtual_machine
.id
961 self
.logger
.debug("exception creating vm try to rollback")
962 self
.delete_vminstance(vm_id
, created_items
)
963 except Exception as e2
:
964 self
.logger
.error("new_vminstance rollback fail {}".format(e2
))
966 self
.logger
.debug("Exception creating new vminstance: %s", e
, exc_info
=True)
967 self
._format
_vimconn
_exception
(e
)
969 def _build_os_profile(self
, vm_name
, cloud_config
, image_id
):
972 os_profile
= {"computer_name": vm_name
}
974 # for azure os_profile admin_username is required
975 if cloud_config
and cloud_config
.get("users"):
976 admin_username
= cloud_config
.get("users")[0].get(
977 "name", self
._get
_default
_admin
_user
(image_id
)
980 admin_username
= self
._get
_default
_admin
_user
(image_id
)
981 os_profile
["admin_username"] = admin_username
983 # if there is a cloud-init load it
985 _
, userdata
= self
._create
_user
_data
(cloud_config
)
986 custom_data
= base64
.b64encode(userdata
.encode("utf-8")).decode("latin-1")
987 os_profile
["custom_data"] = custom_data
989 # either password of ssh-keys are required
990 # we will always use ssh-keys, in case it is not available we will generate it
991 if cloud_config
and cloud_config
.get("key-pairs"):
992 key_data
= cloud_config
.get("key-pairs")[0]
994 _
, key_data
= self
._generate
_keys
()
996 os_profile
["linux_configuration"] = {
1000 "path": "/home/{}/.ssh/authorized_keys".format(admin_username
),
1001 "key_data": key_data
,
1009 def _generate_keys(self
):
1010 """Method used to generate a pair of private/public keys.
1011 This method is used because to create a vm in Azure we always need a key or a password
1012 In some cases we may have a password in a cloud-init file but it may not be available
1014 key
= rsa
.generate_private_key(
1015 backend
=crypto_default_backend(), public_exponent
=65537, key_size
=2048
1017 private_key
= key
.private_bytes(
1018 crypto_serialization
.Encoding
.PEM
,
1019 crypto_serialization
.PrivateFormat
.PKCS8
,
1020 crypto_serialization
.NoEncryption(),
1022 public_key
= key
.public_key().public_bytes(
1023 crypto_serialization
.Encoding
.OpenSSH
,
1024 crypto_serialization
.PublicFormat
.OpenSSH
,
1026 private_key
= private_key
.decode("utf8")
1027 # Change first line because Paramiko needs a explicit start with 'BEGIN RSA PRIVATE KEY'
1028 i
= private_key
.find("\n")
1029 private_key
= "-----BEGIN RSA PRIVATE KEY-----" + private_key
[i
:]
1030 public_key
= public_key
.decode("utf8")
1032 return private_key
, public_key
1034 def _get_unused_vm_name(self
, vm_name
):
1036 Checks the vm name and in case it is used adds a suffix to the name to allow creation
1039 all_vms
= self
.conn_compute
.virtual_machines
.list(self
.resource_group
)
1040 # Filter to vms starting with the indicated name
1041 vms
= list(filter(lambda vm
: (vm
.name
.startswith(vm_name
)), all_vms
))
1042 vm_names
= [str(vm
.name
) for vm
in vms
]
1044 # get the name with the first not used suffix
1046 # name = subnet_name + "-" + str(name_suffix)
1047 name
= vm_name
# first subnet created will have no prefix
1049 while name
in vm_names
:
1051 name
= vm_name
+ "-" + str(name_suffix
)
1055 def _get_vm_zone(self
, availability_zone_index
, availability_zone_list
):
1056 if availability_zone_index
is None:
1059 vim_availability_zones
= self
._get
_azure
_availability
_zones
()
1060 # check if VIM offer enough availability zones describe in the VNFD
1061 if vim_availability_zones
and len(availability_zone_list
) <= len(
1062 vim_availability_zones
1064 # check if all the names of NFV AV match VIM AV names
1065 match_by_index
= False
1067 if not availability_zone_list
:
1068 match_by_index
= True
1070 for av
in availability_zone_list
:
1071 if av
not in vim_availability_zones
:
1072 match_by_index
= True
1076 return vim_availability_zones
[availability_zone_index
]
1078 return availability_zone_list
[availability_zone_index
]
1080 raise vimconn
.VimConnConflictException(
1081 "No enough availability zones at VIM for this deployment"
1084 def _get_azure_availability_zones(self
):
1085 return self
.AZURE_ZONES
1087 def _add_newvm_disk(
1088 self
, virtual_machine
, vm_name
, disk_index
, disk
, created_items
={}
1093 # Check if must create empty disk or from image
1094 if disk
.get("vim_id"):
1095 # disk already exists, just get
1096 parsed_id
= azure_tools
.parse_resource_id(disk
.get("vim_id"))
1097 disk_name
= parsed_id
.get("name")
1098 data_disk
= self
.conn_compute
.disks
.get(self
.resource_group
, disk_name
)
1100 disk_name
= vm_name
+ "_DataDisk_" + str(disk_index
)
1101 if not disk
.get("image_id"):
1102 self
.logger
.debug("create new data disk name: %s", disk_name
)
1103 async_disk_creation
= self
.conn_compute
.disks
.begin_create_or_update(
1104 self
.resource_group
,
1107 "location": self
.region
,
1108 "disk_size_gb": disk
.get("size"),
1109 "creation_data": {"create_option": DiskCreateOption
.empty
},
1112 data_disk
= async_disk_creation
.result()
1113 created_items
[data_disk
.id] = True
1115 image_id
= disk
.get("image_id")
1117 if azure_tools
.is_valid_resource_id(image_id
):
1118 parsed_id
= azure_tools
.parse_resource_id(image_id
)
1120 # Check if image is snapshot or disk
1121 image_name
= parsed_id
.get("name")
1122 type = parsed_id
.get("resource_type")
1124 if type == "snapshots" or type == "disks":
1125 self
.logger
.debug("create disk from copy name: %s", image_name
)
1126 # ¿Should check that snapshot exists?
1127 async_disk_creation
= (
1128 self
.conn_compute
.disks
.begin_create_or_update(
1129 self
.resource_group
,
1132 "location": self
.region
,
1134 "create_option": "Copy",
1135 "source_uri": image_id
,
1140 data_disk
= async_disk_creation
.result()
1141 created_items
[data_disk
.id] = True
1143 raise vimconn
.VimConnNotFoundException(
1144 "Invalid image_id: %s ", image_id
1147 raise vimconn
.VimConnNotFoundException(
1148 "Invalid image_id: %s ", image_id
1151 # Attach the disk created
1152 virtual_machine
.storage_profile
.data_disks
.append(
1156 "create_option": DiskCreateOption
.attach
,
1157 "managed_disk": {"id": data_disk
.id},
1158 "disk_size_gb": disk
.get("size"),
1161 self
.logger
.debug("attach disk name: %s", disk_name
)
1162 self
.conn_compute
.virtual_machines
.begin_create_or_update(
1163 self
.resource_group
, virtual_machine
.name
, virtual_machine
1166 # It is necesary extract from image_id data to create the VM with this format
1167 # "image_reference": {
1168 # "publisher": vm_reference["publisher"],
1169 # "offer": vm_reference["offer"],
1170 # "sku": vm_reference["sku"],
1171 # "version": vm_reference["version"]
1173 def _get_image_reference(self
, image_id
):
1175 # The data input format example:
1176 # /Subscriptions/ca3d18ab-d373-4afb-a5d6-7c44f098d16a/Providers/Microsoft.Compute/Locations/westeurope/
1177 # Publishers/Canonical/ArtifactTypes/VMImage/
1178 # Offers/UbuntuServer/
1180 # Versions/18.04.201809110
1181 publisher
= str(image_id
.split("/")[8])
1182 offer
= str(image_id
.split("/")[12])
1183 sku
= str(image_id
.split("/")[14])
1184 version
= str(image_id
.split("/")[16])
1187 "publisher": publisher
,
1193 raise vimconn
.VimConnException(
1194 "Unable to get image_reference from invalid image_id format: '{}'".format(
1199 # Azure VM names can not have some special characters
1200 def _check_vm_name(self
, vm_name
):
1202 Checks vm name, in case the vm has not allowed characters they are removed, not error raised
1204 chars_not_allowed_list
= "~!@#$%^&*()=+_[]{}|;:<>/?."
1206 # First: the VM name max length is 64 characters
1207 vm_name_aux
= vm_name
[:64]
1209 # Second: replace not allowed characters
1210 for elem
in chars_not_allowed_list
:
1211 # Check if string is in the main string
1212 if elem
in vm_name_aux
:
1213 # self.logger.debug("Dentro del IF")
1214 # Replace the string
1215 vm_name_aux
= vm_name_aux
.replace(elem
, "-")
1219 def get_flavor_id_from_data(self
, flavor_dict
):
1220 self
.logger
.debug("getting flavor id from data, flavor_dict: %s", flavor_dict
)
1221 filter_dict
= flavor_dict
or {}
1224 self
._reload
_connection
()
1227 for vm_size
in self
.conn_compute
.resource_skus
.list(
1228 "location={}".format(self
.region
)
1232 cpus
= filter_dict
.get("vcpus") or 0
1233 memMB
= filter_dict
.get("ram") or 0
1234 numberInterfaces
= len(filter_dict
.get("interfaces", [])) or 0
1237 if self
._config
.get("flavors_pattern"):
1240 for size
in vm_sizes_list
1241 if size
["capabilities"]["vCPUs"] >= cpus
1242 and size
["capabilities"]["MemoryGB"] >= memMB
/ 1024
1243 and size
["capabilities"]["MaxNetworkInterfaces"] >= numberInterfaces
1244 and re
.search(self
._config
.get("flavors_pattern"), size
["name"])
1249 for size
in vm_sizes_list
1250 if size
["capabilities"]["vCPUs"] >= cpus
1251 and size
["capabilities"]["MemoryGB"] >= memMB
/ 1024
1252 and size
["capabilities"]["MaxNetworkInterfaces"] >= numberInterfaces
1256 listedFilteredSizes
= sorted(
1261 k
["resourceDiskSizeInMB"],
1265 if listedFilteredSizes
:
1266 return listedFilteredSizes
[0]["name"]
1268 raise vimconn
.VimConnNotFoundException(
1269 "Cannot find any flavor matching '{}'".format(str(flavor_dict
))
1271 except Exception as e
:
1272 self
._format
_vimconn
_exception
(e
)
1274 def _get_flavor_id_from_flavor_name(self
, flavor_name
):
1275 # self.logger.debug("getting flavor id from flavor name {}".format(flavor_name))
1277 self
._reload
_connection
()
1280 for vm_size
in self
.conn_compute
.resource_skus
.list(
1281 "location={}".format(self
.region
)
1285 output_flavor
= None
1286 for size
in vm_sizes_list
:
1287 if size
["name"] == flavor_name
:
1288 output_flavor
= size
1290 # None is returned if not found anything
1291 return output_flavor
1292 except Exception as e
:
1293 self
._format
_vimconn
_exception
(e
)
1295 def check_vim_connectivity(self
):
1297 self
._reload
_connection
()
1299 except Exception as e
:
1300 raise vimconn
.VimConnException(
1301 "Connectivity issue with Azure API: {}".format(e
)
1304 def get_network(self
, net_id
):
1305 # self.logger.debug("get network id: {}".format(net_id))
1306 # res_name = self._get_resource_name_from_resource_id(net_id)
1307 self
._reload
_connection
()
1309 filter_dict
= {"name": net_id
}
1310 network_list
= self
.get_network_list(filter_dict
)
1312 if not network_list
:
1313 raise vimconn
.VimConnNotFoundException(
1314 "network '{}' not found".format(net_id
)
1317 return network_list
[0]
1319 def delete_network(self
, net_id
, created_items
=None):
1321 "deleting network {} - {}".format(self
.resource_group
, net_id
)
1324 self
._reload
_connection
()
1325 res_name
= self
._get
_resource
_name
_from
_resource
_id
(net_id
)
1328 # Obtain subnets ant try to delete nic first
1329 subnet
= self
.conn_vnet
.subnets
.get(
1330 self
.resource_group
, self
.vnet_name
, res_name
1333 raise vimconn
.VimConnNotFoundException(
1334 "network '{}' not found".format(net_id
)
1337 # TODO - for a quick-fix delete nics sequentially but should not wait
1339 if subnet
.ip_configurations
:
1340 for ip_configuration
in subnet
.ip_configurations
:
1341 # obtain nic_name from ip_configuration
1342 parsed_id
= azure_tools
.parse_resource_id(ip_configuration
.id)
1343 nic_name
= parsed_id
["name"]
1344 self
.delete_inuse_nic(nic_name
)
1346 # Subnet API fails (CloudError: Azure Error: ResourceNotFound)
1347 # Put the initial virtual_network API
1348 async_delete
= self
.conn_vnet
.subnets
.begin_delete(
1349 self
.resource_group
, self
.vnet_name
, res_name
1355 except ResourceNotFoundError
:
1356 raise vimconn
.VimConnNotFoundException(
1357 "network '{}' not found".format(net_id
)
1359 except CloudError
as e
:
1360 if e
.error
.error
and "notfound" in e
.error
.error
.lower():
1361 raise vimconn
.VimConnNotFoundException(
1362 "network '{}' not found".format(net_id
)
1365 self
._format
_vimconn
_exception
(e
)
1366 except Exception as e
:
1367 self
._format
_vimconn
_exception
(e
)
1369 def delete_inuse_nic(self
, nic_name
):
1372 nic_data
= self
.conn_vnet
.network_interfaces
.get(self
.resource_group
, nic_name
)
1374 # Obtain vm associated to nic in case it exists
1375 if nic_data
.virtual_machine
:
1376 vm_name
= azure_tools
.parse_resource_id(nic_data
.virtual_machine
.id)["name"]
1377 self
.logger
.debug("vm_name: {}".format(vm_name
))
1378 virtual_machine
= self
.conn_compute
.virtual_machines
.get(
1379 self
.resource_group
, vm_name
1381 self
.logger
.debug("obtained vm")
1383 # Deattach nic from vm if it has netwolk machines attached
1384 network_interfaces
= virtual_machine
.network_profile
.network_interfaces
1385 network_interfaces
[:] = [
1387 for interface
in network_interfaces
1388 if self
._get
_resource
_name
_from
_resource
_id
(interface
.id) != nic_name
1391 # TODO - check if there is a public ip to delete and delete it
1392 if network_interfaces
:
1395 async_vm_deallocate
= (
1396 self
.conn_compute
.virtual_machines
.begin_deallocate(
1397 self
.resource_group
, vm_name
1400 self
.logger
.debug("deallocating vm")
1401 async_vm_deallocate
.wait()
1402 self
.logger
.debug("vm deallocated")
1405 self
.conn_compute
.virtual_machines
.begin_create_or_update(
1406 self
.resource_group
, vm_name
, virtual_machine
1409 virtual_machine
= async_vm_update
.result()
1410 self
.logger
.debug("nic removed from interface")
1413 self
.logger
.debug("There are no interfaces left, delete vm")
1414 self
.delete_vminstance(virtual_machine
.id)
1415 self
.logger
.debug("Delete vm")
1418 self
.logger
.debug("delete NIC name: %s", nic_name
)
1419 nic_delete
= self
.conn_vnet
.network_interfaces
.begin_delete(
1420 self
.resource_group
, nic_name
1423 self
.logger
.debug("deleted NIC name: %s", nic_name
)
1425 def delete_vminstance(self
, vm_id
, created_items
=None):
1426 """Deletes a vm instance from the vim."""
1428 "deleting VM instance {} - {}".format(self
.resource_group
, vm_id
)
1430 self
._reload
_connection
()
1432 created_items
= created_items
or {}
1434 # Check vm exists, we can call delete_vm to clean created_items
1436 res_name
= self
._get
_resource
_name
_from
_resource
_id
(vm_id
)
1437 vm
= self
.conn_compute
.virtual_machines
.get(
1438 self
.resource_group
, res_name
1441 # Shuts down the virtual machine and releases the compute resources
1442 # vm_stop = self.conn_compute.virtual_machines.power_off(self.resource_group, resName)
1445 vm_delete
= self
.conn_compute
.virtual_machines
.begin_delete(
1446 self
.resource_group
, res_name
1449 self
.logger
.debug("deleted VM name: %s", res_name
)
1451 # Delete OS Disk, check if exists, in case of error creating
1452 # it may not be fully created
1453 if vm
.storage_profile
.os_disk
:
1454 os_disk_name
= vm
.storage_profile
.os_disk
.name
1455 self
.logger
.debug("delete OS DISK: %s", os_disk_name
)
1456 async_disk_delete
= self
.conn_compute
.disks
.begin_delete(
1457 self
.resource_group
, os_disk_name
1459 async_disk_delete
.wait()
1460 # os disks are created always with the machine
1461 self
.logger
.debug("deleted OS DISK name: %s", os_disk_name
)
1463 for data_disk
in vm
.storage_profile
.data_disks
:
1464 self
.logger
.debug("delete data_disk: %s", data_disk
.name
)
1465 async_disk_delete
= self
.conn_compute
.disks
.begin_delete(
1466 self
.resource_group
, data_disk
.name
1468 async_disk_delete
.wait()
1469 self
._markdel
_created
_item
(data_disk
.managed_disk
.id, created_items
)
1470 self
.logger
.debug("deleted OS DISK name: %s", data_disk
.name
)
1472 # After deleting VM, it is necessary to delete NIC, because if is not deleted delete_network
1473 # does not work because Azure says that is in use the subnet
1474 network_interfaces
= vm
.network_profile
.network_interfaces
1476 for network_interface
in network_interfaces
:
1477 nic_name
= self
._get
_resource
_name
_from
_resource
_id
(
1478 network_interface
.id
1480 nic_data
= self
.conn_vnet
.network_interfaces
.get(
1481 self
.resource_group
, nic_name
1484 public_ip_name
= None
1485 exist_public_ip
= nic_data
.ip_configurations
[0].public_ip_address
1487 public_ip_id
= nic_data
.ip_configurations
[
1489 ].public_ip_address
.id
1492 public_ip_name
= self
._get
_resource
_name
_from
_resource
_id
(
1496 # Public ip must be deleted afterwards of nic that is attached
1498 self
.logger
.debug("delete NIC name: %s", nic_name
)
1499 nic_delete
= self
.conn_vnet
.network_interfaces
.begin_delete(
1500 self
.resource_group
, nic_name
1503 self
._markdel
_created
_item
(network_interface
.id, created_items
)
1504 self
.logger
.debug("deleted NIC name: %s", nic_name
)
1506 # Delete list of public ips
1508 self
.logger
.debug("delete PUBLIC IP - " + public_ip_name
)
1509 ip_delete
= self
.conn_vnet
.public_ip_addresses
.begin_delete(
1510 self
.resource_group
, public_ip_name
1513 self
._markdel
_created
_item
(public_ip_id
, created_items
)
1515 # Delete created items
1516 self
._delete
_created
_items
(created_items
)
1518 except ResourceNotFoundError
:
1519 raise vimconn
.VimConnNotFoundException(
1520 "No vm instance found '{}'".format(vm_id
)
1522 except CloudError
as e
:
1523 if e
.error
.error
and "notfound" in e
.error
.error
.lower():
1524 raise vimconn
.VimConnNotFoundException(
1525 "No vm instance found '{}'".format(vm_id
)
1528 self
._format
_vimconn
_exception
(e
)
1529 except Exception as e
:
1530 self
._format
_vimconn
_exception
(e
)
1532 def _markdel_created_item(self
, item_id
, created_items
):
1533 if item_id
in created_items
:
1534 created_items
[item_id
] = False
1536 def _delete_created_items(self
, created_items
):
1537 """Delete created_items elements that have not been deleted with the virtual machine
1538 Created_items may not be deleted correctly with the created machine if the
1539 virtual machine fails creating or in other cases of error
1541 self
.logger
.debug("Created items: %s", created_items
)
1542 # TODO - optimize - should not wait until it is deleted
1543 # Must delete in order first nics, then public_ips
1544 # As dictionaries don't preserve order, first get items to be deleted then delete them
1546 publics_ip_to_delete
= []
1547 disks_to_delete
= []
1548 for item_id
, v
in created_items
.items():
1549 if not v
: # skip already deleted
1552 # self.logger.debug("Must delete item id: %s", item_id)
1553 # Obtain type, supported nic, disk or public ip
1554 parsed_id
= azure_tools
.parse_resource_id(item_id
)
1555 resource_type
= parsed_id
.get("resource_type")
1556 name
= parsed_id
.get("name")
1558 if resource_type
== "networkInterfaces":
1559 nics_to_delete
.append(name
)
1560 elif resource_type
== "publicIPAddresses":
1561 publics_ip_to_delete
.append(name
)
1562 elif resource_type
== "disks":
1563 disks_to_delete
.append(name
)
1566 for item_name
in nics_to_delete
:
1568 self
.logger
.debug("deleting nic name %s:", item_name
)
1569 nic_delete
= self
.conn_vnet
.network_interfaces
.begin_delete(
1570 self
.resource_group
, item_name
1573 self
.logger
.debug("deleted nic name %s:", item_name
)
1574 except Exception as e
:
1576 "Error deleting item: {}: {}".format(type(e
).__name
__, e
)
1579 for item_name
in publics_ip_to_delete
:
1581 self
.logger
.debug("deleting public ip name %s:", item_name
)
1582 ip_delete
= self
.conn_vnet
.public_ip_addresses
.begin_delete(
1583 self
.resource_group
, name
1586 self
.logger
.debug("deleted public ip name %s:", item_name
)
1587 except Exception as e
:
1589 "Error deleting item: {}: {}".format(type(e
).__name
__, e
)
1592 for item_name
in disks_to_delete
:
1594 self
.logger
.debug("deleting data disk name %s:", name
)
1595 async_disk_delete
= self
.conn_compute
.disks
.begin_delete(
1596 self
.resource_group
, item_name
1598 async_disk_delete
.wait()
1599 self
.logger
.debug("deleted data disk name %s:", name
)
1600 except Exception as e
:
1602 "Error deleting item: {}: {}".format(type(e
).__name
__, e
)
1605 def action_vminstance(self
, vm_id
, action_dict
, created_items
={}):
1606 """Send and action over a VM instance from VIM
1607 Returns the vm_id if the action was successfully sent to the VIM
1609 self
.logger
.debug("Action over VM '%s': %s", vm_id
, str(action_dict
))
1612 self
._reload
_connection
()
1613 resName
= self
._get
_resource
_name
_from
_resource
_id
(vm_id
)
1615 if "start" in action_dict
:
1616 self
.conn_compute
.virtual_machines
.begin_start(
1617 self
.resource_group
, resName
1620 "stop" in action_dict
1621 or "shutdown" in action_dict
1622 or "shutoff" in action_dict
1624 self
.conn_compute
.virtual_machines
.begin_power_off(
1625 self
.resource_group
, resName
1627 elif "terminate" in action_dict
:
1628 self
.conn_compute
.virtual_machines
.begin_delete(
1629 self
.resource_group
, resName
1631 elif "reboot" in action_dict
:
1632 self
.conn_compute
.virtual_machines
.begin_restart(
1633 self
.resource_group
, resName
1637 except ResourceNotFoundError
:
1638 raise vimconn
.VimConnNotFoundException("No vm found '{}'".format(vm_id
))
1639 except CloudError
as e
:
1640 if e
.error
.error
and "notfound" in e
.error
.error
.lower():
1641 raise vimconn
.VimConnNotFoundException("No vm found '{}'".format(vm_id
))
1643 self
._format
_vimconn
_exception
(e
)
1644 except Exception as e
:
1645 self
._format
_vimconn
_exception
(e
)
1647 def delete_flavor(self
, flavor_id
):
1648 raise vimconn
.VimConnAuthException(
1649 "It is not possible to delete a FLAVOR in AZURE"
1652 def delete_tenant(self
, tenant_id
):
1653 raise vimconn
.VimConnAuthException(
1654 "It is not possible to delete a TENANT in AZURE"
1657 def delete_image(self
, image_id
):
1658 raise vimconn
.VimConnAuthException(
1659 "It is not possible to delete a IMAGE in AZURE"
1662 def get_vminstance(self
, vm_id
):
1664 Obtaing the vm instance data from v_id
1666 self
.logger
.debug("get vm instance: %s", vm_id
)
1667 self
._reload
_connection
()
1669 resName
= self
._get
_resource
_name
_from
_resource
_id
(vm_id
)
1670 vm
= self
.conn_compute
.virtual_machines
.get(self
.resource_group
, resName
)
1671 except ResourceNotFoundError
:
1672 raise vimconn
.VimConnNotFoundException(
1673 "No vminstance found '{}'".format(vm_id
)
1675 except CloudError
as e
:
1676 if e
.error
.error
and "notfound" in e
.error
.error
.lower():
1677 raise vimconn
.VimConnNotFoundException(
1678 "No vminstance found '{}'".format(vm_id
)
1681 self
._format
_vimconn
_exception
(e
)
1682 except Exception as e
:
1683 self
._format
_vimconn
_exception
(e
)
1687 def get_flavor(self
, flavor_id
):
1689 Obtains the flavor_data from the flavor_id
1691 self
._reload
_connection
()
1692 self
.logger
.debug("get flavor from id: %s", flavor_id
)
1693 flavor_data
= self
._get
_flavor
_id
_from
_flavor
_name
(flavor_id
)
1699 "ram": flavor_data
["memoryInMB"],
1700 "vcpus": flavor_data
["numberOfCores"],
1701 "disk": flavor_data
["resourceDiskSizeInMB"] / 1024,
1706 raise vimconn
.VimConnNotFoundException(
1707 "flavor '{}' not found".format(flavor_id
)
1710 def get_tenant_list(self
, filter_dict
={}):
1711 """Obtains the list of tenants
1712 For the azure connector only the azure tenant will be returned if it is compatible
1715 tenants_azure
= [{"name": self
.tenant
, "id": self
.tenant
}]
1718 self
.logger
.debug("get tenant list: %s", filter_dict
)
1719 for tenant_azure
in tenants_azure
:
1722 filter_dict
.get("id")
1723 and str(tenant_azure
.get("id")) != filter_dict
["id"]
1728 filter_dict
.get("name")
1729 and str(tenant_azure
.get("name")) != filter_dict
["name"]
1733 tenant_list
.append(tenant_azure
)
1737 def refresh_nets_status(self
, net_list
):
1738 """Get the status of the networks
1739 Params: the list of network identifiers
1740 Returns a dictionary with:
1741 net_id: #VIM id of this network
1742 status: #Mandatory. Text with one of:
1743 # DELETED (not found at vim)
1744 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1745 # OTHER (Vim reported other status not understood)
1746 # ERROR (VIM indicates an ERROR status)
1747 # ACTIVE, INACTIVE, DOWN (admin down),
1748 # BUILD (on building process)
1750 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
1751 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1754 self
._reload
_connection
()
1756 self
.logger
.debug("reload nets status net_list: %s", net_list
)
1757 for net_id
in net_list
:
1759 netName
= self
._get
_net
_name
_from
_resource
_id
(net_id
)
1760 resName
= self
._get
_resource
_name
_from
_resource
_id
(net_id
)
1762 net
= self
.conn_vnet
.subnets
.get(self
.resource_group
, netName
, resName
)
1764 out_nets
[net_id
] = {
1765 "status": self
.provision_state2osm
[net
.provisioning_state
],
1766 "vim_info": str(net
),
1768 except CloudError
as e
:
1769 if e
.error
.error
and "notfound" in e
.error
.error
.lower():
1771 "Not found subnet net_name: %s, subnet_name: %s",
1775 out_nets
[net_id
] = {"status": "DELETED", "error_msg": str(e
)}
1778 "CloudError Exception %s when searching subnet", e
1780 out_nets
[net_id
] = {
1781 "status": "VIM_ERROR",
1782 "error_msg": str(e
),
1784 except vimconn
.VimConnNotFoundException
as e
:
1786 "VimConnNotFoundException %s when searching subnet", e
1788 out_nets
[net_id
] = {
1789 "status": "DELETED",
1790 "error_msg": str(e
),
1792 except Exception as e
:
1794 "Exception %s when searching subnet", e
, exc_info
=True
1796 out_nets
[net_id
] = {
1797 "status": "VIM_ERROR",
1798 "error_msg": str(e
),
1803 def refresh_vms_status(self
, vm_list
):
1804 """Get the status of the virtual machines and their interfaces/ports
1805 Params: the list of VM identifiers
1806 Returns a dictionary with:
1807 vm_id: # VIM id of this Virtual Machine
1808 status: # Mandatory. Text with one of:
1809 # DELETED (not found at vim)
1810 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1811 # OTHER (Vim reported other status not understood)
1812 # ERROR (VIM indicates an ERROR status)
1813 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
1814 # BUILD (on building process), ERROR
1815 # ACTIVE:NoMgmtIP (Active but none of its interfaces has an IP address
1816 # (ACTIVE:NoMgmtIP is not returned for Azure)
1818 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
1819 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
1820 interfaces: list with interface info. Each item a dictionary with:
1821 vim_interface_id - The ID of the interface
1822 mac_address - The MAC address of the interface.
1823 ip_address - The IP address of the interface within the subnet.
1826 self
._reload
_connection
()
1828 self
.logger
.debug("refresh vm status vm_list: %s", vm_list
)
1829 search_vm_list
= vm_list
or {}
1831 for vm_id
in search_vm_list
:
1834 res_name
= self
._get
_resource
_name
_from
_resource
_id
(vm_id
)
1836 vm
= self
.conn_compute
.virtual_machines
.get(
1837 self
.resource_group
, res_name
1839 out_vm
["vim_info"] = str(vm
)
1840 out_vm
["status"] = self
.provision_state2osm
.get(
1841 vm
.provisioning_state
, "OTHER"
1844 if vm
.provisioning_state
== "Succeeded":
1845 # check if machine is running or stopped
1846 instance_view
= self
.conn_compute
.virtual_machines
.instance_view(
1847 self
.resource_group
, res_name
1850 for status
in instance_view
.statuses
:
1851 splitted_status
= status
.code
.split("/")
1853 len(splitted_status
) == 2
1854 and splitted_status
[0] == "PowerState"
1856 out_vm
["status"] = self
.power_state2osm
.get(
1857 splitted_status
[1], "OTHER"
1860 network_interfaces
= vm
.network_profile
.network_interfaces
1861 out_vm
["interfaces"] = self
._get
_vm
_interfaces
_status
(
1862 vm_id
, network_interfaces
1865 except CloudError
as e
:
1866 if e
.error
.error
and "notfound" in e
.error
.error
.lower():
1867 self
.logger
.debug("Not found vm id: %s", vm_id
)
1868 out_vm
["status"] = "DELETED"
1869 out_vm
["error_msg"] = str(e
)
1870 out_vm
["vim_info"] = None
1872 # maybe connection error or another type of error, return vim error
1873 self
.logger
.error("Exception %s refreshing vm_status", e
)
1874 out_vm
["status"] = "VIM_ERROR"
1875 out_vm
["error_msg"] = str(e
)
1876 out_vm
["vim_info"] = None
1877 except Exception as e
:
1878 self
.logger
.error("Exception %s refreshing vm_status", e
, exc_info
=True)
1879 out_vm
["status"] = "VIM_ERROR"
1880 out_vm
["error_msg"] = str(e
)
1881 out_vm
["vim_info"] = None
1883 out_vms
[vm_id
] = out_vm
1887 def _get_vm_interfaces_status(self
, vm_id
, interfaces
):
1889 Gets the interfaces detail for a vm
1890 :param interfaces: List of interfaces.
1891 :return: Dictionary with list of interfaces including, vim_interface_id, mac_address and ip_address
1895 for network_interface
in interfaces
:
1897 nic_name
= self
._get
_resource
_name
_from
_resource
_id
(
1898 network_interface
.id
1900 interface_dict
["vim_interface_id"] = network_interface
.id
1902 nic_data
= self
.conn_vnet
.network_interfaces
.get(
1903 self
.resource_group
,
1908 if nic_data
.ip_configurations
[0].public_ip_address
:
1909 self
.logger
.debug("Obtain public ip address")
1910 public_ip_name
= self
._get
_resource
_name
_from
_resource
_id
(
1911 nic_data
.ip_configurations
[0].public_ip_address
.id
1913 public_ip
= self
.conn_vnet
.public_ip_addresses
.get(
1914 self
.resource_group
, public_ip_name
1916 self
.logger
.debug("Public ip address is: %s", public_ip
.ip_address
)
1917 ips
.append(public_ip
.ip_address
)
1919 private_ip
= nic_data
.ip_configurations
[0].private_ip_address
1920 ips
.append(private_ip
)
1922 interface_dict
["mac_address"] = nic_data
.mac_address
1923 interface_dict
["ip_address"] = ";".join(ips
)
1924 interface_list
.append(interface_dict
)
1926 return interface_list
1927 except Exception as e
:
1929 "Exception %s obtaining interface data for vm: %s",
1934 self
._format
_vimconn
_exception
(e
)
1936 def _get_default_admin_user(self
, image_id
):
1937 if "ubuntu" in image_id
.lower():
1940 return self
._default
_admin
_user
1943 if __name__
== "__main__":
1945 log_format
= "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(funcName)s(): %(message)s"
1946 log_formatter
= logging
.Formatter(log_format
, datefmt
="%Y-%m-%dT%H:%M:%S")
1947 handler
= logging
.StreamHandler()
1948 handler
.setFormatter(log_formatter
)
1949 logger
= logging
.getLogger("ro.vim.azure")
1950 # logger.setLevel(level=logging.ERROR)
1951 # logger.setLevel(level=logging.INFO)
1952 logger
.setLevel(level
=logging
.DEBUG
)
1953 logger
.addHandler(handler
)
1955 # Making some basic test
1958 needed_test_params
= {
1959 "client_id": "AZURE_CLIENT_ID",
1960 "secret": "AZURE_SECRET",
1961 "tenant": "AZURE_TENANT",
1962 "resource_group": "AZURE_RESOURCE_GROUP",
1963 "subscription_id": "AZURE_SUBSCRIPTION_ID",
1964 "vnet_name": "AZURE_VNET_NAME",
1968 for param
, env_var
in needed_test_params
.items():
1969 value
= getenv(env_var
)
1972 raise Exception("Provide a valid value for env '{}'".format(env_var
))
1974 test_params
[param
] = value
1977 "region_name": getenv("AZURE_REGION_NAME", "northeurope"),
1978 "resource_group": getenv("AZURE_RESOURCE_GROUP"),
1979 "subscription_id": getenv("AZURE_SUBSCRIPTION_ID"),
1980 "pub_key": getenv("AZURE_PUB_KEY", None),
1981 "vnet_name": getenv("AZURE_VNET_NAME", "osm_vnet"),
1984 azure
= vimconnector(
1987 tenant_id
=test_params
["tenant"],
1991 user
=test_params
["client_id"],
1992 passwd
=test_params
["secret"],
1998 logger.debug("List images")
1999 image = azure.get_image_list({"name": "Canonical:UbuntuServer:18.04-LTS:18.04.201809110"})
2000 logger.debug("image: {}".format(image))
2002 logger.debug("List networks")
2003 network_list = azure.get_network_list({"name": "internal"})
2004 logger.debug("Network_list: {}".format(network_list))
2006 logger.debug("List flavors")
2007 flavors = azure.get_flavor_id_from_data({"vcpu": "2"})
2008 logger.debug("flavors: {}".format(flavors))
2012 # Create network and test machine
2013 #new_network_id, _ = azure.new_network("testnet1", "data")
2014 new_network_id = ("/subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}/providers")
2015 "/Microsoft.Network/virtualNetworks/osm_vnet/subnets/testnet1"
2016 ).format(test_params["resource_group"])
2017 logger.debug("new_network_id: {}".format(new_network_id))
2019 logger.debug("Delete network")
2020 new_network_id = azure.delete_network(new_network_id)
2021 logger.debug("deleted network_id: {}".format(new_network_id))
2025 logger.debug("List networks")
2026 network_list = azure.get_network_list({"name": "internal"})
2027 logger.debug("Network_list: {}".format(network_list))
2029 logger.debug("Show machine isabelvm")
2030 vmachine = azure.get_vminstance( ("/subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}"
2031 "/providers/Microsoft.Compute/virtualMachines/isabelVM"
2032 ).format(test_params["resource_group"])
2034 logger.debug("Vmachine: {}".format(vmachine))
2037 logger
.debug("List images")
2038 image
= azure
.get_image_list({"name": "Canonical:UbuntuServer:16.04"})
2039 # image = azure.get_image_list({"name": "Canonical:UbuntuServer:18.04-LTS"})
2040 logger
.debug("image: {}".format(image
))
2043 # Create network and test machine
2044 new_network_id, _ = azure.new_network("testnet1", "data")
2045 image_id = ("/Subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/Providers/Microsoft.Compute"
2046 "/Locations/northeurope/Publishers/Canonical/ArtifactTypes/VMImage/Offers/UbuntuServer"
2047 "/Skus/18.04-LTS/Versions/18.04.201809110")
2051 network_id = ("subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}
2052 "/providers/Microsoft.Network/virtualNetworks/osm_vnet/subnets/internal"
2053 ).format(test_params["resource_group"])
2057 logger.debug("Create machine")
2058 image_id = ("/Subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/Providers/Microsoft.Compute/Locations"
2059 "/northeurope/Publishers/Canonical/ArtifactTypes/VMImage/Offers/UbuntuServer/Skus/18.04-LTS"
2060 "/Versions/18.04.202103151")
2061 cloud_config = {"user-data": (
2064 "chpasswd: { expire: False }\n"
2065 "ssh_pwauth: True\n\n"
2068 " # My new helloworld file\n\n"
2069 " owner: root:root\n"
2070 " permissions: '0644'\n"
2071 " path: /root/helloworld.txt",
2073 ("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC/p7fuw/W0+6uhx9XNPY4dN/K2cXZweDfjJN8W/sQ1AhKvn"
2074 "j0MF+dbBdsd2tfq6XUhx5LiKoGTunRpRonOw249ivH7pSyNN7FYpdLaij7Krn3K+QRNEOahMI4eoqdglVftA3"
2075 "vlw4Oe/aZOU9BXPdRLxfr9hRKzg5zkK91/LBkEViAijpCwK6ODPZLDDUwY4iihYK9R5eZ3fmM4+3k3Jd0hPRk"
2076 "B5YbtDQOu8ASWRZ9iTAWqr1OwQmvNc6ohSVg1tbq3wSxj/5bbz0J24A7TTpY0giWctne8Qkl/F2e0ZSErvbBB"
2077 "GXKxfnq7sc23OK1hPxMAuS+ufzyXsnL1+fB4t2iF azureuser@osm-test-client\n"
2080 network_id = ("subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}/providers"
2081 "/Microsoft.Network/virtualNetworks/osm_vnet/subnets/internal"
2082 ).format(test_params["resource_group"])
2083 vm = azure.new_vminstance(name="isabelvm",
2084 description="testvm",
2087 flavor_id="Standard_B1ls",
2088 net_list = [{"net_id": network_id, "name": "internal", "use": "mgmt", "floating_ip":True}],
2089 cloud_config = cloud_config)
2090 logger.debug("vm: {}".format(vm))
2094 # Delete nonexistent vm
2096 logger.debug("Delete machine")
2097 vm_id = ("/subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}/providers/Microsoft.Compute/"
2098 "virtualMachines/isabelvm"
2099 ).format(test_params["resource_group"])
2101 ("/subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}/providers/Microsoft.Network"
2102 "/networkInterfaces/isabelvm-nic-0"
2103 ).format(test_params["resource_group"]): True,
2104 ("/subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}/providers/Microsoft.Network"
2105 "/publicIPAddresses/isabelvm-nic-0-public-ip"
2106 ).format(test_params["resource_group"]): True
2108 azure.delete_vminstance(vm_id, created_items)
2109 except vimconn.VimConnNotFoundException as e:
2110 print("Ok: excepcion no encontrada")
2114 network_id = ("/subscriptions/5c1a2458-dfde-4adf-a4e3-08fa0e21d171/resourceGroups/{}/providers/Microsoft.Network"
2115 "/virtualNetworks/osm_vnet/subnets/hfcloudinit-internal-1"
2116 ).format(test_params["resource_group"])
2117 azure.delete_network(network_id)