From 22047b37686546b7ae0d1bd43be7cc1697fb4bbb Mon Sep 17 00:00:00 2001 From: Mohamad Gebai Date: Wed, 28 Feb 2018 18:15:42 -0500 Subject: [PATCH] doc: update MonCommand.h and mgr docs to include the polling flag Signed-off-by: Mohamad Gebai --- doc/mgr/plugins.rst | 7 +++++-- src/mon/MonCommands.h | 2 ++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst index ecf2943d39f..0ac5ee1ba76 100644 --- a/doc/mgr/plugins.rst +++ b/doc/mgr/plugins.rst @@ -51,13 +51,16 @@ like this:: { "cmd": "foobar name=myarg,type=CephString", "desc": "Do something awesome", - "perm": "rw" + "perm": "rw", + # optional: + "poll": "true" } ] 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) +the Ceph source for examples). Note that the "poll" field is optional, +and is set to False by default. Config settings --------------- diff --git a/src/mon/MonCommands.h b/src/mon/MonCommands.h index 4d42ca74e86..96dd6508cbd 100644 --- a/src/mon/MonCommands.h +++ b/src/mon/MonCommands.h @@ -112,6 +112,8 @@ * OBSOLETE - command is considered obsolete * DEPRECATED - command is considered deprecated * MGR - command goes to ceph-mgr (for luminous+) + * POLL - command is intended to be called periodically by the + * client (see iostat) * * A command should always be first considered DEPRECATED before being * considered OBSOLETE, giving due consideration to users and conforming -- 2.47.3