From 8e0e38bef902421ff45c39e3b1c9ae9a929e48d5 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Tue, 21 May 2024 01:07:14 +1000 Subject: [PATCH] doc/cephfs: edit "Pinning Subvolumes..." Edit the section "Pinning Subvolumes and Subvolume Groups" in doc/cephfs/fs-volumes.rst. This is merely a grammar edit. Signed-off-by: Zac Dover (cherry picked from commit b319ead00e17a3a6d734e305454c8cfc403619ea) --- doc/cephfs/fs-volumes.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst index 8ad5258814ae6..448b9688082f1 100644 --- a/doc/cephfs/fs-volumes.rst +++ b/doc/cephfs/fs-volumes.rst @@ -811,31 +811,32 @@ to policies. This can distribute load across MDS ranks in predictable and stable ways. Review :ref:`cephfs-pinning` and :ref:`cephfs-ephemeral-pinning` for details on how pinning works. -Pinning is configured by: +Run a command of the following form to configure pinning for subvolumegroups: .. prompt:: bash # ceph fs subvolumegroup pin -or for subvolumes: +Run a command of the following form to configure pinning for subvolumes: .. prompt:: bash # ceph fs subvolume pin -Typically you will want to set subvolume group pins. The ``pin_type`` may be -one of ``export``, ``distributed``, or ``random``. The ``pin_setting`` -corresponds to the extended attributed "value" as in the pinning documentation -referenced above. +Under most circumstances, you will want to set subvolume group pins. The +``pin_type`` may be ``export``, ``distributed``, or ``random``. The +``pin_setting`` corresponds to the extended attributed "value" as in the +pinning documentation referenced above. -So, for example, setting a distributed pinning strategy on a subvolume group: +Here is an example of setting a distributed pinning strategy on a subvolume +group: .. prompt:: bash # ceph fs subvolumegroup pin cephfilesystem-a csi distributed 1 -Will enable distributed subtree partitioning policy for the "csi" subvolume -group. This will cause every subvolume within the group to be automatically +This enables distributed subtree partitioning policy for the "csi" subvolume +group. This will cause every subvolume within the group to be automatically pinned to one of the available ranks on the file system. Subvolume quiesce -- 2.47.3