Merge pull request #881 from consideRatio/curvenote/main

added `remove_named_servers` setting for jupyterhub-idle-culler
jupyterhub · May 13, 2023 · 186ae71 · 186ae71
2 parents bdc90d6 + e6994aa
commit 186ae71
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 0 deletions.
diff --git a/docs/topic/idle-culler.md b/docs/topic/idle-culler.md
@@ -40,6 +40,12 @@ the users will not be culled alongside their notebooks and will continue to exis
 services.cull.users = False
 ```
 
+If named servers are in use, they are not removed after being culled.
+
+```python
+services.cull.remove_named_servers = False
+```
+
 ## Configuring the idle culler
 
 The available configuration options are:
@@ -76,6 +82,16 @@ sudo tljh-config set services.cull.max_age <server-max-age>
 sudo tljh-config reload
 ```
 
+### Remove Named Servers
+
+Remove named servers after they are shutdown. Only applies if named servers are
+enabled on the hub installation:
+
+```bash
+sudo tljh-config set services.cull.remove_named_servers True
+sudo tljh-config reload
+```
+
 ### User culling
 
 In addition to servers, it is also possible to cull the users. This is usually

diff --git a/tests/test_configurer.py b/tests/test_configurer.py
@@ -220,6 +220,43 @@ def test_set_cull_service():
     ]
 
 
+def test_cull_service_named():
+    """
+    Test default cull service settings with named server removal
+    """
+    c = apply_mock_config(
+        {
+            "services": {
+                "cull": {
+                    "every": 10,
+                    "cull_users": True,
+                    "remove_named_servers": True,
+                    "max_age": 60,
+                }
+            }
+        }
+    )
+
+    cull_cmd = [
+        sys.executable,
+        "-m",
+        "jupyterhub_idle_culler",
+        "--timeout=600",
+        "--cull-every=10",
+        "--concurrency=5",
+        "--max-age=60",
+        "--cull-users",
+        "--remove-named-servers",
+    ]
+    assert c.JupyterHub.services == [
+        {
+            "name": "cull-idle",
+            "admin": True,
+            "command": cull_cmd,
+        }
+    ]
+
+
 def test_load_secrets(tljh_dir):
     """
     Test loading secret files

diff --git a/tljh/configurer.py b/tljh/configurer.py
@@ -59,6 +59,7 @@
             "concurrency": 5,
             "users": False,
             "max_age": 0,
+            "remove_named_servers": False,
         },
         "configurator": {"enabled": False},
     },
@@ -256,6 +257,8 @@ def set_cull_idle_service(config):
     cull_cmd += ["--max-age=%d" % cull_config["max_age"]]
     if cull_config["users"]:
         cull_cmd += ["--cull-users"]
+    if cull_config["remove_named_servers"]:
+        cull_cmd += ["--remove-named-servers"]
 
     cull_service = {
         "name": "cull-idle",