mirror of
https://github.com/ceph/ceph
synced 2026-08-02 07:03:18 +00:00
Merge PR #36125 into master
* refs/pull/36125/head: doc: cephfs/fs-nfs-exports: more cleanups doc: cephfs/fs-nfs-exports: command requires enabled orch module doc: cephfs/fs-nfs-exports.rst: write "RADOS" in ALL-CAPS doc: cephfs/fs-nfs-exports: use "NFS Ganesha" everywhere doc: cephfs: clarify that pseudo root path must be absolute doc: cephfs: fix misleading "ceph fs volume create" command doc: cephfs: fix misleading "ceph nfs create" command Reviewed-by: Varsha Rao <varao@redhat.com> Reviewed-by: Patrick Donnelly <pdonnell@redhat.com> Reviewed-by: Zac Dover <zac.dover@gmail.com>
This commit is contained in:
Patrick Donnelly
commit
9fcc49fae7
@ -125,3 +125,4 @@ mchangir Milind Changire <mchangir@redhat.com>
|
||||
kotreshhr Kotresh Hiremath Ravishankar <khiremat@redhat.com>
|
||||
vkmc Victoria Martinez de la Cruz <vkmc@redhat.com>
|
||||
gouthampacha Goutham Pacha Ravi <gouthamr@redhat.com>
|
||||
zdover23 Zac Dover <zac.dover@gmail.com>
|
||||
|
||||
@ -17,15 +17,39 @@ Create NFS Ganesha Cluster
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ ceph nfs cluster create <type=cephfs> <clusterid> [<placement>]
|
||||
$ ceph nfs cluster create <type> <clusterid> [<placement>]
|
||||
|
||||
This creates a common recovery pool for all Ganesha daemons, new user based on
|
||||
cluster_id and common ganesha config rados object.
|
||||
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.
|
||||
|
||||
Here type is export type and placement specifies the size of cluster and hosts.
|
||||
For more details on placement specification refer the `orchestrator doc
|
||||
<https://docs.ceph.com/docs/master/mgr/orchestrator/#placement-specification>`_.
|
||||
Currently only CephFS export type is supported.
|
||||
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.
|
||||
|
||||
<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
|
||||
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
|
||||
daemon running per node). For example, the following placement string means
|
||||
"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):
|
||||
|
||||
"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.
|
||||
|
||||
Update NFS Ganesha Cluster
|
||||
==========================
|
||||
@ -63,8 +87,8 @@ Show NFS Ganesha Cluster Information
|
||||
|
||||
This displays ip and port of deployed cluster.
|
||||
|
||||
Set Customized Ganesha Configuration
|
||||
====================================
|
||||
Set Customized NFS Ganesha Configuration
|
||||
========================================
|
||||
|
||||
.. code:: bash
|
||||
|
||||
@ -73,8 +97,8 @@ Set Customized Ganesha Configuration
|
||||
With this the nfs cluster will use the specified config and it will have
|
||||
precedence over default config blocks.
|
||||
|
||||
Reset Ganesha Configuration
|
||||
===========================
|
||||
Reset NFS Ganesha Configuration
|
||||
===============================
|
||||
|
||||
.. code:: bash
|
||||
|
||||
@ -89,8 +113,14 @@ Create CephFS Export
|
||||
|
||||
$ ceph nfs export create cephfs <fsname> <clusterid> <binding> [--readonly] [--path=/path/in/cephfs]
|
||||
|
||||
It creates export rados objects containing the export block. Here binding is
|
||||
the pseudo root name and type is export type.
|
||||
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.
|
||||
|
||||
``binding`` is the pseudo root path (must be an absolute path).
|
||||
|
||||
Delete CephFS Export
|
||||
====================
|
||||
@ -99,17 +129,24 @@ Delete CephFS Export
|
||||
|
||||
$ ceph nfs export delete <clusterid> <binding>
|
||||
|
||||
It deletes an export in cluster based on pseudo root name (binding).
|
||||
This deletes an export in an NFS Ganesha cluster, where:
|
||||
|
||||
List CephFS Export
|
||||
==================
|
||||
``clusterid`` is the NFS Ganesha cluster ID.
|
||||
|
||||
``binding`` is the pseudo root path (must be an absolute path).
|
||||
|
||||
List CephFS Exports
|
||||
===================
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ ceph nfs export ls <clusterid> [--detailed]
|
||||
|
||||
It lists export for a cluster. With detailed option enabled it shows entire
|
||||
export block.
|
||||
It lists exports for a cluster, where:
|
||||
|
||||
``clusterid`` is the NFS Ganesha cluster ID.
|
||||
|
||||
With the ``--detailed`` option enabled it shows entire export block.
|
||||
|
||||
Get CephFS Export
|
||||
=================
|
||||
@ -118,18 +155,25 @@ Get CephFS Export
|
||||
|
||||
$ ceph nfs export get <clusterid> <binding>
|
||||
|
||||
It displays export block for a cluster based on pseudo root name (binding).
|
||||
This displays export block for a cluster based on pseudo root name (binding),
|
||||
where:
|
||||
|
||||
Configuring NFS-Ganesha to export CephFS with vstart
|
||||
``clusterid`` is the NFS Ganesha cluster ID.
|
||||
|
||||
``binding`` is the pseudo root path (must be an absolute path).
|
||||
|
||||
Configuring NFS Ganesha to export CephFS with vstart
|
||||
====================================================
|
||||
|
||||
1) Using cephadm
|
||||
1) Using ``cephadm``
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ MDS=1 MON=1 OSD=3 NFS=1 ../src/vstart.sh -n -d --cephadm
|
||||
|
||||
It can deploy only single ganesha daemon with vstart on default 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
|
||||
|
||||
@ -137,15 +181,17 @@ Configuring NFS-Ganesha to export CephFS with vstart
|
||||
|
||||
$ MDS=1 MON=1 OSD=3 NFS=1 ../src/vstart.sh -n -d
|
||||
|
||||
It can deploy multiple ganesha daemons on random port. But this requires
|
||||
ganesha packages to be installed.
|
||||
This will deploy multiple NFS Ganesha daemons, each listening on a random
|
||||
port, where:
|
||||
|
||||
NFS: It is the number of NFS-Ganesha clusters to be created.
|
||||
``NFS`` is the number of NFS Ganesha clusters to be created.
|
||||
|
||||
NOTE: NFS Ganesha packages must be pre-installed for this to work.
|
||||
|
||||
Mount
|
||||
=====
|
||||
|
||||
After the exports are successfully created and Ganesha daemons are no longer in
|
||||
After the exports are successfully created and NFS Ganesha daemons are no longer in
|
||||
grace period. The exports can be mounted by
|
||||
|
||||
.. code:: bash
|
||||
|
||||
@ -45,9 +45,29 @@ Create a volume using::
|
||||
|
||||
$ ceph fs volume create <vol_name> [<placement>]
|
||||
|
||||
This creates a CephFS file system and its data and metadata pools. It also tries
|
||||
to create MDSes for the filesystem using the enabled ceph-mgr orchestrator
|
||||
module (see :doc:`/mgr/orchestrator`) , e.g., rook.
|
||||
This creates a CephFS file system and its data and metadata pools. It can also
|
||||
try to create MDSes for the filesystem using the enabled ceph-mgr orchestrator
|
||||
module (see :doc:`/mgr/orchestrator`), e.g. rook.
|
||||
|
||||
<vol_name> is the volume name (an arbitrary string), and
|
||||
|
||||
<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
|
||||
daemon running per node). For example, the following placement string means
|
||||
"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):
|
||||
|
||||
"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.
|
||||
|
||||
Remove a volume using::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user
