Skip to content

Fixes issue with loading Capacity dashboard when mulitple backup providers configured #12550

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
Pearl1594 wants to merge 7 commits into
base: 4.20
Choose a base branch
from
+63 −6
Open

Fixes issue with loading Capacity dashboard when mulitple backup providers configured #12550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0bb1616
Fixes issue with loading Capacity dashboard when mulitple backup prov…
Pearl1594 Jan 29, 2026
94ac3ea
Add validator for config key
Pearl1594 Jan 29, 2026
2d146fa
cleanup
Pearl1594 Jan 29, 2026
de23052
extract code
Pearl1594 Jan 30, 2026
174f92d
trim spaces when checking for commas
Pearl1594 Jan 30, 2026
0669ac3
address comments
Pearl1594 Jan 30, 2026
7b21739
revert old code
Pearl1594 Feb 4, 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
16 changes: 14 additions & 2 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 @@ -26,6 +26,7 @@
import org.apache.cloudstack.api.command.user.backup.ListBackupOfferingsCmd;
import org.apache.cloudstack.api.command.user.backup.ListBackupsCmd;
import org.apache.cloudstack.framework.config.ConfigKey;
import org.apache.cloudstack.framework.config.ValidatedConfigKey;
import org.apache.cloudstack.framework.config.Configurable;

import com.cloud.utils.Pair;
Expand All @@ -42,10 +43,11 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
"false",
"Is backup and recovery framework enabled.", false, ConfigKey.Scope.Zone);

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

@abh1sar abh1sar Jan 30, 2026

Choose a reason for hiding this comment

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

Suggested change
true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String)value));
true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String) value));


ConfigKey<Long> BackupSyncPollingInterval = new ConfigKey<>("Advanced", Long.class,
"backup.framework.sync.interval",
Expand Down Expand Up @@ -148,4 +150,14 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
boolean deleteBackup(final Long backupId, final Boolean forced);

BackupOffering updateBackupOffering(UpdateBackupOfferingCmd updateBackupOfferingCmd);

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");
Copy link
Contributor

@sureshanaparti sureshanaparti Feb 4, 2026

Choose a reason for hiding this comment

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

can check these values with the enum?

Copy link
Contributor Author

@Pearl1594 Pearl1594 Feb 4, 2026

Choose a reason for hiding this comment

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

we don't have enums - do you want me to create one?

if (value != null && !validPlugins.contains(value.toLowerCase())) {
throw new IllegalArgumentException("Invalid backup provider plugin: " + value + ". Valid plugin values are: " + String.join(", ", validPlugins));
}
}
}
38 changes: 38 additions & 0 deletions ...ework/config/src/main/java/org/apache/cloudstack/framework/config/ValidatedConfigKey.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package org.apache.cloudstack.framework.config;

import java.util.function.Consumer;

public class ValidatedConfigKey<T> extends ConfigKey<T> {
private final Consumer<T> validator;

public ValidatedConfigKey(String category, Class<T> type, String name, String defaultValue, String description, boolean dynamic, Scope scope, String parent, Consumer<T> validator) {
super(category, type, name, defaultValue, description, dynamic, scope, parent);
this.validator = validator;
}

public Consumer<T> getValidator() {
return validator;
}

public void validateValue(String value) {
if (validator != null) {
validator.accept((T) value);
}
}
}
7 changes: 7 additions & 0 deletions server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
import org.apache.cloudstack.framework.config.ConfigDepot;
import org.apache.cloudstack.framework.config.ConfigKey;
import org.apache.cloudstack.framework.config.Configurable;
import org.apache.cloudstack.framework.config.ValidatedConfigKey;
import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
import org.apache.cloudstack.framework.config.dao.ConfigurationGroupDao;
import org.apache.cloudstack.framework.config.dao.ConfigurationSubGroupDao;
Expand Down Expand Up @@ -716,6 +717,12 @@ public String updateConfiguration(final long userId, final String name, final St
throw new InvalidParameterValueException(validationMsg);
}

ConfigKey<?> configKey = _configDepot.get(name);
if (configKey instanceof ValidatedConfigKey) {
ValidatedConfigKey<?> validatedConfigKey = (ValidatedConfigKey<?>) configKey;
validatedConfigKey.validateValue(value);
}

// If scope of the parameter is given then it needs to be updated in the
// corresponding details table,
// if scope is mentioned as global or not mentioned then it is normal
Expand Down
8 changes: 4 additions & 4 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 @@ -972,10 +972,10 @@ 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);
}
return backupProvidersMap.get(name);
if (!backupProvidersMap.containsKey(name)) {
throw new CloudRuntimeException("Failed to find backup provider by the name: " + name);
}
return backupProvidersMap.get(name);
}

@Override
Expand Down
Loading