From f5fa58cb1f92b18a70d833790f86062efc2819cb Mon Sep 17 00:00:00 2001 From: Patrick Donnelly Date: Mon, 12 Apr 2021 19:42:57 -0700 Subject: [PATCH] doc: document new .mgr pool And that pool names beginning with `.` are reserved names. Signed-off-by: Patrick Donnelly --- PendingReleaseNotes | 3 +++ doc/mgr/administrator.rst | 15 +++++++++++++++ doc/rados/operations/pools.rst | 8 ++++++++ 3 files changed, 26 insertions(+) diff --git a/PendingReleaseNotes b/PendingReleaseNotes index 81ca8d6b20076..156bf1d9bea4d 100644 --- a/PendingReleaseNotes +++ b/PendingReleaseNotes @@ -17,6 +17,9 @@ that were storing state in RADOS omap, especially without striping which limits scalability. +* The ``device_health_metrics`` pool has been renamed ``.mgr``. It is now + used as a common store for all ``ceph-mgr`` modules. + * RGW: `radosgw-admin realm delete` is now renamed to `radosgw-admin realm rm`. This is consistent with the help message. diff --git a/doc/mgr/administrator.rst b/doc/mgr/administrator.rst index af1a3ee97db74..8feca8fc4d56e 100644 --- a/doc/mgr/administrator.rst +++ b/doc/mgr/administrator.rst @@ -121,6 +121,21 @@ this to your ``ceph.conf``: [mon] mgr_initial_modules = dashboard balancer +Module Pool +----------- + +The manager creates a pool for use by its module to store state. The name of +this pool is ``.mgr`` (with the leading ``.`` indicating a reserved pool +name). + +.. note:: + + Prior to Quincy, the ``devicehealth`` module created a + ``device_health_metrics`` pool to store device SMART statistics. With + Quincy, this pool is automatically renamed to be the common manager module + pool. + + Calling module commands ----------------------- diff --git a/doc/rados/operations/pools.rst b/doc/rados/operations/pools.rst index 7703b5df37f32..191ade928d23e 100644 --- a/doc/rados/operations/pools.rst +++ b/doc/rados/operations/pools.rst @@ -30,6 +30,14 @@ pools for storing data. A pool provides you with: To organize data into pools, you can list, create, and remove pools. You can also view the utilization statistics for each pool. +Pool Names +========== + +Pool names beginning with ``.`` are reserved for use by Ceph's internal +operations. Please do not create or manipulate pools with these names. + + + List Pools ========== -- 2.39.5