]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephadm: rewrite "nfs.rst"
authorZac Dover <zac.dover@gmail.com>
Mon, 26 Apr 2021 13:04:04 +0000 (23:04 +1000)
committerSage Weil <sage@newdream.net>
Tue, 4 May 2021 16:19:43 +0000 (11:19 -0500)
This PR makes a few (very small) stylistic
corrections, mostly typographical, to the text.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 36426d6df56cadb33f20605a47e369bd8c01a813)

doc/cephadm/nfs.rst

index 51da9f0845e63c881ed2f5987b04000fe2a0b6a3..f0b67a102a4f4af371601e216a07a7e51b60ab15 100644 (file)
@@ -10,7 +10,7 @@ Deploying NFS ganesha
 =====================
 
 Cephadm deploys NFS Ganesha using a pre-defined RADOS *pool*
-and optional *namespace*
+and optional *namespace*.
 
 To deploy a NFS Ganesha gateway, run the following command:
 
@@ -18,24 +18,25 @@ To deploy a NFS Ganesha gateway, run the following command:
 
     ceph orch apply nfs *<svc_id>* *<pool>* *<namespace>* --placement="*<num-daemons>* [*<host1>* ...]"
 
-For example, to deploy NFS with a service id of *foo*, that will use the RADOS
-pool *nfs-ganesha* and namespace *nfs-ns*:
+For example, to deploy NFS with a service id of *foo* that will use the RADOS
+pool *nfs-ganesha* and the namespace *nfs-ns*, run this command:
 
 .. prompt:: bash #
 
    ceph orch apply nfs foo nfs-ganesha nfs-ns
 
 .. note::
-   Create the *nfs-ganesha* pool first if it doesn't exist.
+   If the *nfs-ganesha* doesn't exist, create it.
 
-See :ref:`orchestrator-cli-placement-spec` for details of the placement specification.
+See :ref:`orchestrator-cli-placement-spec` for the details of the placement
+specification.
 
 Service Specification
 =====================
 
-Alternatively, an NFS service can also be applied using a YAML specification. 
+Alternatively, an NFS service can be applied using a YAML specification. 
 
-A service of type ``nfs`` requires a pool name and may contain
+A service of type ``nfs`` requires a pool name and can contain
 an optional namespace:
 
 .. code-block:: yaml
@@ -50,11 +51,11 @@ an optional namespace:
       pool: mypool
       namespace: mynamespace
 
-where ``pool`` is a RADOS pool where NFS client recovery data is stored
-and ``namespace`` is a RADOS namespace where NFS client recovery
-data is stored in the pool.
+In this example, ``pool`` is a RADOS pool where NFS client recovery data is
+stored and ``namespace`` is a RADOS namespace where NFS client recovery data
+is stored.
 
-The specification can then be applied using:
+The specification can then be applied by running the following command:
 
 .. prompt:: bash #