From b4dc62eeadb6d50103b5d4799a0299d28f0c2de7 Mon Sep 17 00:00:00 2001 From: Min RK Date: Thu, 5 May 2022 14:42:57 +0200 Subject: [PATCH] clarify direction of information in idle-culler JupyterHub does not poll servers, servers post activity --- docs/topic/idle-culler.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/topic/idle-culler.rst b/docs/topic/idle-culler.rst index b8c520b..21e3889 100644 --- a/docs/topic/idle-culler.rst +++ b/docs/topic/idle-culler.rst @@ -8,13 +8,14 @@ The idle culler automatically shuts down user notebook servers when they have not been used for a certain time period, in order to reduce the total resource usage on your JupyterHub. -JupyterHub pings the user's notebook server at certain time intervals. If no response -is received from the server during this checks and the timeout expires, the server is -considered to be *inactive (idle)* and will be culled. +The notebook server monitors activity internally +and notifies JupyterHub of recent activity at certain time intervals (the activity interval). +If JupyterHub has not been notified of any activity after a certain period (the idle timeout), +the server is considered to be *inactive (idle)* and will be culled (shutdown). The `idle culler `_ is a JupyterHub service that is installed and enabled by default in TLJH. It can be configured using tljh-config. For advanced use-cases, like purging old user data, -the idle culler configuration can be extended beyond tljh-config options, using custom +the idle culler configuration can be extended beyond tljh-config options, using custom `jupyterhub_config.py snippets `__.