From: Sage Weil <sage@redhat.com>
Date: Tue, 4 Dec 2018 23:34:18 +0000 (-0600)
Subject: pybind/mgr: rename get_option -> get_ceph_option
X-Git-Tag: v14.1.0~641^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=3432636b8aba7bd866ce252ce880fd95cbb28c82;p=ceph.git

pybind/mgr: rename get_option -> get_ceph_option

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

diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst
index d1196dea6f7c..c3c2c8c58707 100644
--- a/doc/mgr/plugins.rst
+++ b/doc/mgr/plugins.rst
@@ -96,38 +96,38 @@ Configuration options
 ---------------------
 
 Modules can load and store configuration options using the
-``set_config`` and ``get_config`` methods.
+``set_module_option`` and ``get_module_option`` methods.
 
-.. note:: Use ``set_config`` and ``get_config`` to manage user-visible
-   configuration options that are not blobs (like certificates). If you want to
-   persist module-internal data or binary configuration data consider using
-   the `KV store`_.
+.. note:: Use ``set_module_option`` and ``get_module_option`` to
+   manage user-visible configuration options that are not blobs (like
+   certificates). If you want to persist module-internal data or
+   binary configuration data consider using the `KV store`_.
 
 You must declare your available configuration options in the
-``OPTIONS`` class attribute, like this:
+``MODULE_OPTIONS`` class attribute, like this:
 
 ::
 
-    OPTIONS = [
+    MODULE_OPTIONS = [
         {
             "name": "my_option"
         }
     ]
 
-If you try to use set_config or get_config on options not declared
-in ``OPTIONS``, an exception will be raised.
+If you try to use set_module_option or get_module_option on options not declared
+in ``MODULE_OPTIONS``, an exception will be raised.
 
 You may choose to provide setter commands in your module to perform
 high level validation.  Users can also modify configuration using
 the normal `ceph config set` command, where the configuration options
 for a mgr module are named like `mgr/<module name>/<option>`.
 
-If a configuration option is different depending on which node
-the mgr is running on, then use *localized* configuration (
-``get_localized_config``, ``set_localized_config``).  This may be necessary
-for options such as what address to listen on.  Localized options may
-also be set externally with ``ceph config set``, where they key name
-is like ``mgr/<module name>/<mgr id>/<option>``
+If a configuration option is different depending on which node the mgr
+is running on, then use *localized* configuration (
+``get_localized_module_option``, ``set_localized_module_option``).
+This may be necessary for options such as what address to listen on.
+Localized options may also be set externally with ``ceph config set``,
+where they key name is like ``mgr/<module name>/<mgr id>/<option>``
 
 If you need to load and store data (e.g. something larger, binary, or multiline),
 use the KV store instead of configuration options (see next section).
@@ -135,21 +135,21 @@ use the KV store instead of configuration options (see next section).
 Hints for using config options:
 
 * Reads are fast: ceph-mgr keeps a local in-memory copy, so in many cases
-  you can just do a get_config every time you use a option, rather than
+  you can just do a get_module_option every time you use a option, rather than
   copying it out into a variable.
 * Writes block until the value is persisted (i.e. round trip to the monitor),
   but reads from another thread will see the new value immediately.
 * If a user has used `config set` from the command line, then the new
-  value will become visible to `get_config` immediately, although the
+  value will become visible to `get_module_option` immediately, although the
   mon->mgr update is asynchronous, so `config set` will return a fraction
   of a second before the new value is visible on the mgr.
 * To delete a config value (i.e. revert to default), just pass ``None`` to
-  set_config.
+  set_module_option.
 
-.. automethod:: MgrModule.get_config
-.. automethod:: MgrModule.set_config
-.. automethod:: MgrModule.get_localized_config
-.. automethod:: MgrModule.set_localized_config
+.. automethod:: MgrModule.get_module_option
+.. automethod:: MgrModule.set_module_option
+.. automethod:: MgrModule.get_localized_module_option
+.. automethod:: MgrModule.set_localized_module_option
 
 KV store
 --------
@@ -373,7 +373,7 @@ Limitations
 -----------
 
 It is not possible to call back into C++ code from a module's
-``__init__()`` method.  For example calling ``self.get_config()`` at
+``__init__()`` method.  For example calling ``self.get_module_option()`` 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.
diff --git a/src/pybind/mgr/balancer/module.py b/src/pybind/mgr/balancer/module.py
index 330a4fde28d4..fb910c2f1ff3 100644
--- a/src/pybind/mgr/balancer/module.py
+++ b/src/pybind/mgr/balancer/module.py
@@ -647,7 +647,7 @@ class Module(MgrModule):
     def optimize(self, plan):
         self.log.info('Optimize plan %s' % plan.name)
         plan.mode = self.get_module_option('mode', default_mode)
-        max_misplaced = float(self.get_option('target_max_misplaced_ratio'))
+        max_misplaced = float(self.get_ceph_option('target_max_misplaced_ratio'))
         self.log.info('Mode %s, max misplaced %f' %
                       (plan.mode, max_misplaced))
 
@@ -731,7 +731,7 @@ class Module(MgrModule):
         step = float(self.get_module_option('crush_compat_step', .5))
         if step <= 0 or step >= 1.0:
             return -errno.EINVAL, '"crush_compat_step" must be in (0, 1)'
-        max_misplaced = float(self.get_option('target_max_misplaced_ratio'))
+        max_misplaced = float(self.get_ceph_option('target_max_misplaced_ratio'))
         min_pg_per_osd = 2
 
         ms = plan.initial
diff --git a/src/pybind/mgr/dashboard/module.py b/src/pybind/mgr/dashboard/module.py
index c7fb0368a641..35560e7bc27d 100644
--- a/src/pybind/mgr/dashboard/module.py
+++ b/src/pybind/mgr/dashboard/module.py
@@ -180,7 +180,7 @@ class CherryPyConfig(object):
         cherrypy.config.update(config)
 
         self._url_prefix = prepare_url_prefix(self.get_module_option('url_prefix',
-                                                              default=''))
+                                                                     default=''))
 
         uri = "{0}://{1}:{2}{3}/".format(
             'https' if ssl else 'http',
diff --git a/src/pybind/mgr/dashboard/settings.py b/src/pybind/mgr/dashboard/settings.py
index 502181ba3b41..7c0ea15411af 100644
--- a/src/pybind/mgr/dashboard/settings.py
+++ b/src/pybind/mgr/dashboard/settings.py
@@ -49,8 +49,9 @@ class Options(object):
 class SettingsMeta(type):
     def __getattr__(cls, attr):
         default, stype = getattr(Options, attr)
-        if stype == bool and str(mgr.get_module_option(attr,
-                                                default)).lower() == 'false':
+        if stype == bool and str(mgr.get_module_option(
+                attr,
+                default)).lower() == 'false':
             value = False
         else:
             value = stype(mgr.get_module_option(attr, default))
diff --git a/src/pybind/mgr/dashboard/tests/test_access_control.py b/src/pybind/mgr/dashboard/tests/test_access_control.py
index 74414aa23e36..bad47a42a457 100644
--- a/src/pybind/mgr/dashboard/tests/test_access_control.py
+++ b/src/pybind/mgr/dashboard/tests/test_access_control.py
@@ -20,19 +20,20 @@ class AccessControlTest(unittest.TestCase):
     CONFIG_KEY_DICT = {}
 
     @classmethod
-    def mock_set_config(cls, attr, val):
+    def mock_set_module_option(cls, attr, val):
         cls.CONFIG_KEY_DICT[attr] = val
 
     @classmethod
-    def mock_get_config(cls, attr, default=None):
+    def mock_get_module_option(cls, attr, default=None):
         return cls.CONFIG_KEY_DICT.get(attr, default)
 
     @classmethod
     def setUpClass(cls):
-        mgr.set_config.side_effect = cls.mock_set_config
-        mgr.get_config.side_effect = cls.mock_get_config
-        mgr.set_store.side_effect = cls.mock_set_config
-        mgr.get_store.side_effect = cls.mock_get_config
+        mgr.set_module_option.side_effect = cls.mock_set_module_option
+        mgr.get_module_option.side_effect = cls.mock_get_module_option
+        # kludge below
+        mgr.set_store.side_effect = cls.mock_set_module_option
+        mgr.get_store.side_effect = cls.mock_get_module_option
 
     def setUp(self):
         self.CONFIG_KEY_DICT.clear()
diff --git a/src/pybind/mgr/dashboard/tests/test_api_auditing.py b/src/pybind/mgr/dashboard/tests/test_api_auditing.py
index d22410e847b8..ed5362d9a3d1 100644
--- a/src/pybind/mgr/dashboard/tests/test_api_auditing.py
+++ b/src/pybind/mgr/dashboard/tests/test_api_auditing.py
@@ -37,17 +37,17 @@ class ApiAuditingTest(ControllerTestCase):
         super(ApiAuditingTest, self).__init__(*args, **kwargs)
 
     @classmethod
-    def mock_set_config(cls, key, val):
+    def mock_set_module_option(cls, key, val):
         cls.settings[key] = val
 
     @classmethod
-    def mock_get_config(cls, key, default=None):
+    def mock_get_module_option(cls, key, default=None):
         return cls.settings.get(key, default)
 
     @classmethod
     def setUpClass(cls):
-        mgr.get_config.side_effect = cls.mock_get_config
-        mgr.set_config.side_effect = cls.mock_set_config
+        mgr.get_module_option.side_effect = cls.mock_get_module_option
+        mgr.set_module_option.side_effect = cls.mock_set_module_option
 
     @classmethod
     def setup_server(cls):
@@ -55,8 +55,8 @@ class ApiAuditingTest(ControllerTestCase):
 
     def setUp(self):
         mgr.cluster_log = mock.Mock()
-        mgr.set_config('AUDIT_API_ENABLED', True)
-        mgr.set_config('AUDIT_API_LOG_PAYLOAD', True)
+        mgr.set_module_option('AUDIT_API_ENABLED', True)
+        mgr.set_module_option('AUDIT_API_LOG_PAYLOAD', True)
 
     def _validate_cluster_log_msg(self, path, method, user, params):
         channel, _, msg = mgr.cluster_log.call_args_list[0][0]
@@ -70,12 +70,12 @@ class ApiAuditingTest(ControllerTestCase):
         self.assertDictEqual(json.loads(m.group(5)), params)
 
     def test_no_audit(self):
-        mgr.set_config('AUDIT_API_ENABLED', False)
+        mgr.set_module_option('AUDIT_API_ENABLED', False)
         self._delete('/foo/test1')
         mgr.cluster_log.assert_not_called()
 
     def test_no_payload(self):
-        mgr.set_config('AUDIT_API_LOG_PAYLOAD', False)
+        mgr.set_module_option('AUDIT_API_LOG_PAYLOAD', False)
         self._delete('/foo/test1')
         _, _, msg = mgr.cluster_log.call_args_list[0][0]
         self.assertNotIn('params=', msg)
diff --git a/src/pybind/mgr/dashboard/tests/test_grafana.py b/src/pybind/mgr/dashboard/tests/test_grafana.py
index 1a0665269b4f..503ad00f6050 100644
--- a/src/pybind/mgr/dashboard/tests/test_grafana.py
+++ b/src/pybind/mgr/dashboard/tests/test_grafana.py
@@ -35,7 +35,7 @@ class GrafanaControllerTestCase(ControllerTestCase):
             'GRAFANA_API_USERNAME': 'admin',
             'GRAFANA_API_PASSWORD': 'admin'
         }
-        mgr.get_config.side_effect = settings.get
+        mgr.get_module_option.side_effect = settings.get
         GrafanaProxy._cp_config['tools.authenticate.on'] = False  # pylint: disable=protected-access
 
         cls.setup_controllers([GrafanaProxy, GrafanaMockInstance])
diff --git a/src/pybind/mgr/dashboard/tests/test_rest_client.py b/src/pybind/mgr/dashboard/tests/test_rest_client.py
index f1f0267abd54..36ecd51a334b 100644
--- a/src/pybind/mgr/dashboard/tests/test_rest_client.py
+++ b/src/pybind/mgr/dashboard/tests/test_rest_client.py
@@ -11,7 +11,7 @@ from ..rest_client import RequestException, RestClient
 class RestClientTest(unittest.TestCase):
     def setUp(self):
         settings = {'REST_REQUESTS_TIMEOUT': 45}
-        mgr.get_config.side_effect = settings.get
+        mgr.get_module_option.side_effect = settings.get
 
     def test_timeout_auto_set(self):
         with patch('requests.Session.request') as mock_request:
diff --git a/src/pybind/mgr/dashboard/tests/test_rgw_client.py b/src/pybind/mgr/dashboard/tests/test_rgw_client.py
index 1502cdeb55b9..8bdb01a1b5c3 100644
--- a/src/pybind/mgr/dashboard/tests/test_rgw_client.py
+++ b/src/pybind/mgr/dashboard/tests/test_rgw_client.py
@@ -14,27 +14,27 @@ class RgwClientTest(unittest.TestCase):
     }
 
     @classmethod
-    def mock_set_config(cls, key, val):
+    def mock_set_module_option(cls, key, val):
         cls.settings[key] = val
 
     @classmethod
-    def mock_get_config(cls, key, default):
+    def mock_get_module_option(cls, key, default):
         return cls.settings.get(key, default)
 
     @classmethod
     def setUpClass(cls):
-        mgr.get_config.side_effect = cls.mock_get_config
-        mgr.set_config.side_effect = cls.mock_set_config
+        mgr.get_module_option.side_effect = cls.mock_get_module_option
+        mgr.set_module_option.side_effect = cls.mock_set_module_option
 
     def setUp(self):
         RgwClient._user_instances.clear()  # pylint: disable=protected-access
 
     def test_ssl_verify(self):
-        mgr.set_config('RGW_API_SSL_VERIFY', True)
+        mgr.set_module_option('RGW_API_SSL_VERIFY', True)
         instance = RgwClient.admin_instance()
         self.assertTrue(instance.session.verify)
 
     def test_no_ssl_verify(self):
-        mgr.set_config('RGW_API_SSL_VERIFY', False)
+        mgr.set_module_option('RGW_API_SSL_VERIFY', False)
         instance = RgwClient.admin_instance()
         self.assertFalse(instance.session.verify)
diff --git a/src/pybind/mgr/dashboard/tests/test_settings.py b/src/pybind/mgr/dashboard/tests/test_settings.py
index a29931cc956a..3965bde95410 100644
--- a/src/pybind/mgr/dashboard/tests/test_settings.py
+++ b/src/pybind/mgr/dashboard/tests/test_settings.py
@@ -22,17 +22,17 @@ class SettingsTest(unittest.TestCase):
         settings._OPTIONS_COMMAND_MAP = settings._options_command_map()
 
     @classmethod
-    def mock_set_config(cls, attr, val):
+    def mock_set_module_option(cls, attr, val):
         cls.CONFIG_KEY_DICT[attr] = val
 
     @classmethod
-    def mock_get_config(cls, attr, default):
+    def mock_get_module_option(cls, attr, default):
         return cls.CONFIG_KEY_DICT.get(attr, default)
 
     def setUp(self):
         self.CONFIG_KEY_DICT.clear()
-        mgr.set_config.side_effect = self.mock_set_config
-        mgr.get_config.side_effect = self.mock_get_config
+        mgr.set_module_option.side_effect = self.mock_set_module_option
+        mgr.get_module_option.side_effect = self.mock_get_module_option
         if Settings.GRAFANA_API_HOST != 'localhost':
             Settings.GRAFANA_API_HOST = 'localhost'
         if Settings.GRAFANA_API_PORT != 3000:
@@ -119,17 +119,17 @@ class SettingsControllerTest(ControllerTestCase):
         cls.setup_controllers([SettingsController])
 
     @classmethod
-    def mock_set_config(cls, attr, val):
+    def mock_set_module_option(cls, attr, val):
         cls.config_values[attr] = val
 
     @classmethod
-    def mock_get_config(cls, attr, default):
+    def mock_get_module_option(cls, attr, default):
         return cls.config_values.get(attr, default)
 
     def setUp(self):
         self.config_values.clear()
-        mgr.set_config.side_effect = self.mock_set_config
-        mgr.get_config.side_effect = self.mock_get_config
+        mgr.set_module_option.side_effect = self.mock_set_module_option
+        mgr.get_module_option.side_effect = self.mock_get_module_option
 
     def test_settings_list(self):
         self._get('/api/settings')
diff --git a/src/pybind/mgr/dashboard/tests/test_sso.py b/src/pybind/mgr/dashboard/tests/test_sso.py
index 35cb5df855a1..583da425610f 100644
--- a/src/pybind/mgr/dashboard/tests/test_sso.py
+++ b/src/pybind/mgr/dashboard/tests/test_sso.py
@@ -14,11 +14,11 @@ class AccessControlTest(unittest.TestCase):
     CONFIG_KEY_DICT = {}
 
     @classmethod
-    def mock_set_config(cls, attr, val):
+    def mock_set_module_option(cls, attr, val):
         cls.CONFIG_KEY_DICT[attr] = val
 
     @classmethod
-    def mock_get_config(cls, attr, default):
+    def mock_get_module_option(cls, attr, default):
         return cls.CONFIG_KEY_DICT.get(attr, default)
 
     IDP_METADATA = '''<?xml version="1.0"?>
@@ -71,10 +71,11 @@ class AccessControlTest(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        mgr.set_config.side_effect = cls.mock_set_config
-        mgr.get_config.side_effect = cls.mock_get_config
-        mgr.set_store.side_effect = cls.mock_set_config
-        mgr.get_store.side_effect = cls.mock_get_config
+        mgr.set_module_option.side_effect = cls.mock_set_module_option
+        mgr.get_module_option.side_effect = cls.mock_get_module_option
+        # kludge below
+        mgr.set_store.side_effect = cls.mock_set_module_option
+        mgr.get_store.side_effect = cls.mock_get_module_option
 
     def setUp(self):
         self.CONFIG_KEY_DICT.clear()
diff --git a/src/pybind/mgr/devicehealth/module.py b/src/pybind/mgr/devicehealth/module.py
index a769f7e99b9b..6cd8fdac5b2f 100644
--- a/src/pybind/mgr/devicehealth/module.py
+++ b/src/pybind/mgr/devicehealth/module.py
@@ -577,7 +577,7 @@ class Module(MgrModule):
 
     def predict_lift_expectancy(self, devid):
         plugin_name = ''
-        model = self.get_option('device_failure_prediction_mode')
+        model = self.get_ceph_option('device_failure_prediction_mode')
         if model and model.lower() == 'cloud':
             plugin_name = 'diskprediction_cloud'
         elif model and model.lower() == 'local':
@@ -593,7 +593,7 @@ class Module(MgrModule):
 
     def predict_all_devices(self):
         plugin_name = ''
-        model = self.get_option('device_failure_prediction_mode')
+        model = self.get_ceph_option('device_failure_prediction_mode')
         if model and model.lower() == 'cloud':
             plugin_name = 'diskprediction_cloud'
         elif model and model.lower() == 'local':
diff --git a/src/pybind/mgr/diskprediction_cloud/module.py b/src/pybind/mgr/diskprediction_cloud/module.py
index 4cbfb4de7874..cb323d6a615a 100644
--- a/src/pybind/mgr/diskprediction_cloud/module.py
+++ b/src/pybind/mgr/diskprediction_cloud/module.py
@@ -133,9 +133,9 @@ class Module(MgrModule):
                     opt['name'],
                     self.get_module_option(opt['name']) or opt['default'])
             self.log.debug(' %s = %s', opt['name'], getattr(self, opt['name']))
-        if not self._activated_cloud and self.get_option('device_failure_prediction_mode') == 'cloud':
+        if not self._activated_cloud and self.get_ceph_option('device_failure_prediction_mode') == 'cloud':
             self._event.set()
-        if self._activated_cloud and self.get_option('device_failure_prediction_mode') != 'cloud':
+        if self._activated_cloud and self.get_ceph_option('device_failure_prediction_mode') != 'cloud':
             self._event.set()
 
     @property
@@ -370,7 +370,7 @@ class Module(MgrModule):
 
         while self._run:
             self.refresh_config()
-            mode = self.get_option('device_failure_prediction_mode')
+            mode = self.get_ceph_option('device_failure_prediction_mode')
             if mode == 'cloud':
                 if not self._activated_cloud:
                     self.start_cloud_disk_prediction()
diff --git a/src/pybind/mgr/diskprediction_local/module.py b/src/pybind/mgr/diskprediction_local/module.py
index 1cdea759e66e..191b25cdb468 100644
--- a/src/pybind/mgr/diskprediction_local/module.py
+++ b/src/pybind/mgr/diskprediction_local/module.py
@@ -44,7 +44,7 @@ class Module(MgrModule):
                     opt['name'],
                     self.get_module_option(opt['name']) or opt['default'])
             self.log.debug(' %s = %s', opt['name'], getattr(self, opt['name']))
-        if self.get_option('device_failure_prediction_mode') == 'local':
+        if self.get_ceph_option('device_failure_prediction_mode') == 'local':
             self._event.set()
 
     def refresh_config(self):
@@ -77,7 +77,7 @@ class Module(MgrModule):
 
         while self._run:
             self.refresh_config()
-            mode = self.get_option('device_failure_prediction_mode')
+            mode = self.get_ceph_option('device_failure_prediction_mode')
             if mode == 'local':
                 now = datetime.datetime.utcnow()
                 if not last_predicted:
diff --git a/src/pybind/mgr/mgr_module.py b/src/pybind/mgr/mgr_module.py
index 8808d7a9b8ad..e143468b20db 100644
--- a/src/pybind/mgr/mgr_module.py
+++ b/src/pybind/mgr/mgr_module.py
@@ -678,7 +678,7 @@ class MgrModule(ceph_module.BaseMgrModule):
         """
         return self._ceph_get_mgr_id()
 
-    def get_option(self, key):
+    def get_ceph_option(self, key):
         return self._ceph_get_option(key)
 
     def _validate_module_option(self, key):