Extensions Framework & Orchestrate Anything by harikrishna-patnala · Pull Request #9752 · apache/cloudstack

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

Description

The Extensions Framework in Apache CloudStack is designed to provide a flexible and standardised mechanism for integrating external systems and custom workflows into CloudStack’s orchestration process. By defining structured hook points during key operations—such as virtual machine deployment, resource preparation, and lifecycle events—the framework allows administrators and developers to extend CloudStack’s behaviour without modifying its core codebase. This design specification outlines the architecture, payload structure, execution flow, and integration guidelines necessary to implement, register, and manage extensions effectively within the CloudStack environment.

For the initial implementation of the Extensions Framework, only Orchestrator-type extensions will be supported. These extensions enable seamless integration of external VM deployment and lifecycle management systems into CloudStack

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

Screenshots (if appropriate):

Extensions List:

Create Extension Form:

Extension View:

Add Custom Action Form:

Run Custom Action Form:

Run Action:

Built-in Extensions:

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

Codecov Report

❌ Patch coverage is 44.76840% with 2349 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.00%. Comparing base (217ff27) to head (d673742).
⚠️ Report is 115 commits behind head on main.

Files with missing lines	Patch %	Lines
...work/extensions/manager/ExtensionsManagerImpl.java	59.23%	265 Missing and 159 partials ⚠️
...al/provisioner/ExternalPathPayloadProvisioner.java	62.59%	161 Missing and 35 partials ⚠️
...hypervisor/external/resource/ExternalResource.java	9.70%	184 Missing and 2 partials ⚠️
...udstack/agent/manager/ExternalTemplateAdapter.java	21.62%	112 Missing and 4 partials ⚠️
.../external/discoverer/ExternalServerDiscoverer.java	37.10%	96 Missing and 4 partials ⚠️
...loudstack/agent/manager/ExternalServerPlanner.java	0.00%	84 Missing ⚠️
...n/java/com/cloud/vm/VirtualMachineManagerImpl.java	52.79%	50 Missing and 26 partials ⚠️
...che/cloudstack/api/response/ExtensionResponse.java	0.00%	73 Missing ⚠️
...ck/api/response/ExtensionCustomActionResponse.java	0.00%	72 Missing ⚠️
...n/java/com/cloud/resource/ResourceManagerImpl.java	0.00%	66 Missing ⚠️
... and 89 more

Additional details and impacted files

@@ Coverage Diff @@## main #9752 +/- ##
============================================
+ Coverage 16.76% 17.00% +0.23% - Complexity 14281 14718 +437 
============================================
Files 5767 5832 +65 Lines 512657 517561 +4904 Branches 62359 62982 +623 ============================================
+ Hits 85941 87988 +2047 - Misses 417118 419640 +2522 - Partials 9598 9933 +335

Flag	Coverage Δ
uitests	`3.82% <ø> (-0.04%)`	⬇️
unittests	`17.95% <44.76%> (+0.26%)`	⬆️

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:37:08Z

 @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:41:48Z

 }
 }
+
+ detailsMap.putAll(getExternalDetails());


see? these are just details.

yadvr · 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

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.

abh1sar · 2025-07-26T05:02:27Z

@blueorangutan package

blueorangutan · 2025-07-26T05:04:04Z

@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-07-26T06:22:58Z

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

github-actions · 2025-07-26T08:29:49Z

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

…ntegration

sureshanaparti · 2025-07-26T08:42:08Z

@blueorangutan package

blueorangutan · 2025-07-26T08:44:04Z

@sureshanaparti 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-07-26T09:33:34Z

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

Test	Result	Time (s)	Test File
test_08_extension_sync	`Failure`	317.43	test_extension_lifecycle.py
test_09_extension_deploy_vm	`Error`	12.16	test_extension_lifecycle.py
test_09_extension_deploy_vm	`Error`	12.16	test_extension_lifecycle.py
test_list_zones_metrics	`Error`	0.28	test_metrics_api.py
test_02_L2_persistent_network	`Failure`	102.88	test_persistent_network.py
test_03_deploy_and_destroy_VM_and_verify_network_resources_persist	`Failure`	151.52	test_persistent_network.py

blueorangutan · 2025-07-26T09:47:33Z

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

Test	Result	Time (s)	Test File
test_list_zones_metrics	`Error`	0.22	test_metrics_api.py

blueorangutan · 2025-07-26T10:35:29Z

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

sureshanaparti · 2025-07-26T12:09:26Z

@blueorangutan test

blueorangutan · 2025-07-26T12:10:03Z

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

blueorangutan · 2025-07-26T15:57:23Z

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

Test	Result	Time (s)	Test File
test_list_zones_metrics	`Error`	0.22	test_metrics_api.py
test_01_vpn_usage	`Error`	1.11	test_usage.py

sureshanaparti · 2025-07-26T19:46:05Z

@blueorangutan test ubuntu24 kvm-ubuntu24

blueorangutan · 2025-07-26T19:48:03Z

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

sureshanaparti · 2025-07-26T21:57:31Z

@blueorangutan test ol8 vmware-70u3

blueorangutan · 2025-07-26T21:58:03Z

@sureshanaparti a [SL] Trillian-Jenkins test job (ol8 mgmt + vmware-70u3) has been kicked to run smoke tests

blueorangutan · 2025-07-27T01:20:06Z

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

Test	Result	Time (s)	Test File
test_list_zones_metrics	`Error`	0.20	test_metrics_api.py

blueorangutan · 2025-07-27T04:29:05Z

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

Test	Result	Time (s)	Test File

blueorangutan · 2025-07-27T13:21:34Z

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

Test	Result	Time (s)	Test File

blueorangutan · 2025-07-27T20:19:52Z

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

Test	Result	Time (s)	Test File
test_01_internallb_roundrobin_1VPC_3VM_HTTP_port80	`Error`	654.05	test_internal_lb.py
test_02_internallb_roundrobin_1RVPC_3VM_HTTP_port80	`Error`	574.28	test_internal_lb.py
test_02_internallb_roundrobin_1RVPC_3VM_HTTP_port80	`Error`	574.30	test_internal_lb.py
ContextSuite context=TestIpv4Routing>:setup	`Error`	0.00	test_ipv4_routing.py
test_08_upgrade_kubernetes_ha_cluster	`Failure`	202.51	test_kubernetes_clusters.py
test_01_vpn_usage	`Error`	1.10	test_usage.py

shwstppr · 2025-07-28T05:03:13Z

Similar VMware failures here, #10149 (comment)
cc @sureshanaparti

sureshanaparti · 2025-07-28T05:09:09Z

Merging based on review & tests.

blueorangutan · 2025-07-28T05:52:19Z

[SF] Trillian test result (tid-13900)
Environment: vmware-70u3 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 219439 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr9752-t13900-vmware-70u3.zip
Smoke tests completed. 130 look OK, 8 have errors, 7 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_3d_gpu_support	`Error`	314.31	test_deploy_vgpu_enabled_vm.py
test_list_zones_metrics	`Error`	0.21	test_metrics_api.py
test_01_vpn_usage	`Error`	1.11	test_usage.py
test_01_deploy_vm_on_specific_host	`Error`	4.44	test_vm_deployment_planner.py
test_02_deploy_vm_on_specific_cluster	`Error`	1802.49	test_vm_deployment_planner.py
test_03_deploy_vm_on_specific_pod	`Error`	1.46	test_vm_deployment_planner.py
test_04_deploy_vm_on_host_override_pod_and_cluster	`Error`	2.45	test_vm_deployment_planner.py
test_05_deploy_vm_on_cluster_override_pod	`Error`	1.33	test_vm_deployment_planner.py
test_08_migrate_vm	`Error`	1858.50	test_vm_life_cycle.py
test_09_expunge_vm	`Failure`	424.69	test_vm_life_cycle.py
test_13_destroy_and_expunge_vm	`Error`	3825.59	test_vm_life_cycle.py
test_01_migrate_vm_strict_tags_success	`Error`	0.66	test_vm_strict_host_tags.py
test_02_migrate_vm_strict_tags_failure	`Error`	0.62	test_vm_strict_host_tags.py
test_01_restore_vm_strict_tags_success	`Error`	0.90	test_vm_strict_host_tags.py
test_02_restore_vm_strict_tags_failure	`Error`	0.64	test_vm_strict_host_tags.py
test_01_scale_vm_strict_tags_success	`Error`	0.67	test_vm_strict_host_tags.py
test_02_scale_vm_strict_tags_failure	`Error`	0.98	test_vm_strict_host_tags.py
test_01_deploy_vm_on_specific_host_without_strict_tags	`Error`	0.67	test_vm_strict_host_tags.py
test_02_deploy_vm_on_any_host_without_strict_tags	`Error`	0.62	test_vm_strict_host_tags.py
test_03_deploy_vm_on_specific_host_with_strict_tags_success	`Error`	0.67	test_vm_strict_host_tags.py
test_04_deploy_vm_on_any_host_with_strict_tags_success	`Error`	0.69	test_vm_strict_host_tags.py
test_05_deploy_vm_on_specific_host_with_strict_tags_failure	`Failure`	0.63	test_vm_strict_host_tags.py
test_06_deploy_vm_on_any_host_with_strict_tags_failure	`Failure`	0.57	test_vm_strict_host_tags.py
ContextSuite context=TestCreateVolume>:teardown	`Error`	2225.97	test_volumes.py
test_01_verify_ipv6_vpc	`Error`	1807.61	test_vpc_ipv6.py
test_01_verify_ipv6_vpc	`Error`	1807.69	test_vpc_ipv6.py
all_test_vpc_redundant	`Skipped`	---	test_vpc_redundant.py
all_test_vpc_router_nics	`Skipped`	---	test_vpc_router_nics.py
all_test_vpc_vpn	`Skipped`	---	test_vpc_vpn.py
all_test_webhook_delivery	`Skipped`	---	test_webhook_delivery.py
all_test_webhook_lifecycle	`Skipped`	---	test_webhook_lifecycle.py
all_test_host_maintenance	`Skipped`	---	test_host_maintenance.py
all_test_hostha_kvm	`Skipped`	---	test_hostha_kvm.py

iamfoolberg · 2025-08-19T13:00:02Z

Unable to list running VMs from PVE cluster in CloudStack

Description:
I've successfully added a Proxmox VE (PVE) cluster and hosts to CloudStack following:

The wiki guide: CloudStack Extensions Framework{target="_blank"}
The official documentation: Troubleshooting Extensions{target="_blank"}

Current behavior:

PVE cluster and hosts are successfully added
Cannot list/display the running VMs from the PVE environment

Questions:

Is libvirt installation required for this integration?
Are there any additional configuration steps I might have missed?
Are there specific logs I should check to diagnose this issue?

Environment:

CloudStack version: 4.21
Proxmox VE version: 8.4.1

Thanks.

DaanHoogland · 2025-08-20T07:23:23Z

@iamfoolberg , as this item is closed, I think you better start a Q&A discussion item referring this ticket.
regards,

boring-cyborgBot 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-actionsBot added status:has-conflicts and removed status:has-conflicts labels Oct 10, 2024

JoaoJandre requested review from BryanMLima, GutoVeronezi and JoaoJandre 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-actionsBot 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

Merge remote-tracking branch 'upstream/main' into ExternalDeploymentI…
d673742
…ntegration

yadvr mentioned this pull request Aug 1, 2025
Proxmox support #11367
Closed

sureshanaparti mentioned this pull request Oct 9, 2025
UI: Fix for cluster addition in VMware #11812
Merged
14 tasks

shwstppr mentioned this pull request Oct 10, 2025
ui: fix add host form state on submit #11815
Merged
14 tasks

sureshanaparti mentioned this pull request Jan 29, 2026
Alert type fixes and some code improvements #12546
Open
14 tasks

Uh oh!

Conversation

harikrishna-patnala commented Oct 1, 2024• edited 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

Screenshots (if appropriate):

Uh oh!

codecovBot 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-actionsBot 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!

DaanHooglandOct 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DaanHooglandOct 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yadvr 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-actionsBot commented Dec 3, 2024

Uh oh!

github-actionsBot commented Dec 3, 2024

Uh oh!

abh1sar commented Jul 26, 2025

Uh oh!

blueorangutan commented Jul 26, 2025

Uh oh!

blueorangutan commented Jul 26, 2025

Uh oh!

github-actionsBot commented Jul 26, 2025

Uh oh!

sureshanaparti commented Jul 26, 2025

Uh oh!

blueorangutan commented Jul 26, 2025

Uh oh!

blueorangutan commented Jul 26, 2025

Uh oh!

blueorangutan commented Jul 26, 2025

Uh oh!

blueorangutan commented Jul 26, 2025

Uh oh!

sureshanaparti commented Jul 26, 2025

harikrishna-patnala commented Oct 1, 2024•
edited
Loading

codecovBot commented Oct 1, 2024•
edited
Loading