From: Sage Weil <sage@redhat.com>
Date: Mon, 5 Aug 2019 19:44:10 +0000 (-0500)
Subject: mgr/hello: fully document our options
X-Git-Tag: v15.1.0~1935^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=a4e860bc39dd586cffb73cc3acb0b56eb3ea2cc3;p=ceph.git

mgr/hello: fully document our options

Signed-off-by: Sage Weil <sage@redhat.com>
---

diff --git a/src/pybind/mgr/hello/module.py b/src/pybind/mgr/hello/module.py
index 94d532ee70b7..323890b0a4dd 100644
--- a/src/pybind/mgr/hello/module.py
+++ b/src/pybind/mgr/hello/module.py
@@ -20,18 +20,34 @@ class Hello(MgrModule):
         },
     ]
 
-    # these are module options we understand.  These can be set with
-    # 'ceph config set global mgr/hello/<name> <value>'.  e.g.,
-    # 'ceph config set global mgr/hello/place Earth'
+    # These are module options we understand.  These can be set with
+    #
+    #   ceph config set global mgr/hello/<name> <value>
+    #
+    # e.g.,
+    #
+    #   ceph config set global mgr/hello/place Earth
+    #
     MODULE_OPTIONS = [
         {
             'name': 'place',
             'default': 'world',
+            'desc': 'a place in the world',
+            'runtime': True,   # can be updated at runtime (no mgr restart)
         },
         {
             'name': 'emphatic',
             'type': 'bool',
+            'desc': 'whether to say it loudly',
             'default': True,
+            'runtime': True,
+        },
+        {
+            'name': 'foo',
+            'type': 'enum',
+            'enum_allowed': [ 'a', 'b', 'c' ],
+            'default': 'a',
+            'runtime': True,
         },
     ]