Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more explanation regarding the project purpose #7

Merged
merged 2 commits into from
Jun 15, 2020
Merged

Add more explanation regarding the project purpose #7

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9a170c
Add more explanation regarding the project purpose
1kastner Jun 13, 2020
9e78d32
Fix typo
1kastner Jun 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
JupyterHub Idle Culler Service
==============================

``jupyterhub-idle-culler`` provides a JupyterHub service to cull and
shut down idle notebook servers and users on a JupyterHub deployment.
``jupyterhub-idle-culler`` provides a JupyterHub service to identify and shut down idle or long-running Jupyter Notebook servers.
The exact actions performed are dependent on the used spawner for the Jupyter Notebook server (e.g. the default `LocalProcessSpawner <https://jupyterhub.readthedocs.io/en/stable/api/spawner.html#localprocessspawner>`_, `kubespawner <https://github.com/jupyterhub/kubespawner>`_, or `dockerspawner <https://github.com/jupyterhub/dockerspawner>`_.
In addition, if explicitely requested, all users whose Jupyter Notebook servers have been shut down this way are deleted as JupyterHub users from the internal database. This neither affects the authentication method which continues to allow those users to log in nor does it delete persisted user data (e.g. stored in docker volumes for dockerspawner or in persisted volumes for kubespawner).
1kastner marked this conversation as resolved.
Show resolved Hide resolved

Setup
=====
Expand Down