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

Attention: Patch coverage is 65.67742% with 266 lines in your changes missing coverage. Please review.

Project coverage is 16.47%. Comparing base (a8b18a5) to head (4e6d689).
Report is 274 commits behind head on main.

Files with missing lines	Patch %	Lines
...ache/cloudstack/backup/BackrollBackupProvider.java	57.14%	105 Missing and 12 partials ⚠️
...kup/backroll/utils/BackrollHttpClientProvider.java	67.20%	69 Missing and 12 partials ⚠️
...dstack/backup/backroll/model/BackrollOffering.java	31.25%	21 Missing and 1 partial ⚠️
...che/cloudstack/backup/backroll/BackrollClient.java	88.81%	4 Missing and 12 partials ⚠️
...dstack/backup/backroll/model/BackrollVmBackup.java	33.33%	9 Missing and 1 partial ⚠️
...oudstack/backup/backroll/model/BackrollBackup.java	0.00%	7 Missing ⚠️
...tack/backup/backroll/model/BackrollTaskStatus.java	68.42%	6 Missing ⚠️
...k/backup/backroll/model/BackrollBackupMetrics.java	90.90%	0 Missing and 1 partial ⚠️
...tack/backup/backroll/model/response/TaskState.java	0.00%	1 Missing ⚠️
...kup/backroll/model/response/TaskStateResponse.java	0.00%	1 Missing ⚠️
... and 4 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #8251      +/-   ##
============================================
+ Coverage     16.15%   16.47%   +0.31%     
- Complexity    13265    13695     +430     
============================================
  Files          5666     5744      +78     
  Lines        497960   504837    +6877     
  Branches      60241    61159     +918     
============================================
+ Hits          80469    83178    +2709     
- Misses       408482   412422    +3940     
- Partials       9009     9237     +228

Flag	Coverage Δ
uitests	`3.99% <ø> (-0.01%)`	⬇️
unittests	`17.33% <65.67%> (+0.33%)`	⬆️

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!

rajujith · 2025-03-13T05:31:30Z

@blueorangutan package

blueorangutan · 2025-03-13T05:32:04Z

@rajujith 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-03-13T06:31:12Z

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

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

…store

DaanHoogland · 2025-03-24T10:33:22Z

@blueorangutan package

blueorangutan · 2025-03-24T10:34:03Z

@DaanHoogland 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-03-24T11:18:46Z

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

rajujith · 2025-03-26T04:37:25Z

@blueorangutan package

blueorangutan · 2025-03-26T04:38:04Z

@rajujith 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-03-26T04:55:48Z

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

… metrics)

PeterBackroll · 2025-04-04T12:19:15Z

@blueorangutan package

blueorangutan · 2025-04-04T12:20:03Z

@PeterBackroll 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-04-04T13:30:22Z

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

rajujith · 2025-05-20T04:55:13Z

@blueorangutan package

blueorangutan · 2025-05-20T04:56:03Z

@rajujith 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-05-20T06:18:12Z

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

sureshanaparti · 2025-06-05T10:07:48Z

@blueorangutan package

blueorangutan · 2025-06-05T10:10:04Z

@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-05T12:58:28Z

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

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

Bug fix + new features for backroll

1f51822

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

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

PeterBackroll added 2 commits March 12, 2025 12:48

Adding some UT test

e86ccc3

Checkstyle error

5741318

abh1sar reviewed Mar 19, 2025

View reviewed changes

plugins/backup/backroll/src/main/java/org/apache/cloudstack/backup/BackrollBackupProvider.java Outdated Show resolved Hide resolved

DaanHoogland requested a review from JoaoJandre March 20, 2025 12:40

Delete syncBackups in backroll provider, fix delete backup and fix re…

86f5066

…store

Fix unit tests, fix metrics (waiting PR apache#10140 to finish to fix…

f903871

… metrics)

Delete unused folders/files

4e6d689

sureshanaparti added this to Apache CloudStack 4.21.0 Jun 5, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jun 5, 2025

	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");

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