From: Zac Dover <zac.dover@proton.me>
Date: Sun, 25 Feb 2024 21:14:25 +0000 (+1000)
Subject: doc/glossary: Add "OMAP" to glossary
X-Git-Tag: v19.1.0~278^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F55748%2Fhead;p=ceph.git

doc/glossary: Add "OMAP" to glossary

Add an entry for "OMAP" to the glossary. This commit represents only the
first improvement to the documentation of OMAP in the Ceph docs suite.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 1d8baa1d4c3583f4a8dc0f46d81f198a3d027e4d)
---

diff --git a/doc/glossary.rst b/doc/glossary.rst
index 15dddadc2296..8f1c5659756d 100644
--- a/doc/glossary.rst
+++ b/doc/glossary.rst
@@ -287,6 +287,19 @@
 	Object Storage Device
                 See :term:`OSD`.
 
+        OMAP
+                "object map". A key-value store (a database) that is used to
+                reduce the time it takes to read data from and to write to the
+                Ceph cluster. RGW bucket indexes are stored as OMAPs.
+                Erasure-coded pools cannot store RADOS OMAP data structures.
+               
+                Run the command ``ceph osd df`` to see your OMAPs.
+
+                See Eleanor Cawthon's 2012 paper `A Distributed Key-Value Store
+                using Ceph
+                <https://ceph.io/assets/pdfs/CawthonKeyValueStore.pdf>`_ (17
+                pages).
+
 	OSD
                 Probably :term:`Ceph OSD`, but not necessarily. Sometimes
                 (especially in older correspondence, and especially in