Skip to content

Allow removing VMs from instance groups #14395

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
nvazquez wants to merge 2 commits into
base: 4.22
Choose a base branch
from
+76 −22
Open

Allow removing VMs from instance groups #14395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
442e468
Allow removing VMs from instance groups
nvazquez Oct 13, 2026
d8c8dea
Address review comments
nvazquez Oct 14, 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
2 changes: 1 addition & 1 deletion api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
@Parameter(name = ApiConstants.DISPLAY_NAME, type = CommandType.STRING, description = "User generated name")
private String displayName;

@Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "Group of the Instance")
@Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "Group of the Instance. To remove an Instance from its current Group, please pass an empty string as parameter")
private String group;

@Parameter(name = ApiConstants.HA_ENABLE, type = CommandType.BOOLEAN, description = "True if high-availability is enabled for the Instance, false otherwise")
Expand Down
9 changes: 8 additions & 1 deletion server/src/main/java/com/cloud/vm/UserVmManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3208,8 +3208,11 @@ public UserVm updateVirtualMachine(long id, String displayName, String group, Bo
osTypeId = vm.getGuestOSId();
}

if (group != null) {
if (StringUtils.isNotBlank(group)) {
addInstanceToGroup(id, group);
} else if (group != null) {
// Allow removing an instance from its group when passing an empty group on update
removeInstanceFromInstanceGroup(vm.getId());
Comment thread
nvazquez marked this conversation as resolved.
Comment thread
nvazquez marked this conversation as resolved.
}

if (isDynamicallyScalable == null) {
Expand Down Expand Up @@ -3791,6 +3794,10 @@ public InstanceGroupVO getGroupForVm(long vmId) {
public void removeInstanceFromInstanceGroup(long vmId) {
try {
List<InstanceGroupVMMapVO> groupVmMaps = _groupVMMapDao.listByInstanceId(vmId);
if (CollectionUtils.isEmpty(groupVmMaps)) {
logger.debug("Vm id: {} does not belong to any group", vmId);
return;
}
for (InstanceGroupVMMapVO groupMap : groupVmMaps) {
SearchCriteria<InstanceGroupVMMapVO> sc = _groupVMMapDao.createSearchCriteria();
sc.addAnd("instanceId", SearchCriteria.Op.EQ, groupMap.getInstanceId());
Expand Down
76 changes: 59 additions & 17 deletions server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@
import java.util.TimeZone;
import java.util.UUID;

import com.cloud.utils.db.SearchCriteria;
import com.cloud.vm.dao.InstanceGroupVMMapDao;
import org.apache.cloudstack.acl.ControlledEntity;
import org.apache.cloudstack.acl.SecurityChecker;
import org.apache.cloudstack.api.ApiCommandResourceType;
Expand Down Expand Up @@ -471,6 +473,9 @@ public class UserVmManagerImplTest {
@Mock
ServiceOfferingDetailsDao serviceOfferingDetailsDao;

@Mock
InstanceGroupVMMapDao instanceGroupVMMapDao;

private static final long vmId = 1L;
private static final long zoneId = 2L;
private static final long accountId = 3L;
Expand Down Expand Up @@ -583,7 +588,7 @@ public void validateInputsAndPermissionForUpdateVirtualMachineCommandTest() {

@Test
public void updateVirtualMachineTestDisplayChanged() throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);
ServiceOffering offering = getSvcoffering(512);
Mockito.when(_serviceOfferingDao.findById(Mockito.anyLong(), Mockito.anyLong())).thenReturn((ServiceOfferingVO) offering);
Mockito.when(userVmVoMock.isDisplay()).thenReturn(true);
Expand All @@ -598,7 +603,7 @@ public void updateVirtualMachineTestDisplayChanged() throws ResourceUnavailableE

@Test
public void updateVirtualMachineTestCleanUpTrue() throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);
ServiceOffering offering = getSvcoffering(512);
Mockito.when(_serviceOfferingDao.findById(Mockito.anyLong(), Mockito.anyLong())).thenReturn((ServiceOfferingVO) offering);
Mockito.when(updateVmCommand.isCleanupDetails()).thenReturn(true);
Expand All @@ -615,6 +620,41 @@ public void updateVirtualMachineTestCleanUpTrue() throws ResourceUnavailableExce
Mockito.verify(userVmManagerImpl, times(0)).updateDisplayVmFlag(false, vmId, userVmVoMock);
}

@Test
public void testUpdateVirtualMachineInstanceGroupNull() throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
configureDoNothingForMethodsThatWeDoNotWantToTest(false);
ServiceOffering offering = getSvcoffering(512);
Mockito.when(_serviceOfferingDao.findById(Mockito.anyLong(), Mockito.anyLong())).thenReturn((ServiceOfferingVO) offering);
Mockito.when(updateVmCommand.getUserdataId()).thenReturn(null);

userVmManagerImpl.updateVirtualMachine(updateVmCommand);
Mockito.verify(userVmManagerImpl, never()).removeInstanceFromInstanceGroup(Mockito.anyLong());
}

@Test
public void testUpdateVirtualMachineInstanceGroupEmptyValue() throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
configureDoNothingForMethodsThatWeDoNotWantToTest(false);
ServiceOffering offering = getSvcoffering(512);
Mockito.when(_serviceOfferingDao.findById(Mockito.anyLong(), Mockito.anyLong())).thenReturn((ServiceOfferingVO) offering);
Mockito.when(updateVmCommand.getUserdataId()).thenReturn(null);

Mockito.when(userVmVoMock.getId()).thenReturn(vmId);
InstanceGroupVMMapVO mapVO = Mockito.mock(InstanceGroupVMMapVO.class);
Mockito.when(mapVO.getInstanceId()).thenReturn(vmId);
Mockito.when(instanceGroupVMMapDao.listByInstanceId(vmId)).thenReturn(Collections.singletonList(mapVO));
SearchCriteria<InstanceGroupVMMapVO> searchCriteria = Mockito.mock(SearchCriteria.class);
Mockito.when(instanceGroupVMMapDao.createSearchCriteria()).thenReturn(searchCriteria);

// Set group = "" to reset/restore the instance group for a VM
Mockito.when(updateVmCommand.getGroup()).thenReturn("");

userVmManagerImpl.updateVirtualMachine(updateVmCommand);

verifyMethodsThatAreAlwaysExecuted();
Mockito.verify(userVmManagerImpl).removeInstanceFromInstanceGroup(vmId);
Mockito.verify(instanceGroupVMMapDao).expunge(searchCriteria);
}

@Test
public void updateVirtualMachineTestCleanUpTrueAndDetailEmpty() throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
prepareAndExecuteMethodDealingWithDetails(true, true);
Expand Down Expand Up @@ -647,7 +687,7 @@ private List<VMInstanceDetailVO> prepareExistingDetails(Long vmId, String... exi
}

private void prepareAndExecuteMethodDealingWithDetails(boolean cleanUpDetails, boolean isDetailsEmpty) throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

ServiceOffering offering = getSvcoffering(512);
Mockito.when(_serviceOfferingDao.findById(Mockito.anyLong(), Mockito.anyLong())).thenReturn((ServiceOfferingVO) offering);
Expand Down Expand Up @@ -701,18 +741,20 @@ private void verifyMethodsThatAreAlwaysExecuted() throws ResourceUnavailableExce

}

private void configureDoNothingForMethodsThatWeDoNotWantToTest() throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
private void configureDoNothingForMethodsThatWeDoNotWantToTest(boolean mockUpdateVM) throws ResourceUnavailableException, InsufficientCapacityException, ResourceAllocationException {
Mockito.doNothing().when(userVmManagerImpl).validateInputsAndPermissionForUpdateVirtualMachineCommand(updateVmCommand);
Mockito.doReturn(new ArrayList<Long>()).when(userVmManagerImpl).getSecurityGroupIdList(updateVmCommand);

Mockito.lenient().doReturn(Mockito.mock(UserVm.class)).when(userVmManagerImpl).updateVirtualMachine(Mockito.anyLong(), Mockito.anyString(), Mockito.anyString(), Mockito.anyBoolean(),
Mockito.anyBoolean(), Mockito.anyBoolean(), Mockito.anyLong(), Mockito.anyString(), Mockito.anyLong(), Mockito.anyString(), Mockito.anyBoolean(), Mockito.any(HTTPMethod.class), Mockito.anyString(), Mockito.anyString(),
Mockito.anyString(), anyList(), Mockito.any());
if (mockUpdateVM) {
Mockito.lenient().doReturn(Mockito.mock(UserVm.class)).when(userVmManagerImpl).updateVirtualMachine(Mockito.anyLong(), Mockito.anyString(), Mockito.anyString(), Mockito.anyBoolean(),
Mockito.anyBoolean(), Mockito.anyBoolean(), Mockito.anyLong(), Mockito.anyString(), Mockito.anyLong(), Mockito.anyString(), Mockito.anyBoolean(), Mockito.any(HTTPMethod.class), Mockito.anyString(), Mockito.anyString(),
Mockito.anyString(), anyList(), Mockito.any());
Mockito.doNothing().when(userVmManagerImpl).removeInstanceFromInstanceGroup(Mockito.anyLong());
}

Mockito.doNothing().when(userVmManagerImpl).validateIfVmSupportsMigration(Mockito.any(), Mockito.anyLong());
Mockito.doNothing().when(userVmManagerImpl).validateOldAndNewAccounts(Mockito.nullable(Account.class), Mockito.nullable(Account.class), Mockito.anyLong(), Mockito.nullable(String.class), Mockito.nullable(Long.class));
Mockito.doNothing().when(userVmManagerImpl).validateIfVmHasNoRules(Mockito.any(), Mockito.anyLong());
Mockito.doNothing().when(userVmManagerImpl).removeInstanceFromInstanceGroup(Mockito.anyLong());
Mockito.doNothing().when(userVmManagerImpl).validateIfNewOwnerHasAccessToTemplate(Mockito.any(), Mockito.any(), Mockito.any());

Mockito.doNothing().when(userVmManagerImpl).updateVmOwner(Mockito.any(), Mockito.any());
Expand Down Expand Up @@ -3199,7 +3241,7 @@ public void moveVmToUserTestMovesVmWhenProjectIdIsProvidedAndDomainIdIsNull() th
Mockito.doNothing().when(userVmManagerImpl).executeStepsToChangeOwnershipOfVm(Mockito.any(), Mockito.any(), Mockito.any(),
Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any());

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

userVmManagerImpl.moveVmToUser(assignVmCmdMock);

Expand All @@ -3215,7 +3257,7 @@ public void moveVmToUserTestValidateIfVmHasNoRulesThrowsInvalidParameterValueExc
Mockito.doReturn(userVmVoMock).when(userVmDao).findById(Mockito.anyLong());
Mockito.doReturn(null).when(assignVmCmdMock).getProjectId();

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

doThrow(InvalidParameterValueException.class).when(userVmManagerImpl).validateIfVmHasNoRules(Mockito.any(), Mockito.anyLong());

Expand All @@ -3234,7 +3276,7 @@ public void moveVmToUserTestSnapshotsForVolumeExistThrowsInvalidParameterValueEx
Mockito.doReturn(null).when(assignVmCmdMock).getProjectId();
Mockito.doReturn(volumes).when(volumeDaoMock).findByInstance(Mockito.anyLong());

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

doThrow(InvalidParameterValueException.class).when(userVmManagerImpl).validateIfVolumesHaveNoSnapshots(Mockito.any());

Expand All @@ -3252,7 +3294,7 @@ public void moveVmToUserTestVerifyResourceLimitsForAccountAndStorageThrowsResour
Mockito.doReturn(null).when(assignVmCmdMock).getProjectId();
Mockito.doReturn(volumes).when(volumeDaoMock).findByInstance(Mockito.anyLong());

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

doThrow(ResourceAllocationException.class).when(userVmManagerImpl).verifyResourceLimitsForAccountAndStorage(Mockito.any(), Mockito.any(),
Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any());
Expand All @@ -3271,7 +3313,7 @@ public void moveVmToUserTestVerifyValidateIfNewOwnerHasAccessToTemplateThrowsInv
Mockito.doReturn(null).when(assignVmCmdMock).getProjectId();
Mockito.doReturn(volumes).when(volumeDaoMock).findByInstance(Mockito.anyLong());

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

doThrow(InvalidParameterValueException.class).when(userVmManagerImpl).validateIfNewOwnerHasAccessToTemplate(Mockito.any(), Mockito.any(), Mockito.any());

Expand All @@ -3287,7 +3329,7 @@ public void executeStepsToChangeOwnershipOfVmTestUpdateVmNetworkThrowsInsufficie
try (MockedStatic<UsageEventUtils> ignored = mockStatic(UsageEventUtils.class)) {
Mockito.doReturn(Hypervisor.HypervisorType.KVM).when(userVmVoMock).getHypervisorType();

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

doThrow(InsufficientAddressCapacityException.class).when(userVmManagerImpl).updateVmNetwork(Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(),
Mockito.any());
Expand All @@ -3310,7 +3352,7 @@ public void executeStepsToChangeOwnershipOfVmTestUpdateVmNetworkThrowsResourceAl
try (MockedStatic<UsageEventUtils> ignored = mockStatic(UsageEventUtils.class)) {
Mockito.doReturn(Hypervisor.HypervisorType.KVM).when(userVmVoMock).getHypervisorType();

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

doThrow(ResourceAllocationException.class).when(userVmManagerImpl).updateVmNetwork(Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(),
Mockito.any());
Expand All @@ -3335,7 +3377,7 @@ public void executeStepsToChangeOwnershipOfVmTestResourceCountRunningVmsOnlyEnab
Mockito.doReturn(Hypervisor.HypervisorType.KVM).when(userVmVoMock).getHypervisorType();
Mockito.doReturn(false).when(userVmManagerImpl).isResourceCountRunningVmsOnlyEnabled();

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

userVmManagerImpl.executeStepsToChangeOwnershipOfVm(assignVmCmdMock, callerAccount, accountMock, accountMock, userVmVoMock, serviceOfferingVoMock, volumes,
virtualMachineTemplateMock);
Expand All @@ -3358,7 +3400,7 @@ public void executeStepsToChangeOwnershipOfVmTestResourceCountRunningVmsOnlyEnab
Mockito.doReturn(Hypervisor.HypervisorType.KVM).when(userVmVoMock).getHypervisorType();
Mockito.doReturn(true).when(userVmManagerImpl).isResourceCountRunningVmsOnlyEnabled();

configureDoNothingForMethodsThatWeDoNotWantToTest();
configureDoNothingForMethodsThatWeDoNotWantToTest(true);

userVmManagerImpl.executeStepsToChangeOwnershipOfVm(assignVmCmdMock, callerAccount, accountMock, accountMock, userVmVoMock, serviceOfferingVoMock, volumes,
virtualMachineTemplateMock);
Expand Down
11 changes: 8 additions & 3 deletions ui/src/views/compute/EditVM.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@
<a-auto-complete
v-model:value="form.group"
:filterOption="(input, option) => {
return option.value.toLowerCase().indexOf(input.toLowerCase()) >= 0
return !option.value || !input || input === resource.group ||
option.value.toLowerCase().indexOf(input.toLowerCase()) >= 0
}"
:options="groups.opts" />
</a-form-item>
Expand Down Expand Up @@ -338,6 +339,10 @@ export default {
fetchInstaceGroups () {
this.groups.loading = true
this.groups.opts = []
this.groups.opts.push({
id: '',
value: ''
})
const params = {
domainid: this.$store.getters.userInfo.domainid,
listall: true
Expand Down Expand Up @@ -411,8 +416,8 @@ export default {
if (values.haenable !== undefined) {
params.haenable = values.haenable
}
if (values.group && values.group.length > 0) {
params.group = values.group
if ((values.group || '') !== (this.resource.group || '')) {
params.group = values.group || ''
}
if (values.userdata && values.userdata.length > 0) {
params.userdata = this.$toBase64AndURIEncoded(values.userdata)
Expand Down
Loading