Skip to main content

Culler for JupyterHub

Project description

SwanCuller

JupyterHub service that checks and cleans user sessions. It also calls bash scripts to check/renew kerberos tokens for the users, if their sessions still exist, or remove them if not in use.

Requirements

This module requires and installs Tornado.

Installation

Install the package:

pip install swanculler

Usage

Call the binary and specify configuration parameters:

swanculler --cull_every=600

Configuration parameters:

  • url: The JupyterHub API URL (default=$JUPYTERHUB_API_URL)
  • timeout: The idle timeout (in seconds) (default=600)
  • cull_every: The interval (in seconds) for checking for idle servers to cull (default=0)
  • max_age: The maximum age (in seconds) of servers that should be culled even if they are active (default=0)
  • cull_users: Cull users in addition to servers (default=False)
  • concurrency: Limit the number of concurrent requests made to the Hub (default=10)
  • hooks_dir: Path to the directory for the krb tickets script (check_ticket.sh) (default="/srv/jupyterhub/culler)
  • disable_hooks: Whether to call the krb tickets scripts or not (default=False)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swanculler-1.0.4.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

swanculler-1.0.4-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file swanculler-1.0.4.tar.gz.

File metadata

  • Download URL: swanculler-1.0.4.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for swanculler-1.0.4.tar.gz
Algorithm Hash digest
SHA256 51ea694990428e9474e6f0e7c99dda8df0274fefdb6798bf5e71c9e2c68464e6
MD5 a804e5de16fd71a0c88bc1f92ce138e9
BLAKE2b-256 8c19584f3e77e326cd100652165ec01c858c6f45bf1bb2d39562e17122d53c56

See more details on using hashes here.

File details

Details for the file swanculler-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: swanculler-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for swanculler-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bd92086326337153d037a65ca9644937da7daa7455b74e8a25e522040d380edc
MD5 8690b497e0eee64d8450bb29c4f64159
BLAKE2b-256 be93fcae1218613d825fb89bb602f35cbdd7566eb261bdc10a24490459fa5206

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page