mgr/dashboard: Add backend support for changing dashboard configuration settings via the REST API #22457

p-se · 2018-06-07T15:41:21Z

Enables to change (set/unset) values of settings of the dashboard using the REST API.

Fixes: https://tracker.ceph.com/issues/24273

Signed-off-by: Patrick Nawracay pnawracay@suse.com

votdev · 2018-06-08T07:51:44Z

src/pybind/mgr/dashboard/controllers/settings.py

+        try:
+            default, data_type = getattr(Options, attr)
+        except AttributeError:
+            raise cherrypy.HTTPError(404)


Consider to use DashboardException(http_status_code=404) here.

I'd use cherrypy.NotFound()

votdev · 2018-06-08T07:51:52Z

src/pybind/mgr/dashboard/controllers/settings.py

+        try:
+            setattr(Settings, self._to_native(name), value)
+        except AttributeError:
+            raise cherrypy.HTTPError(404)


Consider to use DashboardException(http_status_code=404) here.

votdev · 2018-06-08T07:52:01Z

src/pybind/mgr/dashboard/controllers/settings.py

+        try:
+            delattr(Settings, self._to_native(name))
+        except AttributeError:
+            raise cherrypy.HTTPError(404)


Consider to use DashboardException(http_status_code=404) here.

votdev · 2018-06-08T07:52:10Z

src/pybind/mgr/dashboard/controllers/settings.py

+            for name, value in kwargs.items():
+                setattr(Settings, self._to_native(name), value)
+        except AttributeError:
+            raise cherrypy.HTTPError(404)


Consider to use DashboardException(http_status_code=404) here.

does it make sense to refactor this into a separate method or function?

sebastian-philipp · 2018-06-08T08:32:38Z

src/pybind/mgr/dashboard/controllers/settings.py

+        try:
+            default, data_type = getattr(Options, attr)
+        except AttributeError:
+            raise cherrypy.HTTPError(404)


I'd use cherrypy.NotFound()

sebastian-philipp · 2018-06-08T08:35:04Z

src/pybind/mgr/dashboard/controllers/settings.py

+    def _to_native(setting):
+        return setting.upper().replace('-', '_')
+
+    def list(self):


def list(self): return [self.get(name) for name in Options.__dict__]

??

return [ json.loads(self.get(name)) for name in Options.__dict__ if name.isupper() and not name.startswith('_') ]

That would work, but it requires to unserialize the result of get as the result is automatically serialized. Do you prefer this solution?

why do you need to run json.loads?

The list method of the RESTController class is being modified at initialization, so that it returns the serialized version of the output of list. I resolved this by creating a _get method, like you proposed in our call.

sebastian-philipp · 2018-06-08T08:36:20Z

src/pybind/mgr/dashboard/controllers/settings.py

+            for name, value in kwargs.items():
+                setattr(Settings, self._to_native(name), value)
+        except AttributeError:
+            raise cherrypy.HTTPError(404)


does it make sense to refactor this into a separate method or function?

outdated

p-se · 2018-07-26T10:37:02Z

jenkins retest this please

p-se · 2018-07-26T14:25:25Z

jenkins retest this please

s0nea · 2018-07-30T09:34:33Z

jenkins retest this please

rjfd

Please add integration (QA) tests for testing the Settings controller.

Implemented

callithea · 2018-08-07T14:52:03Z

QA run was successful: http://pulpito.ceph.com/laura-2018-08-07_11:09:18-rados:mgr-wip-lpaduano-testing-22457-distro-basic-smithi/

ricardoasmarques

I've added some suggestions to improve the swagger API documentation.

ricardoasmarques · 2018-08-09T15:05:00Z

src/pybind/mgr/dashboard/controllers/settings.py

+        with self._attribute_handler(name) as sname:
+            delattr(Settings, self._to_native(sname))
+
+    def bulk_set(self, **kwargs):


The swagger API docs generator doesn't play well with this **kargs parameter (documentation says there is not parameters):

Is this something that can be fixed?

I've looked into it and yes, I think it can be fixed but it's a general issue with generating the API documentation (or how the Endpoints are generated) for the bulk_set method of the RestController. Hence, I'd say it shouldn't be fixed in this PR.

Thanks for the info. Agree, this should be fixed in a separate PR.

ricardoasmarques · 2018-08-09T15:06:40Z

src/pybind/mgr/dashboard/controllers/settings.py

+
+
+@ApiController('/settings', Scope.CONFIG_OPT)
+class SettingsController(RESTController):


Shouldn't we rename this controller to Settings, for consistency in the API documentation?

Enables to change (set/unset) values of settings of the dashboard using the REST API. Fixes: https://tracker.ceph.com/issues/24273 Signed-off-by: Patrick Nawracay <pnawracay@suse.com>

ricardoasmarques

Lgtm

ricardoasmarques · 2018-08-10T15:54:46Z

QA run failed: http://pulpito.ceph.com/laura-2018-08-10_13:53:29-rados:mgr-wip-lpaduano-testing-22457-2-distro-basic-smithi/

s0nea · 2018-08-13T06:22:50Z

I don't have the feeling that the error is related to this pull request:

2018-08-10T14:25:46.695 INFO:tasks.cephfs_test_runner:======================================================================
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:FAIL: test_list (tasks.mgr.dashboard.test_rgw.RgwUserTest)
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:----------------------------------------------------------------------
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:Traceback (most recent call last):
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:  File "/home/teuthworker/src/git.ceph.com_ceph-c_wip-lpaduano-testing-22457-2/qa/tasks/mgr/dashboard/test_rgw.py", line 260, in test_list
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:    self.assertStatus(200)
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:  File "/home/teuthworker/src/git.ceph.com_ceph-c_wip-lpaduano-testing-22457-2/qa/tasks/mgr/dashboard/helper.py", line 325, in assertStatus
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:    self.assertEqual(self._resp.status_code, status)
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:AssertionError: 500 != 200
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:
2018-08-10T14:25:46.696 INFO:tasks.cephfs_test_runner:----------------------------------------------------------------------
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:Ran 62 tests in 753.519s
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:FAILED (failures=1)
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:======================================================================
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:FAIL: test_list (tasks.mgr.dashboard.test_rgw.RgwUserTest)
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:----------------------------------------------------------------------
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:Traceback (most recent call last):
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:  File "/home/teuthworker/src/git.ceph.com_ceph-c_wip-lpaduano-testing-22457-2/qa/tasks/mgr/dashboard/test_rgw.py", line 260, in test_list
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:    self.assertStatus(200)
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:  File "/home/teuthworker/src/git.ceph.com_ceph-c_wip-lpaduano-testing-22457-2/qa/tasks/mgr/dashboard/helper.py", line 325, in assertStatus
2018-08-10T14:25:46.697 INFO:tasks.cephfs_test_runner:    self.assertEqual(self._resp.status_code, status)
2018-08-10T14:25:46.698 INFO:tasks.cephfs_test_runner:AssertionError: 500 != 200

Exotelis · 2018-08-14T07:01:58Z

QA run passed
Packages: https://shaman.ceph.com/builds/ceph/wip-skrah-testing-22457-2018-08-13-10-57/
Tests: http://pulpito.ceph.com/skrah-2018-08-13_11:08:53-rados:mgr-wip-skrah-testing-22457-2018-08-13-10-57-distro-basic-smithi/

p-se added feature dashboard labels Jun 7, 2018

p-se requested review from LenzGr, votdev, sebastian-philipp, s0nea and rjfd June 7, 2018 15:41

votdev requested changes Jun 8, 2018

View reviewed changes

sebastian-philipp previously requested changes Jun 8, 2018

View reviewed changes

LenzGr changed the title ~~mgr/dashboard: Add support for changing configuration settings via the UI~~ mgr/dashboard: Add support for changing dashboard configuration settings via the UI Jun 11, 2018

p-se force-pushed the dash-settings branch 2 times, most recently from 9695fcf to 8be01b6 Compare June 11, 2018 12:47

votdev approved these changes Jun 13, 2018

View reviewed changes

votdev added the needs-review label Jun 15, 2018

LenzGr changed the title ~~mgr/dashboard: Add support for changing dashboard configuration settings via the UI~~ mgr/dashboard: Add backend support for changing dashboard configuration settings via the REST API Jun 15, 2018

LenzGr added the needs-rebase label Jun 26, 2018

p-se force-pushed the dash-settings branch from 8be01b6 to c61e12f Compare July 23, 2018 11:50

p-se removed the needs-rebase label Jul 24, 2018

p-se force-pushed the dash-settings branch 2 times, most recently from c286808 to 20d3218 Compare July 25, 2018 12:32

callithea added the needs-rebase label Jul 26, 2018

p-se force-pushed the dash-settings branch from 20d3218 to 82c9aa6 Compare July 26, 2018 10:21

p-se removed the needs-rebase label Jul 26, 2018

sebastian-philipp mentioned this pull request Jul 26, 2018

mgr/dashboard config options add #23230

Merged

s0nea approved these changes Aug 1, 2018

View reviewed changes

rjfd previously requested changes Aug 1, 2018

View reviewed changes

p-se force-pushed the dash-settings branch from 82c9aa6 to 452f59a Compare August 3, 2018 13:42

p-se force-pushed the dash-settings branch from 452f59a to 3f82a65 Compare August 6, 2018 07:59

p-se removed the needs-review label Aug 7, 2018

callithea added needs-qa needs-review wip-laura-testing labels Aug 7, 2018

p-se removed the needs-review label Aug 7, 2018

p-se removed needs-qa wip-laura-testing labels Aug 7, 2018

ricardoasmarques suggested changes Aug 9, 2018

View reviewed changes

p-se force-pushed the dash-settings branch from 3f82a65 to 5becf7b Compare August 10, 2018 08:55

mgr/dashboard/backend: API to manage dashboard settings

7340e70

Enables to change (set/unset) values of settings of the dashboard using the REST API. Fixes: https://tracker.ceph.com/issues/24273 Signed-off-by: Patrick Nawracay <pnawracay@suse.com>

p-se force-pushed the dash-settings branch from 5becf7b to 7340e70 Compare August 10, 2018 09:32

ricardoasmarques approved these changes Aug 10, 2018

View reviewed changes

ricardoasmarques added the needs-qa label Aug 10, 2018

callithea added the wip-laura-testing label Aug 10, 2018

s0nea added wip-tdehler-testing and removed wip-laura-testing labels Aug 13, 2018

Exotelis added wip-skrah-testing and removed wip-tdehler-testing labels Aug 13, 2018

Exotelis removed needs-qa wip-skrah-testing labels Aug 14, 2018

ricardoasmarques merged commit 2a6ce09 into ceph:master Aug 14, 2018

s0nea mentioned this pull request Dec 11, 2018

mgr/dashboard: Settings service #25327

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mgr/dashboard: Add backend support for changing dashboard configuration settings via the REST API #22457

mgr/dashboard: Add backend support for changing dashboard configuration settings via the REST API #22457

p-se commented Jun 7, 2018 •

edited by LenzGr

votdev Jun 8, 2018

sebastian-philipp Jun 8, 2018

votdev Jun 8, 2018

votdev Jun 8, 2018

votdev Jun 8, 2018

sebastian-philipp Jun 8, 2018

sebastian-philipp Jun 8, 2018

sebastian-philipp Jun 8, 2018

p-se Jun 11, 2018 •

edited

sebastian-philipp Jun 11, 2018

p-se Jun 11, 2018

sebastian-philipp Jun 8, 2018

p-se commented Jul 26, 2018 •

edited

p-se commented Jul 26, 2018

s0nea commented Jul 30, 2018

rjfd left a comment

callithea commented Aug 7, 2018

ricardoasmarques left a comment

ricardoasmarques Aug 9, 2018 •

edited

p-se Aug 10, 2018

ricardoasmarques Aug 10, 2018

ricardoasmarques Aug 9, 2018

ricardoasmarques left a comment

ricardoasmarques commented Aug 10, 2018

s0nea commented Aug 13, 2018

Exotelis commented Aug 14, 2018



		@ApiController('/settings', Scope.CONFIG_OPT)
		class SettingsController(RESTController):

mgr/dashboard: Add backend support for changing dashboard configuration settings via the REST API #22457

mgr/dashboard: Add backend support for changing dashboard configuration settings via the REST API #22457

Conversation

p-se commented Jun 7, 2018 • edited by LenzGr

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

p-se Jun 11, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

p-se commented Jul 26, 2018 • edited

p-se commented Jul 26, 2018

s0nea commented Jul 30, 2018

rjfd left a comment

Choose a reason for hiding this comment

callithea commented Aug 7, 2018

ricardoasmarques left a comment

Choose a reason for hiding this comment

ricardoasmarques Aug 9, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ricardoasmarques left a comment

Choose a reason for hiding this comment

ricardoasmarques commented Aug 10, 2018

s0nea commented Aug 13, 2018

Exotelis commented Aug 14, 2018

p-se commented Jun 7, 2018 •

edited by LenzGr

p-se Jun 11, 2018 •

edited

p-se commented Jul 26, 2018 •

edited

ricardoasmarques Aug 9, 2018 •

edited