ceph/doc/cephadm/nfs.rst
Zac Dover 3af9fe3fd8 doc/cephadm: add a single word
s/If the nfs-ganesha doesn't/If the
nfs-ganesha pool doesn't/

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-04-27 00:32:21 +10:00

63 lines
1.5 KiB
ReStructuredText

===========
NFS Service
===========
.. note:: Only the NFSv4 protocol is supported.
.. _deploy-cephadm-nfs-ganesha:
Deploying NFS ganesha
=====================
Cephadm deploys NFS Ganesha using a pre-defined RADOS *pool*
and optional *namespace*.
To deploy a NFS Ganesha gateway, run the following command:
.. prompt:: bash #
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 the namespace *nfs-ns*, run this command:
.. prompt:: bash #
ceph orch apply nfs foo nfs-ganesha nfs-ns
.. note::
If the *nfs-ganesha* pool doesn't exist, create it.
See :ref:`orchestrator-cli-placement-spec` for the details of the placement
specification.
Service Specification
=====================
Alternatively, an NFS service can be applied using a YAML specification.
A service of type ``nfs`` requires a pool name and can contain
an optional namespace:
.. code-block:: yaml
service_type: nfs
service_id: mynfs
placement:
hosts:
- host1
- host2
spec:
pool: mypool
namespace: mynamespace
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 by running the following command:
.. prompt:: bash #
ceph orch apply -i nfs.yaml