Merge pull request #816 from minrk/activity-doc

clarify direction of information in idle-culler
This commit is contained in:
Georgiana Elena
2022-05-05 15:51:25 +03:00
committed by GitHub

View File

@@ -8,9 +8,10 @@ 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 not been used for a certain time period, in order to reduce the total resource
usage on your JupyterHub. usage on your JupyterHub.
JupyterHub pings the user's notebook server at certain time intervals. If no response The notebook server monitors activity internally
is received from the server during this checks and the timeout expires, the server is and notifies JupyterHub of recent activity at certain time intervals (the activity interval).
considered to be *inactive (idle)* and will be culled. 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 <https://github.com/jupyterhub/jupyterhub-idle-culler>`_ is a JupyterHub service that is installed and enabled by default in TLJH. The `idle culler <https://github.com/jupyterhub/jupyterhub-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, It can be configured using tljh-config. For advanced use-cases, like purging old user data,