Skip to content

fix: allow third-party backup provider plugins via configurable allowed list #13332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yigitbasalma wants to merge 5 commits into
base: main
Choose a base branch
from
+10 −20
Open

fix: allow third-party backup provider plugins via configurable allowed list #13332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5ad3651
Fix
Jun 3, 2026
6b1bb48
fix: validate backup provider plugin via Spring bean instead of allow…
Jun 20, 2026
38457bc
fix: unused import error
Jun 21, 2026
de543b7
fix: handle missing backup provider gracefully to prevent dashboard f…
Jul 1, 2026
c77e222
Merge branch 'main' into fix/configurable-backup-provider-plugins
yigitbasalma Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions api/src/main/java/org/apache/cloudstack/backup/BackupManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
import org.apache.cloudstack.api.command.user.backup.ListBackupsCmd;
import org.apache.cloudstack.api.response.BackupResponse;
import org.apache.cloudstack.framework.config.ConfigKey;
import org.apache.cloudstack.framework.config.ValidatedConfigKey;
import org.apache.cloudstack.framework.config.Configurable;

import com.cloud.exception.ResourceUnavailableException;
Expand All @@ -55,11 +54,11 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
"false",
"Is backup and recovery framework enabled.", false, ConfigKey.Scope.Zone);

ConfigKey<String> BackupProviderPlugin = new ValidatedConfigKey<>("Advanced", String.class,
ConfigKey<String> BackupProviderPlugin = new ConfigKey<>("Advanced", String.class,
"backup.framework.provider.plugin",
"dummy",
"The backup and recovery provider plugin. Valid plugin values: dummy, veeam, networker and nas",
true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String)value));
"The backup and recovery provider plugin.",
true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key());

ConfigKey<Long> BackupSyncPollingInterval = new ConfigKey<>("Advanced", Long.class,
"backup.framework.sync.interval",
Expand Down Expand Up @@ -258,14 +257,4 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
Capacity getBackupStorageUsedStats(Long zoneId);

void checkAndRemoveBackupOfferingBeforeExpunge(VirtualMachine vm);

static void validateBackupProviderConfig(String value) {
if (value != null && (value.contains(",") || value.trim().contains(" "))) {
throw new IllegalArgumentException("Multiple backup provider plugins are not supported. Please provide a single plugin value.");
}
List<String> validPlugins = List.of("dummy", "veeam", "networker", "nas");
if (value != null && !validPlugins.contains(value)) {
throw new IllegalArgumentException("Invalid backup provider plugin: " + value + ". Valid plugin values are: " + String.join(", ", validPlugins));
}
}
}
13 changes: 7 additions & 6 deletions server/src/main/java/org/apache/cloudstack/backup/BackupManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1822,12 +1822,9 @@ public BackupProvider getBackupProvider(final Long zoneId) {
}

public BackupProvider getBackupProvider(final String name) {
if (StringUtils.isEmpty(name)) {
throw new CloudRuntimeException("Invalid backup provider name provided");
}
if (!backupProvidersMap.containsKey(name)) {
throw new CloudRuntimeException("Failed to find backup provider by the name: " + name);
}

@weizhouapache weizhouapache Jul 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@yigitbasalma
I think these checks are fine here, no need to remove

if (StringUtils.isEmpty(name)) {
return null;
}
return backupProvidersMap.get(name);
}

Expand Down Expand Up @@ -2474,6 +2471,10 @@ public CapacityVO getBackupStorageUsedStats(Long zoneId) {
return new CapacityVO(null, zoneId, null, null, 0L, 0L, Capacity.CAPACITY_TYPE_BACKUP_STORAGE);
}
final BackupProvider backupProvider = getBackupProvider(zoneId);
if (backupProvider == null) {
logger.warn("Backup provider not configured or not found for zone {}", zoneId);
return new CapacityVO(null, zoneId, null, null, 0L, 0L, Capacity.CAPACITY_TYPE_BACKUP_STORAGE);
}
Pair<Long, Long> backupUsage = backupProvider.getBackupStorageStats(zoneId);
return new CapacityVO(null, zoneId, null, null, backupUsage.first(), backupUsage.second(), Capacity.CAPACITY_TYPE_BACKUP_STORAGE);
}
Expand Down
Loading