]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc: add docs for seastore support in cephadm
authorShraddha Agrawal <shraddha.agrawal000@gmail.com>
Thu, 12 Feb 2026 05:06:31 +0000 (10:36 +0530)
committerShraddha Agrawal <shraddha.agrawal000@gmail.com>
Thu, 19 Feb 2026 11:52:30 +0000 (17:22 +0530)
This commit updates the crimson user facing docs to add
instructions on how to deploy a crimson OSD with seastore
objectstore.

Signed-off-by: Shraddha Agrawal <shraddha.agrawal000@gmail.com>
doc/crimson/crimson.rst

index 863c160c890da15cc3c10fcc2e63b714903fa3a0..daf9885efcc2aa2dbaa78b64259edce7256e1517 100644 (file)
@@ -151,7 +151,35 @@ Native backends perform I/O operations using the **Seastar reactor**. These are
 
 .. describe:: seastore
 
-   SeaStore is the primary native object store for Crimson OSD. It is built with the Seastar framework and adheres to its asynchronous, shard-based architecture.
+   SeaStore is the primary native object store for Crimson OSD, though it is not the default as the support is in early stages. 
+   It is built with the Seastar framework and adheres to its asynchronous, shard-based architecture.
+
+.. note::
+   The Orchastrator's ``apply osd --method`` command does not currently support deploying
+   Crimson OSDs with SeaStore directly on the physical device with ``--method raw``.
+   Use the default ``lvm`` method instead.
+
+   When :ref:`deploying OSDs <cephadm-deploy-osds>`, use the ``--objectstore`` flag to specify the object store type. 
+   The default value is ``bluestore``. To deploy a Crimson OSD with SeaStore, set this flag to ``seastore``.
+
+   .. prompt:: bash #
+
+      ceph orch apply osd --osd-type crimson --objectstore seastore ...
+
+   Alternatively, you can also set the ``objectstore`` to ``seastore`` in the :ref:`OSD Service Specification <drivegroups>` file
+   like so: 
+
+   .. code-block:: yaml 
+
+      service_type: osd
+      service_id: default_drive_group  
+      placement:
+        host_pattern: '*'              
+      spec:
+        data_devices:                 
+          all: true  
+        osd_type: crimson   
+        objectstore: seastore # objectstore should be set to seastore      
 
 .. describe:: cyanstore
 
@@ -166,7 +194,7 @@ These backends allow Crimson to interact with legacy or external object store im
 
 .. describe:: bluestore
 
-   The default object store used by the classic ``ceph-osd``. It provides robust, production-grade storage capabilities.
+   The default object store. It provides robust, production-grade storage capabilities.
 
    The ``crimson_bluestore_num_threads`` option needs to be set according to the CPU set available.
    This defines the number of threads dedicated to serving the BlueStore ObjectStore on each OSD.