doc/cephadm: Disable automatic deployment of daemons

Fixes: https://tracker.ceph.com/issues/45767
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>

diff --git a/doc/cephadm/operations.rst b/doc/cephadm/operations.rst
index f852ef94424de082b43e3e43f2a0f747fc5fc609..ec7fea6b2b40815f437bf5ddb5df0e02acbd98ec 100644 (file)
--- a/doc/cephadm/operations.rst
+++ b/doc/cephadm/operations.rst
@@ -355,3 +355,65 @@ the following command on the host:
 .. code-block:: bash
 
   cephadm rm-daemon --fsid CLUSTER_ID --name SERVICE_NAME
+
+
+.. _cephadm-spec-unmanaged:
+
+Disable automatic deployment of daemons
+=======================================
+
+Cephadm supports disabling the automated deployment and removal of daemons per service. In
+this case, the CLI supports two commands that are dedicated to this mode. 
+
+To disable the automatic management of dameons, apply
+the :ref:`orchestrator-cli-service-spec` with ``unmanaged=True``. 
+
+``mgr.yaml``:
+
+.. code-block:: yaml
+
+  service_type: mgr
+  unmanaged: true
+  placement:
+    label: mgr
+
+.. code-block:: bash
+
+  ceph orch apply -i mgr.yaml
+
+.. note::
+
+  cephadm will no longer deploy any new daemons, if the placement
+  specification matches additional hosts.
+
+To manually deploy a daemon on a host, please execute:
+
+.. code-block:: bash
+
+  ceph orch daemon add <daemon-type>  --placement=<placement spec>
+
+For example 
+
+.. code-block:: bash
+
+  ceph orch daemon add mgr --placement=my_host
+
+To manually remove a daemon, please run:
+
+.. code-block:: bash
+
+  ceph orch daemon rm <daemon name>... [--force]
+
+For example 
+
+.. code-block:: bash
+
+  ceph orch daemon rm mgr.my_host.xyzxyz
+
+.. note:: 
+
+  For managed services (``unmanaged=False``), cephadm will automatically
+  deploy a new daemon a few seconds later.
+    
+* See :ref:`orchestrator-cli-create-osds` for special handling of unmanaged OSDs. 
+* See also :ref:`cephadm-pause`
\ No newline at end of file

diff --git a/doc/cephadm/troubleshooting.rst b/doc/cephadm/troubleshooting.rst
index 3228772ab4c61008cdf86ca16d79d80ab795b8f4..0c0a687faf82a3d74008a76616c80d9cb8b59236 100644 (file)
--- a/doc/cephadm/troubleshooting.rst
+++ b/doc/cephadm/troubleshooting.rst
@@ -8,6 +8,8 @@ a specific service no longer runs properly.
 As cephadm deploys daemons as containers, troubleshooting daemons is slightly
 different. Here are a few tools and commands to help investigating issues.
 
+.. _cephadm-pause:
+
 Pausing or disabling cephadm
 ----------------------------
 
@@ -27,6 +29,9 @@ This will disable all of the ``ceph orch ...`` CLI commands but the previously
 deployed daemon containers will still continue to exist and start as they
 did before.
 
+Please refer to :ref:`cephadm-spec-unmanaged` for disabling individual
+services.
+
 
 Per-service and per-daemon events
 ---------------------------------

diff --git a/doc/mgr/orchestrator.rst b/doc/mgr/orchestrator.rst
index 0d1b4192e5a6a1c60aaf31f940ef304a0b3198ba..e434bf490cd271755d3f76076b8463aa34535006 100644 (file)
--- a/doc/mgr/orchestrator.rst
+++ b/doc/mgr/orchestrator.rst
@@ -198,6 +198,8 @@ If you want to avoid this behavior (disable automatic creation of OSD on availab
 
     ceph orch apply osd --all-available-devices --unmanaged=true
 
+* For cephadm, see also :ref:`cephadm-spec-unmanaged`.
+
 Remove an OSD
 -------------
 ::
@@ -703,7 +705,7 @@ where the properties of a service specification are:
     If set to ``true``, the orchestrator will not deploy nor
     remove any daemon associated with this service. Placement and all other
     properties will be ignored. This is useful, if this service should not
-    be managed temporarily.
+    be managed temporarily. For cephadm, See :ref:`cephadm-spec-unmanaged`
 
 Each service type can have additional service specific properties.