CSTACKEX-18_2: using flexvolume snapshot even for CS volume snapshot workflow

Author: rajiv-jain-netapp

plugins/storage/volume/ontap/src/main/java/org/apache/cloudstack/storage/driver/OntapPrimaryDatastoreDriver.java

@@ -29,8 +29,6 @@
 import com.cloud.storage.Volume;
 import com.cloud.storage.VolumeVO;
 import com.cloud.storage.ScopeType;
-import com.cloud.storage.dao.SnapshotDetailsDao;
-import com.cloud.storage.dao.SnapshotDetailsVO;
 import com.cloud.storage.dao.VolumeDao;
 import com.cloud.storage.dao.VolumeDetailsDao;
 import com.cloud.utils.Pair;
@@ -49,22 +47,18 @@
 import org.apache.cloudstack.engine.subsystem.api.storage.VolumeInfo;
 import org.apache.cloudstack.framework.async.AsyncCompletionCallback;
 import org.apache.cloudstack.storage.command.CommandResult;
-import org.apache.cloudstack.storage.command.CreateObjectAnswer;
 import org.apache.cloudstack.storage.datastore.db.PrimaryDataStoreDao;
 import org.apache.cloudstack.storage.datastore.db.StoragePoolDetailsDao;
 import org.apache.cloudstack.storage.datastore.db.StoragePoolVO;
-import org.apache.cloudstack.storage.feign.model.FileInfo;
 import org.apache.cloudstack.storage.feign.model.Lun;
 import org.apache.cloudstack.storage.service.SANStrategy;
 import org.apache.cloudstack.storage.service.StorageStrategy;
 import org.apache.cloudstack.storage.service.UnifiedSANStrategy;
 import org.apache.cloudstack.storage.service.model.AccessGroup;
 import org.apache.cloudstack.storage.service.model.CloudStackVolume;
 import org.apache.cloudstack.storage.service.model.ProtocolType;
-import org.apache.cloudstack.storage.to.SnapshotObjectTO;
 import org.apache.cloudstack.storage.utils.Constants;
 import org.apache.cloudstack.storage.utils.Utility;
-import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -86,16 +80,17 @@ public class OntapPrimaryDatastoreDriver implements PrimaryDataStoreDriver {
     @Inject private VMInstanceDao vmDao;
     @Inject private VolumeDao volumeDao;
     @Inject private VolumeDetailsDao volumeDetailsDao;
-    @Inject private SnapshotDetailsDao snapshotDetailsDao;
 
     @Override
     public Map<String, String> getCapabilities() {
         s_logger.trace("OntapPrimaryDatastoreDriver: getCapabilities: Called");
         Map<String, String> mapCapabilities = new HashMap<>();
-        // RAW managed initial implementation: snapshot features not yet supported
-        // TODO Set it to false once we start supporting snapshot feature
-        mapCapabilities.put(DataStoreCapabilities.STORAGE_SYSTEM_SNAPSHOT.toString(), Boolean.TRUE.toString());
-        mapCapabilities.put(DataStoreCapabilities.CAN_CREATE_VOLUME_FROM_SNAPSHOT.toString(), Boolean.TRUE.toString());
+        // Snapshot operations are handled by OntapSnapshotStrategy (volume-level)
+        // and OntapVMSnapshotStrategy (VM-level) using native ONTAP FlexVol snapshots.
+        // These capabilities are set to FALSE so that StorageSystemSnapshotStrategy
+        // does not attempt to handle ONTAP volumes through the driver path.
+        mapCapabilities.put(DataStoreCapabilities.STORAGE_SYSTEM_SNAPSHOT.toString(), Boolean.FALSE.toString());
+        mapCapabilities.put(DataStoreCapabilities.CAN_CREATE_VOLUME_FROM_SNAPSHOT.toString(), Boolean.FALSE.toString());
         return mapCapabilities;
     }
 
@@ -532,84 +527,15 @@ public long getUsedIops(StoragePool storagePool) {
 
     @Override
     public void takeSnapshot(SnapshotInfo snapshot, AsyncCompletionCallback<CreateCmdResult> callback) {
-        s_logger.info("takeSnapshot : entered with snapshot id: " + snapshot.getId() + " and name: " + snapshot.getName());
-        CreateCmdResult result;
-
-        try {
-            VolumeInfo volumeInfo = snapshot.getBaseVolume();
-
-            VolumeVO volumeVO = volumeDao.findById(volumeInfo.getId());
-            if(volumeVO == null) {
-                throw new CloudRuntimeException("takeSnapshot: VolumeVO not found for id: " + volumeInfo.getId());
-            }
-
-            /** we are keeping file path at volumeVO.getPath() */
-
-            StoragePoolVO storagePool = storagePoolDao.findById(volumeVO.getPoolId());
-            if(storagePool == null) {
-                s_logger.error("takeSnapshot : Storage Pool not found for id: " + volumeVO.getPoolId());
-                throw new CloudRuntimeException("takeSnapshot : Storage Pool not found for id: " + volumeVO.getPoolId());
-            }
-            Map<String, String> poolDetails = storagePoolDetailsDao.listDetailsKeyPairs(volumeVO.getPoolId());
-            StorageStrategy storageStrategy = Utility.getStrategyByStoragePoolDetails(poolDetails);
-
-            CloudStackVolume cloudStackVolume = null;
-            long usedBytes = getUsedBytes(storagePool);
-            long capacityBytes = storagePool.getCapacityBytes();
-            long fileSize = 0l;
-            // Only proceed for NFS3 protocol
-            if (ProtocolType.NFS3.name().equalsIgnoreCase(poolDetails.get(Constants.PROTOCOL))) {
-                Map<String, String> cloudStackVolumeRequestMap = new HashMap<>();
-                cloudStackVolumeRequestMap.put(Constants.VOLUME_UUID, poolDetails.get(Constants.VOLUME_UUID));
-                cloudStackVolumeRequestMap.put(Constants.FILE_PATH, volumeVO.getPath());
-                cloudStackVolume = storageStrategy.getCloudStackVolume(cloudStackVolumeRequestMap);
-                if (cloudStackVolume == null || cloudStackVolume.getFile() == null) {
-                    throw new CloudRuntimeException("Failed to get source file to take snapshot");
-                    }
-                s_logger.info("takeSnapshot : entered after getting cloudstack volume with file path: " + cloudStackVolume.getFile().getPath() + " and size: " + cloudStackVolume.getFile().getSize());
-                fileSize = cloudStackVolume.getFile().getSize();
-                usedBytes += fileSize;
-            }
-
-            if (usedBytes > capacityBytes) {
-                throw new CloudRuntimeException("Insufficient space remains in this primary storage to take a snapshot");
-            }
-
-            storagePool.setUsedBytes(usedBytes);
-
-            SnapshotObjectTO snapshotObjectTo = (SnapshotObjectTO)snapshot.getTO();
-
-            String snapshotName = volumeInfo.getName() + "-" + snapshot.getUuid();
-
-            int trimRequired = snapshotName.length() - Constants.MAX_SNAPSHOT_NAME_LENGTH;
-
-            if (trimRequired > 0) {
-                snapshotName = StringUtils.left(volumeInfo.getName(), (volumeInfo.getName().length() - trimRequired)) + "-" + snapshot.getUuid();
-            }
-
-            CloudStackVolume snapCloudStackVolumeRequest = snapshotCloudStackVolumeRequestByProtocol(poolDetails, volumeVO.getPath(), snapshotName);
-            CloudStackVolume cloneCloudStackVolume = storageStrategy.snapshotCloudStackVolume(snapCloudStackVolumeRequest);
-
-            updateSnapshotDetails(snapshot.getId(), volumeInfo.getId(), poolDetails.get(Constants.VOLUME_UUID), cloneCloudStackVolume.getFile().getPath(), volumeVO.getPoolId(), fileSize);
-
-            snapshotObjectTo.setPath(Constants.ONTAP_SNAP_ID +"="+cloneCloudStackVolume.getFile().getPath());
-
-            /** Update size for the storage-pool including snapshot size */
-            storagePoolDao.update(volumeVO.getPoolId(), storagePool);
-
-            CreateObjectAnswer createObjectAnswer = new CreateObjectAnswer(snapshotObjectTo);
-
-            result = new CreateCmdResult(null, createObjectAnswer);
-
-            result.setResult(null);
-        }
-        catch (Exception ex) {
-            s_logger.error("takeSnapshot: Failed due to ", ex);
-            result = new CreateCmdResult(null, new CreateObjectAnswer(ex.toString()));
-
-            result.setResult(ex.toString());
-        }
-
+        // Snapshot operations are now handled by OntapSnapshotStrategy which intercepts
+        // at the strategy layer before the driver is ever called. This method should
+        // not be reached for ONTAP volumes. If it is, fail explicitly.
+        s_logger.error("takeSnapshot: This driver method should not be called. " +
+                "Snapshot operations for ONTAP are handled by OntapSnapshotStrategy. " +
+                "Snapshot id: " + snapshot.getId());
+        CreateCmdResult result = new CreateCmdResult(null, new Answer(null, false,
+                "takeSnapshot not supported via driver path; use OntapSnapshotStrategy"));
+        result.setResult("takeSnapshot not supported via driver path");
         callback.complete(result);
     }
 
@@ -709,60 +635,4 @@ private CloudStackVolume createDeleteCloudStackVolumeRequest(StoragePool storage
 
     }
 
-    private CloudStackVolume snapshotCloudStackVolumeRequestByProtocol(Map<String, String> details,
-                                                                       String sourcePath,
-                                                                       String destinationPath) {
-        CloudStackVolume cloudStackVolumeRequest = null;
-        ProtocolType protocolType = null;
-        String protocol = null;
-
-        try {
-            protocol = details.get(Constants.PROTOCOL);
-            protocolType = ProtocolType.valueOf(protocol);
-        } catch (IllegalArgumentException e) {
-            throw new CloudRuntimeException("getCloudStackVolumeRequestByProtocol: Protocol: "+ protocol +" is not valid");
-        }
-        switch (protocolType) {
-            case NFS3:
-                cloudStackVolumeRequest = new CloudStackVolume();
-                FileInfo fileInfo = new FileInfo();
-                fileInfo.setPath(sourcePath);
-                cloudStackVolumeRequest.setFile(fileInfo);
-                String volumeUuid = details.get(Constants.VOLUME_UUID);
-                cloudStackVolumeRequest.setFlexVolumeUuid(volumeUuid);
-                cloudStackVolumeRequest.setDestinationPath(destinationPath);
-                break;
-            default:
-                throw new CloudRuntimeException("createCloudStackVolumeRequestByProtocol: Unsupported protocol " + protocol);
-
-        }
-        return cloudStackVolumeRequest;
-    }
-
-    /**
-     *
-     * @param csSnapshotId: generated snapshot id from cloudstack
-     * @param csVolumeId: Source CS volume id
-     * @param ontapVolumeUuid: storage flexvolume id
-     * @param ontapNewSnapshot: generated snapshot id from ONTAP
-     * @param storagePoolId: primary storage pool id
-     * @param ontapSnapSize: Size of snapshot CS volume(LUN/file)
-     */
-    private void updateSnapshotDetails(long csSnapshotId, long csVolumeId, String ontapVolumeUuid, String ontapNewSnapshot, long storagePoolId, long ontapSnapSize) {
-        SnapshotDetailsVO snapshotDetail = new SnapshotDetailsVO(csSnapshotId, Constants.SRC_CS_VOLUME_ID,  String.valueOf(csVolumeId), false);
-        snapshotDetailsDao.persist(snapshotDetail);
-
-        snapshotDetail = new SnapshotDetailsVO(csSnapshotId, Constants.BASE_ONTAP_FV_ID, String.valueOf(ontapVolumeUuid), false);
-        snapshotDetailsDao.persist(snapshotDetail);
-
-        snapshotDetail = new SnapshotDetailsVO(csSnapshotId, Constants.ONTAP_SNAP_ID, String.valueOf(ontapNewSnapshot), false);
-        snapshotDetailsDao.persist(snapshotDetail);
-
-        snapshotDetail = new SnapshotDetailsVO(csSnapshotId, Constants.PRIMARY_POOL_ID, String.valueOf(storagePoolId), false);
-        snapshotDetailsDao.persist(snapshotDetail);
-
-        snapshotDetail = new SnapshotDetailsVO(csSnapshotId, Constants.ONTAP_SNAP_SIZE, String.valueOf(ontapSnapSize), false);
-        snapshotDetailsDao.persist(snapshotDetail);
-    }
-
 }