assorted changes

shwstppr · shwstppr · commit 8b0bb7b785c9 · 2025-06-23T09:59:51.000+05:30
- capabilities returns extensions path
- provisioner refactor - payload cleanup in b/g
- delete extension additional checks

Signed-off-by: Abhishek Kumar &lt;abhishek.mrt22@gmail.com&gt;
diff --git a/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java b/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java
@@ -223,6 +223,7 @@ public class ApiConstants {
     public static final String EXTENSION = "extension";
     public static final String EXTENSION_ID = "extensionid";
     public static final String EXTENSION_NAME = "extensionname";
+    public static final String EXTENSIONS_PATH = "extensionspath";
     public static final String FENCE = "fence";
     public static final String FETCH_LATEST = "fetchlatest";
     public static final String FILESYSTEM = "filesystem";
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java
@@ -73,6 +73,7 @@ public void execute() {
         response.setSharedFsVmMinCpuCount((Integer)capabilities.get(ApiConstants.SHAREDFSVM_MIN_CPU_COUNT));
         response.setSharedFsVmMinRamSize((Integer)capabilities.get(ApiConstants.SHAREDFSVM_MIN_RAM_SIZE));
         response.setInstanceLeaseEnabled((Boolean) capabilities.get(ApiConstants.INSTANCE_LEASE_ENABLED));
+        response.setExtensionsPath((String)capabilities.get(ApiConstants.EXTENSIONS_PATH));
         response.setObjectName("capability");
         response.setResponseName(getCommandName());
         this.setResponseObject(response);
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java
@@ -16,6 +16,7 @@
 // under the License.
 package org.apache.cloudstack.api.response;
 
+import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.BaseResponse;
 
@@ -140,6 +141,10 @@ public class CapabilitiesResponse extends BaseResponse {
     @Param(description = "true if instance lease feature is enabled", since = "4.21.0")
     private Boolean instanceLeaseEnabled;
 
+    @SerializedName(ApiConstants.EXTENSIONS_PATH)
+    @Param(description = "The path of the extensions directory", since = "4.21.0", authorized = {RoleType.Admin})
+    private String extensionsPath;
+
     public void setSecurityGroupsEnabled(boolean securityGroupsEnabled) {
         this.securityGroupsEnabled = securityGroupsEnabled;
     }
@@ -255,4 +260,8 @@ public void setSharedFsVmMinRamSize(Integer sharedFsVmMinRamSize) {
     public void setInstanceLeaseEnabled(Boolean instanceLeaseEnabled) {
         this.instanceLeaseEnabled = instanceLeaseEnabled;
     }
+
+    public void setExtensionsPath(String extensionsPath) {
+        this.extensionsPath = extensionsPath;
+    }
 }
diff --git a/engine/components-api/src/main/java/com/cloud/hypervisor/ExternalProvisioner.java b/engine/components-api/src/main/java/com/cloud/hypervisor/ExternalProvisioner.java
@@ -33,6 +33,8 @@
 
 public interface ExternalProvisioner extends Manager {
 
+    String getExtensionsPath();
+
     String getExtensionEntryPoint(String relativeEntryPoint);
 
     String getChecksumForExtensionEntryPoint(String extensionName, String relativeEntryPoint);
diff --git a/engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDao.java b/engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDao.java
@@ -101,4 +101,6 @@ public interface VMTemplateDao extends GenericDao<VMTemplateVO, Long>, StateDao<
     List<VMTemplateVO> listByIds(List<Long> ids);
 
     List<Long> listIdsByTemplateTag(String tag);
+
+    List<Long> listIdsByExtensionId(long extensionId);
 }
diff --git a/engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDaoImpl.java b/engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDaoImpl.java
@@ -837,6 +837,17 @@ public List<Long> listIdsByTemplateTag(String tag) {
         return customSearchIncludingRemoved(sc, null);
     }
 
+    @Override
+    public List<Long> listIdsByExtensionId(long extensionId) {
+        GenericSearchBuilder<VMTemplateVO, Long> sb = createSearchBuilder(Long.class);
+        sb.selectFields(sb.entity().getId());
+        sb.and("extensionId", sb.entity().getExtensionId(), SearchCriteria.Op.EQ);
+        sb.done();
+        SearchCriteria<Long> sc = sb.create();
+        sc.setParameters("extensionId", extensionId);
+        return customSearch(sc, null);
+    }
+
     @Override
     public boolean updateState(
             com.cloud.template.VirtualMachineTemplate.State currentState,
diff --git a/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/dao/ExtensionCustomActionDao.java b/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/dao/ExtensionCustomActionDao.java
@@ -16,9 +16,12 @@
 // under the License.
 package org.apache.cloudstack.framework.extensions.dao;
 
+import java.util.List;
+
 import com.cloud.utils.db.GenericDao;
 import org.apache.cloudstack.framework.extensions.vo.ExtensionCustomActionVO;
 
 public interface ExtensionCustomActionDao extends GenericDao<ExtensionCustomActionVO, Long> {
-    ExtensionCustomActionVO findByNameAndExtensionId(Long extensionId, String name);
+    ExtensionCustomActionVO findByNameAndExtensionId(long extensionId, String name);
+    List<Long> listIdsByExtensionId(long extensionId);
 }
diff --git a/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/dao/ExtensionCustomActionDaoImpl.java b/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/dao/ExtensionCustomActionDaoImpl.java
@@ -17,10 +17,14 @@
 
 package org.apache.cloudstack.framework.extensions.dao;
 
+import java.util.List;
+
+import org.apache.cloudstack.framework.extensions.vo.ExtensionCustomActionVO;
+
 import com.cloud.utils.db.GenericDaoBase;
+import com.cloud.utils.db.GenericSearchBuilder;
 import com.cloud.utils.db.SearchBuilder;
 import com.cloud.utils.db.SearchCriteria;
-import org.apache.cloudstack.framework.extensions.vo.ExtensionCustomActionVO;
 
 public class ExtensionCustomActionDaoImpl extends GenericDaoBase<ExtensionCustomActionVO, Long> implements ExtensionCustomActionDao {
 
@@ -34,11 +38,22 @@ public ExtensionCustomActionDaoImpl() {
     }
 
     @Override
-    public ExtensionCustomActionVO findByNameAndExtensionId(Long extensionId, String name) {
+    public ExtensionCustomActionVO findByNameAndExtensionId(long extensionId, String name) {
         SearchCriteria<ExtensionCustomActionVO> sc = AllFieldSearch.create();
         sc.setParameters("extensionId", extensionId);
         sc.setParameters("name", name);
 
         return findOneBy(sc);
     }
+
+    @Override
+    public List<Long> listIdsByExtensionId(long extensionId) {
+        GenericSearchBuilder<ExtensionCustomActionVO, Long> sb = createSearchBuilder(Long.class);
+        sb.selectFields(sb.entity().getId());
+        sb.and("extensionId", sb.entity().getExtensionId(), SearchCriteria.Op.EQ);
+        sb.done();
+        SearchCriteria<Long> sc = sb.create();
+        sc.setParameters("extensionId", extensionId);
+        return customSearch(sc, null);
+    }
 }
diff --git a/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/manager/ExtensionsManager.java b/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/manager/ExtensionsManager.java
@@ -50,6 +50,8 @@
 
 public interface ExtensionsManager extends Manager {
 
+    String getExtensionsPath();
+
     Extension createExtension(CreateExtensionCmd cmd);
 
     boolean prepareExtensionEntryPointAcrossServers(Extension extension);
diff --git a/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/manager/ExtensionsManagerImpl.java b/framework/extensions/src/main/java/org/apache/cloudstack/framework/extensions/manager/ExtensionsManagerImpl.java
@@ -57,9 +57,11 @@
 import org.apache.cloudstack.context.CallContext;
 import org.apache.cloudstack.extension.CustomActionResultResponse;
 import org.apache.cloudstack.extension.Extension;
-import org.apache.cloudstack.extension.ExtensionHelper;
 import org.apache.cloudstack.extension.ExtensionCustomAction;
+import org.apache.cloudstack.extension.ExtensionHelper;
 import org.apache.cloudstack.extension.ExtensionResourceMap;
+import org.apache.cloudstack.framework.config.ConfigKey;
+import org.apache.cloudstack.framework.config.Configurable;
 import org.apache.cloudstack.framework.extensions.api.AddCustomActionCmd;
 import org.apache.cloudstack.framework.extensions.api.CreateExtensionCmd;
 import org.apache.cloudstack.framework.extensions.api.DeleteCustomActionCmd;
@@ -121,6 +123,7 @@
 import com.cloud.hypervisor.Hypervisor;
 import com.cloud.org.Cluster;
 import com.cloud.serializer.GsonHelper;
+import com.cloud.storage.dao.VMTemplateDao;
 import com.cloud.utils.Pair;
 import com.cloud.utils.component.ManagerBase;
 import com.cloud.utils.component.PluggableService;
@@ -138,7 +141,12 @@
 import com.cloud.vm.VmDetailConstants;
 import com.cloud.vm.dao.VMInstanceDao;
 
-public class ExtensionsManagerImpl extends ManagerBase implements ExtensionsManager, ExtensionHelper, PluggableService {
+public class ExtensionsManagerImpl extends ManagerBase implements ExtensionsManager, ExtensionHelper, PluggableService, Configurable {
+
+    ConfigKey<Integer> EntryPointStateCheckInterval = new ConfigKey<>("Advanced", Integer.class,
+            "extension.entrypoint.state.check.interval", "60",
+            "Interval (in seconds) for checking entry-point state of extensions",
+            false, ConfigKey.Scope.Global);
 
     @Inject
     ExtensionDao extensionDao;
@@ -191,6 +199,9 @@ public class ExtensionsManagerImpl extends ManagerBase implements ExtensionsMana
     @Inject
     AlertManager alertManager;
 
+    @Inject
+    VMTemplateDao templateDao;
+
     private ScheduledExecutorService entryPointSyncCheckExecutor;
 
     protected String getDefaultExtensionRelativeEntryPoint(String name) {
@@ -469,6 +480,18 @@ protected Map<String, Object> getExternalAccessDetails(Map<String, String> actio
         return externalDetails;
     }
 
+    protected void checkOrchestratorTemplates(Long extensionId) {
+        List<Long> extensionTemplateIds = templateDao.listIdsByExtensionId(extensionId);
+        if (CollectionUtils.isNotEmpty(extensionTemplateIds)) {
+            throw new CloudRuntimeException("Orchestrator extension has associated templates, remove them to delete the extension");
+        }
+    }
+
+    @Override
+    public String getExtensionsPath() {
+        return externalProvisioner.getExtensionsPath();
+    }
+
     @Override
     @ActionEvent(eventType = EventTypes.EVENT_EXTENSION_CREATE, eventDescription = "creating extension")
     public Extension createExtension(CreateExtensionCmd cmd) {
@@ -701,6 +724,12 @@ public boolean deleteExtension(DeleteExtensionCmd cmd) {
         if (CollectionUtils.isNotEmpty(registeredResources)) {
             throw new CloudRuntimeException("Extension has associated resources, unregister them to delete the extension");
         }
+        List<Long> customActionIds = extensionCustomActionDao.listIdsByExtensionId(extensionId);
+        if (CollectionUtils.isNotEmpty(customActionIds)) {
+            throw new CloudRuntimeException(String.format("Extension has %d custom actions, delete them to delete the extension",
+                    customActionIds.size()));
+        }
+        checkOrchestratorTemplates(extensionId);
 
         boolean result = Transaction.execute((TransactionCallbackWithException<Boolean, CloudRuntimeException>) status -> {
             extensionDetailsDao.removeDetails(extensionId);
@@ -1413,8 +1442,8 @@ public Extension getExtensionForCluster(long clusterId) {
 
     @Override
     public boolean start() {
-        long syncCheckInitialDelay = 120;
-        long syncCheckInterval = 600;
+        long syncCheckInterval = EntryPointStateCheckInterval.value();
+        long syncCheckInitialDelay = Math.max(60, syncCheckInterval);
         logger.debug("Scheduling extensions entrypoint sync check task with initial delay={}s and interval={}s",
                 syncCheckInitialDelay, syncCheckInterval);
         entryPointSyncCheckExecutor.scheduleWithFixedDelay(new EntryPointSyncCheckWorker(),
@@ -1451,6 +1480,18 @@ public List<Class<?>> getCommands() {
         return cmds;
     }
 
+    @Override
+    public String getConfigComponentName() {
+        return ExtensionsManager.class.getSimpleName();
+    }
+
+    @Override
+    public ConfigKey<?>[] getConfigKeys() {
+        return new ConfigKey[]{
+                EntryPointStateCheckInterval
+        };
+    }
+
     public class EntryPointSyncCheckWorker extends ManagedContextRunnable {
 
         protected void checkExtensionEntryPointSync(Extension extension, List<ManagementServerHostVO> msHosts) {
diff --git a/plugins/hypervisors/external/src/main/java/org/apache/cloudstack/hypervisor/external/provisioner/ExternalEntryPointPayloadProvisioner.java b/plugins/hypervisors/external/src/main/java/org/apache/cloudstack/hypervisor/external/provisioner/ExternalEntryPointPayloadProvisioner.java
@@ -34,6 +34,11 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+import java.util.concurrent.RejectedExecutionException;
+import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Stream;
@@ -89,7 +94,8 @@
 public class ExternalEntryPointPayloadProvisioner extends ManagerBase implements ExternalProvisioner, PluggableService {
 
     public static final String BASE_EXTERNAL_PROVISIONER_SCRIPTS_DIR = "scripts/vm/hypervisor/external/provisioner";
-    public static final String BASE_EXTERNAL_PROVISIONER_SCRIPT = BASE_EXTERNAL_PROVISIONER_SCRIPTS_DIR + "/provisioner.sh";
+    public static final String BASE_EXTERNAL_PROVISIONER_SHELL_SCRIPT =
+            BASE_EXTERNAL_PROVISIONER_SCRIPTS_DIR + "/provisioner.sh";
 
     private static final String PROPERTIES_FILE = "server.properties";
     private static final String EXTENSIONS_DEPLOYMENT_MODE_NAME = "extensions.deployment.mode";
@@ -115,8 +121,9 @@ public class ExternalEntryPointPayloadProvisioner extends ManagerBase implements
 
     private static final AtomicReference<Properties> propertiesRef = new AtomicReference<>();
     private String extensionsDirectory;
-
     private String extensionsDataDirectory;
+    private ExecutorService payloadCleanupExecutor;
+    private ScheduledExecutorService payloadCleanupScheduler;
 
     @Override
     public String getName() {
@@ -234,6 +241,25 @@ public boolean configure(String name, Map<String, Object> params) throws Configu
         return true;
     }
 
+    @Override
+    public boolean start() {
+        payloadCleanupExecutor = Executors.newSingleThreadExecutor();
+        payloadCleanupScheduler = Executors.newSingleThreadScheduledExecutor();
+        return true;
+    }
+
+    @Override
+    public boolean stop() {
+        payloadCleanupExecutor.shutdown();
+        payloadCleanupScheduler.shutdown();
+        return true;
+    }
+
+    @Override
+    public String getExtensionsPath() {
+        return extensionsDirectory;
+    }
+
     @Override
     public String getExtensionEntryPoint(String relativeEntryPoint) {
         return String.format("%s%s%s", extensionsDirectory, File.separator, relativeEntryPoint);
@@ -278,7 +304,8 @@ public PrepareExternalProvisioningAnswer prepareExternalProvisioning(String host
             VirtualMachineTO virtualMachineTO  = GsonHelper.getGson().fromJson(merged, VirtualMachineTO.class);
             return new PrepareExternalProvisioningAnswer(cmd, null, virtualMachineTO, null);
         } catch (Exception e) {
-            logger.warn("Failed to parse the output from preparing external provisioning operation as part of VM deployment: {}", e.getMessage(), e);
+            logger.warn("Failed to parse the output from preparing external provisioning operation as " +
+                    "part of VM deployment: {}", e.getMessage(), e);
             return new PrepareExternalProvisioningAnswer(cmd, false, "Failed to parse VM");
         }
     }
@@ -446,7 +473,7 @@ public RunCustomActionAnswer runCustomAction(String hostGuid, String extensionNa
     }
 
     protected boolean createEntryPoint(String extensionName, Path destinationPathObj) throws IOException {
-        String sourceScriptPath = Script.findScript("", BASE_EXTERNAL_PROVISIONER_SCRIPT);
+        String sourceScriptPath = Script.findScript("", BASE_EXTERNAL_PROVISIONER_SHELL_SCRIPT);
         if(sourceScriptPath == null) {
             logger.error("Failed to find base script for preparing extension: {}",
                     extensionName);
@@ -523,7 +550,8 @@ public void cleanupExtensionEntryPoint(String extensionName, String extensionRel
                     .normalize();
             if (!Files.isDirectory(filePath) && !Files.isRegularFile(filePath)) {
                 throw new CloudRuntimeException(
-                        String.format("Failed to cleanup extension entry-point: %s for extension: %s as it either does not exist or is not a regular file/directory",
+                        String.format("Failed to cleanup extension entry-point: %s for extension: %s as it either " +
+                                        "does not exist or is not a regular file/directory",
                                 extensionName, extensionRelativeEntryPoint));
             }
             if (!FileUtil.deleteRecursively(filePath)) {
@@ -671,7 +699,8 @@ public Pair<Boolean, String> executeExternalCommand(String extensionName, String
             ProcessBuilder builder = new ProcessBuilder(command);
             builder.redirectErrorStream(true);
 
-            logger.debug("Executing {} for command: {} with wait: {} and data file: {}", executablePath, action, wait, dataFile);
+            logger.debug("Executing {} for command: {} with wait: {} and data file: {}", executablePath,
+                    action, wait, dataFile);
 
             Process process = builder.start();
             boolean finished = process.waitFor(wait, TimeUnit.SECONDS);
@@ -700,7 +729,39 @@ public Pair<Boolean, String> executeExternalCommand(String extensionName, String
         }
     }
 
-    private String prepareExternalPayload(String extensionName, Map<String, Object> details) throws IOException {
+    protected void scheduleExtensionPayloadDirectoryCleanup(String extensionName) {
+        try {
+            Future<?> future = payloadCleanupExecutor.submit(() -> {
+                try {
+                    cleanupExtensionData(extensionName, 1, false);
+                    logger.trace("Cleaned up payload directory for extension: {}", extensionName);
+                } catch (Exception e) {
+                    logger.warn("Exception during payload cleanup for extension: {} due to {}", extensionName,
+                            e.getMessage());
+                    logger.trace(e);
+                }
+            });
+            payloadCleanupScheduler.schedule(() -> {
+                try {
+                    if (!future.isDone()) {
+                        future.cancel(true);
+                        logger.trace("Cancelled cleaning up payload directory for extension: {} as it " +
+                                "running for more than 3 seconds", extensionName);
+                    }
+                } catch (Exception e) {
+                    logger.warn("Failed to cancel payload cleanup task for extension: {} due to {}",
+                            extensionName, e.getMessage());
+                    logger.trace(e);
+                }
+            }, 3, TimeUnit.SECONDS);
+        } catch (RejectedExecutionException e) {
+            logger.warn("Payload cleanup task for extension: {} was rejected due to: {}", extensionName,
+                    e.getMessage());
+            logger.trace(e);
+        }
+    }
+
+    protected String prepareExternalPayload(String extensionName, Map<String, Object> details) throws IOException {
         String json = GsonHelper.getGson().toJson(details);
         long epochMillis = System.currentTimeMillis();
         String fileName = epochMillis + ".json";
@@ -709,7 +770,7 @@ private String prepareExternalPayload(String extensionName, Map<String, Object>
         if (!Files.exists(payloadDirPath)) {
             Files.createDirectories(payloadDirPath);
         } else {
-            cleanupExtensionData(extensionName, 1, false);
+            scheduleExtensionPayloadDirectoryCleanup(extensionName);
         }
         Path payloadFile = payloadDirPath.resolve(fileName);
         Files.writeString(payloadFile, json, StandardOpenOption.CREATE_NEW);
diff --git a/plugins/hypervisors/external/src/main/java/org/apache/cloudstack/hypervisor/external/resource/ExternalResource.java b/plugins/hypervisors/external/src/main/java/org/apache/cloudstack/hypervisor/external/resource/ExternalResource.java
diff --git a/server/src/main/java/com/cloud/server/ManagementServerImpl.java b/server/src/main/java/com/cloud/server/ManagementServerImpl.java

Original file line number	Diff line number	Diff line change
`@@ -101,4 +101,6 @@ public interface VMTemplateDao extends GenericDao<VMTemplateVO, Long>, StateDao<`
`101`	`101`	`List<VMTemplateVO> listByIds(List<Long> ids);`
`102`	`102`
`103`	`103`	`List<Long> listIdsByTemplateTag(String tag);`
	`104`	`+`
	`105`	`+ List<Long> listIdsByExtensionId(long extensionId);`
`104`	`106`	`}`