Skip to content

Commit 88582e0

Browse files
authored
Merge pull request ceph#57574 from zdover23/wip-doc-2024-05-21-cephfs-fs-volumes-pinning-subvolumes
doc/cephfs: edit "Pinning Subvolumes..." Reviewed-by: Anthony D'Atri <[email protected]>
2 parents ef9bf76 + b319ead commit 88582e0

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

doc/cephfs/fs-volumes.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -811,31 +811,32 @@ to policies. This can distribute load across MDS ranks in predictable and
811811
stable ways. Review :ref:`cephfs-pinning` and :ref:`cephfs-ephemeral-pinning`
812812
for details on how pinning works.
813813

814-
Pinning is configured by:
814+
Run a command of the following form to configure pinning for subvolumegroups:
815815

816816
.. prompt:: bash #
817817

818818
ceph fs subvolumegroup pin <vol_name> <group_name> <pin_type> <pin_setting>
819819

820-
or for subvolumes:
820+
Run a command of the following form to configure pinning for subvolumes:
821821

822822
.. prompt:: bash #
823823

824824
ceph fs subvolume pin <vol_name> <group_name> <pin_type> <pin_setting>
825825

826-
Typically you will want to set subvolume group pins. The ``pin_type`` may be
827-
one of ``export``, ``distributed``, or ``random``. The ``pin_setting``
828-
corresponds to the extended attributed "value" as in the pinning documentation
829-
referenced above.
826+
Under most circumstances, you will want to set subvolume group pins. The
827+
``pin_type`` may be ``export``, ``distributed``, or ``random``. The
828+
``pin_setting`` corresponds to the extended attributed "value" as in the
829+
pinning documentation referenced above.
830830

831-
So, for example, setting a distributed pinning strategy on a subvolume group:
831+
Here is an example of setting a distributed pinning strategy on a subvolume
832+
group:
832833

833834
.. prompt:: bash #
834835

835836
ceph fs subvolumegroup pin cephfilesystem-a csi distributed 1
836837

837-
Will enable distributed subtree partitioning policy for the "csi" subvolume
838-
group. This will cause every subvolume within the group to be automatically
838+
This enables distributed subtree partitioning policy for the "csi" subvolume
839+
group. This will cause every subvolume within the group to be automatically
839840
pinned to one of the available ranks on the file system.
840841

841842
Subvolume quiesce

0 commit comments

Comments
 (0)