CephFS Exports over NFS
=======================
-CephFS namespaces can be exported over NFS protocol using the
-`NFS-Ganesha NFS server <https://github.com/nfs-ganesha/nfs-ganesha/wiki>`_.
+CephFS namespaces can be exported over NFS protocol using the `NFS-Ganesha NFS server`_
Requirements
============
- Latest Ceph file system with mgr enabled
-- 'nfs-ganesha', 'nfs-ganesha-ceph', 'nfs-ganesha-rados-grace' and
- 'nfs-ganesha-rados-urls' packages (version 3.3 and above)
+- ``nfs-ganesha``, ``nfs-ganesha-ceph``, ``nfs-ganesha-rados-grace`` and
+ ``nfs-ganesha-rados-urls`` packages (version 3.3 and above)
Create NFS Ganesha Cluster
==========================
$ ceph nfs cluster create <type> <clusterid> [<placement>]
This creates a common recovery pool for all NFS Ganesha daemons, new user based on
-cluster_id, and a common NFS Ganesha config RADOS object.
+``clusterid``, 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
-least one such module must be enabled for it to work.
+.. 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
+ least one such module must be enabled for it to work.
-<type> signifies the export type, which corresponds to the NFS Ganesha file
-system abstraction layer (FSAL). Permissible values are "cephfs" or "rgw", but
-currently only "cephfs" is supported.
+``<type>`` signifies the export type, which corresponds to the NFS Ganesha file
+system abstraction layer (FSAL). Permissible values are ``"cephfs`` or
+``rgw``, but currently only ``cephfs`` is supported.
-<clusterid> is an arbitrary string by which this NFS Ganesha cluster will be
+``<clusterid>`` 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
+``<placement>`` is an optional string signifying which hosts should have NFS Ganesha
daemon containers running on them and, optionally, the total number of NFS
-Ganesha daemons the cluster (should you want to have more than one NFS Ganesha
+Ganesha daemons on the cluster (should you want to have more than one NFS Ganesha
daemon running per node). For example, the following placement string means
-"deploy NFS Ganesha daemons on nodes host1 and host2 (one daemon per host):
+"deploy NFS Ganesha daemons on nodes host1 and host2 (one daemon per host)::
"host1,host2"
and this placement specification says to deploy two NFS Ganesha daemons each
on nodes host1 and host2 (for a total of four NFS Ganesha daemons in the
-cluster):
+cluster)::
"4 host1,host2"
-For more details on placement specification refer to the `orchestrator doc
-<https://docs.ceph.com/docs/master/mgr/orchestrator/#placement-specification>`_
-but keep in mind that specifying the placement via a YAML file is not supported.
+For more details, refer :ref:`orchestrator-cli-placement-spec` but keep
+in mind that specifying the placement via a YAML file is not supported.
Update NFS Ganesha Cluster
==========================
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.
+``<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.
+``<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.
+``<binding>`` is the pseudo root path (must be an absolute path and unique).
+It specifies the export position within the NFS v4 Pseudo Filesystem.
-``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:
+``<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:
.. code::
This deletes an export in an NFS Ganesha cluster, where:
-``clusterid`` is the NFS Ganesha cluster ID.
+``<clusterid>`` is the NFS Ganesha cluster ID.
-``binding`` is the pseudo root path (must be an absolute path).
+``<binding>`` is the pseudo root path (must be an absolute path).
List CephFS Exports
===================
It lists exports for a cluster, where:
-``clusterid`` is the NFS Ganesha cluster ID.
+``<clusterid>`` is the NFS Ganesha cluster ID.
With the ``--detailed`` option enabled it shows entire export block.
This displays export block for a cluster based on pseudo root name (binding),
where:
-``clusterid`` is the NFS Ganesha cluster ID.
+``<clusterid>`` is the NFS Ganesha cluster ID.
-``binding`` is the pseudo root path (must be an absolute path).
+``<binding>`` is the pseudo root path (must be an absolute path).
Configuring NFS Ganesha to export CephFS with vstart
====================================================
$ MDS=1 MON=1 OSD=3 NFS=1 ../src/vstart.sh -n -d --cephadm
- This will deploy a single NFS Ganesha daemon using ``vstart.sh``, where:
-
- The daemon will listen on the default NFS Ganesha port.
+ This will deploy a single NFS Ganesha daemon using ``vstart.sh``, where
+ the daemon will listen on the default NFS Ganesha port.
2) Using test orchestrator
$ MDS=1 MON=1 OSD=3 NFS=1 ../src/vstart.sh -n -d
- This will deploy multiple NFS Ganesha daemons, each listening on a random
- port, where:
-
- ``NFS`` is the number of NFS Ganesha clusters to be created.
+ Environment variable ``NFS`` is the number of NFS Ganesha daemons to be
+ deployed, each listening on a random port.
- NOTE: NFS Ganesha packages must be pre-installed for this to work.
+ .. note:: NFS Ganesha packages must be pre-installed for this to work.
Mount
=====
$ mount -t nfs -o port=<ganesha-port> <ganesha-host-name>:<ganesha-pseudo-path> <mount-point>
.. note:: Only NFS v4.0+ is supported.
+
+.. _NFS-Ganesha NFS Server: https://github.com/nfs-ganesha/nfs-ganesha/wiki
projects / ceph.git / commitdiff