2 * Copyright 2016-2017, Nokia Corporation
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm;
20 import com.google.gson.Gson;
21 import com.google.gson.JsonElement;
22 import com.google.gson.JsonObject;
23 import com.nokia.cbam.catalog.v1.model.CatalogAdapterVnfpackage;
24 import com.nokia.cbam.lcm.v32.model.*;
25 import com.nokia.cbam.lcm.v32.model.ScaleDirection;
26 import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.api.IGrantManager;
27 import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.api.VimInfoProvider;
28 import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.StoreLoader;
29 import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.UserVisibleError;
30 import org.onap.vnfmdriver.model.ExtVirtualLinkInfo;
31 import org.onap.vnfmdriver.model.*;
32 import org.onap.vnfmdriver.model.VimInfo;
33 import org.onap.vnfmdriver.model.VnfInfo;
34 import org.slf4j.Logger;
35 import org.springframework.beans.factory.annotation.Autowired;
36 import org.springframework.stereotype.Component;
37 import org.yaml.snakeyaml.Yaml;
39 import javax.servlet.http.HttpServletResponse;
41 import java.util.concurrent.ExecutorService;
42 import java.util.concurrent.Executors;
44 import static com.google.common.base.Splitter.on;
45 import static com.google.common.collect.Iterables.find;
46 import static com.google.common.collect.Lists.newArrayList;
47 import static com.google.common.collect.Sets.newHashSet;
48 import static com.nokia.cbam.lcm.v32.model.InstantiationState.INSTANTIATED;
49 import static com.nokia.cbam.lcm.v32.model.OperationStatus.FINISHED;
50 import static com.nokia.cbam.lcm.v32.model.OperationType.INSTANTIATE;
51 import static com.nokia.cbam.lcm.v32.model.VimInfo.VimInfoTypeEnum.*;
52 import static java.lang.Integer.parseInt;
53 import static java.nio.charset.StandardCharsets.UTF_8;
54 import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.CbamUtils.*;
55 import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.SystemFunctions.systemFunctions;
56 import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.CbamRestApiProvider.NOKIA_LCM_API_VERSION;
57 import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.notification.LifecycleChangeNotificationManager.NEWEST_OPERATIONS_FIRST;
58 import static org.slf4j.LoggerFactory.getLogger;
59 import static org.springframework.util.StringUtils.isEmpty;
62 * Responsible for executing lifecycle operation on the VNF
65 public class LifecycleManager {
66 public static final String ONAP_CSAR_ID = "onapCsarId";
67 public static final long OPERATION_STATUS_POLLING_INTERVAL_IN_MS = 5000L;
69 * The key of the CBAM VNF extension for the identifier of the VNFM in ONAP
71 public static final String EXTERNAL_VNFM_ID = "externalVnfmId";
72 public static final String SCALE_OPERATION_NAME = "scale";
73 private static Logger logger = getLogger(LifecycleManager.class);
74 private final CatalogManager catalogManager;
75 private final IGrantManager grantManager;
76 private final JobManager jobManager;
77 private final ILifecycleChangeNotificationManager notificationManager;
78 private final CbamRestApiProvider cbamRestApiProvider;
79 private final VimInfoProvider vimInfoProvider;
82 * Runs asynchronous operations in the background
84 private ExecutorService executorService = Executors.newCachedThreadPool();
87 LifecycleManager(CatalogManager catalogManager, IGrantManager grantManager, CbamRestApiProvider restApiProvider, VimInfoProvider vimInfoProvider, JobManager jobManager, ILifecycleChangeNotificationManager notificationManager) {
88 this.vimInfoProvider = vimInfoProvider;
89 this.grantManager = grantManager;
90 this.cbamRestApiProvider = restApiProvider;
91 this.jobManager = jobManager;
92 this.notificationManager = notificationManager;
93 this.catalogManager = catalogManager;
97 * @param vimId the VIM identifier
98 * @return the name of the region
100 public static String getRegionName(String vimId) {
101 return newArrayList(on(SEPARATOR).split(vimId)).get(1);
105 * @param vimId the VIM identifier
106 * @return the owner of the cloud
108 public static String getCloudOwner(String vimId) {
109 return newArrayList(on(SEPARATOR).split(vimId)).get(0);
112 private static OperationExecution findLastInstantiation(List<OperationExecution> operationExecutions) {
113 return find(NEWEST_OPERATIONS_FIRST.sortedCopy(operationExecutions), op -> INSTANTIATE.equals(op.getOperationType()));
117 * Create the VNF. It consists of the following steps
119 * <li>upload the VNF package to CBAM package (if not already there)</li>
120 * <li>create the VNF on CBAM</li>
121 * <li>modify attributes of the VNF (add onapCsarId field)</li>
123 * The rollback of the failed operation is not implemented
125 * <li>delete the VNF if error occurs before instantiation</li>
126 * <li>terminate & delete VNF if error occurs after instantiation</li>
129 * @param vnfmId the identifier of the VNFM
130 * @param csarId the identifier of the VNF package
131 * @param vnfName the name of the VNF
132 * @param description the description of the VNF
133 * @return the VNF creation result
135 public VnfCreationResult create(String vnfmId, String csarId, String vnfName, String description) {
136 logOperationInput("not yet specified", "creation", csarId);
138 CatalogAdapterVnfpackage cbamPackage = catalogManager.preparePackageInCbam(vnfmId, csarId);
139 CreateVnfRequest vnfCreateRequest = new CreateVnfRequest();
140 vnfCreateRequest.setVnfdId(cbamPackage.getVnfdId());
141 vnfCreateRequest.setName(vnfName);
142 vnfCreateRequest.setDescription(description);
143 com.nokia.cbam.lcm.v32.model.VnfInfo vnfInfo = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsPost(vnfCreateRequest, NOKIA_LCM_API_VERSION).blockingFirst();
144 addVnfdIdToVnfModifyableAttributeExtensions(vnfmId, vnfInfo.getId(), csarId);
145 return new VnfCreationResult(vnfInfo, cbamPackage.getVnfdId());
146 } catch (Exception e) {
147 throw buildFatalFailure(logger, "Unable to create the VNF", e);
151 private void logOperationInput(String vnfId, String operationName, Object payload) {
152 if (logger.isInfoEnabled()) {
153 logger.info("Starting {} operation on VNF with {} identifier with {} parameter", operationName, vnfId, new Gson().toJson(payload));
158 * Instantiate the VNF
160 * @param vnfmId the identifier of the VNFM
161 * @param request the VNF instantiation request
162 * @param httpResponse the HTTP response that corresponds to the VNF instantiation request
163 * @param additionalParameters additional parameters
164 * @param vnfId thr identifier of the VNF
165 * @param vnfdId the identifier of the VNF package in CBAM
166 * @return the instantiation response
168 public VnfInstantiateResponse instantiate(String vnfmId, VnfInstantiateRequest request, HttpServletResponse httpResponse, AdditionalParameters additionalParameters, String vnfId, String vnfdId) {
169 logOperationInput(vnfId, "instantiation", request);
170 validateVimType(additionalParameters.getVimType());
171 VnfInstantiateResponse response = new VnfInstantiateResponse();
172 response.setVnfInstanceId(vnfId);
173 String vimId = getVimId(request.getAdditionalParam());
174 JobInfo spawnJob = scheduleExecution(vnfId, httpResponse, "instantiate", jobInfo ->
175 instantiateVnf(vnfmId, request, additionalParameters, vnfdId, vnfId, vimId, jobInfo)
177 response.setJobId(spawnJob.getJobId());
182 * Instantiate (VF-C terminology) the VNF. It consists of the following steps
184 * <li>upload the VNF package to CBAM package (if not already there)</li>
185 * <li>create the VNF on CBAM</li>
186 * <li>modify attributes of the VNF (add onapCsarId field)</li>
187 * <li>asynchronously</li>
188 * <li>request grant from VF-C</li>
189 * <li>instantiate VNF on CBAM</li>
190 * <li>return VNF & job id (after create VNF on CBAM)</li>
193 * The rollback of the failed operation is not implemented
195 * <li>delete the VNF if error occurs before instantiation</li>
196 * <li>terminate & delete VNf if error occurs after instantiation</li>
199 * @param vnfmId the identifier of the VNFM
200 * @param request the instantiation request
201 * @param httpResponse the HTTP response
202 * @return the instantiation response
204 public VnfInstantiateResponse createAndInstantiate(String vnfmId, VnfInstantiateRequest request, HttpServletResponse httpResponse) {
205 AdditionalParameters additionalParameters = convertInstantiationAdditionalParams(request.getVnfPackageId(), request.getAdditionalParam());
206 validateVimType(additionalParameters.getVimType());
207 VnfCreationResult creationResult = create(vnfmId, request.getVnfDescriptorId(), request.getVnfInstanceName(), request.getVnfInstanceDescription());
208 return instantiate(vnfmId, request, httpResponse, additionalParameters, creationResult.vnfInfo.getId(), creationResult.vnfdId);
211 private void instantiateVnf(String vnfmId, VnfInstantiateRequest request, AdditionalParameters additionalParameters, String vnfdId, String vnfId, String vimId, JobInfo jobInfo) {
212 String vnfdContent = catalogManager.getCbamVnfdContent(vnfmId, vnfdId);
213 GrantVNFResponseVim vim = grantManager.requestGrantForInstantiate(vnfmId, vnfId, vimId, request.getVnfPackageId(), additionalParameters.getInstantiationLevel(), vnfdContent, jobInfo.getJobId());
214 if (vim.getVimId() == null) {
215 throw buildFatalFailure(logger, "VF-C did not send VIM identifier in grant response");
217 VimInfo vimInfo = vimInfoProvider.getVimInfo(vim.getVimId());
218 InstantiateVnfRequest instantiationRequest = new InstantiateVnfRequest();
219 addExternalLinksToRequest(request.getExtVirtualLink(), additionalParameters, instantiationRequest, vimId);
220 instantiationRequest.getVims().add(addVim(additionalParameters, vimId, vim, vimInfo));
221 instantiationRequest.setFlavourId(getFlavorId(vnfdContent));
222 instantiationRequest.setComputeResourceFlavours(additionalParameters.getComputeResourceFlavours());
223 instantiationRequest.setGrantlessMode(true);
224 instantiationRequest.setInstantiationLevelId(additionalParameters.getInstantiationLevel());
225 instantiationRequest.setSoftwareImages(additionalParameters.getSoftwareImages());
226 instantiationRequest.setZones(additionalParameters.getZones());
227 instantiationRequest.setExtManagedVirtualLinks(additionalParameters.getExtManagedVirtualLinks());
228 for (ExtVirtualLinkData extVirtualLinkData : additionalParameters.getExtVirtualLinks()) {
229 instantiationRequest.addExtVirtualLinksItem(extVirtualLinkData);
231 JsonObject root = new Gson().toJsonTree(jobInfo).getAsJsonObject();
232 if (additionalParameters.getAdditionalParams() != null) {
233 for (Map.Entry<String, JsonElement> item : new Gson().toJsonTree(additionalParameters.getAdditionalParams()).getAsJsonObject().entrySet()) {
234 root.add(item.getKey(), item.getValue());
237 logger.warn("No additional parameters were specified for the operation");
239 instantiationRequest.setAdditionalParams(root);
240 OperationExecution operationExecution = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdInstantiatePost(vnfId, instantiationRequest, NOKIA_LCM_API_VERSION).blockingFirst();
241 waitForOperationToFinish(vnfmId, vnfId, operationExecution.getId());
244 private com.nokia.cbam.lcm.v32.model.VimInfo addVim(AdditionalParameters additionalParameters, String vimId, GrantVNFResponseVim vim, VimInfo vimInfo) {
245 if (additionalParameters.getVimType() == OPENSTACK_V2_INFO) {
246 return buildOpenStackV2INFO(vimId, vim, vimInfo);
248 } else if (additionalParameters.getVimType() == OPENSTACK_V3_INFO) {
249 return buildOpenStackV3INFO(vimId, additionalParameters, vim, vimInfo);
252 //OTHER VIM TYPE is not possible
253 return buildVcloudInfo(vimId, vimInfo);
257 private void validateVimType(com.nokia.cbam.lcm.v32.model.VimInfo.VimInfoTypeEnum vimType) {
258 if (com.nokia.cbam.lcm.v32.model.VimInfo.VimInfoTypeEnum.OTHER_VIM_INFO.equals(vimType)) {
259 throw buildFatalFailure(logger, "Only " + OPENSTACK_V2_INFO + ", " + OPENSTACK_V3_INFO + " and " + VMWARE_VCLOUD_INFO + " is the supported VIM types");
263 private String getVimId(Object additionalParams) {
264 return childElement(new Gson().toJsonTree(additionalParams).getAsJsonObject(), "vimId").getAsString();
267 private AdditionalParameters convertInstantiationAdditionalParams(String csarId, Object additionalParams) {
268 JsonObject vnfParameters = child(child(new Gson().toJsonTree(additionalParams).getAsJsonObject(), "inputs"), "vnfs");
269 if (!vnfParameters.has(csarId)) {
270 throw buildFatalFailure(logger, "The additional parameter section does not contain setting for VNF with " + csarId + " CSAR id");
272 JsonElement additionalParamsForVnf = vnfParameters.get(csarId);
273 return new Gson().fromJson(additionalParamsForVnf, AdditionalParameters.class);
276 private String getFlavorId(String vnfdContent) {
277 JsonObject root = new Gson().toJsonTree(new Yaml().load(vnfdContent)).getAsJsonObject();
278 JsonObject capabilities = child(child(child(root, "topology_template"), "substitution_mappings"), "capabilities");
279 JsonObject deploymentFlavorProperties = child(child(capabilities, "deployment_flavour"), "properties");
280 return childElement(deploymentFlavorProperties, "flavour_id").getAsString();
283 private Set<Map.Entry<String, JsonElement>> getAcceptableOperationParameters(String vnfdContent, String categroryOfOperation, String operationName) {
284 JsonObject root = new Gson().toJsonTree(new Yaml().load(vnfdContent)).getAsJsonObject();
285 JsonObject interfaces = child(child(child(root, "topology_template"), "substitution_mappings"), "interfaces");
286 JsonObject additionalParameters = child(child(child(child(interfaces, categroryOfOperation), operationName), "inputs"), "additional_parameters");
287 return additionalParameters.entrySet();
290 private void addExternalLinksToRequest(List<ExtVirtualLinkInfo> extVirtualLinks, AdditionalParameters additionalParameters, InstantiateVnfRequest instantiationRequest, String vimId) {
291 for (ExtVirtualLinkInfo extVirtualLink : extVirtualLinks) {
292 ExtVirtualLinkData cbamExternalVirtualLink = new ExtVirtualLinkData();
293 cbamExternalVirtualLink.setVimId(vimId);
294 cbamExternalVirtualLink.setResourceId(extVirtualLink.getResourceId());
295 VnfExtCpData ecp = new VnfExtCpData();
296 cbamExternalVirtualLink.setExtVirtualLinkId(extVirtualLink.getVlInstanceId());
297 cbamExternalVirtualLink.getExtCps().add(ecp);
298 ecp.setCpdId(extVirtualLink.getCpdId());
299 List<NetworkAddress> addresses = additionalParameters.getExternalConnectionPointAddresses().get(extVirtualLink.getCpdId());
300 ecp.setAddresses(addresses);
301 instantiationRequest.addExtVirtualLinksItem(cbamExternalVirtualLink);
305 private void addVnfdIdToVnfModifyableAttributeExtensions(String vnfmId, String vnfId, String onapCsarId) {
306 ModifyVnfInfoRequest request = new ModifyVnfInfoRequest();
307 VnfProperty onapCsarIdProperty = new VnfProperty();
308 onapCsarIdProperty.setName(ONAP_CSAR_ID);
309 onapCsarIdProperty.setValue(onapCsarId);
310 request.setExtensions(new ArrayList<>());
311 request.getExtensions().add(onapCsarIdProperty);
312 VnfProperty externalVnfmIdProperty = new VnfProperty();
313 externalVnfmIdProperty.setName(EXTERNAL_VNFM_ID);
314 externalVnfmIdProperty.setValue(vnfmId);
315 request.getExtensions().add(externalVnfmIdProperty);
316 request.setVnfConfigurableProperties(null);
318 OperationExecution operationExecution = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdPatch(vnfId, request, NOKIA_LCM_API_VERSION).blockingFirst();
319 waitForOperationToFinish(vnfmId, vnfId, operationExecution.getId());
320 } catch (Exception e) {
321 throw buildFatalFailure(logger, "Unable to set the " + ONAP_CSAR_ID + " property on the VNF", e);
325 private OPENSTACKV3INFO buildOpenStackV3INFO(String vimId, AdditionalParameters additionalParameters, GrantVNFResponseVim vim, org.onap.vnfmdriver.model.VimInfo vimInfo) {
326 OPENSTACKV3INFO openstackv3INFO = new OPENSTACKV3INFO();
327 openstackv3INFO.setVimInfoType(OPENSTACK_V3_INFO);
328 OpenStackAccessInfoV3 accessInfov3 = new OpenStackAccessInfoV3();
329 openstackv3INFO.accessInfo(accessInfov3);
330 accessInfov3.setPassword(vimInfo.getPassword());
331 accessInfov3.setDomain(additionalParameters.getDomain());
332 accessInfov3.setProject(vim.getAccessInfo().getTenant());
333 accessInfov3.setRegion(getRegionName(vimId));
334 accessInfov3.setUsername(vimInfo.getUserName());
335 EndpointInfo interfaceInfoV3 = new EndpointInfo();
336 interfaceInfoV3.setEndpoint(vimInfo.getUrl());
337 if (!isEmpty(vimInfo.getSslInsecure())) {
338 interfaceInfoV3.setSkipCertificateVerification(Boolean.parseBoolean(vimInfo.getSslInsecure()));
339 interfaceInfoV3.setSkipCertificateHostnameCheck(Boolean.parseBoolean(vimInfo.getSslInsecure()));
341 interfaceInfoV3.setSkipCertificateHostnameCheck(true);
342 interfaceInfoV3.setSkipCertificateVerification(true);
344 if (!interfaceInfoV3.isSkipCertificateVerification()) {
345 interfaceInfoV3.setTrustedCertificates(new ArrayList<>());
346 for (String trustedCertificate : StoreLoader.getCertifacates(vimInfo.getSslCacert())) {
347 interfaceInfoV3.getTrustedCertificates().add(trustedCertificate.getBytes(UTF_8));
350 openstackv3INFO.setInterfaceInfo(interfaceInfoV3);
351 openstackv3INFO.setId(vimId);
352 return openstackv3INFO;
355 private OPENSTACKV2INFO buildOpenStackV2INFO(String vimId, GrantVNFResponseVim vim, org.onap.vnfmdriver.model.VimInfo vimInfo) {
356 OPENSTACKV2INFO openstackv2INFO = new OPENSTACKV2INFO();
357 openstackv2INFO.setVimInfoType(OPENSTACK_V2_INFO);
358 OpenStackAccessInfoV2 accessInfo = new OpenStackAccessInfoV2();
359 openstackv2INFO.setAccessInfo(accessInfo);
360 accessInfo.setPassword(vimInfo.getPassword());
361 accessInfo.setTenant(vim.getAccessInfo().getTenant());
362 accessInfo.setUsername(vimInfo.getUserName());
363 accessInfo.setRegion(getRegionName(vimId));
364 EndpointInfo interfaceEndpoint = new EndpointInfo();
365 if (!isEmpty(vimInfo.getSslInsecure())) {
366 interfaceEndpoint.setSkipCertificateHostnameCheck(Boolean.parseBoolean(vimInfo.getSslInsecure()));
367 interfaceEndpoint.setSkipCertificateVerification(Boolean.parseBoolean(vimInfo.getSslInsecure()));
369 interfaceEndpoint.setSkipCertificateHostnameCheck(true);
370 interfaceEndpoint.setSkipCertificateVerification(true);
372 interfaceEndpoint.setEndpoint(vimInfo.getUrl());
373 if (!interfaceEndpoint.isSkipCertificateVerification()) {
374 interfaceEndpoint.setTrustedCertificates(new ArrayList<>());
375 for (String trustedCertificate : StoreLoader.getCertifacates(vimInfo.getSslCacert())) {
376 interfaceEndpoint.getTrustedCertificates().add(trustedCertificate.getBytes(UTF_8));
379 openstackv2INFO.setInterfaceInfo(interfaceEndpoint);
380 openstackv2INFO.setId(vimId);
381 return openstackv2INFO;
384 private VMWAREVCLOUDINFO buildVcloudInfo(String vimId, org.onap.vnfmdriver.model.VimInfo vimInfo) {
385 VMWAREVCLOUDINFO vcloudInfo = new VMWAREVCLOUDINFO();
386 vcloudInfo.setVimInfoType(VMWARE_VCLOUD_INFO);
387 VCloudAccessInfo accessInfo = new VCloudAccessInfo();
388 vcloudInfo.setAccessInfo(accessInfo);
389 accessInfo.setPassword(vimInfo.getPassword());
390 accessInfo.setUsername(vimInfo.getUserName());
391 accessInfo.setOrganization(getRegionName(vimId));
392 EndpointInfo interfaceEndpoint = new EndpointInfo();
393 if (!isEmpty(vimInfo.getSslInsecure())) {
394 interfaceEndpoint.setSkipCertificateHostnameCheck(Boolean.parseBoolean(vimInfo.getSslInsecure()));
395 interfaceEndpoint.setSkipCertificateVerification(Boolean.parseBoolean(vimInfo.getSslInsecure()));
397 interfaceEndpoint.setSkipCertificateHostnameCheck(true);
398 interfaceEndpoint.setSkipCertificateVerification(true);
400 interfaceEndpoint.setEndpoint(vimInfo.getUrl());
401 if (!interfaceEndpoint.isSkipCertificateVerification()) {
402 interfaceEndpoint.setTrustedCertificates(new ArrayList<>());
403 for (String trustedCertificate : StoreLoader.getCertifacates(vimInfo.getSslCacert())) {
404 interfaceEndpoint.getTrustedCertificates().add(trustedCertificate.getBytes(UTF_8));
407 vcloudInfo.setInterfaceInfo(interfaceEndpoint);
408 vcloudInfo.setId(vimId);
413 * Terminates and deletes the VNF
415 * <li>fails if the VNF does not exist</li>
416 * <li>terminates if instantiated</li>
417 * <li>deletes the VNF</li>
420 * @param vnfmId the identifier of the VNFM
421 * @param vnfId the identifier of the VNF
422 * @param request the termination request
423 * @param httpResponse the HTTP response
424 * @return the job for polling the progress of the termination
426 public JobInfo terminateVnf(String vnfmId, String vnfId, VnfTerminateRequest request, HttpServletResponse httpResponse) {
427 logOperationInput(vnfId, "termination", request);
428 return scheduleExecution(vnfId, httpResponse, "terminate", jobInfo -> {
429 TerminateVnfRequest cbamRequest = new TerminateVnfRequest();
430 if (request.getTerminationType() == null) {
431 cbamRequest.setTerminationType(TerminationType.FORCEFUL);
433 if (request.getTerminationType().equals(VnfTerminationType.GRACEFUL)) {
434 cbamRequest.setTerminationType(TerminationType.GRACEFUL);
435 cbamRequest.setGracefulTerminationTimeout(parseInt(request.getGracefulTerminationTimeout()));
437 cbamRequest.setTerminationType(TerminationType.FORCEFUL);
440 com.nokia.cbam.lcm.v32.model.VnfInfo vnf = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdGet(vnfId, NOKIA_LCM_API_VERSION).blockingFirst();
441 if (vnf.getInstantiationState() == INSTANTIATED) {
442 terminateVnf(vnfmId, vnfId, jobInfo, cbamRequest, vnf);
444 cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdDelete(vnfId, NOKIA_LCM_API_VERSION);
449 private void terminateVnf(String vnfmId, String vnfId, JobInfo jobInfo, TerminateVnfRequest cbamRequest, com.nokia.cbam.lcm.v32.model.VnfInfo vnf) {
450 String vimId = getVimIdFromInstantiationRequest(vnfmId, vnf);
451 grantManager.requestGrantForTerminate(vnfmId, vnfId, vimId, getVnfdIdFromModifyableAttributes(vnf), vnf, jobInfo.getJobId());
452 OperationExecution terminationOperation = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdTerminatePost(vnfId, cbamRequest, NOKIA_LCM_API_VERSION).blockingFirst();
453 OperationExecution finishedOperation = waitForOperationToFinish(vnfmId, vnfId, terminationOperation.getId());
454 if (finishedOperation.getStatus() == FINISHED) {
455 notificationManager.waitForTerminationToBeProcessed(finishedOperation.getId());
456 logger.info("Deleting VNF with {}", vnfId);
457 cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdDelete(vnfId, NOKIA_LCM_API_VERSION);
458 logger.info("VNF with {} has been deleted", vnfId);
461 logger.error("Unable to terminate VNF the operation did not finish with success");
465 private String getVimIdFromInstantiationRequest(String vnfmId, com.nokia.cbam.lcm.v32.model.VnfInfo vnf) {
466 OperationExecution lastInstantiation = findLastInstantiation(vnf.getOperationExecutions());
467 Object operationParameters = cbamRestApiProvider.getCbamOperationExecutionApi(vnfmId).operationExecutionsOperationExecutionIdOperationParamsGet(lastInstantiation.getId(), NOKIA_LCM_API_VERSION).blockingFirst();
468 JsonObject root = new Gson().toJsonTree(operationParameters).getAsJsonObject();
469 return childElement(childElement(root, "vims").getAsJsonArray().get(0).getAsJsonObject(), "id").getAsString();
472 private String getVnfdIdFromModifyableAttributes(com.nokia.cbam.lcm.v32.model.VnfInfo vnf) {
473 return find(vnf.getExtensions(), p -> p.getName().equals(ONAP_CSAR_ID)).getValue().toString();
477 * @param vnfmId the identifier of the VNFM
478 * @param vnfId the identifier of the VNF
479 * @return the current state of the VNF
481 public VnfInfo queryVnf(String vnfmId, String vnfId) {
483 com.nokia.cbam.lcm.v32.model.VnfInfo cbamVnfInfo = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdGet(vnfId, NOKIA_LCM_API_VERSION).blockingFirst();
484 VnfInfo vnfInfo = new VnfInfo();
485 vnfInfo.setVersion(cbamVnfInfo.getVnfSoftwareVersion());
486 vnfInfo.setVnfInstanceId(vnfId);
487 String onapCsarId = getVnfdIdFromModifyableAttributes(cbamVnfInfo);
488 vnfInfo.setVnfdId(onapCsarId);
489 vnfInfo.setVnfPackageId(onapCsarId);
490 vnfInfo.setVnfInstanceDescription(cbamVnfInfo.getDescription());
491 vnfInfo.setVnfInstanceName(cbamVnfInfo.getName());
492 vnfInfo.setVnfProvider(cbamVnfInfo.getVnfProvider());
493 vnfInfo.setVnfStatus("ACTIVE");
494 vnfInfo.setVnfType("Kuku");
496 } catch (Exception e) {
497 throw buildFatalFailure(logger, "Unable to query VNF (" + vnfId + ")", e);
501 private ScaleDirection convert(org.onap.vnfmdriver.model.ScaleDirection direction) {
502 if (org.onap.vnfmdriver.model.ScaleDirection.IN.equals(direction)) {
503 return ScaleDirection.IN;
505 return ScaleDirection.OUT;
512 * @param vnfmId the identifier of the VNFM
513 * @param vnfId the identifier of the VNF
514 * @param request the scale request
515 * @param httpResponse the HTTP response
516 * @return the job for tracking the scale
518 public JobInfo scaleVnf(String vnfmId, String vnfId, VnfScaleRequest request, HttpServletResponse httpResponse) {
519 logOperationInput(vnfId, SCALE_OPERATION_NAME, request);
520 return scheduleExecution(vnfId, httpResponse, SCALE_OPERATION_NAME, jobInfo -> {
521 ScaleVnfRequest cbamRequest = new ScaleVnfRequest();
522 cbamRequest.setAspectId(request.getAspectId());
523 cbamRequest.setNumberOfSteps(Integer.valueOf(request.getNumberOfSteps()));
524 cbamRequest.setType(convert(request.getType()));
525 com.nokia.cbam.lcm.v32.model.VnfInfo vnf = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdGet(vnfId, NOKIA_LCM_API_VERSION).blockingFirst();
526 JsonObject root = new Gson().toJsonTree(jobInfo).getAsJsonObject();
527 com.nokia.cbam.lcm.v32.model.VnfInfo cbamVnfInfo = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdGet(vnfId, NOKIA_LCM_API_VERSION).blockingFirst();
528 String vnfdContent = catalogManager.getCbamVnfdContent(vnfmId, cbamVnfInfo.getVnfdId());
529 Set<Map.Entry<String, JsonElement>> acceptableOperationParameters = getAcceptableOperationParameters(vnfdContent, "Basic", SCALE_OPERATION_NAME);
530 buildAdditionalParameters(request, root, acceptableOperationParameters);
531 cbamRequest.setAdditionalParams(root);
532 grantManager.requestGrantForScale(vnfmId, vnfId, getVimIdFromInstantiationRequest(vnfmId, vnf), getVnfdIdFromModifyableAttributes(vnf), request, jobInfo.getJobId());
533 OperationExecution operationExecution = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdScalePost(vnfId, cbamRequest, NOKIA_LCM_API_VERSION).blockingFirst();
534 waitForOperationToFinish(vnfmId, vnfId, operationExecution.getId());
538 private void buildAdditionalParameters(VnfScaleRequest request, JsonObject root, Set<Map.Entry<String, JsonElement>> acceptableOperationParameters) {
539 if (request.getAdditionalParam() != null) {
540 for (Map.Entry<String, JsonElement> item : new Gson().toJsonTree(request.getAdditionalParam()).getAsJsonObject().entrySet()) {
541 if (isParameterAccepted(acceptableOperationParameters, item)) {
542 root.add(item.getKey(), item.getValue());
546 logger.warn("No additional parameters were passed for scaling");
550 private boolean isParameterAccepted(Set<Map.Entry<String, JsonElement>> acceptableOperationParameters, Map.Entry<String, JsonElement> item) {
551 boolean found = false;
552 for (Map.Entry<String, JsonElement> acceptableOperationParameter : acceptableOperationParameters) {
553 if (acceptableOperationParameter.getKey().equals(item.getKey())) {
563 * @param vnfmId the identifier of the VNFM
564 * @param vnfId the identifier of the VNF
565 * @param request the heal request
566 * @param httpResponse the HTTP response
567 * @param vnfcId the identifer of thr VNFC to be healed
568 * @return the job for tracking the heal
570 public JobInfo healVnf(String vnfmId, String vnfId, VnfHealRequest request, Optional<String> vnfcId, HttpServletResponse httpResponse) {
571 logOperationInput(vnfId, "heal", request);
572 return scheduleExecution(vnfId, httpResponse, "heal", job -> {
573 HealVnfRequest cbamHealRequest = new HealVnfRequest();
574 Map<String, String> additionalParams = new HashMap<>();
575 additionalParams.put("vmName", request.getAffectedvm().getVmname());
576 additionalParams.put("action", request.getAction());
577 additionalParams.put("jobId", job.getJobId());
578 additionalParams.put("vnfcId", vnfcId.orElse("unknown"));
579 cbamHealRequest.setAdditionalParams(additionalParams);
580 com.nokia.cbam.lcm.v32.model.VnfInfo vnf = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdGet(vnfId, NOKIA_LCM_API_VERSION).blockingFirst();
581 String vimId = getVimIdFromInstantiationRequest(vnfmId, vnf);
582 grantManager.requestGrantForHeal(vnfmId, vnfId, vimId, getVnfdIdFromModifyableAttributes(vnf), request, job.getJobId());
583 OperationExecution operationExecution = cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdHealPost(vnfId, cbamHealRequest, NOKIA_LCM_API_VERSION).blockingFirst();
584 waitForOperationToFinish(vnfmId, vnfId, operationExecution.getId());
588 private JobInfo scheduleExecution(String vnfId, HttpServletResponse httpResponse, String operation, AsynchronousExecution asynchronExecution) {
589 JobInfo jobInfo = new JobInfo();
590 jobInfo.setJobId(jobManager.spawnJob(vnfId, httpResponse));
591 executorService.submit(() -> {
593 asynchronExecution.execute(jobInfo);
594 } catch (RuntimeException e) {
595 logger.error("Unable to " + operation + " VNF with " + vnfId + " identifier", e);
596 jobManager.jobFinished(jobInfo.getJobId());
598 } catch (Exception e) {
599 String msg = "Unable to " + operation + " VNF with " + vnfId + " identifier";
600 logger.error(msg, e);
601 //the job can only be signaled to be finished after the error is logged
602 jobManager.jobFinished(jobInfo.getJobId());
603 throw new UserVisibleError(msg, e);
605 jobManager.jobFinished(jobInfo.getJobId());
610 private OperationExecution waitForOperationToFinish(String vnfmId, String vnfId, String operationExecutionId) {
613 OperationExecution operationExecution = find(cbamRestApiProvider.getCbamLcmApi(vnfmId).vnfsVnfInstanceIdOperationExecutionsGet(vnfId, NOKIA_LCM_API_VERSION).blockingFirst(), opEx -> operationExecutionId.equals(opEx.getId()));
614 if (hasOperationFinished(operationExecution)) {
615 logger.debug("Operation finished with " + operationExecution.getId());
616 return operationExecution;
618 } catch (Exception e) {
619 //swallow exception and retry
620 logger.warn("Unable to retrieve operations details", e);
622 systemFunctions().sleep(OPERATION_STATUS_POLLING_INTERVAL_IN_MS);
626 private boolean hasOperationFinished(OperationExecution operationExecution) {
627 return newHashSet(FINISHED, OperationStatus.FAILED).contains(operationExecution.getStatus());
631 private interface AsynchronousExecution {
632 void execute(JobInfo job);
635 public static class VnfCreationResult {
636 private final com.nokia.cbam.lcm.v32.model.VnfInfo vnfInfo;
637 private final String vnfdId;
639 VnfCreationResult(com.nokia.cbam.lcm.v32.model.VnfInfo vnfInfo, String vnfdId) {
640 this.vnfInfo = vnfInfo;
641 this.vnfdId = vnfdId;
644 public com.nokia.cbam.lcm.v32.model.VnfInfo getVnfInfo() {