[WIP] DNS provider framework - PowerDNS plugin by sudo87 · Pull Request #12737 · apache/cloudstack

sudo87 · 2026-03-03T11:49:04Z

Description

This PR introduces initial implementation for a plugin based DNS framework in Apache CloudStack. It enables both admin and end-users to manage DNS zones and record with external authoritative dns providers. PowerDNS is the first provider for initial implementation.

Github issue: #9958
Cwiki: https://cwiki.apache.org/confluence/display/CLOUDSTACK/DNS+Framework+and+Plugins

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

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

…teDnsServer

2. added relevant changes in dao and vo 3. worked on creatednszone, integration with mgr 4. powerdns create zone api call

1. creatednszone 2. listdnszone 3. updatednszone 4. deletednszone

1. Add dns server 2. create zone 3. add records 4. verify in powerdns 5. verify using dig

1. Registerdnsrecordforvm api 2. removednsrecordforvm api 3. cleanup; fixed license, dao logic

1. refactored client 2. added exceptions 3. enhanced updateZone 4. ownership check for deleteDnsServer

1. port for dns_server 2. remove hard coded localhost for server_id 3. resolve and store server id if not passed in the api request 4. restrict public dns_server for domain admins and admins

…n svc and handle dot version in client

…elete events 2. add dnsrecordurl in nic_details table 3. add dnsrecordurl in vm response

codecov · 2026-03-03T12:02:37Z

Codecov Report

❌ Patch coverage is 78.87500% with 507 lines in your changes missing coverage. Please review.
✅ Project coverage is 18.21%. Comparing base (82bfa9f) to head (f96d4cd).

Files with missing lines	Patch %	Lines
.../apache/cloudstack/dns/DnsProviderManagerImpl.java	81.33%	101 Missing and 44 partials ⚠️
...ava/org/apache/cloudstack/dns/DnsProviderUtil.java	62.50%	33 Missing and 12 partials ⚠️
...g/apache/cloudstack/dns/dao/DnsNicJoinDaoImpl.java	0.00%	45 Missing ⚠️
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	21.42%	43 Missing and 1 partial ⚠️
...apache/cloudstack/dns/powerdns/PowerDnsClient.java	83.12%	12 Missing and 28 partials ⚠️
...ava/org/apache/cloudstack/dns/vo/DnsNicJoinVO.java	0.00%	33 Missing ⚠️
...n/java/org/apache/cloudstack/dns/vo/DnsZoneVO.java	53.57%	24 Missing and 2 partials ⚠️
...pache/cloudstack/api/response/DnsZoneResponse.java	55.81%	18 Missing and 1 partial ⚠️
...che/cloudstack/api/response/DnsServerResponse.java	69.23%	11 Missing and 1 partial ⚠️
.../main/java/com/cloud/vm/dao/NicDetailsDaoImpl.java	0.00%	12 Missing ⚠️
... and 32 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12737      +/-   ##
============================================
+ Coverage     17.95%   18.21%   +0.25%     
- Complexity    16522    16883     +361     
============================================
  Files          6022     6076      +54     
  Lines        541387   544147    +2760     
  Branches      66346    66674     +328     
============================================
+ Hits          97211    99102    +1891     
- Misses       433210   433975     +765     
- Partials      10966    11070     +104

Flag	Coverage Δ
uitests	`3.49% <ø> (-0.04%)`	⬇️
unittests	`19.39% <78.87%> (+0.28%)`	⬆️

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 · 2026-03-09T16:13:30Z

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

sudo87 · 2026-04-06T13:54:40Z

@blueorangutan package

blueorangutan · 2026-04-06T13:56:07Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

weizhouapache · 2026-04-08T06:47:08Z

@blueorangutan package

blueorangutan · 2026-04-08T06:48:04Z

@weizhouapache a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-08T07:36:16Z

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

weizhouapache

technically it looks fine overall.

left some minor comments

weizhouapache · 2026-04-08T10:03:16Z

+
+    @Encrypt
+    @Column(name = "api_key")
+    private String apiKey;


the API parameter is credentials, but database column name is api_key

what if there are multiple secrets ? for example both credentials and apikey (just an example) ?
can they be stored in the same column with a separator ?

There is another param "dns_username" (might rename) which could be used with other providers following apiKey : apiSecret kind of credential.

sudo87 · 2026-04-10T02:38:11Z

@blueorangutan package

blueorangutan · 2026-04-10T02:40:04Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-10T03:32:54Z

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

1. handle vm hostname change for dns registration 2. generate event for dns name collision 3. remove dns record lifecycle subscriber

sudo87 · 2026-04-10T10:07:17Z

@blueorangutan package

blueorangutan · 2026-04-10T10:08:04Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-10T10:59:41Z

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

sudo87 · 2026-04-13T06:45:08Z

@blueorangutan package

blueorangutan · 2026-04-13T06:46:04Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-13T07:33:43Z

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

sudo87 · 2026-04-13T14:24:24Z

@blueorangutan package

blueorangutan · 2026-04-13T14:26:04Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-13T15:09:56Z

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

github-actions · 2026-04-14T17:32:21Z

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

sudo87 added 22 commits February 9, 2026 10:52

wip: dns provider framework

7b9fc0e

add db schema, vo and dao classes

b2d597c

add powerdns module in plugins

6ef7f9b

Changes done to AddDnsServer, ListDnsServer, DeleteDnsServer and Upda…

9911c28

…teDnsServer

1. Setup Dns zone schema

df21318

2. added relevant changes in dao and vo 3. worked on creatednszone, integration with mgr 4. powerdns create zone api call

following dns zone apis are integrated:

f29b8be

1. creatednszone 2. listdnszone 3. updatednszone 4. deletednszone

Tested following flow:

9b77c37

1. Add dns server 2. create zone 3. add records 4. verify in powerdns 5. verify using dig

Add associate and disassociate zone to network APIs

c5972ae

following things are done:

99f8c7d

1. Registerdnsrecordforvm api 2. removednsrecordforvm api 3. cleanup; fixed license, dao logic

add missing license, cleanup, log std

e011ce1

following changes are done:

4a9f66d

1. refactored client 2. added exceptions 3. enhanced updateZone 4. ownership check for deleteDnsServer

include:

c64cf81

1. port for dns_server 2. remove hard coded localhost for server_id 3. resolve and store server id if not passed in the api request 4. restrict public dns_server for domain admins and admins

normalize dns zone and record in svc layer, always use dotless data i…

4df11a4

…n svc and handle dot version in client

enable apis for all roles

857436e

add ACL annotation, entitytype, minor cleanup

582b687

acl related changes, fixes, mistakes

add7763

fixes related to acl, dao

1fe79bd

add views for dns_server and dns_zone

6ca9d5a

Add Listener for VM lifecycle to add dnsrecords for associated dns zone

1c1eef3

1. implement event processing for vm start/stop/destroy, nic create/d…

caf8533

…elete events 2. add dnsrecordurl in nic_details table 3. add dnsrecordurl in vm response

starting on ui work

856158c

resolve merge conflict with main

928db65

boring-cyborg bot added the component:api label Mar 3, 2026

fix lint issue

369bb16

winterhazel added this to the 4.23.0 milestone Mar 3, 2026

fix list dnsservers api, ui screens for dns servers, generate events

0df50ce

github-actions bot added the status:has-conflicts label Mar 9, 2026

UI related work and fixes in updateDnsServer cmd

a9afbce

weizhouapache reviewed Apr 8, 2026

View reviewed changes

fix automatic dns record registration based on vm and nic lifecycle

3567819

changes:

883dc32

1. handle vm hostname change for dns registration 2. generate event for dns name collision 3. remove dns record lifecycle subscriber

fix normalizing dns record values for mx, srv and other type

3ae9834

sudo87 force-pushed the dnsProviderFramework branch from 39955d8 to 3ae9834 Compare April 11, 2026 12:06

split cleanup of old dns urls and new record registration

a036281

unit tests

6466362

github-actions bot added the status:has-conflicts label Apr 14, 2026

sudo87 added 3 commits April 15, 2026 18:57

add marvin test for powerdns

9d0884a

merge main changes

30566d1

trim trailing space

f96d4cd

sudo87 force-pushed the dnsProviderFramework branch from 3b13651 to f96d4cd Compare April 15, 2026 14:58

Conversation

sudo87 commented Mar 3, 2026 • 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

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Mar 9, 2026

Uh oh!

sudo87 commented Apr 6, 2026

Uh oh!

blueorangutan commented Apr 6, 2026

Uh oh!

weizhouapache commented Apr 8, 2026

Uh oh!

blueorangutan commented Apr 8, 2026

Uh oh!

blueorangutan commented Apr 8, 2026

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weizhouapache Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

sudo87 Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

sudo87 commented Apr 10, 2026

Uh oh!

blueorangutan commented Apr 10, 2026

Uh oh!

blueorangutan commented Apr 10, 2026

Uh oh!

sudo87 commented Apr 10, 2026

Uh oh!

blueorangutan commented Apr 10, 2026

Uh oh!

blueorangutan commented Apr 10, 2026

Uh oh!

sudo87 commented Apr 13, 2026

Uh oh!

blueorangutan commented Apr 13, 2026

Uh oh!

blueorangutan commented Apr 13, 2026

Uh oh!

sudo87 commented Apr 13, 2026

Uh oh!

blueorangutan commented Apr 13, 2026

Uh oh!

blueorangutan commented Apr 13, 2026

Uh oh!

github-actions bot commented Apr 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sudo87 commented Mar 3, 2026 •

edited

Loading

codecov bot commented Mar 3, 2026 •

edited

Loading