Skip to content

Commit 5b23781

Browse files
committed
doc: update doc for subvolumes earmarking mentioning valid formats
Signed-off-by: Avan Thakkar <[email protected]>
1 parent bc168d7 commit 5b23781

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/cephfs/fs-volumes.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,24 @@ The earmarking mechanism ensures that subvolumes are correctly tagged and manage
299299
helping to avoid conflicts and ensuring that each subvolume is associated
300300
with the intended service or use case.
301301

302+
Valid Earmarks
303+
~~~~~~~~~~~~~~~~~~~~
304+
305+
- **For NFS:**
306+
- The valid earmark format is the top-level scope: ``'nfs'``.
307+
308+
- **For SMB:**
309+
- The valid earmark formats are:
310+
- The top-level scope: ``'smb'``.
311+
- 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.
312+
- Example without intra-module scope: ``smb``
313+
- Example with intra-module scope: ``smb.cluster.cluster_1``
314+
315+
.. note:: If you are changing an earmark from one scope to another (e.g., from nfs to smb or vice versa),
316+
be aware that user permissions and ACLs associated with the previous scope might still apply. Ensure that
317+
any necessary permissions are updated as needed to maintain proper access control.
318+
319+
302320
Removing a subvolume
303321
~~~~~~~~~~~~~~~~~~~~
304322

0 commit comments

Comments
 (0)