Ability to specify NFS mount options while adding a primary storage and modify them on a pre-existing primary storage

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -1097,6 +1097,8 @@ public class ApiConstants {
 
     public static final String PARAMETER_DESCRIPTION_IS_TAG_A_RULE = "Whether the informed tag is a JS interpretable rule or not.";
 
+    public static final String NFS_MOUNT_OPTIONS = "nfsmountopts";
+
     /**
      * This enum specifies IO Drivers, each option controls specific policies on I/O.
      * Qemu guests support "threads" and "native" options Since 0.8.8 ; "io_uring" is supported Since 6.3.0 (QEMU 5.0).

api/src/main/java/org/apache/cloudstack/api/response/StoragePoolResponse.java

@@ -101,6 +101,10 @@ public class StoragePoolResponse extends BaseResponseWithAnnotations {
     @Param(description = "the tags for the storage pool")
     private String tags;
 
+    @SerializedName(ApiConstants.NFS_MOUNT_OPTIONS)
+    @Param(description = "the nfs mount options for the storage pool", since = "4.19.1")
+    private String nfsMountOpts;
+
     @SerializedName(ApiConstants.IS_TAG_A_RULE)
     @Param(description = ApiConstants.PARAMETER_DESCRIPTION_IS_TAG_A_RULE)
     private Boolean isTagARule;
@@ -347,4 +351,12 @@ public String getProvider() {
     public void setProvider(String provider) {
         this.provider = provider;
     }
+
+    public String getNfsMountOpts() {
+        return nfsMountOpts;
+    }
+
+    public void setNfsMountOpts(String nfsMountOpts) {
+        this.nfsMountOpts = nfsMountOpts;
+    }
 }

core/src/main/java/com/cloud/agent/api/ModifyStoragePoolCommand.java

@@ -46,6 +46,10 @@ public ModifyStoragePoolCommand(boolean add, StoragePool pool, String localPath,
         this.details = details;
     }
 
+    public ModifyStoragePoolCommand(boolean add, StoragePool pool, Map<String, String> details) {
+        this(add, pool, LOCAL_PATH_PREFIX + File.separator + UUID.nameUUIDFromBytes((pool.getHostAddress() + pool.getPath()).getBytes()), details);
+    }
+
     public ModifyStoragePoolCommand(boolean add, StoragePool pool) {
         this(add, pool, LOCAL_PATH_PREFIX + File.separator + UUID.nameUUIDFromBytes((pool.getHostAddress() + pool.getPath()).getBytes()));
     }

engine/components-api/src/main/java/com/cloud/storage/StorageManager.java

@@ -18,6 +18,7 @@
 
 import java.math.BigDecimal;
 import java.util.List;
+import java.util.Map;
 
 import org.apache.cloudstack.engine.subsystem.api.storage.DataStore;
 import org.apache.cloudstack.engine.subsystem.api.storage.HypervisorHostListener;
@@ -341,6 +342,10 @@ static Boolean getFullCloneConfiguration(Long storeId) {
 
     boolean registerHostListener(String providerUuid, HypervisorHostListener listener);
 
+    Pair<Map<String, String>, Boolean> getStoragePoolNFSMountOpts(StoragePool pool, Map<String, String> details);
+
+    String getStoragePoolMountFailureReason(String error);
+
     boolean connectHostToSharedPool(long hostId, long poolId) throws StorageUnavailableException, StorageConflictException;
 
     void disconnectHostFromSharedPool(long hostId, long poolId) throws StorageUnavailableException, StorageConflictException;

engine/storage/volume/src/main/java/org/apache/cloudstack/storage/datastore/provider/DefaultHostListener.java

@@ -42,7 +42,9 @@
 import com.cloud.storage.StoragePoolHostVO;
 import com.cloud.storage.StorageService;
 import com.cloud.storage.dao.StoragePoolHostDao;
+import com.cloud.utils.Pair;
 import com.cloud.utils.exception.CloudRuntimeException;
+
 import org.apache.cloudstack.engine.subsystem.api.storage.DataStoreManager;
 import org.apache.cloudstack.engine.subsystem.api.storage.HypervisorHostListener;
 import org.apache.cloudstack.storage.datastore.db.PrimaryDataStoreDao;
@@ -53,7 +55,9 @@
 import org.apache.log4j.Logger;
 
 import javax.inject.Inject;
+
 import java.util.List;
+import java.util.Map;
 
 public class DefaultHostListener implements HypervisorHostListener {
     private static final Logger s_logger = Logger.getLogger(DefaultHostListener.class);
@@ -125,7 +129,9 @@ private NicTO createNicTOFromNetworkAndOffering(NetworkVO networkVO, NetworkOffe
     @Override
     public boolean hostConnect(long hostId, long poolId) throws StorageConflictException {
         StoragePool pool = (StoragePool) this.dataStoreMgr.getDataStore(poolId, DataStoreRole.Primary);
-        ModifyStoragePoolCommand cmd = new ModifyStoragePoolCommand(true, pool);
+        Pair<Map<String, String>, Boolean> nfsMountOpts = storageManager.getStoragePoolNFSMountOpts(pool, null);
+
+        ModifyStoragePoolCommand cmd = new ModifyStoragePoolCommand(true, pool, nfsMountOpts.first());
         cmd.setWait(modifyStoragePoolCommandWait);
         s_logger.debug(String.format("Sending modify storage pool command to agent: %d for storage pool: %d with timeout %d seconds",
                 hostId, poolId, cmd.getWait()));
@@ -138,7 +144,7 @@ public boolean hostConnect(long hostId, long poolId) throws StorageConflictExcep
         if (!answer.getResult()) {
             String msg = "Unable to attach storage pool" + poolId + " to the host" + hostId;
             alertMgr.sendAlert(AlertManager.AlertType.ALERT_TYPE_HOST, pool.getDataCenterId(), pool.getPodId(), msg, msg);
-            throw new CloudRuntimeException("Unable establish connection from storage head to storage pool " + pool.getId() + " due to " + answer.getDetails() +
+            throw new CloudRuntimeException("Unable to establish connection from storage head to storage pool " + pool.getId() + " due to " + answer.getDetails() +
                 pool.getId());
         }
 

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtStoragePoolDef.java

@@ -16,6 +16,12 @@
 // under the License.
 package com.cloud.hypervisor.kvm.resource;
 
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import org.apache.commons.collections.CollectionUtils;
+
 public class LibvirtStoragePoolDef {
     public enum PoolType {
         ISCSI("iscsi"), NETFS("netfs"), LOGICAL("logical"), DIR("dir"), RBD("rbd"), GLUSTERFS("glusterfs"), POWERFLEX("powerflex");
@@ -55,6 +61,7 @@ public String toString() {
     private String _authUsername;
     private AuthenticationType _authType;
     private String _secretUuid;
+    private Set<String> _nfsMountOpts = new HashSet<>();
 
     public LibvirtStoragePoolDef(PoolType type, String poolName, String uuid, String host, int port, String dir, String targetPath) {
         _poolType = type;
@@ -75,6 +82,15 @@ public LibvirtStoragePoolDef(PoolType type, String poolName, String uuid, String
         _targetPath = targetPath;
     }
 
+    public LibvirtStoragePoolDef(PoolType type, String poolName, String uuid, String host, String dir, String targetPath, List<String> nfsMountOpts) {
+        this(type, poolName, uuid, host, dir, targetPath);
+        if (CollectionUtils.isNotEmpty(nfsMountOpts)) {
+            for (String nfsMountOpt : nfsMountOpts) {
+                this._nfsMountOpts.add(nfsMountOpt);
+            }
+        }
+    }
+
     public LibvirtStoragePoolDef(PoolType type, String poolName, String uuid, String sourceHost, int sourcePort, String dir, String authUsername, AuthenticationType authType,
             String secretUuid) {
         _poolType = type;
@@ -124,69 +140,98 @@ public AuthenticationType getAuthType() {
         return _authType;
     }
 
+    public Set<String> getNfsMountOpts() {
+        return _nfsMountOpts;
+    }
+
     @Override
     public String toString() {
         StringBuilder storagePoolBuilder = new StringBuilder();
-        if (_poolType == PoolType.GLUSTERFS) {
-            /* libvirt mounts a Gluster volume, similar to NFS */
-            storagePoolBuilder.append("<pool type='netfs'>\n");
-        } else {
-            storagePoolBuilder.append("<pool type='");
-            storagePoolBuilder.append(_poolType);
-            storagePoolBuilder.append("'>\n");
+        String poolTypeXML;
+        switch (_poolType) {
+            case NETFS:
+                if (_nfsMountOpts != null) {
+                    poolTypeXML = "netfs' xmlns:fs='http://libvirt.org/schemas/storagepool/fs/1.0";
+                } else {
+                    poolTypeXML = _poolType.toString();
+                }
+                break;
+            case GLUSTERFS:
+                /* libvirt mounts a Gluster volume, similar to NFS */
+                poolTypeXML = "netfs";
+                break;
+            default:
+                poolTypeXML = _poolType.toString();
         }
 
+        storagePoolBuilder.append("<pool type='");
+        storagePoolBuilder.append(poolTypeXML);
+        storagePoolBuilder.append("'>\n");
+
         storagePoolBuilder.append("<name>" + _poolName + "</name>\n");
         if (_uuid != null)
             storagePoolBuilder.append("<uuid>" + _uuid + "</uuid>\n");
-        if (_poolType == PoolType.NETFS) {
-            storagePoolBuilder.append("<source>\n");
-            storagePoolBuilder.append("<host name='" + _sourceHost + "'/>\n");
-            storagePoolBuilder.append("<dir path='" + _sourceDir + "'/>\n");
-            storagePoolBuilder.append("</source>\n");
-        }
-        if (_poolType == PoolType.RBD) {
-            storagePoolBuilder.append("<source>\n");
-            for (String sourceHost : _sourceHost.split(",")) {
+
+        switch (_poolType) {
+            case NETFS:
+                storagePoolBuilder.append("<source>\n");
+                storagePoolBuilder.append("<host name='" + _sourceHost + "'/>\n");
+                storagePoolBuilder.append("<dir path='" + _sourceDir + "'/>\n");
+                storagePoolBuilder.append("</source>\n");
+                break;
+
+            case RBD:
+                storagePoolBuilder.append("<source>\n");
+                for (String sourceHost : _sourceHost.split(",")) {
+                    storagePoolBuilder.append("<host name='");
+                    storagePoolBuilder.append(sourceHost);
+                    if (_sourcePort != 0) {
+                        storagePoolBuilder.append("' port='");
+                        storagePoolBuilder.append(_sourcePort);
+                    }
+                    storagePoolBuilder.append("'/>\n");
+                }
+
+                storagePoolBuilder.append("<name>" + _sourceDir + "</name>\n");
+                if (_authUsername != null) {
+                    storagePoolBuilder.append("<auth username='" + _authUsername + "' type='" + _authType + "'>\n");
+                    storagePoolBuilder.append("<secret uuid='" + _secretUuid + "'/>\n");
+                    storagePoolBuilder.append("</auth>\n");
+                }
+                storagePoolBuilder.append("</source>\n");
+                break;
+
+            case GLUSTERFS:
+                storagePoolBuilder.append("<source>\n");
                 storagePoolBuilder.append("<host name='");
-                storagePoolBuilder.append(sourceHost);
+                storagePoolBuilder.append(_sourceHost);
                 if (_sourcePort != 0) {
                     storagePoolBuilder.append("' port='");
                     storagePoolBuilder.append(_sourcePort);
                 }
                 storagePoolBuilder.append("'/>\n");
-            }
-
-            storagePoolBuilder.append("<name>" + _sourceDir + "</name>\n");
-            if (_authUsername != null) {
-                storagePoolBuilder.append("<auth username='" + _authUsername + "' type='" + _authType + "'>\n");
-                storagePoolBuilder.append("<secret uuid='" + _secretUuid + "'/>\n");
-                storagePoolBuilder.append("</auth>\n");
-            }
-            storagePoolBuilder.append("</source>\n");
-        }
-        if (_poolType == PoolType.GLUSTERFS) {
-            storagePoolBuilder.append("<source>\n");
-            storagePoolBuilder.append("<host name='");
-            storagePoolBuilder.append(_sourceHost);
-            if (_sourcePort != 0) {
-                storagePoolBuilder.append("' port='");
-                storagePoolBuilder.append(_sourcePort);
-            }
-            storagePoolBuilder.append("'/>\n");
-            storagePoolBuilder.append("<dir path='");
-            storagePoolBuilder.append(_sourceDir);
-            storagePoolBuilder.append("'/>\n");
-            storagePoolBuilder.append("<format type='");
-            storagePoolBuilder.append(_poolType);
-            storagePoolBuilder.append("'/>\n");
-            storagePoolBuilder.append("</source>\n");
+                storagePoolBuilder.append("<dir path='");
+                storagePoolBuilder.append(_sourceDir);
+                storagePoolBuilder.append("'/>\n");
+                storagePoolBuilder.append("<format type='");
+                storagePoolBuilder.append(_poolType);
+                storagePoolBuilder.append("'/>\n");
+                storagePoolBuilder.append("</source>\n");
+                break;
         }
+
         if (_poolType != PoolType.RBD && _poolType != PoolType.POWERFLEX) {
             storagePoolBuilder.append("<target>\n");
             storagePoolBuilder.append("<path>" + _targetPath + "</path>\n");
             storagePoolBuilder.append("</target>\n");
         }
+        if (_poolType == PoolType.NETFS && _nfsMountOpts != null) {
+            storagePoolBuilder.append("<fs:mount_opts>\n");
+            for (String options : _nfsMountOpts) {
+                storagePoolBuilder.append("<fs:option name='" + options + "'/>\n");
+            }
+            storagePoolBuilder.append("</fs:mount_opts>\n");
+        }
         storagePoolBuilder.append("</pool>\n");
         return storagePoolBuilder.toString();
     }

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtStoragePoolXMLParser.java

@@ -37,6 +37,19 @@
 public class LibvirtStoragePoolXMLParser {
     private static final Logger s_logger = Logger.getLogger(LibvirtStoragePoolXMLParser.class);
 
+    private List<String> getNFSMountOptsFromRootElement(Element rootElement) {
+        List<String> nfsMountOpts = new ArrayList<>();
+        Element mountOpts = (Element) rootElement.getElementsByTagName("fs:mount_opts").item(0);
+        if (mountOpts != null) {
+            NodeList options = mountOpts.getElementsByTagName("fs:option");
+            for (int i = 0; i < options.getLength(); i++) {
+                Element option = (Element) options.item(i);
+                nfsMountOpts.add(option.getAttribute("name"));
+            }
+        }
+        return nfsMountOpts;
+    }
+
     public LibvirtStoragePoolDef parseStoragePoolXML(String poolXML) {
         DocumentBuilder builder;
         try {
@@ -94,11 +107,15 @@ public LibvirtStoragePoolDef parseStoragePoolXML(String poolXML) {
                         poolName, uuid, host, port, path, targetPath);
             } else {
                 String path = getAttrValue("dir", "path", source);
-
                 Element target = (Element)rootElement.getElementsByTagName("target").item(0);
                 String targetPath = getTagValue("path", target);
 
-                return new LibvirtStoragePoolDef(LibvirtStoragePoolDef.PoolType.valueOf(type.toUpperCase()), poolName, uuid, host, path, targetPath);
+                if (type.equalsIgnoreCase("netfs")) {
+                    List<String> nfsMountOpts = getNFSMountOptsFromRootElement(rootElement);
+                    return new LibvirtStoragePoolDef(LibvirtStoragePoolDef.PoolType.valueOf(type.toUpperCase()), poolName, uuid, host, path, targetPath, nfsMountOpts);
+                } else {
+                    return new LibvirtStoragePoolDef(LibvirtStoragePoolDef.PoolType.valueOf(type.toUpperCase()), poolName, uuid, host, path, targetPath);
+                }
             }
         } catch (ParserConfigurationException e) {
             s_logger.debug(e.toString());