From: Dan Mick Date: Tue, 19 Jun 2018 23:45:06 +0000 (-0700) Subject: doc/mgr/plugins.rst: explain more about the plugin command protocol X-Git-Tag: v14.0.1~1069^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=d9cabf2b04454547fcd24256e5b37ac033a76eec;p=ceph.git doc/mgr/plugins.rst: explain more about the plugin command protocol Signed-off-by: Dan Mick --- diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst index 377078fd899a..8cfab3520fca 100644 --- a/doc/mgr/plugins.rst +++ b/doc/mgr/plugins.rst @@ -61,7 +61,15 @@ like this:: The ``cmd`` part of each entry is parsed in the same way as internal Ceph mon and admin socket commands (see mon/MonCommands.h in the Ceph source for examples). Note that the "poll" field is optional, -and is set to False by default. +and is set to False by default; this indicates to the ``ceph`` CLI +that it should call this command repeatedly and output results (see +``ceph -h`` and its ``--period`` option). + +Each command is expected to return a tuple ``(retval, stdout, stderr)``. +``retval`` is an integer representing a libc error code (e.g. EINVAL, +EPERM, or 0 for no error), ``stdout`` is a string containing any +non-error output, and ``stderr`` is a string containing any progress or +error explanation output. Either or both of the two strings may be empty. Configuration options ---------------------