Backroll Plugin #8251

PeterBackroll · 2023-11-20T16:44:55Z

Description

This is the pull request for Backroll Plugin (a backup & restore plugin).
This plugin allows users to use Backroll as backup provider inside Cloudstack.

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

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

boring-cyborg · 2023-11-20T16:45:00Z

Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
Here are some useful points:

In case of a new feature add useful documentation (raise doc PR at https://github.com/apache/cloudstack-documentation)
Be patient and persistent. It might take some time to get a review or get the final approval from the committers.
Pay attention to the quality of your code, ensure tests are passing and your PR doesn't have conflicts.
Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Issues, Mailing list and Slack.
Be sure to read the CloudStack Coding Conventions.
Apache CloudStack is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: [email protected] (https://cloudstack.apache.org/mailing-lists.html)
Slack: https://apachecloudstack.slack.com/

weizhouapache · 2023-11-20T18:47:51Z

@blueorangutan package

blueorangutan · 2023-11-20T18:50:03Z

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

codecov · 2023-11-20T19:21:40Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 3.58%. Comparing base (6dc259c) to head (dd07f56).

❗ There is a different number of reports uploaded between BASE (6dc259c) and HEAD (dd07f56). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (6dc259c) HEAD (dd07f56)

unittests 1 0

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #8251       +/-   ##
============================================
- Coverage     17.55%   3.58%   -13.98%     
============================================
  Files          5911     445     -5466     
  Lines        529359   37536   -491823     
  Branches      64655    6901    -57754     
============================================
- Hits          92949    1347    -91602     
+ Misses       425952   36025   -389927     
+ Partials      10458     164    -10294

Flag	Coverage Δ
uitests	`3.58% <ø> (ø)`
unittests	`?`

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.

blueorangutan · 2023-11-20T19:49:07Z

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

DaanHoogland · 2023-11-21T09:23:21Z

@PeterBackroll , nice to see this coming in. Will you add a documentation PR as well? I think you'll have a lot of reviews ;)

DaanHoogland · 2023-11-21T09:24:03Z

@blueorangutan test

blueorangutan · 2023-11-21T09:26:04Z

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

blueorangutan · 2023-11-21T22:36:46Z

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

Test	Result	Time (s)	Test File
test_08_upgrade_kubernetes_ha_cluster	`Failure`	672.30	test_kubernetes_clusters.py

PeterBackroll · 2023-11-22T07:55:52Z

Hi @DaanHoogland Yes I will add a documentation PR as soon as possible :)

DaanHoogland

some comments @PeterBackroll .
I haven't gotten to review the Provider and Client yet, the core of the plugin.
I'll do that next week ;)

.../backup/backroll/src/test/java/org/apache/cloudstack/backup/backroll/BackrollClientTest.java

...s/backup/backroll/src/test/java/org/apache/cloudstack/backup/BackrollBackupProviderTest.java

...java/org/apache/cloudstack/backup/backroll/model/response/policy/BackupPoliciesResponse.java

...rg/apache/cloudstack/backup/backroll/model/response/policy/BackrollBackupPolicyResponse.java

...kup/backroll/model/response/metrics/virtualMachineBackups/VirtualMachineBackupsResponse.java

...p/backroll/src/main/java/org/apache/cloudstack/backup/backroll/model/BackrollTaskStatus.java

...kup/backroll/src/main/java/org/apache/cloudstack/backup/backroll/model/BackrollOffering.java

...ackroll/src/main/java/org/apache/cloudstack/backup/backroll/model/BackrollBackupMetrics.java

...ackup/backroll/src/main/java/org/apache/cloudstack/backup/backroll/model/BackrollBackup.java

plugins/backup/backroll/src/main/java/org/apache/cloudstack/backup/backroll/BackrollClient.java

rohityadavcloud · 2023-11-27T06:36:18Z

@blueorangutan package

blueorangutan · 2023-11-27T06:38: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 · 2023-11-27T07:36:59Z

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

shwstppr · 2023-11-28T08:11:07Z

@PeterBackroll can you please have a look at the GH actions failures

DaanHoogland

some comments @PeterBackroll .
I haven't gotten to review the Provider and Client yet, the core of the plugin.
Thatś up next ;)

...ckroll/src/main/java/org/apache/cloudstack/backup/backroll/api/command/GetBackrollHello.java

...kroll/src/main/java/org/apache/cloudstack/backup/backroll/api/response/ApiHelloResponse.java

DaanHoogland

looks generally good, @PeterBackroll .
some changes will have to be done though (before merging)

plugins/backup/backroll/src/main/java/org/apache/cloudstack/backup/BackrollBackupProvider.java

DaanHoogland · 2023-12-01T16:24:19Z

plugins/backup/backroll/src/main/java/org/apache/cloudstack/backup/BackrollBackupProvider.java

+
+    public ConfigKey<String> BackrollPasswordConfigKey = new ConfigKey<>("Advanced", String.class,
+    "backup.plugin.backroll.config.password",
+    "VviX8dALauSyYJMqVYJqf3UyZOpO3joS",


can we make this more clear, this string is just as insecure but less inviting to change

Suggested change

"VviX8dALauSyYJMqVYJqf3UyZOpO3joS",

"password",

or

Suggested change

"VviX8dALauSyYJMqVYJqf3UyZOpO3joS",

"C'est vraiment secret",

plugins/backup/backroll/src/main/java/org/apache/cloudstack/backup/BackrollBackupProvider.java

DaanHoogland · 2023-12-01T16:51:55Z

plugins/backup/backroll/src/main/java/org/apache/cloudstack/backup/BackrollBackupProvider.java

+    public boolean deleteBackup(Backup backup, boolean forced) {
+        s_logger.info("backroll delete backup id: " + backup.getExternalId());
+        if(backup.getStatus().equals(Backup.Status.BackingUp)) {
+            throw new CloudRuntimeException("You can't delete a backup while it still BackingUp");


Suggested change

throw new CloudRuntimeException("You can't delete a backup while it still BackingUp");

throw new CloudRuntimeException("You can't delete a backup while it's still BackingUp");

plugins/backup/backroll/src/main/java/org/apache/cloudstack/backup/backroll/BackrollClient.java

andrijapanicsb · 2024-01-08T13:44:14Z

@PeterBackroll do we have any docs on how to configure the plugin, what kind of storage is supported, any limitations, etc?
Thx!

sureshanaparti · 2025-06-06T04:48:11Z

@blueorangutan package

blueorangutan · 2025-06-06T04:50: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.

blueorangutan · 2025-06-06T05:56:03Z

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

rohityadavcloud · 2025-07-30T02:56:15Z

@blueorangutan package

blueorangutan · 2025-07-30T02:58:04Z

@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 · 2025-07-30T04:17:35Z

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

sureshanaparti · 2025-07-30T04:59:49Z

[email protected]

remove this file

sureshanaparti · 2025-07-30T05:00:30Z

@blueorangutan test

blueorangutan · 2025-07-30T05:02:06Z

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

blueorangutan · 2025-07-31T01:07:31Z

[SF] Trillian test result (tid-13966)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 69391 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr8251-t13966-kvm-ol8.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_06_download_detached_volume	`Error`	303.11	test_volumes.py
test_13_migrate_volume_and_change_offering	`Error`	124.19	test_volumes.py
ContextSuite context=TestIpv6Vpc>:setup	`Error`	0.00	test_vpc_ipv6.py
ContextSuite context=TestVPCNics>:setup	`Error`	0.00	test_vpc_router_nics.py
ContextSuite context=TestVPCRedundancy>:setup	`Error`	0.00	test_vpc_redundant.py

abh1sar · 2025-07-31T11:21:48Z

@PeterBackroll PR #10140 is now merged which has the per-Backup Backup.Metrics changes. Please check if/how Backroll needs to handle that.
Let me know if I can help in anyway. Thanks.

PeterBackroll · 2025-07-31T13:19:24Z

Thank you very much @abh1sar. I will contact you if necessary.

rajujith · 2025-09-11T04:36:26Z

@PeterBackroll, I tried the plugin with BackROLL v1.0.0-beta.1, the backup got created, but the status is not updated in CloudStack due to the following error. Once the related fixes are made, I will try the plugin again.

2025-09-10 11:44:50,656 ERROR [o.a.c.b.b.BackrollClient] (BackgroundTaskPollManager-1:[ctx-3e1d0b09]) (logid:b6f10097) org.apache.cloudstack.backup.backroll.utils.BackrollHttpClientProvider$NotOkBodyException
2025-09-10 11:44:50,656 ERROR [o.a.c.b.B.BackupSyncTask] (BackgroundTaskPollManager-1:[ctx-3e1d0b09]) (logid:b6f10097) Error trying to run backup-sync background task due to: [Failed to sync backups]. com.cloud.utils.exception.CloudRuntimeException: Failed to sync backups
        at org.apache.cloudstack.backup.BackrollBackupProvider.getBackupMetrics(BackrollBackupProvider.java:183)

harikrishna-patnala · 2025-09-11T04:44:39Z

@PeterBackroll Thanks for keep working on this PR. If we want this PR to get into 4.22 version please continue to fix the issues and make it stable before September itself. 4.22 freeze date will be in the first week of October.

harikrishna-patnala · 2025-09-22T06:27:12Z

plugins/backup/backroll/pom.xml

+    <parent>
+        <artifactId>cloudstack-plugins</artifactId>
+        <groupId>org.apache.cloudstack</groupId>
+        <version>4.21.0.0-SNAPSHOT</version>


Suggested change

<version>4.21.0.0-SNAPSHOT</version>

<version>4.22.0.0-SNAPSHOT</version>

Bug fix + new features for backroll

1f51822

boring-cyborg bot added component:backup component:build labels Nov 20, 2023

DaanHoogland requested review from BryanMLima, GutoVeronezi, rohityadavcloud, shwstppr and soreana November 23, 2023 10:57

DaanHoogland added this to the 4.20.0.0 milestone Nov 23, 2023

DaanHoogland reviewed Nov 23, 2023

View reviewed changes

DaanHoogland reviewed Nov 28, 2023

View reviewed changes

DaanHoogland reviewed Dec 1, 2023

View reviewed changes

rohityadavcloud changed the base branch from main to 4.19 February 5, 2024 09:04

rohityadavcloud requested review from harikrishna-patnala and sureshanaparti February 5, 2024 09:04

rohityadavcloud closed this Jul 30, 2025

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.21.0 Jul 30, 2025

rohityadavcloud reopened this Jul 30, 2025

sureshanaparti reviewed Jul 30, 2025

View reviewed changes

[email protected]

Copy link

Contributor

sureshanaparti Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this file

sureshanaparti moved this from Done to In Progress in Apache CloudStack 4.21.0 Jul 31, 2025

weizhouapache modified the milestones: 4.21.0, 4.22.0 Aug 29, 2025

sureshanaparti removed this from Apache CloudStack 4.21.0 Aug 29, 2025

sureshanaparti added this to Apache CloudStack 4.22.0 Aug 29, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.0 Aug 29, 2025

Merge branch 'apache:main' into Backroll

ad6ffca

harikrishna-patnala reviewed Sep 22, 2025

View reviewed changes

DaanHoogland marked this pull request as draft October 10, 2025 08:03

harikrishna-patnala modified the milestones: 4.22.0, 4.22.1 Nov 12, 2025

harikrishna-patnala removed this from Apache CloudStack 4.22.0 Nov 12, 2025

Merge branch 'main' into Backroll

dd07f56

	throw new CloudRuntimeException("You can't delete a backup while it still BackingUp");
	throw new CloudRuntimeException("You can't delete a backup while it's still BackingUp");

	<version>4.21.0.0-SNAPSHOT</version>
	<version>4.22.0.0-SNAPSHOT</version>

Backroll Plugin #8251

Are you sure you want to change the base?

Backroll Plugin #8251

Uh oh!

Conversation

PeterBackroll commented Nov 20, 2023 • edited by soreana 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

Uh oh!

boring-cyborg bot commented Nov 20, 2023

Uh oh!

weizhouapache commented Nov 20, 2023

Uh oh!

blueorangutan commented Nov 20, 2023

Uh oh!

codecov bot commented Nov 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Nov 20, 2023

Uh oh!

DaanHoogland commented Nov 21, 2023

Uh oh!

DaanHoogland commented Nov 21, 2023

Uh oh!

blueorangutan commented Nov 21, 2023

Uh oh!

blueorangutan commented Nov 21, 2023

Uh oh!

PeterBackroll commented Nov 22, 2023

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rohityadavcloud commented Nov 27, 2023

Uh oh!

blueorangutan commented Nov 27, 2023

Uh oh!

blueorangutan commented Nov 27, 2023

Uh oh!

shwstppr commented Nov 28, 2023

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DaanHoogland Dec 1, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DaanHoogland Dec 1, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andrijapanicsb commented Jan 8, 2024

PeterBackroll commented Nov 20, 2023 •

edited by soreana

Loading

codecov bot commented Nov 20, 2023 •

edited

Loading

rajujith commented Sep 11, 2025 •

edited

Loading