hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-09 19:13:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6821e63b7189950bb526c35d38544b701e77ed90
jupyterhub/examples/cull-idle
History
Richard Darst 52c099193d cull_idle_servers.py: rebind max_age and inactive_limit locally 
- In the cull script, the max_age and inactive_limit are used from the
  outer scope.  In the case that you add extra logic, one may want to
  modify these values.
- In that case, you either have to rename them locally, or access the
  outer scope with "nonlocal", the first of which is too much work,
  the second of which has a high chance of introducing bugs (as it did
  for me).
- This change introduces a fix for everyone.  It doesn't change basic
  functionality, but makes local modifications simpler.
2019-10-25 14:36:16 +03:00
..
cull_idle_servers.py
cull_idle_servers.py: rebind max_age and inactive_limit locally
2019-10-25 14:36:16 +03:00
jupyterhub_config.py
pass flake8 on examples
2019-02-19 16:59:11 +01:00
README.md
Use $() for command substitution instead of backticks/quotes.
2018-10-04 13:44:16 -07:00

README.md

cull-idle Example

The cull_idle_servers.py file provides a script to cull and shut down idle single-user notebook servers. This script is used when cull-idle is run as a Service or when it is run manually as a standalone script.

Configure cull-idle to run as a Hub-Managed Service

In jupyterhub_config.py, add the following dictionary for the cull-idle Service to the c.JupyterHub.services list:

c.JupyterHub.services = [
    {
        'name': 'cull-idle',
        'admin': True,
        'command': [sys.executable, 'cull_idle_servers.py', '--timeout=3600'],
    }
]

where:

  • 'admin': True indicates that the Service has 'admin' permissions, and
  • 'command' indicates that the Service will be managed by the Hub.

Run cull-idle manually as a standalone script

This will run cull-idle manually. cull-idle can be run as a standalone script anywhere with access to the Hub, and will periodically check for idle servers and shut them down via the Hub's REST API. In order to shutdown the servers, the token given to cull-idle must have admin privileges.

Generate an API token and store it in the JUPYTERHUB_API_TOKEN environment variable. Run cull_idle_servers.py manually.

    export JUPYTERHUB_API_TOKEN=$(jupyterhub token)
    python3 cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]