Merge pull request ceph#57299 from rhcs-dashboard/fix-47066-main

mgr/{restful,zabbix}: remove deprecated module

Reviewed-by: @tchaikov 
Reviewed-by: @ktdreyer 
Reviewed-by: @jmolmo

Author: epuertat

PendingReleaseNotes

@@ -35,6 +35,13 @@
   users that modifying "max_mds" may not help with troubleshooting or recovery
   effort. Instead, it might further destabilize the cluster.
 
+* mgr/restful, mgr/zabbix: both modules, already deprecated since 2020, have been
+  finally removed. They have not been actively maintenance in the last years,
+  and started suffering from vulnerabilities in their dependency chain (e.g.:
+  CVE-2023-46136).  As alternatives, for the `restful` module, the `dashboard` module
+  provides a richer and better maintained RESTful API. Regarding the `zabbix` module,
+  there are alternative monitoring solutions, like `prometheus`, which is the most
+  widely adopted among the Ceph user community.
 
 
 >=19.0.0

ceph.spec.in

@@ -336,7 +336,6 @@ BuildRequires:  hostname
 BuildRequires:  jq
 BuildRequires:	libuuid-devel
 BuildRequires:	python%{python3_pkgversion}-bcrypt
-BuildRequires:	python%{python3_pkgversion}-pecan
 BuildRequires:	python%{python3_pkgversion}-requests
 BuildRequires:	python%{python3_pkgversion}-dateutil
 BuildRequires:	python%{python3_pkgversion}-coverage
@@ -469,7 +468,6 @@ BuildRequires:	xmlsec1-openssl-devel
 BuildRequires:	python%{python3_pkgversion}-cherrypy
 BuildRequires:	python%{python3_pkgversion}-routes
 BuildRequires:	python%{python3_pkgversion}-scipy
-BuildRequires:	python%{python3_pkgversion}-werkzeug
 BuildRequires:	python%{python3_pkgversion}-pyOpenSSL
 %endif
 BuildRequires:	jsonnet
@@ -480,7 +478,6 @@ BuildRequires:	libxmlsec1-nss1
 BuildRequires:	libxmlsec1-openssl1
 BuildRequires:	python%{python3_pkgversion}-CherryPy
 BuildRequires:	python%{python3_pkgversion}-Routes
-BuildRequires:	python%{python3_pkgversion}-Werkzeug
 BuildRequires:	python%{python3_pkgversion}-numpy-devel
 BuildRequires:	xmlsec1-devel
 BuildRequires:	xmlsec1-openssl-devel
@@ -705,7 +702,6 @@ Recommends:     python%{python3_pkgversion}-grpcio-tools
 %if 0%{?suse_version}
 Requires:       python%{python3_pkgversion}-CherryPy
 Requires:       python%{python3_pkgversion}-Routes
-Requires:       python%{python3_pkgversion}-Werkzeug
 Recommends:     python%{python3_pkgversion}-python3-saml
 %endif
 %description mgr-dashboard
@@ -738,20 +734,17 @@ Group:          System/Filesystems
 %endif
 Requires:       python%{python3_pkgversion}-bcrypt
 Requires:       python%{python3_pkgversion}-packaging
-Requires:       python%{python3_pkgversion}-pecan
 Requires:       python%{python3_pkgversion}-pyOpenSSL
 Requires:       python%{python3_pkgversion}-requests
 Requires:       python%{python3_pkgversion}-dateutil
 Requires:       python%{python3_pkgversion}-setuptools
 %if 0%{?fedora} || 0%{?rhel} >= 8 || 0%{?openEuler}
 Requires:       python%{python3_pkgversion}-cherrypy
 Requires:       python%{python3_pkgversion}-pyyaml
-Requires:       python%{python3_pkgversion}-werkzeug
 %endif
 %if 0%{?suse_version}
 Requires:       python%{python3_pkgversion}-CherryPy
 Requires:       python%{python3_pkgversion}-PyYAML
-Requires:       python%{python3_pkgversion}-Werkzeug
 %endif
 # RHEL8 has python 3.6 and that lacks dataclasses in the stdlib, so pull in the
 # backport dataclasses module instead.
@@ -1996,7 +1989,6 @@ fi
 %{_datadir}/ceph/mgr/progress
 %{_datadir}/ceph/mgr/prometheus
 %{_datadir}/ceph/mgr/rbd_support
-%{_datadir}/ceph/mgr/restful
 %{_datadir}/ceph/mgr/rgw
 %{_datadir}/ceph/mgr/selftest
 %{_datadir}/ceph/mgr/smb
@@ -2007,7 +1999,6 @@ fi
 %{_datadir}/ceph/mgr/telemetry
 %{_datadir}/ceph/mgr/test_orchestrator
 %{_datadir}/ceph/mgr/volumes
-%{_datadir}/ceph/mgr/zabbix
 
 %files mgr-rook
 %{_datadir}/ceph/mgr/rook

debian/ceph-mgr-modules-core.install

@@ -16,7 +16,6 @@ usr/share/ceph/mgr/progress
 usr/share/ceph/mgr/prometheus
 usr/share/ceph/mgr/rbd_support
 usr/share/ceph/mgr/rgw
-usr/share/ceph/mgr/restful
 usr/share/ceph/mgr/selftest
 usr/share/ceph/mgr/snap_schedule
 usr/share/ceph/mgr/stats
@@ -25,4 +24,3 @@ usr/share/ceph/mgr/telegraf
 usr/share/ceph/mgr/telemetry
 usr/share/ceph/mgr/test_orchestrator
 usr/share/ceph/mgr/volumes
-usr/share/ceph/mgr/zabbix

debian/ceph-mgr-modules-core.requires

@@ -1,7 +1,5 @@
 natsort
 CherryPy
 packaging
-pecan
-werkzeug
 requests
 python-dateutil

debian/control

@@ -94,7 +94,6 @@ Build-Depends: automake,
                python3-all-dev,
                python3-cherrypy3,
                python3-natsort,
-               python3-pecan <pkg.ceph.check>,
                python3-bcrypt <pkg.ceph.check>,
                tox <pkg.ceph.check>,
                python3-coverage <pkg.ceph.check>,
@@ -107,7 +106,6 @@ Build-Depends: automake,
                python3-setuptools,
                python3-sphinx,
                python3-venv,
-               python3-werkzeug <pkg.ceph.check>,
                python3-yaml,
                ragel <pkg.ceph.crimson>,
                socat <pkg.ceph.check>,

doc/_ext/ceph_commands.py

@@ -285,12 +285,6 @@ def mocked_modules(self):
         # make diskprediction_local happy
         mock_imports += ['numpy',
                          'scipy']
-        # make restful happy
-        mock_imports += ['pecan',
-                         'pecan.rest',
-                         'pecan.hooks',
-                         'werkzeug',
-                         'werkzeug.serving']
 
         for m in mock_imports:
             args = {}

doc/_ext/ceph_confval.py

@@ -289,12 +289,6 @@ def mocked_modules(self):
         # make diskprediction_local happy
         mock_imports += ['numpy',
                          'scipy']
-        # make restful happy
-        mock_imports += ['pecan',
-                         'pecan.rest',
-                         'pecan.hooks',
-                         'werkzeug',
-                         'werkzeug.serving']
 
         for m in mock_imports:
             args = {}

doc/dev/developer_guide/dash-devel.rst

@@ -161,8 +161,6 @@ dashboard and its URLs::
 
   dashboard urls: https://192.168.178.84:41259, https://192.168.178.84:43259, https://192.168.178.84:45259
     w/ user/pass: admin / admin
-  restful urls: https://192.168.178.84:42259, https://192.168.178.84:44259, https://192.168.178.84:46259
-    w/ user/pass: admin / 598da51f-8cd1-4161-a970-b2944d5ad200
 
 During development (especially in backend development), you also want to
 check on occasions if the dashboard manager module is still running. To do so
@@ -175,8 +173,7 @@ should look similar to the following output:
 
   $ ./bin/ceph mgr services
   {
-      "dashboard": "https://home:41931/",
-      "restful": "https://home:42931/"
+      "dashboard": "https://home:41931/"
   }
 
 By default, this environment uses a randomly chosen port for Ceph Dashboard

doc/mgr/administrator.rst

@@ -100,7 +100,6 @@ Here is an example of enabling the :term:`Dashboard` module:
 	$ ceph mgr module ls
 	{
 		"enabled_modules": [
-			"restful",
 			"status"
 		],
 		"disabled_modules": [
@@ -112,7 +111,6 @@ Here is an example of enabling the :term:`Dashboard` module:
 	$ ceph mgr module ls
 	{
 		"enabled_modules": [
-			"restful",
 			"status",
 			"dashboard"
 		],
@@ -122,8 +120,7 @@ Here is an example of enabling the :term:`Dashboard` module:
 
 	$ ceph mgr services
 	{
-		"dashboard": "http://myserver.com:7789/",
-		"restful": "https://myserver.com:8789/"
+		"dashboard": "http://myserver.com:7789/"
 	}
 
 

doc/mgr/index.rst

@@ -33,8 +33,6 @@ sensible.
     Alerts module <alerts>
     DiskPrediction module <diskprediction>
     Local pool module <localpool>
-    RESTful module <restful>
-    Zabbix module <zabbix>
     Prometheus module <prometheus>
     Influx module <influx>
     Hello module <hello>