From 8729551f8f3c68aa2e4444e1be1111be574fe1c4 Mon Sep 17 00:00:00 2001
From: Christopher Hoffman <choffman@redhat.com>
Date: Tue, 25 Feb 2025 14:15:53 +0000
Subject: [PATCH] doc: Add documentation for enctag in subvolume

Signed-off-by: Christopher Hoffman <choffman@redhat.com>
---
 doc/cephfs/fs-volumes.rst | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst
index 73721180223..e424a35184a 100644
--- a/doc/cephfs/fs-volumes.rst
+++ b/doc/cephfs/fs-volumes.rst
@@ -287,7 +287,7 @@ Use a command of the following form to create a subvolume:
 
 .. prompt:: bash #
 
-   ceph fs subvolume create <vol_name> <subvol_name> [--size <size_in_bytes>] [--group_name <subvol_group_name>] [--pool_layout <data_pool_name>] [--uid <uid>] [--gid <gid>] [--mode <octal_mode>] [--namespace-isolated] [--earmark <earmark>] [--normalization <form>] [--casesensitive <bool>]
+   ceph fs subvolume create <vol_name> <subvol_name> [--size <size_in_bytes>] [--group_name <subvol_group_name>] [--pool_layout <data_pool_name>] [--uid <uid>] [--gid <gid>] [--mode <octal_mode>] [--namespace-isolated] [--earmark <earmark>] [--normalization <form>] [--casesensitive <bool>] [--enctag <enctag>]
 
 
 The command succeeds even if the subvolume already exists.
@@ -351,6 +351,10 @@ file. The case of the file name used when the file was created is preserved.
 .. note:: Setting ``--casesensitive=0`` option implicitly enables
    unicode normalization on the subvolume.
 
+A separate encryption tag is available for use with encryption. This is to be used tagging the subvolume, with
+an identifier that is useful for system administrators or other services. By default, the tag is empty. This tag
+is not required, but can be a useful step in setting up encrypted subvolumes.
+
 Removing a subvolume
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -484,6 +488,7 @@ The output format is JSON and contains the following fields.
   source snapshot and names of the volume, subvolume group and subvolume in
   which the source snapshot is located. If the clone was created with Tentacle
   or earlier release, value of this field is 'N/A'.
+* ``enctag``: Encryption tag of the subvolume
 
 If a subvolume has been removed but its snapshots have been retained, the
 output contains only the following fields.
@@ -615,6 +620,33 @@ Use a command of the following form to remove the earmark of a subvolume:
 
    ceph fs subvolume earmark rm <vol_name> <subvol_name> [--group_name <subvol_group_name>]
 
+Getting enctag of a subvolume
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use a command of the following form to get the enctag on a subvolume:
+
+.. prompt:: bash #
+
+   ceph fs subvolume enctag get <vol_name> <subvol_name> [--group_name <subvol_group_name>]
+
+Setting enctag of a subvolume
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use a command of the following form to set the enctag on a subvolume:
+
+.. prompt:: bash #
+
+   ceph fs subvolume enctag set <vol_name> <subvol_name> [--group_name <subvol_group_name>] <enctag>
+
+Removing enctag of a subvolume
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use a command of the following form to remove the enctag on a subvolume:
+
+.. prompt:: bash #
+
+   ceph fs subvolume enctag rm <vol_name> <subvol_name> [--group_name <subvol_group_name>]
+
 Creating a Snapshot of a Subvolume
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.39.5