From: Sage Weil <sage@newdream.net>
Date: Mon, 21 Jun 2021 16:13:40 +0000 (-0400)
Subject: doc/cephfs/fs-nfs-export: be consistent with cluster_id and _ vs -
X-Git-Tag: v17.1.0~1551^2~12
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=87c98df2cd2aa27806fe7f4f8cd4e5ec0a4fd74b;p=ceph.git

doc/cephfs/fs-nfs-export: be consistent with cluster_id and _ vs -

Signed-off-by: Sage Weil <sage@newdream.net>
---

diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst
index 76532f833043..267a97e5e237 100644
--- a/doc/cephfs/fs-nfs-exports.rst
+++ b/doc/cephfs/fs-nfs-exports.rst
@@ -68,10 +68,10 @@ Create NFS Ganesha Cluster
 
 .. code:: bash
 
-    $ ceph nfs cluster create <clusterid> [<placement>] [--ingress --virtual-ip <ip>]
+    $ ceph nfs cluster create <cluster_id> [<placement>] [--ingress --virtual-ip <ip>]
 
 This creates a common recovery pool for all NFS Ganesha daemons, new user based on
-``clusterid``, and a common NFS Ganesha config RADOS object.
+``cluster_id``, and a common NFS Ganesha config RADOS object.
 
 .. note:: Since this command also brings up NFS Ganesha daemons using a ceph-mgr
    orchestrator module (see :doc:`/mgr/orchestrator`) such as "mgr/cephadm", at
@@ -80,7 +80,7 @@ This creates a common recovery pool for all NFS Ganesha daemons, new user based
    Currently, NFS Ganesha daemon deployed by cephadm listens on the standard
    port. So only one daemon will be deployed on a host.
 
-``<clusterid>`` is an arbitrary string by which this NFS Ganesha cluster will be
+``<cluster_id>`` is an arbitrary string by which this NFS Ganesha cluster will be
 known.
 
 ``<placement>`` is an optional string signifying which hosts should have NFS Ganesha
@@ -110,7 +110,7 @@ Delete NFS Ganesha Cluster
 
 .. code:: bash
 
-    $ ceph nfs cluster rm <clusterid>
+    $ ceph nfs cluster rm <cluster_id>
 
 This deletes the deployed cluster.
 
@@ -128,7 +128,7 @@ Show NFS Ganesha Cluster Information
 
 .. code:: bash
 
-    $ ceph nfs cluster info [<clusterid>]
+    $ ceph nfs cluster info [<cluster_id>]
 
 This displays ip and port of deployed cluster.
 
@@ -144,7 +144,7 @@ Set Customized NFS Ganesha Configuration
 
 .. code:: bash
 
-    $ ceph nfs cluster config set <clusterid> -i <config_file>
+    $ ceph nfs cluster config set <cluster_id> -i <config_file>
 
 With this the nfs cluster will use the specified config and it will have
 precedence over default config blocks.
@@ -194,7 +194,7 @@ Reset NFS Ganesha Configuration
 
 .. code:: bash
 
-    $ ceph nfs cluster config reset <clusterid>
+    $ ceph nfs cluster config reset <cluster_id>
 
 This removes the user defined configuration.
 
@@ -211,16 +211,16 @@ Create CephFS Export
 
 .. code:: bash
 
-    $ ceph nfs export create cephfs <fsname> <clusterid> <pseudo-path> [--readonly] [--path=/path/in/cephfs]
+    $ ceph nfs export create cephfs <fsname> <cluster_id> <pseudo_path> [--readonly] [--path=/path/in/cephfs]
 
 This creates export RADOS objects containing the export block, where
 
 ``<fsname>`` is the name of the FS volume used by the NFS Ganesha cluster
 that will serve this export.
 
-``<clusterid>`` is the NFS Ganesha cluster ID.
+``<cluster_id>`` is the NFS Ganesha cluster ID.
 
-``<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.
+``<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:
@@ -236,24 +236,24 @@ Delete CephFS Export
 
 .. code:: bash
 
-    $ ceph nfs export rm <clusterid> <pseudo-path>
+    $ ceph nfs export rm <cluster_id> <pseudo_path>
 
 This deletes an export in an NFS Ganesha cluster, where:
 
-``<clusterid>`` is the NFS Ganesha cluster ID.
+``<cluster_id>`` is the NFS Ganesha cluster ID.
 
-``<pseudo-path>`` 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
 ===================
 
 .. code:: bash
 
-    $ ceph nfs export ls <clusterid> [--detailed]
+    $ ceph nfs export ls <cluster_id> [--detailed]
 
 It lists exports for a cluster, where:
 
-``<clusterid>`` is the NFS Ganesha cluster ID.
+``<cluster_id>`` is the NFS Ganesha cluster ID.
 
 With the ``--detailed`` option enabled it shows entire export block.
 
@@ -262,14 +262,14 @@ Get CephFS Export
 
 .. code:: bash
 
-    $ ceph nfs export info <clusterid> <pseudo-path>
+    $ ceph nfs export info <cluster_id> <pseudo_path>
 
 This displays export block for a cluster based on pseudo root name,
 where:
 
-``<clusterid>`` is the NFS Ganesha cluster ID.
+``<cluster_id>`` is the NFS Ganesha cluster ID.
 
-``<pseudo-path>`` 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
@@ -279,7 +279,7 @@ An existing export can be dumped in JSON format with:
 
 .. prompt:: bash #
 
-    ceph nfs export info *<pseudo-path>*
+    ceph nfs export info *<pseudo_path>*
 
 An export can be created or modified by importing a JSON description in the
 same format:
@@ -352,7 +352,7 @@ grace period. The exports can be mounted by
 
 .. code:: bash
 
-    $ mount -t nfs -o port=<ganesha-port> <ganesha-host-name>:<ganesha-pseudo-path> <mount-point>
+    $ mount -t nfs -o port=<ganesha-port> <ganesha-host-name>:<ganesha-pseudo_path> <mount-point>
 
 .. note:: Only NFS v4.0+ is supported.