gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 Nordix Foundation.
   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
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.acm.participant.kubernetes.handler;
  22
  23 import jakarta.ws.rs.core.Response;
  24 import jakarta.ws.rs.core.Response.Status;
  25 import java.io.IOException;
  26 import java.lang.invoke.MethodHandles;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.UUID;
  31 import java.util.concurrent.ConcurrentHashMap;
  32 import lombok.AccessLevel;
  33 import lombok.Getter;
  34 import org.onap.policy.clamp.acm.participant.intermediary.api.AutomationCompositionElementListener;
  35 import org.onap.policy.clamp.acm.participant.intermediary.api.ParticipantIntermediaryApi;
  36 import org.onap.policy.clamp.acm.participant.kubernetes.exception.ServiceException;
  37 import org.onap.policy.clamp.acm.participant.kubernetes.helm.PodStatusValidator;
  38 import org.onap.policy.clamp.acm.participant.kubernetes.models.ChartInfo;
  39 import org.onap.policy.clamp.acm.participant.kubernetes.service.ChartService;
  40 import org.onap.policy.clamp.common.acm.exception.AutomationCompositionException;
  41 import org.onap.policy.clamp.models.acm.concepts.AcElementDeploy;
  42 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  43 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElementDefinition;
  44 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  45 import org.onap.policy.clamp.models.acm.concepts.LockState;
  46 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  47 import org.onap.policy.clamp.models.acm.utils.AcmUtils;
  48 import org.onap.policy.common.utils.coder.Coder;
  49 import org.onap.policy.common.utils.coder.CoderException;
  50 import org.onap.policy.common.utils.coder.StandardCoder;
  51 import org.onap.policy.models.base.PfModelException;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54 import org.springframework.beans.factory.annotation.Autowired;
  55 import org.springframework.stereotype.Component;
  56
  57 /**
  58  * This class handles implementation of automationCompositionElement updates.
  59  */
  60 @Component
  61 public class AutomationCompositionElementHandler implements AutomationCompositionElementListener {
  62     private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  63
  64     // Map of helm installation and the status of corresponding pods
  65     @Getter
  66     private static Map<String, Map<String, String>> podStatusMap = new ConcurrentHashMap<>();
  67     private static final Coder CODER = new StandardCoder();
  68
  69     @Autowired
  70     private ChartService chartService;
  71
  72     @Autowired
  73     private ParticipantIntermediaryApi intermediaryApi;
  74
  75     // Map of acElement Id and installed Helm charts
  76     @Getter(AccessLevel.PACKAGE)
  77     private final Map<UUID, ChartInfo> chartMap = new HashMap<>();
  78
  79     // Default thread config values
  80     private static class ThreadConfig {
  81         private int uninitializedToPassiveTimeout = 60;
  82         private int podStatusCheckInterval = 30;
  83     }
  84
  85     /**
  86      * Callback method to handle a automation composition element state change.
  87      *
  88      * @param automationCompositionElementId the ID of the automation composition element
  89      */
  90     @Override
  91     public synchronized void undeploy(UUID automationCompositionId, UUID automationCompositionElementId) {
  92         var chart = chartMap.get(automationCompositionElementId);
  93         if (chart != null) {
  94             LOGGER.info("Helm deployment to be deleted {} ", chart.getReleaseName());
  95             try {
  96                 chartService.uninstallChart(chart);
  97                 intermediaryApi.updateAutomationCompositionElementState(automationCompositionId,
  98                         automationCompositionElementId, DeployState.UNDEPLOYED, null, StateChangeResult.NO_ERROR,
  99                         "Undeployed");
 100                 chartMap.remove(automationCompositionElementId);
 101                 podStatusMap.remove(chart.getReleaseName());
 102             } catch (ServiceException se) {
 103                 LOGGER.warn("Deletion of Helm deployment failed", se);
 104             }
 105         }
 106     }
 107
 108     /**
 109      * Callback method to handle an update on a automation composition element.
 110      *
 111      * @param automationCompositionId the automationComposition Id
 112      * @param element the information on the automation composition element
 113      * @param properties properties Map
 114      * @throws PfModelException in case of an exception
 115      */
 116     @Override
 117     public synchronized void deploy(UUID automationCompositionId, AcElementDeploy element,
 118             Map<String, Object> properties) throws PfModelException {
 119
 120         try {
 121             var chartInfo = getChartInfo(properties);
 122             if (chartService.installChart(chartInfo)) {
 123                 chartMap.put(element.getId(), chartInfo);
 124
 125                 var config = getThreadConfig(properties);
 126                 checkPodStatus(automationCompositionId, element.getId(), chartInfo,
 127                         config.uninitializedToPassiveTimeout, config.podStatusCheckInterval);
 128             } else {
 129                 intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 130                         DeployState.UNDEPLOYED, null, StateChangeResult.FAILED, "Chart not installed");
 131             }
 132         } catch (ServiceException | IOException e) {
 133             throw new PfModelException(Response.Status.BAD_REQUEST, "Installation of Helm chart failed ", e);
 134         } catch (InterruptedException e) {
 135             Thread.currentThread().interrupt();
 136             throw new PfModelException(Response.Status.BAD_REQUEST, "Error invoking ExecutorService ", e);
 137         } catch (AutomationCompositionException e) {
 138             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 139                     DeployState.UNDEPLOYED, null, StateChangeResult.FAILED, e.getMessage());
 140         }
 141     }
 142
 143     private ThreadConfig getThreadConfig(Map<String, Object> properties) throws AutomationCompositionException {
 144         try {
 145             return CODER.convert(properties, ThreadConfig.class);
 146         } catch (CoderException e) {
 147             throw new AutomationCompositionException(Status.BAD_REQUEST, "Error extracting ThreadConfig ", e);
 148         }
 149     }
 150
 151     private ChartInfo getChartInfo(Map<String, Object> properties) throws AutomationCompositionException {
 152         @SuppressWarnings("unchecked")
 153         var chartData = (Map<String, Object>) properties.get("chart");
 154
 155         LOGGER.info("Installation request received for the Helm Chart {} ", chartData);
 156         try {
 157             return CODER.convert(chartData, ChartInfo.class);
 158         } catch (CoderException e) {
 159             throw new AutomationCompositionException(Status.BAD_REQUEST, "Error extracting ChartInfo ", e);
 160         }
 161     }
 162
 163     /**
 164      * Invoke a new thread to check the status of deployed pods.
 165      *
 166      * @param chart ChartInfo
 167      * @throws ServiceException in case of an exception
 168      */
 169     public void checkPodStatus(UUID automationCompositionId, UUID elementId, ChartInfo chart, int timeout,
 170             int podStatusCheckInterval) throws InterruptedException, ServiceException {
 171
 172         var result = new PodStatusValidator(chart, timeout, podStatusCheckInterval);
 173         result.run();
 174         LOGGER.info("Pod Status Validator Completed");
 175         intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, elementId,
 176                 DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR, "Deployed");
 177
 178     }
 179
 180     @Override
 181     public void lock(UUID instanceId, UUID elementId) throws PfModelException {
 182         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, null, LockState.LOCKED,
 183                 StateChangeResult.NO_ERROR, "Locked");
 184     }
 185
 186     @Override
 187     public void unlock(UUID instanceId, UUID elementId) throws PfModelException {
 188         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, null, LockState.UNLOCKED,
 189                 StateChangeResult.NO_ERROR, "Unlocked");
 190     }
 191
 192     @Override
 193     public void delete(UUID instanceId, UUID elementId) throws PfModelException {
 194         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, DeployState.DELETED, null,
 195                 StateChangeResult.NO_ERROR, "Deleted");
 196     }
 197
 198     @Override
 199     public void update(UUID instanceId, AcElementDeploy element, Map<String, Object> properties)
 200             throws PfModelException {
 201         intermediaryApi.updateAutomationCompositionElementState(instanceId, element.getId(), DeployState.DEPLOYED, null,
 202                 StateChangeResult.NO_ERROR, "Update not supported");
 203     }
 204
 205     @Override
 206     public void prime(UUID compositionId, List<AutomationCompositionElementDefinition> elementDefinitionList)
 207             throws PfModelException {
 208         intermediaryApi.updateCompositionState(compositionId, AcTypeState.PRIMED, StateChangeResult.NO_ERROR, "Primed");
 209     }
 210
 211     @Override
 212     public void deprime(UUID compositionId) throws PfModelException {
 213         intermediaryApi.updateCompositionState(compositionId, AcTypeState.COMMISSIONED, StateChangeResult.NO_ERROR,
 214                 "Deprimed");
 215     }
 216
 217     @Override
 218     public void handleRestartComposition(UUID compositionId,
 219             List<AutomationCompositionElementDefinition> elementDefinitionList, AcTypeState state)
 220             throws PfModelException {
 221         var finalState = AcTypeState.PRIMED.equals(state) || AcTypeState.PRIMING.equals(state) ? AcTypeState.PRIMED
 222                 : AcTypeState.COMMISSIONED;
 223         intermediaryApi.updateCompositionState(compositionId, finalState, StateChangeResult.NO_ERROR, "Restarted");
 224     }
 225
 226     @Override
 227     public void handleRestartInstance(UUID automationCompositionId, AcElementDeploy element,
 228             Map<String, Object> properties, DeployState deployState, LockState lockState) throws PfModelException {
 229         if (DeployState.DEPLOYING.equals(deployState)) {
 230             deploy(automationCompositionId, element, properties);
 231             return;
 232         }
 233         if (DeployState.UNDEPLOYING.equals(deployState) || DeployState.DEPLOYED.equals(deployState)
 234                 || DeployState.UPDATING.equals(deployState)) {
 235             try {
 236                 var chartInfo = getChartInfo(properties);
 237                 chartMap.put(element.getId(), chartInfo);
 238             } catch (AutomationCompositionException e) {
 239                 intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 240                         DeployState.UNDEPLOYED, null, StateChangeResult.FAILED, e.getMessage());
 241             }
 242         }
 243         if (DeployState.UNDEPLOYING.equals(deployState)) {
 244             undeploy(automationCompositionId, element.getId());
 245             return;
 246         }
 247         deployState = AcmUtils.deployCompleted(deployState);
 248         lockState = AcmUtils.lockCompleted(deployState, lockState);
 249         intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(), deployState,
 250                 lockState, StateChangeResult.NO_ERROR, "Restarted");
 251     }
 252
 253     @Override
 254     public void migrate(UUID automationCompositionId, AcElementDeploy element, UUID compositionTargetId,
 255             Map<String, Object> properties) throws PfModelException {
 256         intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 257                 DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR, "Migrated");
 258     }
 259 }