Extensions Framework & Orchestrate Anything #9752

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

Attention: Patch coverage is 44.09581% with 2334 lines in your changes missing coverage. Please review.

Project coverage is 16.81%. Comparing base (3e3a0c0) to head (3c5a1f0).

Files with missing lines	Patch %	Lines
...work/extensions/manager/ExtensionsManagerImpl.java	59.23%	263 Missing and 154 partials ⚠️
...al/provisioner/ExternalPathPayloadProvisioner.java	60.03%	164 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.29%	51 Missing and 27 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 91 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9752      +/-   ##
============================================
+ Coverage     16.58%   16.81%   +0.23%     
- Complexity    13989    14403     +414     
============================================
  Files          5743     5806      +63     
  Lines        510706   515397    +4691     
  Branches      62119    62700     +581     
============================================
+ Hits          84689    86657    +1968     
- Misses       416543   418941    +2398     
- Partials       9474     9799     +325

Flag	Coverage Δ
uitests	`3.84% <ø> (-0.06%)`	⬇️
unittests	`17.73% <44.09%> (+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-07-02T20:35:37Z

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

Test	Result	Time (s)	Test File

abh1sar · 2025-07-03T02:45:56Z

@blueorangutan package

blueorangutan · 2025-07-03T02:48:03Z

@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-03T04:34:25Z

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

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

shwstppr · 2025-07-03T12:20:54Z

@blueorangutan package

blueorangutan · 2025-07-03T12:22: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.

abh1sar · 2025-07-03T13:27:37Z

@blueorangutan package

blueorangutan · 2025-07-03T13:28:03Z

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

DaanHoogland

@shwstppr I won’t be getting through this today but have some questions so far. I will continue later.

DaanHoogland · 2025-07-03T11:56:18Z

api/src/main/java/com/cloud/agent/api/Command.java

@@ -60,6 +61,7 @@ public enum State {
    private int wait;  //in second
    private boolean bypassHostMaintenance = false;
    private transient long requestSequence = 0L;
+    protected Map<String, Map<String, String>> externalDetails;


Is there a reason these should be called externalDetails, and not just details?

@DaanHoogland yes, externalDetails is more appropriate here as these are filtered details and used by extensions specific code. Many of the resources already have a details property and would be a bit confusing.
Also, Answer class that extends Command has a member named details

DaanHoogland · 2025-07-03T11:57:20Z

api/src/main/java/com/cloud/network/NetworkService.java

@@ -270,4 +270,6 @@ Network createPrivateNetwork(String networkName, String displayText, long physic
    List<InternalLoadBalancerElementService> getInternalLoadBalancerElements();

    boolean handleCksIsoOnNetworkVirtualRouter(Long virtualRouterId, boolean mount) throws ResourceUnavailableException;
+
+    String getNsxSegmentId(long domainId, long accountId, long zoneId, Long vpcId, long networkId);


is this a rebase issue? seems unrelated.

Maybe @harikrishna-patnala can give some insight on this. Probably idea is to get a VLAN ID equivalent identifier from SDNs and it should come from that SDN plugin instead defining it in NetworkService. I'll have a look

Its related to the PR only but specific to Nsx. yes, if we can move it to NetworkService, it will be good. thanks @shwstppr

blueorangutan · 2025-07-03T13:53:27Z

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

blueorangutan · 2025-07-03T14:37:18Z

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

abh1sar · 2025-07-04T03:50:15Z

@blueorangutan package

blueorangutan · 2025-07-04T03:52: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-04T05:11:17Z

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

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

shwstppr · 2025-07-04T07:50:49Z

@blueorangutan package

blueorangutan · 2025-07-04T07:52: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-07-04T09:25:35Z

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

sureshanaparti · 2025-07-04T10:53:20Z

@blueorangutan package

blueorangutan · 2025-07-04T10:54:03Z

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

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

shwstppr added 2 commits July 3, 2025 11:52

refactor error message

b14fe74

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

ui: fix serach view

287fe8b

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

shwstppr requested review from weizhouapache and DaanHoogland July 3, 2025 07:57

Fix debian packaging for built-in extensions

85ed77b

DaanHoogland reviewed Jul 3, 2025

View reviewed changes

abh1sar added 2 commits July 4, 2025 09:17

hyperv misc fixes

5018ddc

Add extension files to debian .install

b879183

shwstppr added 4 commits July 4, 2025 12:54

ui: hide delete on builtin extension

017a003

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

improvements for extension alert

e51e340

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

delete payload files for successful trivial actions

31e35ff

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

Merge branch 'main' into ExternalDeploymentIntegration

3c5a1f0

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

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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 Jul 2, 2025

Uh oh!

abh1sar commented Jul 3, 2025

Uh oh!

blueorangutan commented Jul 3, 2025

Uh oh!

blueorangutan commented Jul 3, 2025

Uh oh!

shwstppr commented Jul 3, 2025

Uh oh!

blueorangutan commented Jul 3, 2025

Uh oh!

abh1sar commented Jul 3, 2025

Uh oh!

blueorangutan commented Jul 3, 2025

Uh oh!

DaanHoogland left a comment

harikrishna-patnala commented Oct 1, 2024 •

edited

Loading

codecov bot commented Oct 1, 2024 •

edited

Loading