From: Tim Serong Date: Wed, 11 Apr 2018 10:33:05 +0000 (+1000) Subject: doc/mgr: Add limitations section to plugin guide X-Git-Tag: v13.1.0~326^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F21347%2Fhead;p=ceph.git doc/mgr: Add limitations section to plugin guide Signed-off-by: Tim Serong --- diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst index 9e73b7a58cdf..ecf2943d39f6 100644 --- a/doc/mgr/plugins.rst +++ b/doc/mgr/plugins.rst @@ -193,6 +193,15 @@ If a module implements the ``serve()`` method, it should also implement the ``shutdown()`` method to shutdown cleanly: misbehaving modules may otherwise prevent clean shutdown of ceph-mgr. +Limitations +----------- + +It is not possible to call back into C++ code from a module's +``__init__()`` method. For example calling ``self.get_config()`` at +this point will result in an assertion failure in ceph-mgr. For modules +that implement the ``serve()`` method, it usually makes sense to do most +initialization inside that method instead. + Is something missing? ---------------------