Backroll Plugin by PeterBackroll · Pull Request #8251 · apache/cloudstack

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: dev@cloudstack.apache.org (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.66%. Comparing base (30e6c22) to head (10b2a77).
⚠️ Report is 64 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (30e6c22) and HEAD (10b2a77). Click for more details.
HEAD has 1 upload less than BASE
Flag BASE (30e6c22) HEAD (10b2a77)
unittests 1 0

Additional details and impacted files

@@ Coverage Diff @@## main #8251 +/- ##
============================================
- Coverage 17.92% 3.66% -14.26% 
============================================
Files 5939 454 -5485 Lines 533181 38540 -494641 Branches 65237 7126 -58111 ============================================
- Hits 95585 1414 -94171 + Misses 426856 36938 -389918 + Partials 10740 188 -10552

Flag	Coverage Δ
uitests	`3.66% <ø> (-0.01%)`	⬇️
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 ;)

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

DaanHoogland

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

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

+
+ 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",

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

+ 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
thrownewCloudRuntimeException("You can't delete a backup while it still BackingUp");
thrownewCloudRuntimeException("You can't delete a backup while it's still BackingUp");

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!

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.

rajujith · 2026-01-13T05:54:35Z

@PeterBackroll Since this is for the 4.22.1 release, could you retarget the PR to the 4.22 branch?

DaanHoogland · 2026-01-27T10:21:18Z

@PeterBackroll , is work on this still progressing?

Co-authored-by: Harikrishna <harikrishna.patnala@gmail.com>

m-dhellin · 2026-02-23T17:46:02Z

Hello there, we are working on experimental changes on other branches and then we merge on the PR’s branch.

While I was testing the plugin, I faced an error. Before starting to dig into the issue, I thought that it could be better to be up-to-date with the main branch.

So I updated the main branch and merged it into my working branch but it was no longer compiling. Then I tried to compile the main branch with mvn install -f pom.xml -DskipTests -Dcheckstyle.skip=true but it failed. Each time I launched the command the compilation went further and previously failing-to-compile projects were starting to compile.

To understand better what was happening, I had a look at these pages :
https://cloudstack.apache.org/developers/
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Setting+up+CloudStack+Development+Environment+on+Linux

So I tried mvn clean and then mvn clean install -P developer,systemvm but it kept failing on cloud-framework-managed-context.

I ended up with two questions :

should the main branch compile ?
is there a tutorial on how to update from the main branch on a daily basis ?

DaanHoogland · 2026-02-24T08:55:53Z

@m-dhellin , we keep phony PRs like #12198 to regularly test release branches (main, 4.22, 4.20) . internally as a company we have a daily build as well, but that is not shared. Last night’s passed on all branches.

Did you check java versions?

m-dhellin · 2026-02-24T10:46:33Z

Thank you @DaanHoogland, I reviewed and updated my development environment (java + maven) and it’s compiling again.

m-dhellin · 2026-03-09T11:04:06Z

Hello, I’m no longer able to test the plugin because of this error :

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.beans.factory.config.PropertyPlaceholderConfigurer#0' defined in URL [jar:file:/opt/cloudstack/cli ent/target/cloud-client-ui-4.23.0.0-SNAPSHOT.jar!/META-INF/cloudstack/bootstrap/spring-bootstrap-context-inheritable.xml]: Cannot resolve reference to bean 'DefaultConfigResources' while setting bean proper ty 'locations'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'DefaultConfigResources' available

I run mvn clean install -P systemvm,developer -DskipTests -Dcheckstyle.skip=true on the main branch but the error is still there. Any thoughts ?

java --version
openjdk 17.0.15 2025-04-15
OpenJDK Runtime Environment (build 17.0.15+6-Ubuntu-0ubuntu120.04)
OpenJDK 64-Bit Server VM (build 17.0.15+6-Ubuntu-0ubuntu120.04, mixed mode, sharing

mvn --version
Apache Maven 3.9.12 (848fbb4bf2d427b72bdb2471c22fced7ebd9a7a1)
Maven home: /root/apache-maven-3.9.12
Java version: 17.0.15, vendor: Ubuntu, runtime: /usr/lib/jvm/java-17-openjdk-amd64
Default locale: en, platform encoding: UTF-8
OS name: "linux", version: "5.4.0-131-generic", arch: "amd64", family: "unix

git log -n 1
commit 30e6c224bdd2e33f35349e808ec75428853f2aa0 (HEAD -> main, upstream/main, origin/main, origin/HEAD)
Merge: c0db75b9fa 5caf6cd043
Author: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>
Date: Thu Feb 19 13:20:04 2026 +0530
Merge branch '4.22'

DaanHoogland · 2026-03-09T12:40:51Z

@m-dhellin , this sounds like some bean cannot load (maybe because the DB-scheme doesn’t match its current definition??)

Do or did your beans use ‘locations’ and did that get changed or did an update of the upstream repository contain such a change?

m-dhellin · 2026-03-09T13:40:24Z

Thank you @DaanHoogland for your quick reply, I reset the DB with mvn -P developer -pl developer -Ddeploydb but it’s not working yet. I will try to understand why the bean is not found while I can find its definition.

m-dhellin · 2026-03-09T14:28:36Z

I’ve been able to fix the issue by adding a dependency link with a temporary absolute path and recompiling :

core/src/main/resources/META-INF/cloudstack/bootstrap/spring-bootstrap-context-inheritable.xml

Added this line :

<importresource="file:/opt/cloudstack/framework/spring/module/src/main/resources/org/apache/cloudstack/spring/module/model/impl/defaults-context.xml"/>

The resulting XML :

<beansxmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"xmlns:aop="http://www.springframework.org/schema/aop"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"
>
<context:annotation-config />
<importresource="file:/opt/cloudstack/framework/spring/module/src/main/resources/org/apache/cloudstack/spring/module/model/impl/defaults-context.xml"/>
<beanclass="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<propertyname="order"value="100" />
<propertyname="ignoreResourceNotFound"value="true" />
<propertyname="ignoreUnresolvablePlaceholders"value="true" />
<propertyname="locations"ref="DefaultConfigResources" />
</bean>
</beans>

But know that’s the bean « registryRegistry » which is not found. I may try this for every « ref » attribute I find in beans definitions if I don’t find a better solution.

DaanHoogland · 2026-03-10T12:16:29Z

@m-dhellin , I never heard of this being needed before. If it works for you it work, but I am really curious about the root cause and whether this is specific to your component/project/plugin/change???

Bug fix + new features for backroll
1f51822

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

DaanHoogland requested review from BryanMLima, GutoVeronezi, shwstppr, soreana and yadvr 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

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

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

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

Comment threadplugins/backup/backroll/pom.xml Outdated

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

rajujith added this to Apache CloudStack 4.22.1 Jan 5, 2026

rajujith moved this to In Progress in Apache CloudStack 4.22.1 Jan 7, 2026

Update plugins/backup/backroll/pom.xml
d099788
Co-authored-by: Harikrishna <harikrishna.patnala@gmail.com>

Merge branch 'main' into Backroll
10b2a77

sureshanaparti removed this from Apache CloudStack 4.22.1 Apr 23, 2026

sureshanaparti modified the milestones: 4.22.1, 4.23.0 Apr 23, 2026

weizhouapache modified the milestones: 4.23.0, 4.24.0 Jun 29, 2026

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

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-cyborgBot commented Nov 20, 2023

Uh oh!

weizhouapache commented Nov 20, 2023

Uh oh!

blueorangutan commented Nov 20, 2023

Uh oh!

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

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

DaanHooglandDec 1, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DaanHooglandDec 1, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andrijapanicsb commented Jan 8, 2024

Uh oh!

rajujith commented Sep 11, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PeterBackroll commented Nov 20, 2023•
edited by soreana
Loading

codecovBot commented Nov 20, 2023•
edited
Loading

rajujith commented Sep 11, 2025•
edited
Loading

m-dhellin commented Feb 24, 2026•
edited
Loading