From 36426d6df56cadb33f20605a47e369bd8c01a813 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Mon, 26 Apr 2021 23:04:04 +1000 Subject: [PATCH] doc/cephadm: rewrite "nfs.rst" This PR makes a few (very small) stylistic corrections, mostly typographical, to the text. Signed-off-by: Zac Dover --- doc/cephadm/nfs.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/cephadm/nfs.rst b/doc/cephadm/nfs.rst index 51da9f0845e..f0b67a102a4 100644 --- a/doc/cephadm/nfs.rst +++ b/doc/cephadm/nfs.rst @@ -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 ** ** ** --placement="** [** ...]" -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 #