Merge PR #43896 into master

* refs/pull/43896/head:
	doc: document subvolume (group) pins

Reviewed-by: Kotresh Hiremath Ravishankar <khiremat@redhat.com>
This commit is contained in:
Patrick Donnelly 2021-11-12 10:20:05 -05:00
commit 6588d8ff77
No known key found for this signature in database
GPG Key ID: BE69BB7D36E459B4
2 changed files with 36 additions and 0 deletions

View File

@ -383,5 +383,39 @@ On successful cancelation, the cloned subvolume is moved to `canceled` state::
.. note:: The canceled cloned can be deleted by using --force option in `fs subvolume rm` command.
.. _subvol-pinning:
Pinning Subvolumes and Subvolume Groups
---------------------------------------
Subvolumes and subvolume groups can be automatically pinned to ranks according
to policies. This can help 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::
$ ceph fs subvolumegroup pin <vol_name> <group_name> <pin_type> <pin_setting>
or for subvolumes::
$ ceph fs subvolume pin <vol_name> <group_name> <pin_type> <pin_setting>
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.
So, for example, setting a distributed pinning strategy on a subvolume group::
$ 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
pinned to one of the available ranks on the file system.
.. _manila: https://github.com/openstack/manila
.. _CSI: https://github.com/ceph/ceph-csi

View File

@ -100,6 +100,8 @@ When a daemon finishes stopping, it will respawn itself and go back to being a
standby.
.. _cephfs-pinning:
Manually pinning directory trees to a particular rank
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~