From: Sage Weil <sage@newdream.net>
Date: Thu, 22 Apr 2021 17:57:21 +0000 (-0400)
Subject: mgr/cephadm: document CephadmService flags
X-Git-Tag: v16.2.5~87^2~72
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=1400b3822f6979f66b2ceda065c479c82edc4d76;p=ceph.git

mgr/cephadm: document CephadmService flags

Signed-off-by: Sage Weil <sage@newdream.net>
(cherry picked from commit 2fa80d8769a5b4ab1238a9b18627b9e28a540b66)
---

diff --git a/src/pybind/mgr/cephadm/services/cephadmservice.py b/src/pybind/mgr/cephadm/services/cephadmservice.py
index ba19b1ecaf7..0ce23170b77 100644
--- a/src/pybind/mgr/cephadm/services/cephadmservice.py
+++ b/src/pybind/mgr/cephadm/services/cephadmservice.py
@@ -116,14 +116,25 @@ class CephadmService(metaclass=ABCMeta):
         self.mgr: "CephadmOrchestrator" = mgr
 
     def allow_colo(self) -> bool:
+        """
+        Return True if multiple daemons of the same type can colocate on
+        the same host.
+        """
         return False
 
-    def per_host_daemon_type(self) -> Optional[str]:
-        return None
-
     def primary_daemon_type(self) -> str:
+        """
+        This is the type of the primary (usually only) daemon to be deployed.
+        """
         return self.TYPE
 
+    def per_host_daemon_type(self) -> Optional[str]:
+        """
+        If defined, this type of daemon will be deployed once for each host
+        containing one or more daemons of the primary type.
+        """
+        return None
+
     def make_daemon_spec(
             self, host: str,
             daemon_id: str,