Skip to content

storage: fix vmware volume cleanup failure #7312

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

Closed
shwstppr wants to merge 4 commits into from
Closed

storage: fix vmware volume cleanup failure #7312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
52c5607
storage: fix vmware volume cleanup failure
shwstppr Mar 5, 2023
915ae0a
add test
shwstppr Mar 6, 2023
166e461
newline
shwstppr Mar 6, 2023
d8ca07b
consider only enabled and up host
shwstppr Mar 6, 2023
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
50 changes: 39 additions & 11 deletions ...storage/src/main/java/org/apache/cloudstack/storage/endpoint/DefaultEndPointSelector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,12 @@

import javax.inject.Inject;

import com.cloud.dc.DedicatedResourceVO;
import com.cloud.dc.dao.DedicatedResourceDao;
import com.cloud.user.Account;
import com.cloud.utils.Pair;
import org.apache.cloudstack.context.CallContext;
import org.apache.cloudstack.engine.subsystem.api.storage.DataObject;
import org.apache.cloudstack.engine.subsystem.api.storage.DataStore;
import org.apache.cloudstack.engine.subsystem.api.storage.EndPoint;
import org.apache.cloudstack.engine.subsystem.api.storage.EndPointSelector;
import org.apache.cloudstack.engine.subsystem.api.storage.PrimaryDataStore;
import org.apache.cloudstack.engine.subsystem.api.storage.Scope;
import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotInfo;
import org.apache.cloudstack.engine.subsystem.api.storage.StorageAction;
Expand All @@ -50,14 +47,19 @@
import org.springframework.stereotype.Component;

import com.cloud.capacity.CapacityManager;
import com.cloud.dc.DedicatedResourceVO;
import com.cloud.dc.dao.DedicatedResourceDao;
import com.cloud.host.Host;
import com.cloud.host.HostVO;
import com.cloud.host.Status;
import com.cloud.host.dao.HostDao;
import com.cloud.hypervisor.Hypervisor;
import com.cloud.resource.ResourceState;
import com.cloud.storage.DataStoreRole;
import com.cloud.storage.ScopeType;
import com.cloud.storage.Storage.TemplateType;
import com.cloud.user.Account;
import com.cloud.utils.Pair;
import com.cloud.utils.db.DB;
import com.cloud.utils.db.QueryBuilder;
import com.cloud.utils.db.SearchCriteria.Op;
Expand Down Expand Up @@ -318,6 +320,35 @@ protected EndPoint findEndpointForImageStorage(DataStore store) {
return RemoteHostEndPoint.getHypervisorHostEndPoint(host);
}

protected Host getVmwareHostFromVolumeToDelete(VolumeInfo volume) {
VirtualMachine vm = volume.getAttachedVM();
if (vm == null) {
Copy link
Member

@rohityadavcloud rohityadavcloud Mar 6, 2023

Choose a reason for hiding this comment

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

If the volume isn't attached to a VM - would it be removed by GC (if not by this code) then?

Copy link
Contributor Author

@shwstppr shwstppr Mar 6, 2023

Choose a reason for hiding this comment

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

Yes then the calling method code tries to find a host based on the storage at line 476 https://github.com/apache/cloudstack/pull/7312/files#diff-45668a1459e79e7705bb54a8f6e09d972a12ffe972b06b61468e06f4f8ce2c3dR476

return null;
}
Long hostId = vm.getHostId() != null ? vm.getHostId() : vm.getLastHostId();
if (hostId == null) {
return null;
}
HostVO host = hostDao.findById(hostId);
Copy link
Member

@rohityadavcloud rohityadavcloud Mar 6, 2023

Choose a reason for hiding this comment

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

question - should we find host which has access to the storage pool (not always the vm's host ID or the last host ID?) to be responsible for deleting the volume?

Copy link
Contributor Author

@shwstppr shwstppr Mar 6, 2023

Choose a reason for hiding this comment

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

It will try to find the host based on the storage pool of the volume at line 476, https://github.com/apache/cloudstack/pull/7312/files#diff-45668a1459e79e7705bb54a8f6e09d972a12ffe972b06b61468e06f4f8ce2c3dR476

An option could be to completely remove the logic to try and find a host based on volume VM

if (host == null || !ResourceState.Enabled.equals(host.getResourceState()) || !Status.Up.equals(host.getState())) {
return null;
}
if (volume.getDataStore() instanceof PrimaryDataStore) {
PrimaryDataStore dataStore = (PrimaryDataStore)volume.getDataStore();
if (dataStore.getScope() == null) {
return null;
}
if (ScopeType.HOST.equals(dataStore.getScope().getScopeType()) && !host.getStorageIpAddress().equals(dataStore.getHostAddress())) {
return null;
}
if (ScopeType.CLUSTER.equals(dataStore.getScope().getScopeType()) && !host.getClusterId().equals(dataStore.getClusterId())) {
return null;
}
}
s_logger.debug(String.format("Selected host %s for deleting volume ID: %d", host, volume.getId()));
return host;
}

@Override
public List<EndPoint> findAllEndpointsForScope(DataStore store) {
Long dcId = null;
Expand Down Expand Up @@ -436,13 +467,10 @@ public EndPoint select(DataObject object, StorageAction action) {
}
} else if (action == StorageAction.DELETEVOLUME) {
VolumeInfo volume = (VolumeInfo)object;
if (volume.getHypervisorType() == Hypervisor.HypervisorType.VMware) {
VirtualMachine vm = volume.getAttachedVM();
if (vm != null) {
Long hostId = vm.getHostId() != null ? vm.getHostId() : vm.getLastHostId();
if (hostId != null) {
return getEndPointFromHostId(hostId);
}
if (Hypervisor.HypervisorType.VMware.equals(volume.getHypervisorType())) {
Host host = getVmwareHostFromVolumeToDelete(volume);
if (host != null) {
return RemoteHostEndPoint.getHypervisorHostEndPoint(host);
}
}
}
Expand Down
179 changes: 179 additions & 0 deletions ...age/src/test/java/org/apache/cloudstack/storage/endpoint/DefaultEndPointSelectorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
// 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.storage.endpoint;

import org.apache.cloudstack.engine.subsystem.api.storage.PrimaryDataStore;
import org.apache.cloudstack.engine.subsystem.api.storage.Scope;
import org.apache.cloudstack.engine.subsystem.api.storage.VolumeInfo;
import org.apache.cloudstack.storage.image.datastore.ImageStoreInfo;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;

import com.cloud.host.HostVO;
import com.cloud.host.Status;
import com.cloud.host.dao.HostDao;
import com.cloud.resource.ResourceState;
import com.cloud.storage.ScopeType;
import com.cloud.vm.VirtualMachine;

public class DefaultEndPointSelectorTest {

@Mock
HostDao hostDao;

@Before
public void initMocks() {
MockitoAnnotations.initMocks(this);
}
@InjectMocks
private DefaultEndPointSelector defaultEndPointSelector = new DefaultEndPointSelector();

@Test
public void testGetVmwareHostFromVolumeToDeleteBasic() {
VolumeInfo volumeInfo = Mockito.mock(VolumeInfo.class);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(null);
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));

VirtualMachine virtualMachine = Mockito.mock(VirtualMachine.class);
Mockito.when(virtualMachine.getHostId()).thenReturn(null);
Mockito.when(virtualMachine.getLastHostId()).thenReturn(null);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(virtualMachine);
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));

Long hostId = 1L;
Mockito.when(virtualMachine.getHostId()).thenReturn(hostId);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(virtualMachine);
Mockito.when(hostDao.findById(hostId)).thenReturn(null);
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));

HostVO hostVO = Mockito.mock(HostVO.class);
Mockito.when(hostVO.getResourceState()).thenReturn(ResourceState.Disabled);
Mockito.when(hostDao.findById(hostId)).thenReturn(hostVO);
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));

Mockito.when(hostVO.getResourceState()).thenReturn(ResourceState.Enabled);
Mockito.when(hostVO.getState()).thenReturn(Status.Down);
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));
}

@Test
public void testGetVmwareHostFromVolumeToDeleteNotPrimary() {
VolumeInfo volumeInfo = Mockito.mock(VolumeInfo.class);
Long hostId = 1L;
VirtualMachine virtualMachine = Mockito.mock(VirtualMachine.class);
Mockito.when(virtualMachine.getHostId()).thenReturn(hostId);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(virtualMachine);
HostVO hostVO = Mockito.mock(HostVO.class);
Mockito.when(hostVO.getResourceState()).thenReturn(ResourceState.Enabled);
Mockito.when(hostVO.getState()).thenReturn(Status.Up);
Mockito.when(hostDao.findById(hostId)).thenReturn(hostVO);
Mockito.when(volumeInfo.getDataStore()).thenReturn(Mockito.mock(ImageStoreInfo.class));
Assert.assertNotNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));
}

@Test
public void testGetVmwareHostFromVolumeToDeletePrimaryNoScope() {
VolumeInfo volumeInfo = Mockito.mock(VolumeInfo.class);
Long hostId = 1L;
VirtualMachine virtualMachine = Mockito.mock(VirtualMachine.class);
Mockito.when(virtualMachine.getHostId()).thenReturn(hostId);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(virtualMachine);
HostVO hostVO = Mockito.mock(HostVO.class);
Mockito.when(hostVO.getResourceState()).thenReturn(ResourceState.Enabled);
Mockito.when(hostVO.getState()).thenReturn(Status.Up);
Mockito.when(hostDao.findById(hostId)).thenReturn(hostVO);
PrimaryDataStore store = Mockito.mock(PrimaryDataStore.class);
Mockito.when(store.getScope()).thenReturn(null);
Mockito.when(volumeInfo.getDataStore()).thenReturn(store);
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));
}

@Test
public void testGetVmwareHostFromVolumeToDeletePrimaryNotHostOrClusterScope() {
VolumeInfo volumeInfo = Mockito.mock(VolumeInfo.class);
Long hostId = 1L;
VirtualMachine virtualMachine = Mockito.mock(VirtualMachine.class);
Mockito.when(virtualMachine.getHostId()).thenReturn(hostId);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(virtualMachine);
HostVO hostVO = Mockito.mock(HostVO.class);
Mockito.when(hostVO.getResourceState()).thenReturn(ResourceState.Enabled);
Mockito.when(hostVO.getState()).thenReturn(Status.Up);
Mockito.when(hostDao.findById(hostId)).thenReturn(hostVO);
PrimaryDataStore store = Mockito.mock(PrimaryDataStore.class);
Scope scope = Mockito.mock(Scope.class);
Mockito.when(scope.getScopeType()).thenReturn(ScopeType.ZONE);
Mockito.when(store.getScope()).thenReturn(scope);
Mockito.when(volumeInfo.getDataStore()).thenReturn(store);
Assert.assertNotNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));
}

@Test
public void testGetVmwareHostFromVolumeToDeletePrimaryClusterScope() {
VolumeInfo volumeInfo = Mockito.mock(VolumeInfo.class);
Long hostId = 1L;
Long clusterId = 1L;
VirtualMachine virtualMachine = Mockito.mock(VirtualMachine.class);
Mockito.when(virtualMachine.getHostId()).thenReturn(hostId);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(virtualMachine);
HostVO hostVO = Mockito.mock(HostVO.class);
Mockito.when(hostVO.getResourceState()).thenReturn(ResourceState.Enabled);
Mockito.when(hostVO.getState()).thenReturn(Status.Up);
Mockito.when(hostVO.getClusterId()).thenReturn(clusterId);
Mockito.when(hostDao.findById(hostId)).thenReturn(hostVO);
PrimaryDataStore store = Mockito.mock(PrimaryDataStore.class);
Scope scope = Mockito.mock(Scope.class);
Mockito.when(scope.getScopeType()).thenReturn(ScopeType.CLUSTER);
Mockito.when(store.getScope()).thenReturn(scope);
Mockito.when(store.getClusterId()).thenReturn(clusterId);
Mockito.when(volumeInfo.getDataStore()).thenReturn(store);
Assert.assertNotNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));

Mockito.when(store.getClusterId()).thenReturn(2L);
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));
}

@Test
public void testGetVmwareHostFromVolumeToDeletePrimaryHostScope() {
VolumeInfo volumeInfo = Mockito.mock(VolumeInfo.class);
Long hostId = 1L;
String storageIp = "something";
VirtualMachine virtualMachine = Mockito.mock(VirtualMachine.class);
Mockito.when(virtualMachine.getHostId()).thenReturn(hostId);
Mockito.when(volumeInfo.getAttachedVM()).thenReturn(virtualMachine);
HostVO hostVO = Mockito.mock(HostVO.class);
Mockito.when(hostVO.getResourceState()).thenReturn(ResourceState.Enabled);
Mockito.when(hostVO.getState()).thenReturn(Status.Up);
Mockito.when(hostVO.getStorageIpAddress()).thenReturn(storageIp);
Mockito.when(hostDao.findById(hostId)).thenReturn(hostVO);
PrimaryDataStore store = Mockito.mock(PrimaryDataStore.class);
Scope scope = Mockito.mock(Scope.class);
Mockito.when(scope.getScopeType()).thenReturn(ScopeType.HOST);
Mockito.when(store.getScope()).thenReturn(scope);
Mockito.when(store.getHostAddress()).thenReturn(storageIp);
Mockito.when(volumeInfo.getDataStore()).thenReturn(store);
Assert.assertNotNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));

Mockito.when(store.getHostAddress()).thenReturn("something-else");
Assert.assertNull(defaultEndPointSelector.getVmwareHostFromVolumeToDelete(volumeInfo));
}
}