From da4dcd673bda49a709c5457a2ef9de943f6de479 Mon Sep 17 00:00:00 2001 From: Patrick Donnelly Date: Mon, 29 Mar 2021 09:46:32 -0700 Subject: [PATCH] doc: add links for pacific cephfs features Note: cephfs-mirror does not yet have user-facing documentation to link to. Signed-off-by: Patrick Donnelly --- doc/cephfs/ceph-dokan.rst | 2 ++ doc/cephfs/cephfs-top.rst | 2 ++ doc/cephfs/fs-nfs-exports.rst | 3 +++ doc/cephfs/multimds.rst | 2 ++ doc/cephfs/snap-schedule.rst | 2 ++ doc/releases/pacific.rst | 31 +++++++++++++++++-------------- 6 files changed, 28 insertions(+), 14 deletions(-) diff --git a/doc/cephfs/ceph-dokan.rst b/doc/cephfs/ceph-dokan.rst index 6ddb57082d4fc..d242fe6fccdc1 100644 --- a/doc/cephfs/ceph-dokan.rst +++ b/doc/cephfs/ceph-dokan.rst @@ -1,3 +1,5 @@ +.. _ceph-dokan: + ======================= Mount CephFS on Windows ======================= diff --git a/doc/cephfs/cephfs-top.rst b/doc/cephfs/cephfs-top.rst index 47e80df9d2f14..d409c54745296 100644 --- a/doc/cephfs/cephfs-top.rst +++ b/doc/cephfs/cephfs-top.rst @@ -1,3 +1,5 @@ +.. _cephfs-top: + ================== CephFS Top Utility ================== diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst index 282a5e2842d89..5c5b60e3c971e 100644 --- a/doc/cephfs/fs-nfs-exports.rst +++ b/doc/cephfs/fs-nfs-exports.rst @@ -1,3 +1,6 @@ +.. _cephfs-nfs: + + ======================= CephFS Exports over NFS ======================= diff --git a/doc/cephfs/multimds.rst b/doc/cephfs/multimds.rst index e22a84fac8137..c257285072d03 100644 --- a/doc/cephfs/multimds.rst +++ b/doc/cephfs/multimds.rst @@ -136,6 +136,8 @@ directory's export pin. For example: # a/b is now pinned to rank 0 and a/ and the rest of its children are still pinned to rank 1 +.. _cephfs-ephemeral-pinning: + Setting subtree partitioning policies ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/cephfs/snap-schedule.rst b/doc/cephfs/snap-schedule.rst index aa1f31ea9f754..6d25abadcc32c 100644 --- a/doc/cephfs/snap-schedule.rst +++ b/doc/cephfs/snap-schedule.rst @@ -1,3 +1,5 @@ +.. _snap-schedule: + ========================== Snapshot Scheduling Module ========================== diff --git a/doc/releases/pacific.rst b/doc/releases/pacific.rst index 729d5237c327f..3ae227f269406 100644 --- a/doc/releases/pacific.rst +++ b/doc/releases/pacific.rst @@ -119,40 +119,43 @@ CephFS distributed file system longer backwards compatible. It is not possible to downgrade a file system from Pacific (or later) to an older release. -* Multiple file systems in a single Ceph cluster is now stable. New Ceph clusters - enable support for multiple file systems by default. Existing clusters - must still set the "enable_multiple" flag on the FS. Please see the CephFS - documentation for more information. +* Multiple file systems in a single Ceph cluster is now stable. New Ceph + clusters enable support for multiple file systems by default. Existing clusters + must still set the "enable_multiple" flag on the FS. See also + :ref:`cephfs-multifs`. -* A new ``mds_autoscaler`` plugin is available for automatically deploying - MDS daemons in response to changes to the ``max_mds`` configuration. Expect - further enhancements in the future to simplify MDS scaling. +* A new ``mds_autoscaler`` ``ceph-mgr`` plugin is available for automatically + deploying MDS daemons in response to changes to the ``max_mds`` configuration. + Expect further enhancements in the future to simplify and automate MDS scaling. * ``cephfs-top`` is a new utility for looking at performance metrics from CephFS - clients. It is development preview quality and will have bugs. See the CephFS - documentation for more information. + clients. It is development preview quality and will have bugs. For more + information, see :ref:`cephfs-top`. -* A new ``snap_schedule`` module provides a command toolset for scheduling - snapshots on a CephFS file system. +* A new ``snap_schedule`` ``ceph-mgr`` plugin provides a command toolset for + scheduling snapshots on a CephFS file system. For more information, see + :ref:`snap-schedule`. * First class NFS gateway support in Ceph is here! It's now possible to create scale-out ("active-active") NFS gateway clusters that export CephFS using a few commands. The gateways are deployed via cephadm (or Rook, in the future). + For more information, see :ref:`cephfs-nfs`. * Multiple active MDS file system scrub is now stable. It is no longer necessary to set ``max_mds`` to 1 and wait for non-zero ranks to stop. Scrub commands can only be sent to rank 0: ``ceph tell mds.:0 scrub start /path ...``. + For more information, see :ref:`mds-scrub`. * Ephemeral pinning -- policy based subtree pinning -- is considered stable. ``mds_export_ephemeral_random`` and ``mds_export_ephemeral_distributed`` now - default to true. + default to true. For more information, see :ref:`cephfs-ephemeral-pinning`. * A new ``cephfs-mirror`` daemon is available to mirror CephFS file systems to - a remote Ceph cluster. See the CephFS documentation for details. + a remote Ceph cluster. * A Windows client is now available for connecting to CephFS. This is offered through a new ``ceph-dokan`` utility which operates via the Dokan userspace - API, similar to FUSE. See the CephFS documentation for details. + API, similar to FUSE. For more information, see :ref:`ceph-dokan`. Upgrading from Octopus or Nautilus -- 2.39.5