]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
mgr/nfs: binding -> pseudo_path
authorSage Weil <sage@newdream.net>
Thu, 17 Jun 2021 21:12:15 +0000 (17:12 -0400)
committerSage Weil <sage@newdream.net>
Mon, 21 Jun 2021 18:13:15 +0000 (14:13 -0400)
Signed-off-by: Sage Weil <sage@newdream.net>
doc/cephfs/fs-nfs-exports.rst
doc/radosgw/nfs.rst
qa/suites/orch/cephadm/smoke-roleless/2-services/nfs-ingress.yaml
qa/suites/orch/cephadm/smoke-roleless/2-services/nfs-ingress2.yaml
src/pybind/mgr/nfs/module.py

index 6d08323bccd822e7e190da431baa24fc8278532e..a152be661ab6a9731606a03c0e8b7fcc6c32a3c5 100644 (file)
@@ -211,7 +211,7 @@ Create CephFS Export
 
 .. code:: bash
 
-    $ ceph nfs export create cephfs <fsname> <clusterid> <binding> [--readonly] [--path=/path/in/cephfs]
+    $ ceph nfs export create cephfs <fsname> <clusterid> <pseudo-path> [--readonly] [--path=/path/in/cephfs]
 
 This creates export RADOS objects containing the export block, where
 
@@ -220,8 +220,7 @@ that will serve this export.
 
 ``<clusterid>`` is the NFS Ganesha cluster ID.
 
-``<binding>`` is the pseudo root path (must be an absolute path and unique).
-It specifies the export position within the NFS v4 Pseudo Filesystem.
+``<pseudo-path>`` is the export position within the NFS v4 Pseudo Filesystem where the export will be available on the server.  It must be an absolute path and unique.
 
 ``<path>`` is the path within cephfs. Valid path should be given and default
 path is '/'. It need not be unique. Subvolume path can be fetched using:
@@ -237,13 +236,13 @@ Delete CephFS Export
 
 .. code:: bash
 
-    $ ceph nfs export rm <clusterid> <binding>
+    $ ceph nfs export rm <clusterid> <pseudo-path>
 
 This deletes an export in an NFS Ganesha cluster, where:
 
 ``<clusterid>`` is the NFS Ganesha cluster ID.
 
-``<binding>`` is the pseudo root path (must be an absolute path).
+``<pseudo-path>`` is the pseudo root path (must be an absolute path).
 
 List CephFS Exports
 ===================
@@ -263,14 +262,14 @@ Get CephFS Export
 
 .. code:: bash
 
-    $ ceph nfs export get <clusterid> <binding>
+    $ ceph nfs export get <clusterid> <pseudo-path>
 
-This displays export block for a cluster based on pseudo root name (binding),
+This displays export block for a cluster based on pseudo root name,
 where:
 
 ``<clusterid>`` is the NFS Ganesha cluster ID.
 
-``<binding>`` is the pseudo root path (must be an absolute path).
+``<pseudo-path>`` is the pseudo root path (must be an absolute path).
 
 
 Create or update CephFS Export via JSON specification
index 538ac1da4c63b86097614b92cd01db98d954b1f1..9be7572686fb8f9a3b428a47eb6fef242b15bc19 100644 (file)
@@ -109,7 +109,7 @@ To export a bucket,
 
   .. prompt:: bash #
 
-    ceph nfs export create rgw *<bucket-name>* *<cluster-id>* *<binding>* [--readonly] [--addr *<client-ip-or-cidr>*
+    ceph nfs export create rgw *<bucket-name>* *<cluster-id>* *<pseudo>* [--readonly] [--addr *<client-ip-or-cidr>*
 
 For example, to export *mybucket* via NFS cluster *mynfs* at the pseudo-path */bucketdata* to any host in the ``192.168.10.0/24`` network,
 
@@ -133,7 +133,7 @@ To disable an existing export,
 
   .. prompt:: bash #
 
-    ceph nfs export rm *<cluster-id>* *<binding>*
+    ceph nfs export rm *<cluster-id>* *<pseudo>*
 
 For example, to disable an export from cluster *mynfs* on ``/my-export``,
 
index 3e5ad1a2ecbdbccaf397875af80b0e912acf0875..3d935218a95e410024ab4ab78c6cc0f8ebb25aa9 100644 (file)
@@ -40,7 +40,7 @@ tasks:
 
 - cephadm.shell:
     host.a:
-      - ceph nfs export create cephfs foofs foo --binding /fake
+      - ceph nfs export create cephfs foofs foo --pseudo-path /fake
 
 - vip.exec:
     host.a:
index 09fb3c7684bf476306efabb2ee108c45ac7cf33b..87f83380a1d6a2e51337ecf90ca7552badb64cf8 100644 (file)
@@ -15,7 +15,7 @@ tasks:
     host.a:
       - ceph fs volume create foofs
       - ceph nfs cluster create foo --ingress --virtual-ip {{VIP0}}/{{VIPPREFIXLEN}}
-      - ceph nfs export create cephfs foofs foo --binding /fake
+      - ceph nfs export create cephfs foofs foo --pseudo-path /fake
 
 - cephadm.wait_for_service:
     service: nfs.foo
index 959f0297154d7d21a48385ee985d4365831a8172..7039f5b2041cc5181f83fb2957c1fa718fc31bb9 100644 (file)
@@ -29,7 +29,7 @@ class Module(orchestrator.OrchestratorClientMixin, MgrModule):
             self,
             fsname: str,
             cluster_id: str,
-            binding: str,
+            pseudo_path: str,
             path: Optional[str] = '/',
             readonly: Optional[bool] = False,
             addr: Optional[List[str]] = None,
@@ -37,7 +37,7 @@ class Module(orchestrator.OrchestratorClientMixin, MgrModule):
     ) -> Tuple[int, str, str]:
         """Create a cephfs export"""
         return self.export_mgr.create_export(fsal_type='cephfs', fs_name=fsname,
-                                             cluster_id=cluster_id, pseudo_path=binding,
+                                             cluster_id=cluster_id, pseudo_path=pseudo_path,
                                              read_only=readonly, path=path,
                                              squash=squash, addr=addr)
 
@@ -46,7 +46,7 @@ class Module(orchestrator.OrchestratorClientMixin, MgrModule):
             self,
             bucket: str,
             cluster_id: str,
-            binding: str,
+            pseudo_path: str,
             readonly: Optional[bool] = False,
             addr: Optional[List[str]] = None,
             realm: Optional[str] = None,
@@ -54,19 +54,19 @@ class Module(orchestrator.OrchestratorClientMixin, MgrModule):
         """Create an RGW export"""
         return self.export_mgr.create_export(fsal_type='rgw', bucket=bucket,
                                              realm=realm,
-                                             cluster_id=cluster_id, pseudo_path=binding,
+                                             cluster_id=cluster_id, pseudo_path=pseudo_path,
                                              read_only=readonly, squash='none',
                                              addr=addr)
 
     @CLICommand('nfs export rm', perm='rw')
-    def _cmd_nfs_export_rm(self, cluster_id: str, binding: str) -> Tuple[int, str, str]:
+    def _cmd_nfs_export_rm(self, cluster_id: str, pseudo_path: str) -> Tuple[int, str, str]:
         """Remove a cephfs export"""
-        return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=binding)
+        return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=pseudo_path)
 
     @CLICommand('nfs export delete', perm='rw')
-    def _cmd_nfs_export_delete(self, cluster_id: str, binding: str) -> Tuple[int, str, str]:
+    def _cmd_nfs_export_delete(self, cluster_id: str, pseudo_path: str) -> Tuple[int, str, str]:
         """Delete a cephfs export (DEPRECATED)"""
-        return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=binding)
+        return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=pseudo_path)
 
     @CLICommand('nfs export ls', perm='r')
     def _cmd_nfs_export_ls(self, cluster_id: str, detailed: bool = False) -> Tuple[int, str, str]:
@@ -74,9 +74,9 @@ class Module(orchestrator.OrchestratorClientMixin, MgrModule):
         return self.export_mgr.list_exports(cluster_id=cluster_id, detailed=detailed)
 
     @CLICommand('nfs export get', perm='r')
-    def _cmd_nfs_export_get(self, cluster_id: str, binding: str) -> Tuple[int, str, str]:
+    def _cmd_nfs_export_get(self, cluster_id: str, pseudo_path: str) -> Tuple[int, str, str]:
         """Fetch a export of a NFS cluster given the pseudo path/binding"""
-        return self.export_mgr.get_export(cluster_id=cluster_id, pseudo_path=binding)
+        return self.export_mgr.get_export(cluster_id=cluster_id, pseudo_path=pseudo_path)
 
     @CLICommand('nfs export apply', perm='rw')
     @CLICheckNonemptyFileInput(desc='Export JSON specification')