Explain culler settings better

This commit is contained in:
1kastner
2020-08-25 16:47:34 +02:00
committed by GitHub
parent 5e90b27ff7
commit ef2fed4bc9

View File

@@ -8,15 +8,15 @@ 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 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 is received from the server during this checks and the timeout expires, the server is
considered to be *inactive (idle)* and will be culled. considered to be *inactive (idle)* and will be culled.
The idle culler is maintained as The idle culler is a JupyterHub service that is installed and enabled by default in TLJH.
`a separate project <https://github.com/jupyterhub/jupyterhub-idle-culler>`_. It can be configured using tljh-config. For advanced use-cases, like purging old user data,
For advanced users, the code leaves the option for direct adjustment, e.g. to add the idle culler configuration can be extended beyond tljh-config options, using custom
features such as purging old user data. `jupyterhub_config.py snippets <https://tljh.jupyter.org/en/latest/topic/escape-hatch.html?highlight=escape-hatch#extending-jupyterhub-config-py>`__.
Default settings Default settings
================ ================