Skip to content

Commit

Permalink
doc/mgr: Add limitations section to plugin guide
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Serong <[email protected]>
  • Loading branch information
tserong committed Apr 11, 2018
1 parent 34232b3 commit f3aadbf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/mgr/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?
---------------------

Expand Down

0 comments on commit f3aadbf

Please sign in to comment.