1 # Copyright 2017 ZTE Corporation.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain 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,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
21 from lcm.pub.utils.values import ignore_case_get, set_opt_val
23 from .exceptions import VimException
24 from lcm.pub.exceptions import NFLCMException
25 from lcm.nf.const import ACTION_TYPE, HEAL_ACTION_TYPE
27 logger = logging.getLogger(__name__)
30 RES_EXIST, RES_NEW = 0, 1
32 BOOT_FROM_VOLUME, BOOT_FROM_IMAGE = 1, 2
35 RES_NETWORK = "network"
43 def get_tenant_id(vim_cache, vim_id, tenant_name):
44 if vim_id not in vim_cache:
45 tenants = api.list_tenant(vim_id)
46 vim_cache[vim_id] = {}
47 for tenant in tenants["tenants"]:
48 id, name = tenant["id"], tenant["name"]
49 vim_cache[vim_id][name] = id
50 if tenant_name not in vim_cache[vim_id]:
51 raise VimException("Tenant(%s) not found in vim(%s)" % (tenant_name, vim_id), ERR_CODE)
52 return vim_cache[vim_id][tenant_name]
55 def set_res_cache(res_cache, res_type, key, val):
56 if res_type not in res_cache:
57 res_cache[res_type] = {}
58 if key in res_cache[res_type]:
59 raise VimException("Duplicate key(%s) of %s" % (key, res_type), ERR_CODE)
60 res_cache[res_type][key] = val
63 def get_res_id(res_cache, res_type, key):
64 if res_type not in res_cache:
65 raise VimException("%s not found in cache" % res_type, ERR_CODE)
66 if key not in res_cache[res_type]:
67 raise VimException("%s(%s) not found in cache" % (res_type, key), ERR_CODE)
68 return res_cache[res_type][key]
71 def action_vm(action_type, server, vimId, tenantId):
73 if action_type == ACTION_TYPE.START:
77 elif action_type == ACTION_TYPE.STOP:
81 elif action_type == ACTION_TYPE.REBOOT:
85 if server["status"] == "ACTIVE":
86 param["reboot"]["type"] = "SOFT"
88 param["reboot"]["type"] = "HARD"
90 logger.debug("%s,%s,%s,%s", vimId, tenantId, res_id, param)
91 api.action_vm(vimId, tenantId, res_id, param)
94 # TODO Have to check if the resources should be started and stopped in some order.
95 def operate_vim_res(data, changeStateTo, stopType, gracefulStopTimeout, do_notify_op):
96 for res in ignore_case_get(data, "vm"):
98 if changeStateTo == "STARTED":
99 action_vm(ACTION_TYPE.START, res, res["vim_id"], res["tenant_id"])
100 do_notify_op("ACTIVE", res["id"])
101 elif changeStateTo == "STOPPED":
102 if stopType == "GRACEFUL":
103 if gracefulStopTimeout > 60:
104 gracefulStopTimeout = 60
105 time.sleep(gracefulStopTimeout)
106 action_vm(ACTION_TYPE.STOP, res, res["vim_id"], res["tenant_id"])
107 do_notify_op("INACTIVE", res["id"])
108 except VimException as e:
109 logger.error("Failed to Operate %s(%s)", RES_VM, res["res_id"])
110 logger.error("%s:%s", e.http_code, e.message)
111 raise NFLCMException("Failed to Operate %s(%s)", RES_VM, res["res_id"])
114 def heal_vim_res(vdus, vnfd_info, do_notify, data, vim_cache, res_cache):
116 vimid = data["vimid"]
117 tenant = data["tenant"]
118 actionType = data["action"]
120 if actionType == HEAL_ACTION_TYPE.START:
121 resid = vdus[0]["vdu_id"]
122 create_vm(vim_cache, res_cache, vnfd_info, vdus[0], do_notify, RES_VM)
123 elif actionType == HEAL_ACTION_TYPE.RESTART:
124 resid = vdus[0].resourceid
125 logger.debug("Start restart vm(%s)", resid)
126 vm_info = api.get_vm(vimid, tenant, vdus[0].resourceid)
127 logger.debug("vminfo=%s", vm_info)
128 action_vm(ACTION_TYPE.REBOOT, vm_info, vimid, tenant)
129 except VimException as e:
130 logger.error("Failed to Heal %s(%s)", RES_VM, resid)
131 logger.error("%s:%s", e.http_code, e.message)
132 raise NFLCMException("Failed to Heal %s(%s)" % (RES_VM, resid))
135 def create_vim_res(data, do_notify, vim_cache={}, res_cache={}):
136 for vol in ignore_case_get(data, "volume_storages"):
137 create_volume(vim_cache, res_cache, vol, do_notify, RES_VOLUME)
138 for network in ignore_case_get(data, "vls"):
139 create_network(vim_cache, res_cache, network, do_notify, RES_NETWORK)
140 for subnet in ignore_case_get(data, "vls"):
141 create_subnet(vim_cache, res_cache, subnet, do_notify, RES_SUBNET)
142 for port in ignore_case_get(data, "cps"):
143 create_port(vim_cache, res_cache, data, port, do_notify, RES_PORT)
144 for vdu in ignore_case_get(data, "vdus"):
145 if vdu["type"] == "tosca.nodes.nfv.Vdu.Compute":
146 create_flavor(vim_cache, res_cache, data, vdu, do_notify, RES_FLAVOR)
147 for vdu in ignore_case_get(data, "vdus"):
148 if vdu["type"] == "tosca.nodes.nfv.Vdu.Compute":
149 create_vm(vim_cache, res_cache, data, vdu, do_notify, RES_VM)
152 def delete_vim_res(data, do_notify):
153 res_types = [RES_VM, RES_FLAVOR, RES_PORT, RES_SUBNET, RES_NETWORK, RES_VOLUME]
154 res_del_funs = [api.delete_vm, api.delete_flavor, api.delete_port,
155 api.delete_subnet, api.delete_network, api.delete_volume]
156 for res_type, res_del_fun in zip(res_types, res_del_funs):
157 for res in ignore_case_get(data, res_type):
159 if NOT_PREDEFINED == res["is_predefined"]:
160 res_del_fun(res["vim_id"], res["tenant_id"], res["res_id"])
161 except VimException as e:
162 logger.error("Failed to delete %s(%s)", res_type, res["res_id"])
163 logger.error("%s:%s", e.http_code, e.message)
164 do_notify(res_type, res["res_id"])
167 def create_volume(vim_cache, res_cache, vol, do_notify, res_type):
168 location_info = vol["properties"]["location_info"]
170 "name": vol["properties"]["volume_name"] if vol["properties"].get("volume_name", None) else vol["volume_storage_id"],
171 "volumeSize": int(ignore_case_get(vol["properties"], "size_of_storage", "0").replace('GB', '').replace('"', '').strip())
173 set_opt_val(param, "imageName", ignore_case_get(vol, "image_file"))
174 set_opt_val(param, "volumeType", ignore_case_get(vol["properties"], "type_of_storage"))
175 set_opt_val(param, "availabilityZone", ignore_case_get(location_info, "availability_zone"))
176 vim_id, tenant_name = location_info["vimid"], location_info["tenant"]
177 tenant_id = get_tenant_id(vim_cache, vim_id, tenant_name)
178 ret = api.create_volume(vim_id, tenant_id, param)
179 ret["nodeId"] = vol["volume_storage_id"]
180 do_notify(res_type, ret)
181 vol_id, vol_name = ret["id"], ret["name"]
182 set_res_cache(res_cache, res_type, vol["volume_storage_id"], vol_id)
183 retry_count, max_retry_count = 0, 300
184 while retry_count < max_retry_count:
185 vol_info = api.get_volume(vim_id, tenant_id, vol_id)
186 if vol_info["status"].upper() == "AVAILABLE":
187 logger.debug("Volume(%s) is available", vol_id)
190 retry_count = retry_count + 1
191 raise VimException("Failed to create Volume(%s): Timeout." % vol_name, ERR_CODE)
194 def create_network(vim_cache, res_cache, network, do_notify, res_type):
195 location_info = network["properties"]["location_info"]
196 vl_profile = network["properties"]["vl_profile"]
198 "name": vl_profile["networkName"],
200 "networkType": ignore_case_get(vl_profile, "networkType"),
201 "physicalNetwork": ignore_case_get(vl_profile, "physicalNetwork")
203 set_opt_val(param, "vlanTransparent", ignore_case_get(vl_profile, "vlanTransparent"))
204 set_opt_val(param, "segmentationId", int(ignore_case_get(vl_profile, "segmentationId", "0")))
205 set_opt_val(param, "routerExternal", ignore_case_get(network, "route_external"))
206 vim_id, tenant_name = location_info["vimid"], location_info["tenant"]
207 tenant_id = get_tenant_id(vim_cache, vim_id, tenant_name)
208 ret = api.create_network(vim_id, tenant_id, param)
209 ret["nodeId"] = network["vl_id"]
210 do_notify(res_type, ret)
211 set_res_cache(res_cache, res_type, network["vl_id"], ret["id"])
214 def create_subnet(vim_cache, res_cache, subnet, do_notify, res_type):
215 location_info = subnet["properties"]["location_info"]
216 network_id = get_res_id(res_cache, RES_NETWORK, subnet["vl_id"])
217 vl_profile = subnet["properties"]["vl_profile"]
218 layer_protocol = ignore_case_get(subnet["properties"]["connectivity_type"], "layer_protocol")
220 "networkId": network_id,
221 "name": vl_profile["networkName"] + "_subnet",
222 "cidr": ignore_case_get(vl_profile, "cidr"),
223 "ipVersion": IP_V4 if(layer_protocol == 'ipv4') else (IP_V6 if(layer_protocol == 'ipv6') else None)
225 set_opt_val(param, "enableDhcp", ignore_case_get(vl_profile, "dhcpEnabled"))
226 set_opt_val(param, "gatewayIp", ignore_case_get(vl_profile, "gatewayIp"))
227 set_opt_val(param, "dnsNameservers", ignore_case_get(subnet["properties"], "dns_nameservers"))
229 set_opt_val(allocation_pool, "start", ignore_case_get(vl_profile, "startIp"))
230 set_opt_val(allocation_pool, "end", ignore_case_get(vl_profile, "endIp"))
232 param["allocationPools"] = [allocation_pool]
233 set_opt_val(param, "hostRoutes", ignore_case_get(subnet["properties"], "host_routes"))
234 vim_id, tenant_name = location_info["vimid"], location_info["tenant"]
235 tenant_id = get_tenant_id(vim_cache, vim_id, tenant_name)
236 ret = api.create_subnet(vim_id, tenant_id, param)
237 do_notify(res_type, ret)
238 set_res_cache(res_cache, res_type, subnet["vl_id"], ret["id"])
241 def create_port(vim_cache, res_cache, data, port, do_notify, res_type):
243 port_ref_vdu_id = ignore_case_get(port, "vdu_id")
244 for vdu in ignore_case_get(data, "vdus"):
245 if vdu["vdu_id"] == port_ref_vdu_id:
246 location_info = vdu["properties"]["location_info"]
247 if port["cp_id"] not in vdu["cps"]:
248 vdu["cps"].append(port["cp_id"])
250 if not location_info:
251 err_msg = "vdu_id(%s) for cp(%s) is not defined."
252 raise VimException(err_msg % (port_ref_vdu_id, port["cp_id"]), ERR_CODE)
253 network_id = ignore_case_get(port, "networkId")
254 subnet_id = ignore_case_get(port, "subnetId")
256 network_id = get_res_id(res_cache, RES_NETWORK, port["vl_id"])
257 subnet_id = get_res_id(res_cache, RES_SUBNET, port["vl_id"])
259 "networkId": network_id,
260 "name": port["cp_id"]
262 set_opt_val(param, "subnetId", subnet_id)
263 set_opt_val(param, "macAddress", ignore_case_get(port["properties"], "mac_address"))
265 for one_protocol_data in port["properties"]["protocol_data"]:
266 l3_address_data = one_protocol_data["address_data"]["l3_address_data"] # l3 is not 13
267 fixed_ip_address = ignore_case_get(l3_address_data, "fixed_ip_address")
268 ip_address.extend(fixed_ip_address)
269 for one_virtual_network_interface in port["properties"].get("virtual_network_interface_requirements", []):
270 interfaceTypeString = one_virtual_network_interface["network_interface_requirements"]["interfaceType"]
271 interfaceType = json.loads(interfaceTypeString)["configurationValue"]
272 vnic_type = ignore_case_get(port["properties"], "vnic_type")
274 if interfaceType == "SR-IOV":
275 set_opt_val(param, "vnicType", "direct")
277 set_opt_val(param, "vnicType", vnic_type)
279 set_opt_val(param, "ip", ",".join(ip_address))
280 set_opt_val(param, "securityGroups", "") # TODO
281 vim_id, tenant_name = location_info["vimid"], location_info["tenant"]
282 tenant_id = get_tenant_id(vim_cache, vim_id, tenant_name)
283 ret = api.create_port(vim_id, tenant_id, param)
284 ret["nodeId"] = port["cp_id"]
285 do_notify(res_type, ret)
286 set_res_cache(res_cache, res_type, port["cp_id"], ret["id"])
289 def create_flavor(vim_cache, res_cache, data, flavor, do_notify, res_type):
290 location_info = flavor["properties"]["location_info"]
291 vim_id, tenant_name = location_info["vimid"], location_info["tenant"]
292 virtual_compute = flavor["virtual_compute"]
293 virtual_storages = flavor["virtual_storages"]
294 virtual_cpu = ignore_case_get(virtual_compute, "virtual_cpu")
295 virtual_memory = ignore_case_get(virtual_compute, "virtual_memory")
297 "name": "Flavor_%s" % flavor["vdu_id"],
298 "vcpu": int(ignore_case_get(virtual_cpu, "num_virtual_cpu")),
299 "memory": int(ignore_case_get(virtual_memory, "virtual_mem_size").replace('MB', '').strip()),
303 # Get flavor id from OOF
304 vdu_id = ignore_case_get(flavor, "vdu_id", "")
306 for one_vdu in location_info["vduInfo"]:
307 if one_vdu["vduName"] == vdu_id:
308 flavor_id = ignore_case_get(one_vdu, "flavorId", "")
311 # Add check if OOF return flavor id has value
312 # If value is not None, we use it.
313 # If value is None, we will create flavor again.
315 set_res_cache(res_cache, res_type, flavor["vdu_id"], flavor_id)
317 for virtual_storage in virtual_storages:
318 vs_id = virtual_storage["virtual_storage_id"]
319 for vs in data["volume_storages"]:
320 if vs["volume_storage_id"] == vs_id:
321 disk_type = ignore_case_get(vs["properties"], "type_of_storage")
322 disk_size = int(ignore_case_get(vs["properties"], "size_of_storage").replace('GB', '').replace('"', '').strip())
323 if disk_type == "root":
324 param["disk"] = disk_size
325 elif disk_type == "ephemeral":
326 param["ephemeral"] = disk_size
327 elif disk_type == "swap":
328 param["swap"] = disk_size
329 tenant_id = get_tenant_id(vim_cache, vim_id, tenant_name)
330 logger.debug("param:%s" % param)
331 ret = api.create_flavor(vim_id, tenant_id, param)
332 logger.debug("hhb ret:%s" % ret)
333 do_notify(res_type, ret)
334 set_res_cache(res_cache, res_type, flavor["vdu_id"], ret["id"])
337 def create_vm(vim_cache, res_cache, data, vm, do_notify, res_type):
338 location_info = vm["properties"]["location_info"]
339 vim_id, tenant_name = location_info["vimid"], location_info["tenant"]
340 tenant_id = get_tenant_id(vim_cache, vim_id, tenant_name)
342 "name": vm["properties"].get("name", "undefined"),
343 "flavorId": get_res_id(res_cache, RES_FLAVOR, vm["vdu_id"]),
350 if "artifacts" in vm and vm["artifacts"]:
351 param["boot"]["type"] = BOOT_FROM_IMAGE
353 for artifact in vm["artifacts"]:
354 if artifact["artifact_name"] == "sw_image":
355 # TODO: after DM define
356 img_name = os.path.basename(artifact["file"])
359 raise VimException("Undefined image(%s)" % vm["artifacts"], ERR_CODE)
360 images = api.list_image(vim_id, tenant_id)
361 for image in images["images"]:
362 if img_name == image["name"]:
363 param["boot"]["imageId"] = image["id"]
365 if "imageId" not in param["boot"]:
366 raise VimException("Undefined artifacts image(%s)" % vm["artifacts"], ERR_CODE)
367 elif vm["virtual_storages"]:
368 param["boot"]["type"] = BOOT_FROM_VOLUME
369 vol_id = vm["virtual_storages"][0]["virtual_storage_id"]
370 param["boot"]["volumeId"] = get_res_id(res_cache, RES_VOLUME, vol_id)
372 raise VimException("No image and volume defined", ERR_CODE)
374 for cp_id in ignore_case_get(vm, "cps"):
375 param["nicArray"].append({
376 "portId": get_res_id(res_cache, RES_PORT, cp_id)
378 param["contextArray"] = ignore_case_get(vm["properties"], "inject_files")
379 logger.debug("contextArray:%s", param["contextArray"])
380 for vol_data in ignore_case_get(vm, "volume_storages"):
381 vol_id = vol_data["volume_storage_id"]
382 param["volumeArray"].append({
383 "volumeId": get_res_id(res_cache, RES_VOLUME, vol_id)
386 user_data = base64.encodestring(ignore_case_get(vm["properties"], "user_data"))
387 set_opt_val(param, "availabilityZone", ignore_case_get(location_info, "availability_zone"))
388 set_opt_val(param, "userdata", user_data)
389 set_opt_val(param, "metadata", ignore_case_get(vm["properties"], "meta_data"))
390 set_opt_val(param, "securityGroups", "") # TODO List of names of security group
391 set_opt_val(param, "serverGroup", "") # TODO the ServerGroup for anti-affinity and affinity
393 ret = api.create_vm(vim_id, tenant_id, param)
394 do_notify(res_type, ret)
396 if ignore_case_get(ret, "name"):
397 vm_name = vm["properties"].get("name", "undefined")
398 logger.debug("vm_name:%s" % vm_name)
399 opt_vm_status = "Timeout"
400 retry_count, max_retry_count = 0, 100
401 while retry_count < max_retry_count:
402 vm_info = api.get_vm(vim_id, tenant_id, vm_id)
403 if vm_info["status"].upper() == "ACTIVE":
404 logger.debug("Vm(%s) is active", vm_id)
406 if vm_info["status"].upper() == "ERROR":
407 opt_vm_status = vm_info["status"]
410 retry_count = retry_count + 1
411 raise VimException("Failed to create Vm(%s): %s." % (vm_name, opt_vm_status), ERR_CODE)