From 5b2378104a9dfc0880b8cd8ba2dcef6cdd65fcfa Mon Sep 17 00:00:00 2001 From: Avan Thakkar Date: Tue, 24 Sep 2024 12:31:01 +0530 Subject: [PATCH] doc: update doc for subvolumes earmarking mentioning valid formats Signed-off-by: Avan Thakkar --- doc/cephfs/fs-volumes.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst index 3adac4a51a4..4a5b5232738 100644 --- a/doc/cephfs/fs-volumes.rst +++ b/doc/cephfs/fs-volumes.rst @@ -299,6 +299,24 @@ The earmarking mechanism ensures that subvolumes are correctly tagged and manage helping to avoid conflicts and ensuring that each subvolume is associated with the intended service or use case. +Valid Earmarks +~~~~~~~~~~~~~~~~~~~~ + +- **For NFS:** + - The valid earmark format is the top-level scope: ``'nfs'``. + +- **For SMB:** + - The valid earmark formats are: + - The top-level scope: ``'smb'``. + - The top-level scope with an intra-module level scope: ``'smb.cluster.{cluster_id}'``, where ``cluster_id`` is a short string uniquely identifying the cluster. + - Example without intra-module scope: ``smb`` + - Example with intra-module scope: ``smb.cluster.cluster_1`` + +.. note:: If you are changing an earmark from one scope to another (e.g., from nfs to smb or vice versa), + be aware that user permissions and ACLs associated with the previous scope might still apply. Ensure that + any necessary permissions are updated as needed to maintain proper access control. + + Removing a subvolume ~~~~~~~~~~~~~~~~~~~~ -- 2.47.3