]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: update MonCommand.h and mgr docs to include the polling flag
authorMohamad Gebai <mgebai@suse.com>
Wed, 28 Feb 2018 23:15:42 +0000 (18:15 -0500)
committerMohamad Gebai <mgebai@suse.com>
Thu, 12 Apr 2018 04:26:24 +0000 (00:26 -0400)
Signed-off-by: Mohamad Gebai <mgebai@suse.com>
doc/mgr/plugins.rst
src/mon/MonCommands.h

index ecf2943d39f604b920001eea7d2aeb3320e72957..0ac5ee1ba76277ee38f55ebef1fdd021fda16458 100644 (file)
@@ -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
 ---------------
index 4d42ca74e866469d01121402802a6eaca6891537..96dd6508cbd02ede4a63610ffc73a510ce014be2 100644 (file)
  *  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