doc: document new .mgr pool

And that pool names beginning with `.` are reserved names.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>

diff --git a/PendingReleaseNotes b/PendingReleaseNotes
index 81ca8d6b200768052e6b9ae96fdcd430ae4b5dc6..156bf1d9bea4d8e6953413b88e97d6a364ffeda4 100644 (file)
--- 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 af1a3ee97db74a84b51da43a9ea7de8d20004551..8feca8fc4d56ee3f5688cd0fdd27677f59a2c470 100644 (file)
--- 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 7703b5df37f32e958cca0f74cb2844970270fe6b..191ade928d23eb065f66ba189a01250647c40d81 100644 (file)
--- 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
 ==========