2 * ============LICENSE_START======================================================================
3 * Copyright (C) 2023 Nordix Foundation. All rights reserved.
4 * ===============================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 * ============LICENSE_END========================================================================
19 package com.oransc.rappmanager.acm.service;
21 import com.oransc.rappmanager.acm.configuration.ACMConfiguration;
22 import com.oransc.rappmanager.acm.rest.AutomationCompositionDefinitionApiClient;
23 import com.oransc.rappmanager.acm.rest.AutomationCompositionInstanceApiClient;
24 import com.oransc.rappmanager.models.RappDeployer;
25 import com.oransc.rappmanager.models.csar.RappCsarConfigurationHandler;
26 import com.oransc.rappmanager.models.rapp.Rapp;
27 import com.oransc.rappmanager.models.rapp.RappEvent;
28 import com.oransc.rappmanager.models.rapp.RappState;
29 import com.oransc.rappmanager.models.rappinstance.RappACMInstance;
30 import com.oransc.rappmanager.models.rappinstance.RappInstance;
31 import com.oransc.rappmanager.models.statemachine.RappInstanceStateMachine;
32 import java.util.UUID;
33 import java.util.concurrent.TimeUnit;
34 import lombok.RequiredArgsConstructor;
35 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
36 import org.onap.policy.clamp.models.acm.concepts.DeployState;
37 import org.onap.policy.clamp.models.acm.concepts.LockState;
38 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.AcTypeStateUpdate;
39 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse;
40 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.PrimeOrder;
41 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.AcInstanceStateUpdate;
42 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.DeployOrder;
43 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationResponse;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46 import org.springframework.stereotype.Service;
47 import org.springframework.web.client.RestClientException;
50 @RequiredArgsConstructor
51 public class AcmDeployer implements RappDeployer {
53 Logger logger = LoggerFactory.getLogger(AcmDeployer.class);
55 private final AutomationCompositionDefinitionApiClient automationCompositionDefinitionApiClient;
56 private final AutomationCompositionInstanceApiClient automationCompositionInstanceApiClient;
57 private final RappCsarConfigurationHandler rappCsarConfigurationHandler;
58 private final RappInstanceStateMachine rappInstanceStateMachine;
59 private final ACMConfiguration acmConfiguration;
61 void updateACMInstanceState(UUID compositionId, RappACMInstance rappACMInstance, DeployOrder deployOrder) {
62 AcInstanceStateUpdate acInstanceStateUpdate = new AcInstanceStateUpdate();
63 acInstanceStateUpdate.setDeployOrder(deployOrder);
64 automationCompositionInstanceApiClient.compositionInstanceState(compositionId,
65 rappACMInstance.getAcmInstanceId(), acInstanceStateUpdate, UUID.randomUUID());
68 public void primeACMComposition(UUID compositionId, PrimeOrder primeOrder) {
69 AcTypeStateUpdate acTypeStateUpdate = new AcTypeStateUpdate();
70 acTypeStateUpdate.setPrimeOrder(primeOrder);
71 automationCompositionDefinitionApiClient.compositionDefinitionPriming(compositionId, UUID.randomUUID(),
75 public CommissioningResponse createComposition(String compositionPayload) {
76 CommissioningResponse commissioningResponse = null;
78 commissioningResponse =
79 automationCompositionDefinitionApiClient.createCompositionDefinitions(compositionPayload,
81 } catch (Exception e) {
82 logger.warn("Error in creating composition", e);
84 return commissioningResponse;
87 public CommissioningResponse deleteComposition(UUID compositionId) {
89 return automationCompositionDefinitionApiClient.deleteCompositionDefinition(compositionId,
91 } catch (Exception e) {
92 logger.warn("Error in deleting composition {}", compositionId, e);
97 boolean isCompositionInstanceStateEquals(UUID compositionId, UUID compositionIntanceId, DeployState deployState) {
98 return automationCompositionInstanceApiClient.getCompositionInstance(compositionId, compositionIntanceId,
99 UUID.randomUUID()).getDeployState().equals(deployState);
102 boolean waitForCompositionInstanceTargetState(UUID compositionId, RappInstance rappInstance,
103 DeployState deployState) {
104 boolean targetInstanceStateTransition = false;
106 for (int i = 0; i < acmConfiguration.getMaxRetries(); i++) {
107 logger.debug("Composition instance state check {}", i + 1);
108 if (isCompositionInstanceStateEquals(compositionId, rappInstance.getAcm().getAcmInstanceId(),
110 sendRappInstanceStateEvent(rappInstance, deployState);
111 logger.info("Composition instance {} state is {}", rappInstance.getAcm().getAcmInstanceId(),
113 targetInstanceStateTransition = true;
116 TimeUnit.SECONDS.sleep(acmConfiguration.getRetryInterval());
119 } catch (Exception e) {
120 logger.warn("Unable to get composition instance state for composition {}", compositionId, e);
122 return targetInstanceStateTransition;
126 public boolean deployRappInstance(Rapp rapp, RappInstance rappInstance) {
128 String instantiationPayload =
129 rappCsarConfigurationHandler.getInstantiationPayload(rapp, rappInstance.getAcm(),
130 rapp.getCompositionId());
131 InstantiationResponse instantiationResponse =
132 automationCompositionInstanceApiClient.createCompositionInstance(rapp.getCompositionId(),
133 instantiationPayload, UUID.randomUUID());
134 if (instantiationResponse.getInstanceId() != null) {
135 rappInstance.getAcm().setAcmInstanceId(instantiationResponse.getInstanceId());
136 updateACMInstanceState(rapp.getCompositionId(), rappInstance.getAcm(), DeployOrder.DEPLOY);
139 } catch (Exception e) {
140 logger.warn("Error in deploying Rapp", e);
146 public boolean undeployRappInstance(Rapp rapp, RappInstance rappInstance) {
147 AutomationComposition automationComposition =
148 automationCompositionInstanceApiClient.getCompositionInstance(rapp.getCompositionId(),
149 rappInstance.getAcm().getAcmInstanceId(), UUID.randomUUID());
150 if (automationComposition.getDeployState().equals(DeployState.DEPLOYED) && automationComposition.getLockState()
151 .equals(LockState.LOCKED)) {
152 updateACMInstanceState(rapp.getCompositionId(), rappInstance.getAcm(), DeployOrder.UNDEPLOY);
153 if (waitForCompositionInstanceTargetState(rapp.getCompositionId(), rappInstance, DeployState.UNDEPLOYED)) {
154 automationCompositionInstanceApiClient.deleteCompositionInstance(
155 automationComposition.getCompositionId(), automationComposition.getInstanceId(),
157 rappInstanceStateMachine.sendRappInstanceEvent(rappInstance, RappEvent.ACMUNDEPLOYED);
165 public boolean primeRapp(Rapp rapp) {
166 logger.info("Priming rapp {}", rapp.getName());
168 String compositionPayload = rappCsarConfigurationHandler.getAcmCompositionPayload(rapp);
169 CommissioningResponse commissioningResponse = createComposition(compositionPayload);
170 if (commissioningResponse != null && commissioningResponse.getCompositionId() != null) {
171 rapp.setCompositionId(commissioningResponse.getCompositionId());
172 logger.info("Priming automation Composition");
173 primeACMComposition(commissioningResponse.getCompositionId(), PrimeOrder.PRIME);
174 rapp.setState(RappState.PRIMED);
177 logger.error("Failed to create automation composition");
179 } catch (Exception e) {
180 logger.error("Failed to create automation composition", e);
186 public boolean deprimeRapp(Rapp rapp) {
188 primeACMComposition(rapp.getCompositionId(), PrimeOrder.DEPRIME);
189 CommissioningResponse commissioningResponse = deleteComposition(rapp.getCompositionId());
190 if (commissioningResponse != null) {
191 rapp.setState(RappState.COMMISSIONED);
194 } catch (Exception e) {
195 logger.error("Failed deprime automation composition", e);
200 public void syncRappInstanceStatus(UUID compositionId, RappInstance rappInstance) {
201 if (rappInstance.getAcm().getAcmInstanceId() != null) {
203 AutomationComposition compositionInstance =
204 automationCompositionInstanceApiClient.getCompositionInstance(compositionId,
205 rappInstance.getAcm().getAcmInstanceId(), UUID.randomUUID());
206 sendRappInstanceStateEvent(rappInstance, compositionInstance.getDeployState());
207 } catch (RestClientException exception) {
208 logger.warn("Unable to get the ACM details for rapp instance {}", rappInstance.getRappInstanceId());
213 void sendRappInstanceStateEvent(RappInstance rappInstance, DeployState deployState) {
214 if (deployState.equals(DeployState.DEPLOYED)) {
215 rappInstanceStateMachine.sendRappInstanceEvent(rappInstance, RappEvent.ACMDEPLOYED);
216 } else if (deployState.equals(DeployState.UNDEPLOYED)) {
217 rappInstanceStateMachine.sendRappInstanceEvent(rappInstance, RappEvent.ACMUNDEPLOYED);
218 } else if (deployState.equals(DeployState.DEPLOYING)) {
219 rappInstanceStateMachine.sendRappInstanceEvent(rappInstance, RappEvent.DEPLOYING);
220 } else if (deployState.equals(DeployState.UNDEPLOYING)) {
221 rappInstanceStateMachine.sendRappInstanceEvent(rappInstance, RappEvent.UNDEPLOYING);