mgr/orchestrator: Add doc about how to use OrchestratorClientMixin

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>

diff --git a/src/pybind/mgr/orchestrator.py b/src/pybind/mgr/orchestrator.py
index 35d7e278ebf70cf2b4efd0b2d832617c41e23b2e..0335b56a8c6d7cd9ef696bf8e0f6beb37690a881 100644 (file)
--- a/src/pybind/mgr/orchestrator.py
+++ b/src/pybind/mgr/orchestrator.py
@@ -1467,6 +1467,16 @@ class OrchestratorClientMixin(Orchestrator):
     ...        self._orchestrator_wait([completion])
     ...        self.log.debug(completion.result)
 
+    .. note:: Orchestrator implementations should not inherit from `OrchestratorClientMixin`.
+        Reason is, that OrchestratorClientMixin magically redirects all methods to the
+        "real" implementation of the orchestrator.
+
+
+    >>> import mgr_module
+    >>> class MyImplentation(mgr_module.MgrModule, Orchestrator):
+    ...     def __init__(self, ...):
+    ...         self.orch_client = OrchestratorClientMixin()
+    ...         self.orch_client.set_mgr(self.mgr))
     """
 
     def set_mgr(self, mgr):