From dd615466ef4fd723feb19f414d96d8032c7ebe8e Mon Sep 17 00:00:00 2001 From: silvacarloss Date: Wed, 20 Mar 2024 17:46:36 -0300 Subject: [PATCH] [doc] Mount options in the ceph native driver CephFS native shares will now have the cephfs filesystem name added to its metadata through `__mount_opts`. We are also warning and instructing administrators how to prevent less privileged users to update such metadata. Signed-off-by: silvacarloss Closes-Bug: #2057707 Change-Id: Ica80d80d9a3709814c1ba1c9e5d942ab0c97aec7 --- .../shared-file-systems/drivers/cephfs_driver.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/source/configuration/shared-file-systems/drivers/cephfs_driver.rst b/doc/source/configuration/shared-file-systems/drivers/cephfs_driver.rst index 072859d80f..e7975c5601 100644 --- a/doc/source/configuration/shared-file-systems/drivers/cephfs_driver.rst +++ b/doc/source/configuration/shared-file-systems/drivers/cephfs_driver.rst @@ -314,6 +314,13 @@ Finally, edit ``cephfs_filesystem_name`` with the name of the Ceph filesystem If you have more than one Ceph filesystem in the cluster, you need to set this option. +.. important:: + For Native CephFS shares, the backing ``cephfs_filesystem_name`` is visible + to end users through the ``__mount_options`` metadata. Make sure to add + the ``__mount_options`` metadata key to the list of admin only modifiable + metadata keys (``admin_only_metadata``), as explained in the + :ref:`additional configuration options page `. + .. code-block:: ini @@ -536,6 +543,10 @@ Allow a guest access to the share using ``ip`` access type. Mounting CephFS shares ~~~~~~~~~~~~~~~~~~~~~~ +.. note:: + The cephfs filesystem name will be available in the ``__mount_options`` + share's metadata. + Mounting CephFS native share using FUSE client ----------------------------------------------