diff options
| author | Avan Thakkar <athakkar@redhat.com> | 2024-09-03 15:15:47 +0200 |
|---|---|---|
| committer | Avan Thakkar <athakkar@redhat.com> | 2024-09-16 21:16:00 +0200 |
| commit | b895e596a88a9f4b0fe07dce082b369f4f04b8d2 (patch) | |
| tree | 964aadfcb8d1b6a16c8a4f995eecff1f5d47628a /doc | |
| parent | mgr/nfs: add additional tests for cmount_path & user_id deletion (diff) | |
| download | ceph-b895e596a88a9f4b0fe07dce082b369f4f04b8d2.tar.xz ceph-b895e596a88a9f4b0fe07dce082b369f4f04b8d2.zip | |
doc: nit fixes for nfs doc
Signed-off-by: Avan Thakkar <athakkar@redhat.com>
Fixes some doc lint and also fixed qa tests for having both 3 & 4 protocols
by default in expot config.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mgr/nfs.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst index a4332300039..3077ea40aa6 100644 --- a/doc/mgr/nfs.rst +++ b/doc/mgr/nfs.rst @@ -318,10 +318,11 @@ values may be separated by a comma (example: ``--sectype krb5p,krb5i``). The server will negotatiate a supported security type with the client preferring the supplied methods left-to-right. -``<cmount_path>`` specifies the path within the ceph filesystem to mount this export on. It is +``<cmount_path>`` specifies the path within the CephFS to mount this export on. It is allowed to be any complete path hierarchy between ``/`` and the ``EXPORT {path}``. (i.e. if ``EXPORT { Path }`` parameter is ``/foo/bar`` then cmount_path could be ``/``, ``/foo`` or ``/foo/bar``). -!! If this and the other ``EXPORT { FSAL {} }`` options are the same between multiple exports, those exports will share a single cephfs client. -If not specified, the default is ``/``. + +.. note:: If this and the other ``EXPORT { FSAL {} }`` options are the same between multiple exports, those exports will share a single CephFS client. + If not specified, the default is ``/``. .. note:: Specifying values for sectype that require Kerberos will only function on servers that are configured to support Kerberos. Setting up NFS-Ganesha to support Kerberos @@ -498,7 +499,8 @@ provided JSON should fully describe the new state of the export (just as when creating a new export), with the exception of the authentication credentials, which will be carried over from the previous state of the export where possible. -The ``user_id`` in the ``fsal`` block should not be modified or mentioned in the JSON file as it is auto-generated for CephFS exports. + +!! NOTE: The ``user_id`` in the ``fsal`` block should not be modified or mentioned in the JSON file as it is auto-generated for CephFS exports. It's auto-generated in the format ``nfs.<cluster_id>.<fs_name>.<hash_id>``. :: |