Merge pull request #74 from HCharlie/MLX-1204

add options to cull named servers and default servers separately

Author: yuvipanda

README.md

@@ -135,6 +135,10 @@ python3 -m jupyterhub_idle_culler [--timeout=900] [--url=http://localhost:8081/h
                                    if --cull-users=true). (default True)
   --cull-every                     The interval (in seconds) for checking for
                                    idle servers to cull. (default 0)
+  --cull-default-servers           Whether default servers should be culled (only
+                                   if --cull-default-servers=true). (default True)
+  --cull-named-servers             Whether named servers should be culled (only
+                                   if --cull-named-servers=true). (default True)
   --cull-users                     Cull users in addition to servers.  This is
                                    for use in temporary-user cases such as
                                    tmpnb. (default False)

jupyterhub_idle_culler/__init__.py

@@ -87,6 +87,8 @@ async def cull_idle(
     internal_certs_location="",
     cull_admin_users=True,
     api_page_size=0,
+    cull_default_servers=True,
+    cull_named_servers=True,
 ):
     """Shutdown idle single-user servers
 
@@ -234,8 +236,16 @@ async def handle_server(user, server_name, server, max_age, inactive_limit):
         #     return False
         # inactive_limit = server['state']['culltime']
 
+        is_default_server = server_name == ""
+        is_named_server = server_name != ""
+
         should_cull = (
-            inactive is not None and inactive.total_seconds() >= inactive_limit
+            inactive is not None
+            and inactive.total_seconds() >= inactive_limit
+            and (
+                (cull_default_servers and is_default_server)
+                or (cull_named_servers and is_named_server)
+            )
         )
         if should_cull:
             app_log.info(
@@ -561,6 +571,26 @@ def main():
             """
         ).strip(),
     )
+    define(
+        "cull_default_servers",
+        type=bool,
+        default=True,
+        help=dedent(
+            """
+            Whether default servers should be culled (only if --cull-default-servers=true).
+            """
+        ).strip(),
+    )
+    define(
+        "cull_named_servers",
+        type=bool,
+        default=True,
+        help=dedent(
+            """
+            Whether named servers should be culled (only if --cull-named-servers=true).
+            """
+        ).strip(),
+    )
 
     parse_command_line()
     if not options.cull_every:
@@ -589,6 +619,8 @@ def main():
         internal_certs_location=options.internal_certs_location,
         cull_admin_users=options.cull_admin_users,
         api_page_size=options.api_page_size,
+        cull_default_servers=options.cull_default_servers,
+        cull_named_servers=options.cull_named_servers,
     )
     # schedule first cull immediately
     # because PeriodicCallback doesn't start until the end of the first interval