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

Update docs about user server culling (max-age now 7 days, inactivity workaround) #193

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Update docs about user server culling (max-age now 7 days, inactivity workaround) #193

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c3d190
Update docs about max-age culling, now 7 days
consideRatio Oct 19, 2023
5a698e0
Add note about workaround to avoid culling by inactivity
consideRatio Oct 19, 2023
a8d4d2c
Make link title be more informative than "here"
consideRatio Oct 19, 2023
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
21 changes: 17 additions & 4 deletions admin/howto/control-user-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,28 @@ Active notebooks have their kernel killed as well.

To ensure efficient resource usage, user servers without interactive usage for a
period of time (default `1h`) are automatically stopped (via
[jupyterhub-idle-culler](https://github.com/jupyterhub/jupyterhub-idle-culler)).
This means your notebook server might be stopped for inactivity even if you have
[jupyterhub-idle-culler]).
This means your user server might be stopped for inactivity even if you have
a long running process in the notebook. This timeout can be configured.

% TODO: Add link to SRE guide on how to configure this, once it exists

Culling has the same effect as [stopping a user's server](user-server/stopping).
"Culling a user server" has the same effect as [stopping a user
server](user-server/stopping), but should be distinguished from "culling a
kernel" inside a user server. [jupyterhub-idle-culler] is only involved in
culling user servers, not culling kernels.

There is currently no maximum time limit for a user's notebook.
```{note}
A crude way to [ensure that a server isn't stopped for inactivity](https://github.com/jupyterhub/jupyterhub-idle-culler/issues/55#issuecomment-1413510651) can be implemented.
```

## Stop user servers after maximum age

As a failsafe [jupyterhub-idle-culler] is by 2i2c's defaults configured to stop
user servers that has been running for more than 7 days. This max age can be
re-configured.

[jupyterhub-idle-culler]: https://github.com/jupyterhub/jupyterhub-idle-culler

## Stop user kernels after inactivity

Expand Down