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/CloudStack+Extensions+Framework+-++Orchestartor+or+External+Deployment+Integration

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

Project coverage is 16.80%. Comparing base (0bd35a5) to head (39c8b16).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...work/extensions/manager/ExtensionsManagerImpl.java	59.68%	257 Missing and 151 partials ⚠️
...visioner/ExternalEntryPointPayloadProvisioner.java	59.75%	161 Missing and 37 partials ⚠️
...hypervisor/external/resource/ExternalResource.java	9.75%	184 Missing and 1 partial ⚠️
...udstack/agent/manager/ExternalTemplateAdapter.java	21.62%	112 Missing and 4 partials ⚠️
.../external/discoverer/ExternalServerDiscoverer.java	38.15%	90 Missing and 4 partials ⚠️
...loudstack/agent/manager/ExternalServerPlanner.java	0.00%	80 Missing ⚠️
...n/java/com/cloud/vm/VirtualMachineManagerImpl.java	53.41%	51 Missing and 24 partials ⚠️
...n/java/com/cloud/resource/ResourceManagerImpl.java	0.00%	74 Missing ⚠️
...che/cloudstack/api/response/ExtensionResponse.java	0.00%	73 Missing ⚠️
...ck/api/response/ExtensionCustomActionResponse.java	0.00%	72 Missing ⚠️
... and 92 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9752      +/-   ##
============================================
+ Coverage     16.57%   16.80%   +0.22%     
- Complexity    13968    14375     +407     
============================================
  Files          5743     5806      +63     
  Lines        510470   515178    +4708     
  Branches      62074    62649     +575     
============================================
+ Hits          84615    86559    +1944     
- Misses       416393   418838    +2445     
- Partials       9462     9781     +319

Flag	Coverage Δ
uitests	`3.84% <ø> (-0.06%)`	⬇️
unittests	`17.72% <43.82%> (+0.25%)`	⬆️

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.

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

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...

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

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.

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

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;

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

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

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

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.

blueorangutan · 2025-06-23T18:24: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-23T19:33:50Z

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

…ult.

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

shwstppr · 2025-06-24T08:24:28Z

@blueorangutan package

blueorangutan · 2025-06-24T08:26:05Z

@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-24T09:55:44Z

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

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

…egration

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

…les.

abh1sar · 2025-06-25T11:54:30Z

@blueorangutan package

blueorangutan · 2025-06-25T11:56:05Z

@abh1sar 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-25T13:07:58Z

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

shwstppr · 2025-06-25T18:00:02Z

@blueorangutan test

blueorangutan · 2025-06-25T18:02: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]>

shwstppr · 2025-06-27T10:20:50Z

@blueorangutan package

blueorangutan · 2025-06-27T10:22:03Z

@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.

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

blueorangutan · 2025-06-27T11:59:02Z

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

shwstppr · 2025-06-27T19:19:07Z

@blueorangutan test

blueorangutan · 2025-06-27T19:20:04Z

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

blueorangutan · 2025-06-28T17:57:27Z

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

Test	Result	Time (s)	Test File
test_01_extension_vm_lifecycle	`Error`	3604.80	test_extension_custom.py
test_02_run_custom_action	`Error`	3664.48	test_extension_custom.py
test_03_run_invalid_custom_action	`Error`	3634.78	test_extension_custom.py
ContextSuite context=TestExtensions>:teardown	`Error`	3636.08	test_extension_custom.py
test_09_extension_deploy_vm	`Error`	3609.01	test_extension_lifecycle.py
test_09_extension_deploy_vm	`Error`	3609.26	test_extension_lifecycle.py
test_oobm_issue_power_cycle	`Error`	2.33	test_outofbandmanagement_nestedplugin.py
test_oobm_issue_power_off	`Error`	2.30	test_outofbandmanagement_nestedplugin.py
test_oobm_issue_power_on	`Error`	1.29	test_outofbandmanagement_nestedplugin.py
test_oobm_issue_power_reset	`Error`	2.35	test_outofbandmanagement_nestedplugin.py
test_oobm_issue_power_soft	`Error`	2.33	test_outofbandmanagement_nestedplugin.py
test_oobm_issue_power_status	`Error`	2.34	test_outofbandmanagement_nestedplugin.py
test_02_L2_persistent_network	`Failure`	102.63	test_persistent_network.py
test_03_deploy_and_destroy_VM_and_verify_network_resources_persist	`Failure`	150.19	test_persistent_network.py
test_01_webhook_deliveries	`Failure`	10.49	test_webhook_delivery.py

blueorangutan · 2025-06-28T21:09:14Z

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

Test	Result	Time (s)	Test File
test_01_extension_vm_lifecycle	`Error`	3604.02	test_extension_custom.py
test_02_run_custom_action	`Error`	3665.48	test_extension_custom.py
test_03_run_invalid_custom_action	`Error`	3666.17	test_extension_custom.py
ContextSuite context=TestExtensions>:teardown	`Error`	3667.48	test_extension_custom.py
test_09_extension_deploy_vm	`Error`	3670.91	test_extension_lifecycle.py
test_09_extension_deploy_vm	`Error`	3671.09	test_extension_lifecycle.py
test_01_non_strict_host_anti_affinity	`Failure`	139.36	test_nonstrict_affinity_group.py
test_02_non_strict_host_affinity	`Error`	84.80	test_nonstrict_affinity_group.py
test_02_L2_persistent_network	`Failure`	101.84	test_persistent_network.py
test_03_deploy_and_destroy_VM_and_verify_network_resources_persist	`Failure`	143.78	test_persistent_network.py
test_01_sys_vm_start	`Failure`	0.14	test_secondary_storage.py

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

abh1sar and others added 6 commits June 24, 2025 10:50

Remove prepare from proxmox and hyperv. Builtin exts disabled by defa…

f3b93e6

…ult.

Added ExtensionCustomActionTest

54e844c

refactor to add more tests

f7d0fe8

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

use InvalidParameterValueException, fix integration test failure

af19e3c

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

list all for sync check

35f779b

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

minor fixes

2951a67

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

shwstppr and others added 4 commits June 24, 2025 16:39

ui fixes

be99173

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

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

cace6cd

…egration

show run action result

67377c4

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

extensions directory to be owned by cloud:cloud. Also added debian ru…

10a90e8

…les.

shwstppr added 2 commits June 26, 2025 15:41

prepare changes

2abe27a

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

action name check

39c8b16

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

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

feature: extensions

d6e7c67

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

	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!

Uh oh!

DaanHoogland Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DaanHoogland Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DaanHoogland Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DaanHoogland Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

blueorangutan commented Jun 23, 2025

Uh oh!

blueorangutan commented Jun 23, 2025

Uh oh!

shwstppr commented Jun 24, 2025

Uh oh!

blueorangutan commented Jun 24, 2025

Uh oh!

blueorangutan commented Jun 24, 2025

Uh oh!

abh1sar commented Jun 25, 2025

Uh oh!

blueorangutan commented Jun 25, 2025

Uh oh!

harikrishna-patnala commented Oct 1, 2024 •

edited by shwstppr

Loading

codecov bot commented Oct 1, 2024 •

edited

Loading