feat: Use ui.menu_blocklist to hide and ui.menu_inactivelist to disable menu items

changes/1733.feature.md

@@ -0,0 +1 @@
+Use `ui.menu_blocklist` to hide and `ui.menu_inactivelist` to disable menu items.

configs/webserver/sample.conf

@@ -114,8 +114,10 @@ brand = "Lablup Cloud"
 # default_environment = 'index.docker.io/lablup/python-tensorflow'
 # Default environment to import GitHub repositories / notebooks
 # default_import_environment = 'index.docker.io/lablup/python:3.6-ubuntu18.04'
-# Comma-separated sidebar menu pages
-#menu_blocklist = "statistics,pipeline"
+# Comma-separated sidebar menu pages to hide
+#menu_blocklist = "pipeline"
+# Comma-separated sidebar menu pages to disable
+#menu_inactivelist = "statistics"
 
 [api]
 domain = "default"

src/ai/backend/install/context.py

@@ -513,6 +513,7 @@ async def configure_webserver(self) -> None:
                     redis_table["password"] = halfstack.redis_password
             data["session"]["redis"] = redis_table  # type: ignore
             data["ui"]["menu_blocklist"] = ",".join(service.webui_menu_blocklist)  # type: ignore
+            data["ui"]["menu_inactivelist"] = ",".join(service.webui_menu_inactivelist)  # type: ignore
         with conf_path.open("w") as fp:
             tomlkit.dump(data, fp)
 
@@ -749,7 +750,8 @@ def hydrate_install_info(self) -> InstallInfo:
             webserver_addr=ServerAddr(HostPortPair("127.0.0.1", 8090)),
             webserver_ipc_base_path="ipc/webserver",
             webserver_var_base_path="var/webserver",
-            webui_menu_blocklist=["statistics", "pipeline"],
+            webui_menu_blocklist=["pipeline"],
+            webui_menu_inactivelist=["statistics"],
             manager_addr=ServerAddr(HostPortPair("127.0.0.1", 8091)),
             storage_proxy_manager_auth_key=secrets.token_hex(32),
             manager_ipc_base_path="ipc/manager",
@@ -835,7 +837,8 @@ def hydrate_install_info(self) -> InstallInfo:
             webserver_addr=ServerAddr(HostPortPair("127.0.0.1", 8090)),
             webserver_ipc_base_path="ipc/webserver",
             webserver_var_base_path="var/webserver",
-            webui_menu_blocklist=["statistics", "pipeline"],
+            webui_menu_blocklist=["pipeline"],
+            webui_menu_inactivelist=["statistics"],
             manager_addr=ServerAddr(HostPortPair("127.0.0.1", 8091)),
             storage_proxy_manager_auth_key=secrets.token_urlsafe(32),
             manager_ipc_base_path="ipc/manager",

src/ai/backend/install/types.py

@@ -141,6 +141,7 @@ class ServiceConfig:
     webserver_ipc_base_path: str
     webserver_var_base_path: str
     webui_menu_blocklist: list[str]
+    webui_menu_inactivelist: list[str]
     local_proxy_addr: ServerAddr
     agent_rpc_addr: ServerAddr
     agent_watcher_addr: ServerAddr

src/ai/backend/web/config.py

@@ -109,6 +109,8 @@
         t.Key("default_environment", default=None): t.Null | t.String,
         t.Key("default_import_environment", default=None): t.Null | t.String,
         t.Key("menu_blocklist", default=None): t.Null | tx.StringList(empty_str_as_empty_list=True),
+        t.Key("menu_inactivelist", default=None): t.Null
+        | tx.StringList(empty_str_as_empty_list=True),
     }).allow_extra("*"),
     t.Key("api"): t.Dict({
         t.Key("domain"): t.String,

src/ai/backend/web/templates/config.toml.j2

@@ -52,6 +52,7 @@ connectionMode = "SESSION"
 
 [menu]
 {% toml_strlist_field "blocklist" config["ui"]["menu_blocklist"] %}
+{% toml_strlist_field "inactivelist" config["ui"]["menu_inactivelist"] %}
 
 [plugin]
 {% toml_strlist_field "page" config["plugin"]["page"] %}