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

Documentation PR: apache/cloudstack-documentation#523

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 5.27845% with 1956 lines in your changes missing coverage. Please review.

Project coverage is 16.50%. Comparing base (5b7c3b4) to head (85101ac).

Files with missing lines	Patch %	Lines
...visioner/ExternalEntryPointPayloadProvisioner.java	0.00%	371 Missing ⚠️
...he/cloudstack/extension/ExtensionCustomAction.java	0.00%	222 Missing ⚠️
...n/java/com/cloud/vm/VirtualMachineManagerImpl.java	2.68%	143 Missing and 2 partials ⚠️
...hypervisor/external/resource/ExternalResource.java	0.00%	135 Missing ⚠️
...udstack/agent/manager/ExternalTemplateAdapter.java	0.00%	125 Missing ⚠️
.../external/discoverer/ExternalServerDiscoverer.java	0.00%	107 Missing ⚠️
...n/java/com/cloud/resource/ResourceManagerImpl.java	0.00%	74 Missing ⚠️
...loudstack/agent/manager/ExternalServerPlanner.java	0.00%	68 Missing ⚠️
...ck/api/response/ExtensionCustomActionResponse.java	0.00%	66 Missing ⚠️
...n/java/com/cloud/template/TemplateAdapterBase.java	43.37%	46 Missing and 1 partial ⚠️
... and 61 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9752      +/-   ##
============================================
- Coverage     16.57%   16.50%   -0.07%     
- Complexity    13967    13979      +12     
============================================
  Files          5743     5776      +33     
  Lines        510468   512985    +2517     
  Branches      62073    62446     +373     
============================================
+ Hits          84616    84688      +72     
- Misses       416390   418816    +2426     
- Partials       9462     9481      +19

Flag	Coverage Δ
uitests	`3.84% <ø> (-0.06%)`	⬇️
unittests	`17.41% <5.27%> (-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

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

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

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

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

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

ui/public/locales/en.json

ui/src/components/view/DetailSettings.vue

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.

Signed-off-by: Abhishek Kumar <[email protected]>

For apache/cloudstack#9752 Signed-off-by: Abhishek Kumar <[email protected]>

Signed-off-by: Abhishek Kumar <[email protected]>

…egration

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr · 2025-06-19T12:07:43Z

engine/schema/src/main/resources/META-INF/db/schema-42010to42100.sql

+        )
+        VALUES (
+            UUID(), ext_name, ext_desc, 'Orchestrator',
+            entry_point, 1, 0, 'Enabled', NOW(), NULL


@abh1sar should this be Disabled by default?

shwstppr · 2025-06-19T12:09:00Z

extensions/Proxmox/proxmox.sh

+generate_random_mac() {
+    hexchars="0123456789ABCDEF"
+    echo "52:54:00:$(for i in {1..3}; do echo -n ${hexchars:$(( RANDOM % 16 )):1}${hexchars:$(( RANDOM % 16 )):1}; [[ $i -lt 3 ]] && echo -n ':'; done)"
+}


@abh1sar we don't seem to be using prepare for proxmox, should we remove this?

shwstppr · 2025-06-19T12:10:09Z

extensions/Proxmox/proxmox.sh

+    parse_json "$1" || exit 1
+
+    local mac_address
+    mac_address=$(generate_random_mac)
+
+    local response
+    response=$(jq -n --arg mac "$mac_address" \
+        '{status: "success", mac_address: $mac}')
+
+    echo "$response"


since we are not using prepare maybe better to send empty response or remove prepare handling? @abh1sar

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr · 2025-06-19T15:12:28Z

@blueorangutan package

blueorangutan · 2025-06-19T15:14:04Z

@shwstppr 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-06-19T16:25:55Z

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

shwstppr · 2025-06-19T18:44:57Z

@blueorangutan test

blueorangutan · 2025-06-19T18:46:04Z

@shwstppr a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-06-19T19:33:24Z

[SF] Trillian Build Failed (tid-13575)

shwstppr · 2025-06-19T20:22:47Z

@blueorangutan test

blueorangutan · 2025-06-19T20:24:04Z

@shwstppr a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

Signed-off-by: Abhishek Kumar <[email protected]>

to TemplateAdapterBase Signed-off-by: Abhishek Kumar <[email protected]>

blueorangutan · 2025-06-20T13:09:00Z

[SF] Trillian test result (tid-13576)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 57360 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr9752-t13576-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

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

minor refactor

440aba0

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr added a commit to shapeblue/cloudstack-documentation that referenced this pull request Jun 19, 2025

feature: extensions

9efe56b

For apache/cloudstack#9752 Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr mentioned this pull request Jun 19, 2025

feature: extensions apache/cloudstack-documentation#523

Draft

shwstppr added 2 commits June 19, 2025 17:04

fixes

34691b2

Signed-off-by: Abhishek Kumar <[email protected]>

Merge remote-tracking branch 'apache/main' into ExternalDeploymentInt…

76b08a8

…egration

github-actions bot removed the status:has-conflicts label Jun 19, 2025

shwstppr added 2 commits June 19, 2025 17:28

refactor

9b1ca52

Signed-off-by: Abhishek Kumar <[email protected]>

fix merge issue

a46873d

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr reviewed Jun 19, 2025

View reviewed changes

build fix

a18682e

Signed-off-by: Abhishek Kumar <[email protected]>

abh1sar and others added 8 commits June 20, 2025 08:47

error handling and other improvements in proxmox.sh

7ab2dc9

enable destroy for external vms. get deployvm from vmto.

d205b84

insert parameters as HashMap into accessDetails in RunCustomAction

97c8d6f

refactor, remove todo

2590316

Signed-off-by: Abhishek Kumar <[email protected]>

refactor

840c1c1

Signed-off-by: Abhishek Kumar <[email protected]>

handle upload todo, move common methods from HypervisorTemplateAdapter

5836a2d

to TemplateAdapterBase Signed-off-by: Abhishek Kumar <[email protected]>

Add Proxmox custom actions

a11cdfb

fix pre-commit failure

cb38175

Error handling and custom actions for hyperv

85101ac

	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);

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 by shwstppr Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Uh oh!

codecov bot commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Oct 10, 2024

Uh oh!

harikrishna-patnala commented Nov 8, 2024

Uh oh!

blueorangutan commented Nov 8, 2024

Uh oh!

blueorangutan commented Nov 8, 2024

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rohityadavcloud commented Nov 21, 2024

Uh oh!

blueorangutan commented Nov 21, 2024

Uh oh!

blueorangutan commented Nov 21, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

harikrishna-patnala commented Dec 3, 2024

Uh oh!

github-actions bot commented Dec 3, 2024

Uh oh!

github-actions bot commented Dec 3, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shwstppr commented Jun 19, 2025

Uh oh!

blueorangutan commented Jun 19, 2025

Uh oh!

blueorangutan commented Jun 19, 2025

Uh oh!

harikrishna-patnala commented Oct 1, 2024 •

edited by shwstppr

Loading

codecov bot commented Oct 1, 2024 •

edited

Loading