backup: veeam kvm integration by shwstppr · Pull Request #12991 · apache/cloudstack

shwstppr · 2026-04-09T17:09:43Z

Description

Design spec: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=421954133

This PR introduces the initial implementation of Veeam integration support for KVM in CloudStack by adding a UHAPI-compatible server and image server components.

Veeam Backup & Replication interacts with virtualization platforms using its Universal Hypervisor API (UHAPI). To enable backup and restore workflows for CloudStack-managed KVM environments, this change introduces a UHAPI server that exposes CloudStack resources through a UHAPI-compatible interface.

In addition to the control plane APIs, an image server component is introduced to handle the data transfer operations required during backup and restore workflows.

Architecture

The integration consists of two main components:

UHAPI Server (Control Plane) named CloudStack Veeam Control Service

A lightweight UHAPI server runs inside the CloudStack management server and exposes endpoints under:

/ovirt-engine
    - /api - For APIs
    - /sso - For authentication
    - /services/pki-resource - For certificates

This server provides inventory discovery APIs required by Veeam and translates CloudStack resources into the structures expected by UHAPI.

The server:

exposes infrastructure inventory
handles authentication and session tokens
maps CloudStack resources to UHAPI-compatible representations

Image Server (Data Plane) named CloudStack Image Service

A separate image server component is introduced to handle backup and restore data transfer operations.

This component:

serves disk image data during backup
receives image data during restore operations
exposes endpoints used by Veeam worker components
integrates with CloudStack storage to read and write VM disk data

The separation between both these components server ensures that:

metadata APIs and control operations remain lightweight
bulk image transfer operations are handled independently

Documentation PR: apache/cloudstack-documentation#642

Co-authored by @abh1sar @weizhouapache

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?

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

todo: patch (needed?)

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

…unning. State Transition Initial: Ready Create Image Transfer -> Restoring Finalize Image transfer -> Ready

Adds a zone-level config to use offerings with encryption while restore --------- Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

A new UUID for the restored VM changes the serial for VM h/w info. This may prevent cloud-init from re-running on restore.

Fixes Windows instance file-level restore --------- Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2026-06-03T07:35:57Z

@blueorangutan package

blueorangutan · 2026-06-03T07:38:05Z

@shwstppr 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-06-03T08:23:49Z

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

shwstppr · 2026-06-05T13:16:52Z

@blueorangutan test

blueorangutan · 2026-06-05T13:18:03Z

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

blueorangutan · 2026-06-06T04:35:49Z

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

Test	Result	Time (s)	Test File

kiranchavala

LGTM, Tested the veeam-kvm intergarion and its working fine.

Please find the list of test cases

Test Case Execution	Result
Discover VMs from CloudStack via API	Pass
Deploy Worker VM	Pass
Add CloudStack Platform in Veeam	Pass
Full Backup of Stopped VM	Pass
Full Backup of Running VM	Pass
Incremental Backup	Pass
Restore VM to Original Location	Pass
Restore VM to New Location	Pass
Restore vCenter backedup VM to CloudStack	Pass
Verify Supported Disk Formats	Pass
Backup & Restore on NFS Storage	Pass
Restore CloudStack backedup VM to vCenter	Pass
Restore CloudStack backedup VM to oVirt	Pass
Restore oVirt backedup VM to CloudStack	Pass
Restore Account Owned VM	Pass
Restore Project Owned VM	Pass
Restore Without Owner Assignment	Pass
Backup & Restore on Local Storage	Pass
Backup & Restore on SharedMountPoint	Pass
Backup & Restore VM with BIOS Boot	Pass
Backup & Restore VM with UEFI Boot	Pass
Restore a vm to the correct network	Pass
Restore VM with Correct Template	Pass
Restore VM to the correct service offering	Pass
Incremental Backup After VM Stop	Pass
Incremental Backup After VM Start	Pass
Incremental Backup After VM Migration	Pass
Linux File-Level Restore Support	Pass
Windows File-Level Restore Support	Pass
Create backup job using VM tag	Pass
Active full backup using VM tags	Pass
Incremental backup using VM tags	Pass
Worker VM Self test	Pass

weizhouapache · 2026-06-08T06:44:03Z

This PR has been validated by @kiranchavala

thanks @shwstppr @abh1sar @kiranchavala @nvazquez @RosiKyu @yadvr for your great work !
please update the doc PR if needed: apache/cloudstack-documentation#642

Based on approvals, smoke test results and QA validation, merging

shwstppr and others added 30 commits April 9, 2026 09:38

[WIP] plugins: veeam control service

7c23b26

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

wip

065ec85

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

changes for discovery

a30eb28

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

changes

f52b114

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

changes

2784468

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

changes

81c3b5b

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Basic working version-1

f396c5c

Create volume on the given storage pool

73df3cb

Image server basic working version in SSVM.

23ecb1f

Image server with disk upload

5389fe6

upload fix-1

aae158b

image upload working

10f65b6

wip: changes for imagetransfer handling

7b45d2e

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Added progress to upload Image Transfers

2350661

get Options to return capabilities for upload

9ee9748

add license to image_server.py

f83fd00

fix precommit, license

2bc3114

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

veeam control changes

3460a5d

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

server changes

b926c74

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Support multiple disks and checkpoints

da62e9a

extents(zero/dirty) and capabilities - working

4173947

todo: patch (needed?)

Patch (zero, data) + Flush support in image_server.py

91a081b

Backup of stopped VMs

c36cd2c

api/server: create dummy KVM VM without volume and network is optional

ca4112e

worker vm deployment wip

a366929

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Support file backend for cow format: api and server

586134d

Image server support for file backend (qcow2 upload)

6ca1c9b

ut failure in UserVmManagerImplTest

fba7c63

wip

a89f872

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

fixes to allow worker vm deployment

106fbdb

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

apache deleted a comment from blueorangutan May 25, 2026

shwstppr mentioned this pull request May 26, 2026

Veeam for Red Hat Hypervisor #6618

Closed

abh1sar and others added 3 commits June 2, 2026 16:35

Set state Restoring on the volume on which upload image transfer is r…

da5651a

…unning. State Transition Initial: Ready Create Image Transfer -> Restoring Finalize Image transfer -> Ready

add config for using offerings with encryption

c916518

Adds a zone-level config to use offerings with encryption while restore --------- Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

preserve restore vm uuid

be61c04

A new UUID for the restored VM changes the serial for VM h/w info. This may prevent cloud-init from re-running on restore.

apache deleted a comment from blueorangutan Jun 2, 2026

flr: fix windows vm os type

f794e5c

Fixes Windows instance file-level restore --------- Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

apache deleted a comment from blueorangutan Jun 3, 2026

nvazquez marked this pull request as ready for review June 3, 2026 10:10

nvazquez approved these changes Jun 3, 2026

View reviewed changes

winterhazel added the status:needs-testing label Jun 4, 2026

winterhazel self-requested a review June 4, 2026 02:47

github-actions Bot mentioned this pull request Jun 5, 2026

[repo-status] Daily Status Report – June 5, 2026 #13360

Closed

This was referenced Jun 6, 2026

[repo-status] Daily Status Report – June 6, 2026 #13364

Closed

[repo-status] Daily Status Report – June 7, 2026 #13367

Closed

kiranchavala approved these changes Jun 8, 2026

View reviewed changes

weizhouapache merged commit a1959f2 into apache:main Jun 8, 2026
27 checks passed

github-actions Bot mentioned this pull request Jun 8, 2026

[repo-status] Daily Status Report – June 8, 2026 #13381

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

backup: veeam kvm integration#12991

backup: veeam kvm integration#12991
weizhouapache merged 197 commits into
apache:mainfrom
shapeblue:integration-veeam-kvm

shwstppr commented Apr 9, 2026 •

edited

Loading

Uh oh!

shwstppr commented Jun 3, 2026

Uh oh!

blueorangutan commented Jun 3, 2026

Uh oh!

blueorangutan commented Jun 3, 2026

Uh oh!

shwstppr commented Jun 5, 2026

Uh oh!

blueorangutan commented Jun 5, 2026

Uh oh!

blueorangutan commented Jun 6, 2026

Uh oh!

kiranchavala left a comment •

edited

Loading

Uh oh!

weizhouapache commented Jun 8, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Conversation

shwstppr commented Apr 9, 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!

shwstppr commented Jun 3, 2026

Uh oh!

blueorangutan commented Jun 3, 2026

Uh oh!

blueorangutan commented Jun 3, 2026

Uh oh!

shwstppr commented Jun 5, 2026

Uh oh!

blueorangutan commented Jun 5, 2026

Uh oh!

blueorangutan commented Jun 6, 2026

Uh oh!

kiranchavala left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Jun 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

shwstppr commented Apr 9, 2026 •

edited

Loading

kiranchavala left a comment •

edited

Loading

weizhouapache commented Jun 8, 2026 •

edited

Loading