Skip to content

Commit d5520f2

Browse files
committed
doc/cephadm: document requiring service ids for advanced OSD specs
Signed-off-by: Adam King <[email protected]>
1 parent 993ce91 commit d5520f2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/cephadm/services/osd.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,15 @@ configurations, without knowing the specifics of device names and paths.
454454
Service specifications make it possible to define a yaml or json file that can
455455
be used to reduce the amount of manual work involved in creating OSDs.
456456

457+
.. note::
458+
It is recommended that advanced OSD specs include the ``service_id`` field
459+
set. The plain ``osd`` service with no service id is where OSDs created
460+
using ``ceph orch daemon add`` or ``ceph orch apply osd --all-available-devices``
461+
are placed. Not including a ``service_id`` in your OSD spec would mix
462+
the OSDs from your spec with those OSDs and potentially overwrite services
463+
specs created by cephadm to track them. Newer versions of cephadm will even
464+
block creation of advanced OSD specs without the service_id present
465+
457466
For example, instead of running the following command:
458467

459468
.. prompt:: bash [monitor.1]#

0 commit comments

Comments
 (0)