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 java.io.IOException;
  24 import java.lang.invoke.MethodHandles;
  25 import java.util.HashMap;
  26 import java.util.Map;
  27 import java.util.UUID;
  28 import java.util.concurrent.ConcurrentHashMap;
  29 import java.util.concurrent.ExecutionException;
  30 import java.util.concurrent.ExecutorService;
  31 import java.util.concurrent.Executors;
  32 import lombok.AccessLevel;
  33 import lombok.Getter;
  34 import lombok.Setter;
  35 import org.onap.policy.clamp.acm.participant.intermediary.api.AutomationCompositionElementListener;
  36 import org.onap.policy.clamp.acm.participant.intermediary.api.ParticipantIntermediaryApi;
  37 import org.onap.policy.clamp.acm.participant.kubernetes.exception.ServiceException;
  38 import org.onap.policy.clamp.acm.participant.kubernetes.helm.PodStatusValidator;
  39 import org.onap.policy.clamp.acm.participant.kubernetes.models.ChartInfo;
  40 import org.onap.policy.clamp.acm.participant.kubernetes.service.ChartService;
  41 import org.onap.policy.clamp.models.acm.concepts.AcElementDeploy;
  42 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  43 import org.onap.policy.clamp.models.acm.concepts.LockState;
  44 import org.onap.policy.common.utils.coder.Coder;
  45 import org.onap.policy.common.utils.coder.CoderException;
  46 import org.onap.policy.common.utils.coder.StandardCoder;
  47 import org.onap.policy.models.base.PfModelException;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50 import org.springframework.beans.factory.annotation.Autowired;
  51 import org.springframework.stereotype.Component;
  52
  53 /**
  54  * This class handles implementation of automationCompositionElement updates.
  55  */
  56 @Component
  57 public class AutomationCompositionElementHandler implements AutomationCompositionElementListener {
  58     private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  59
  60     private ExecutorService executor = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
  61
  62     // Map of helm installation and the status of corresponding pods
  63     @Getter
  64     private static Map<String, Map<String, String>> podStatusMap = new ConcurrentHashMap<>();
  65     private static final Coder CODER = new StandardCoder();
  66
  67     @Autowired
  68     private ChartService chartService;
  69
  70     @Setter
  71     private ParticipantIntermediaryApi intermediaryApi;
  72
  73     // Map of acElement Id and installed Helm charts
  74     @Getter(AccessLevel.PACKAGE)
  75     private final Map<UUID, ChartInfo> chartMap = new HashMap<>();
  76
  77     // Default thread config values
  78     private static class ThreadConfig {
  79         private int uninitializedToPassiveTimeout = 60;
  80         private int podStatusCheckInterval = 30;
  81     }
  82
  83     /**
  84      * Callback method to handle a automation composition element state change.
  85      *
  86      * @param automationCompositionElementId the ID of the automation composition element
  87      */
  88     @Override
  89     public synchronized void undeploy(UUID automationCompositionId, UUID automationCompositionElementId) {
  90         var chart = chartMap.get(automationCompositionElementId);
  91         if (chart != null) {
  92             LOGGER.info("Helm deployment to be deleted {} ", chart.getReleaseName());
  93             try {
  94                 chartService.uninstallChart(chart);
  95                 intermediaryApi.updateAutomationCompositionElementState(automationCompositionId,
  96                         automationCompositionElementId, DeployState.UNDEPLOYED, LockState.NONE);
  97                 chartMap.remove(automationCompositionElementId);
  98                 podStatusMap.remove(chart.getReleaseName());
  99             } catch (ServiceException se) {
 100                 LOGGER.warn("Deletion of Helm deployment failed", se);
 101             }
 102         }
 103     }
 104
 105     /**
 106      * Callback method to handle an update on a automation composition element.
 107      *
 108      * @param automationCompositionId the automationComposition Id
 109      * @param element the information on the automation composition element
 110      * @param properties properties Map
 111      * @throws PfModelException in case of an exception
 112      */
 113     @Override
 114     public synchronized void deploy(UUID automationCompositionId, AcElementDeploy element,
 115             Map<String, Object> properties) throws PfModelException {
 116         @SuppressWarnings("unchecked")
 117         var chartData = (Map<String, Object>) properties.get("chart");
 118
 119         LOGGER.info("Installation request received for the Helm Chart {} ", chartData);
 120         try {
 121             var chartInfo = CODER.convert(chartData, ChartInfo.class);
 122             if (chartService.installChart(chartInfo)) {
 123                 chartMap.put(element.getId(), chartInfo);
 124
 125                 var config = CODER.convert(properties, ThreadConfig.class);
 126                 checkPodStatus(automationCompositionId, element.getId(), chartInfo,
 127                         config.uninitializedToPassiveTimeout, config.podStatusCheckInterval);
 128             }
 129         } catch (ServiceException | CoderException | IOException | ExecutionException | InterruptedException e) {
 130             LOGGER.warn("Installation of Helm chart failed", e);
 131         }
 132     }
 133
 134     /**
 135      * Invoke a new thread to check the status of deployed pods.
 136      *
 137      * @param chart ChartInfo
 138      */
 139     public void checkPodStatus(UUID automationCompositionId, UUID elementId, ChartInfo chart, int timeout,
 140             int podStatusCheckInterval) throws ExecutionException, InterruptedException {
 141         // Invoke runnable thread to check pod status
 142         var result = executor.submit(new PodStatusValidator(chart, timeout, podStatusCheckInterval), "Done");
 143         if (!result.get().isEmpty()) {
 144             LOGGER.info("Pod Status Validator Completed: {}", result.isDone());
 145             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, elementId,
 146                     DeployState.DEPLOYED, LockState.LOCKED);
 147         }
 148     }
 149 }