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 ba19b1ecaf74d367f9a7729d653bc8a46c5424a6..0ce23170b7774ee9355911292aef80f22ca87a6d 100644 (file)
--- 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,