Extensions Framework & Orchestrate Anything #9752

harikrishna-patnala · 2024-10-01T07:43:27Z

Description

Apache CloudStack already supports a wide range of hypervisors, including KVM, VMware, and Xen, to provision and manage instances. We are now introducing a new feature or framework that allows seamless integration of "external" provisioning systems into CloudStack. For example, this enables the integration of any baremetal provisioning system, platforms like Proxmox, or even the addition of new hypervisor support through the use of simple scripts.

A design document is made with more details at https://cwiki.apache.org/confluence/display/CLOUDSTACK/External+Deployment+Integration+in+CloudStack

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

codecov · 2024-10-01T07:57:31Z

Codecov Report

Attention: Patch coverage is 1.12430% with 1583 lines in your changes missing coverage. Please review.

Project coverage is 16.37%. Comparing base (2df1ac5) to head (755a5a7).
Report is 12 commits behind head on main.

Files with missing lines	Patch %	Lines
...r/simpleprovisioner/SimpleExternalProvisioner.java	0.00%	218 Missing ⚠️
.../cloud/agent/manager/ExternalAgentManagerImpl.java	0.00%	187 Missing ⚠️
...m/cloud/agent/manager/ExternalTemplateAdapter.java	0.00%	105 Missing ⚠️
...rvisor/external/resource/ExternalResourceBase.java	0.00%	93 Missing ⚠️
.../external/discoverer/ExternalServerDiscoverer.java	0.00%	78 Missing ⚠️
...n/java/com/cloud/vm/VirtualMachineManagerImpl.java	0.00%	71 Missing and 1 partial ⚠️
...tack/engine/orchestration/NetworkOrchestrator.java	4.47%	63 Missing and 1 partial ⚠️
...n/java/com/cloud/resource/ResourceManagerImpl.java	0.00%	60 Missing ⚠️
...apache/cloudstack/guru/ExternalHypervisorGuru.java	0.00%	52 Missing ⚠️
...com/cloud/agent/manager/ExternalServerPlanner.java	0.00%	47 Missing ⚠️
... and 60 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9752      +/-   ##
============================================
- Coverage     16.42%   16.37%   -0.06%     
- Complexity    13549    13553       +4     
============================================
  Files          5673     5704      +31     
  Lines        500080   501770    +1690     
  Branches      60506    60708     +202     
============================================
+ Hits          82153    82170      +17     
- Misses       408794   410453    +1659     
- Partials       9133     9147      +14

Flag	Coverage Δ
uitests	`3.98% <ø> (-0.02%)`	⬇️
unittests	`17.24% <1.12%> (-0.06%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2024-10-10T23:24:33Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

harikrishna-patnala · 2024-11-08T06:42:04Z

@blueorangutan package

blueorangutan · 2024-11-08T06:44:03Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-11-08T07:35:13Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✖️ debian ✔️ suse15. SL-JID 11530

DaanHoogland

@harikrishna-patnala , I noticed I had started reviewing this and abandonned it. I was about half way anf will leave you the comments now. I will revisit after 4.20 is out.

DaanHoogland · 2024-10-01T08:35:48Z

api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddHostCmd.java

+    @Parameter(name = ApiConstants.EXTERNAL_PROVISIONER, type = CommandType.STRING, description = "Name of the provisioner for the external host, this is mandatory input in case of hypervisor type external", since = "4.21.0")
+    private String provisioner;
+
+    @Parameter(name = ApiConstants.EXTERNAL_DETAILS, type = CommandType.MAP, description = "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", since = "4.21.0")


why are these externaldetails and not just details

DaanHoogland · 2024-10-01T08:37:08Z

api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java

@@ -67,6 +70,9 @@ public class UpdateHostCmd extends BaseCmd {
    @Parameter(name = ApiConstants.ANNOTATION, type = CommandType.STRING, description = "Add an annotation to this host", since = "4.11", authorized = {RoleType.Admin})
    private String annotation;

+    @Parameter(name = ApiConstants.EXTERNAL_DETAILS, type = CommandType.MAP, description = "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", since = "4.21.0")


details instead of external...

DaanHoogland · 2024-10-01T08:39:20Z

...src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java

@@ -251,6 +252,8 @@ public class CreateServiceOfferingCmd extends BaseCmd {
            since="4.20")
    private Boolean purgeResources;

+    @Parameter(name = ApiConstants.EXTERNAL_DETAILS, type = CommandType.MAP, description = "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", since = "4.21.0")


why do we need those extra external-details? aren't these just details?

DaanHoogland · 2024-10-01T08:41:48Z

...src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java

@@ -359,9 +362,21 @@ public Map<String, String> getDetails() {
                }
            }
        }
+
+        detailsMap.putAll(getExternalDetails());


see? these are just details.

DaanHoogland · 2024-10-01T08:49:33Z

core/src/main/java/com/cloud/agent/api/RebootCommand.java

 public class RebootCommand extends Command {
    String vmName;
    VirtualMachineTO vm;
+    private Map<String, String> _details;


Suggested change

private Map<String, String> _details;

private Map<String, String> details;

DaanHoogland · 2024-10-01T08:51:01Z

core/src/main/java/com/cloud/agent/api/StopCommand.java

+    }
+
+    public void setDetails(Map<String, String> details) {
+        _details = details;


Suggested change

_details = details;

this.details = details;

DaanHoogland · 2024-10-01T08:51:10Z

core/src/main/java/com/cloud/agent/api/StopCommand.java

+    }
+
+    public Map<String, String> getDetails() {
+        return _details;


Suggested change

return _details;

return details;

DaanHoogland · 2024-10-01T08:53:07Z

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

-            } else if (template.getFormat() == ImageFormat.BAREMETAL) {
-                logger.debug("%s has format [{}]. Skipping ROOT volume [{}] allocation.", template.toString(), ImageFormat.BAREMETAL, rootVolumeName);
+            } else if (template.getFormat() == ImageFormat.BAREMETAL || template.getFormat() == ImageFormat.EXTERNAL) {
+                logger.debug(String.format("%s has format [%s]. Skipping ROOT volume [%s] allocation.", template.toString(), template.getFormat(), rootVolumeName));


Suggested change

logger.debug(String.format("%s has format [%s]. Skipping ROOT volume [%s] allocation.", template.toString(), template.getFormat(), rootVolumeName));

logger.debug("{} has format [{}]. Skipping ROOT volume [{}] allocation.", template.toString(), template.getFormat(), rootVolumeName);

DaanHoogland · 2024-10-01T08:55:50Z

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

+        if (HypervisorType.External.equals(vm.getHypervisorType())) {
+            Long hostID = profile.getHostId();
+            if (hostID != null) {
+                HostVO host = _hostDao.findById(hostID);
+                HashMap<String, String> accessDetails = new HashMap<>();
+                loadExternalHostAccessDetails(host, accessDetails);
+                loadExternalInstanceDetails(vm.getId(), accessDetails);
+
+                stpCmd.setDetails(accessDetails);
+            }
+        }


can this be a method too?

DaanHoogland · 2024-10-01T08:57:03Z

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

+        if (HypervisorType.External.equals(vm.getHypervisorType())) {
+            Long hostID = profile.getHostId();
+            HostVO host = _hostDao.findById(hostID);
+
+            HashMap<String, String> accessDetails = new HashMap<>();
+            loadExternalHostAccessDetails(host, accessDetails);
+            loadExternalInstanceDetails(vm.getId(), accessDetails);
+
+            stop.setDetails(accessDetails);
+        }


another method? maybe even unify with the one at line 1910-1920.

rohityadavcloud · 2024-11-21T16:05:38Z

@blueorangutan package

blueorangutan · 2024-11-21T16:08:03Z

@rohityadavcloud a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-11-21T17:11:11Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11592

BryanMLima · 2024-11-29T19:55:04Z

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

@@ -323,6 +326,8 @@ public class VirtualMachineManagerImpl extends ManagerBase implements VirtualMac
    @Inject
    private HostDao _hostDao;
    @Inject
+    private HostDetailsDao _hostDetailsDao;


Suggested change

private HostDetailsDao _hostDetailsDao;

private HostDetailsDao hostDetailsDao;

BryanMLima · 2024-11-29T19:55:13Z

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

@@ -405,6 +410,8 @@ public class VirtualMachineManagerImpl extends ManagerBase implements VirtualMac
    @Inject
    private DomainDao domainDao;
    @Inject
+    public NetworkService _networkService;


Suggested change

public NetworkService _networkService;

public NetworkService networkService;

BryanMLima · 2024-11-29T20:00:05Z

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

+
+                        NicTO[] nics = vmTO.getNics();
+                        for (NicTO nic : nics) {
+                            if (nic.isDefaultNic()) {


Could invert the condition here to decrease indentation.

BryanMLima · 2024-11-29T20:03:24Z

...hestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java

@@ -285,6 +295,8 @@ public class NetworkOrchestrator extends ManagerBase implements NetworkOrchestra
    @Inject
    UserVmDao _userVmDao;
    @Inject
+    UserVmDetailsDao _userVmDetailsDao;


Suggested change

UserVmDetailsDao _userVmDetailsDao;

UserVmDetailsDao userVmDetailsDao;

BryanMLima · 2024-11-29T20:03:33Z

...hestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java

@@ -358,6 +370,8 @@ public class NetworkOrchestrator extends ManagerBase implements NetworkOrchestra
    private ASNumberDao asNumberDao;
    @Inject
    private BGPService bgpService;
+    @Inject
+    private HypervisorGuruManager _hvGuruMgr;


Suggested change

private HypervisorGuruManager _hvGuruMgr;

private HypervisorGuruManager hvGuruMgr;

BryanMLima · 2024-12-02T17:00:55Z

server/src/main/java/com/cloud/network/guru/GuestNetworkGuru.java

+    private AgentManager _agentMgr;
+    @Inject
+    private UserVmDetailsDao userVmDetailsDao;


Are these necessary? They are not used in this class.

BryanMLima · 2024-12-02T17:02:13Z

server/src/main/java/com/cloud/network/router/NetworkHelperImpl.java

-            if (dest.getCluster().getHypervisorType() == HypervisorType.Ovm) {
-                hypervisors.add(getClusterToStartDomainRouterForOvm(dest.getCluster().getPodId()));
+            HypervisorType destClusterHypType = dest.getCluster().getHypervisorType();
+            Set<HypervisorType> hypervisorsTypesToCheck = Set.of(HypervisorType.Ovm, HypervisorType.BareMetal, HypervisorType.External);


Could move this to this class variable and use it in line 659 as well.

BryanMLima · 2024-12-02T17:36:18Z

server/src/main/java/com/cloud/resource/DiscovererBase.java

@@ -40,6 +41,8 @@ public abstract class DiscovererBase extends AdapterBase implements Discoverer {
    @Inject
    protected ClusterDao _clusterDao;
    @Inject
+    protected ClusterDetailsDao _clusterDetailsDao;


Could you remove the _?

BryanMLima · 2024-12-02T17:42:08Z

ui/public/locales/en.json

@@ -2048,6 +2052,7 @@
 "label.servicelist": "Services",
 "label.serviceofferingid": "Compute offering",
 "label.serviceofferingname": "Compute offering",
+"label.serviceofferingdetails": "Details",


There is already the label label.details, couldn't you use it?

BryanMLima · 2024-12-02T17:42:41Z

ui/src/components/view/DetailSettings.vue

@@ -240,6 +238,7 @@ export default {
    },
    onAddInputChange (val, obj) {
      this.error = false
+      console.log(val)


Leftover from debugging?

Suggested change

console.log(val)

harikrishna-patnala · 2024-12-03T04:25:03Z

@DaanHoogland I see many other custom detail parameters in a few other APIs, such as vnfdetails, domaindetails, accountdetails, and a few more.

In this case, I would like to keep this as a separate parameter because these are the only details that are important if the hypervisor type is External. The other parameters are just meant to fit into CloudStack's workflow. The core purpose of this feature is to send these external details to the external provisioner.

github-actions · 2024-12-03T08:52:47Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

github-actions · 2024-12-03T11:37:41Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

harikrishna-patnala · 2025-04-29T23:06:04Z

@blueorangutan package

blueorangutan · 2025-04-29T23:08:03Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-04-30T00:37:14Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13218

github-actions · 2025-05-02T01:39:18Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

boring-cyborg bot added component:api component:build component:compute component:orchestration distro:ubuntu labels Oct 1, 2024

harikrishna-patnala added this to the 4.21.0.0 milestone Oct 1, 2024

apache deleted a comment from blueorangutan Oct 1, 2024

github-actions bot added status:has-conflicts and removed status:has-conflicts labels Oct 10, 2024

JoaoJandre requested review from JoaoJandre, GutoVeronezi and BryanMLima October 17, 2024 19:57

DaanHoogland reviewed Nov 8, 2024

View reviewed changes

sureshanaparti self-assigned this Nov 13, 2024

BryanMLima reviewed Dec 2, 2024

View reviewed changes

github-actions bot added the status:has-conflicts label Dec 3, 2024

harikrishna-patnala mentioned this pull request Dec 13, 2024

Could we integrate Hyper-v with CloudStack - Windows Server 2016 #10054

Open

harikrishna-patnala mentioned this pull request Feb 14, 2025

Question on modern Windows hypervisors and windows agent versus external framework. #10361

Closed

harikrishna-patnala and others added 23 commits April 30, 2025 04:35

Added since parameter

7703fcc

fix logger

7fe1203

Fix tests

f78728d

License check

842e542

Rename Folder

94fd59b

recent commit for proxmax, I'll have edit this commit afterwards

7e07ca3

Merge this into FR04

8f670b6

working env

c9c0da0

Extension framework

12611a5

Listing API

c1db7a1

Renames and adding path

ad63bb5

New changes

dc97dff

Fix Map and String

ca30937

License

6dff3ea

Unit test fix

dc2d9f8

Lint error

6b2b7e5

gen doc issue

93e18fb

Fix sql

da89169

import issue

4e1622e

Script Fixes

daa629b

Lint error

5daa1a0

response added

1db4a99

Fix restart MS issue and method mappings in provisioner.sh

755a5a7

harikrishna-patnala force-pushed the ExternalDeploymentIntegration branch from b03a8d8 to 755a5a7 Compare April 29, 2025 23:05

github-actions bot removed the status:has-conflicts label Apr 29, 2025

github-actions bot added the status:has-conflicts label May 2, 2025

	private Map<String, String> _details;
	private Map<String, String> details;

	logger.debug(String.format("%s has format [%s]. Skipping ROOT volume [%s] allocation.", template.toString(), template.getFormat(), rootVolumeName));
	logger.debug("{} has format [{}]. Skipping ROOT volume [{}] allocation.", template.toString(), template.getFormat(), rootVolumeName);

	private HostDetailsDao _hostDetailsDao;
	private HostDetailsDao hostDetailsDao;

	public NetworkService _networkService;
	public NetworkService networkService;

	UserVmDetailsDao _userVmDetailsDao;
	UserVmDetailsDao userVmDetailsDao;

	private HypervisorGuruManager _hvGuruMgr;
	private HypervisorGuruManager hvGuruMgr;

Extensions Framework & Orchestrate Anything #9752

Are you sure you want to change the base?

Extensions Framework & Orchestrate Anything #9752

Conversation

harikrishna-patnala commented Oct 1, 2024 • edited Loading

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

codecov bot commented Oct 1, 2024 • edited Loading

Codecov Report

github-actions bot commented Oct 10, 2024

harikrishna-patnala commented Nov 8, 2024

blueorangutan commented Nov 8, 2024

blueorangutan commented Nov 8, 2024

DaanHoogland left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rohityadavcloud commented Nov 21, 2024

blueorangutan commented Nov 21, 2024

blueorangutan commented Nov 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harikrishna-patnala commented Dec 3, 2024

github-actions bot commented Dec 3, 2024

github-actions bot commented Dec 3, 2024

harikrishna-patnala commented Apr 29, 2025

blueorangutan commented Apr 29, 2025

blueorangutan commented Apr 30, 2025

github-actions bot commented May 2, 2025

harikrishna-patnala commented Oct 1, 2024 •

edited

Loading

codecov bot commented Oct 1, 2024 •

edited

Loading