JupyterHub proxy implementation with traefik
Project description
JupyterHub Traefik Proxy
When JupyterHub starts a server for a user, it will dynamically configure a
proxy server so that accessing jupyterhub.example.com/user/<user> routes to
the individual Jupyter server. This project contains what JupyterHub need to
dynamically configure the routes of a traefik proxy
server! There are three implementations of the JupyterHub proxy
API,
depending on how traefik store its routing configuration.
For smaller, single-node deployments:
- TraefikFileProviderProxy
For distributed setups:
- TraefikEtcdProxy
- TraefikConsulProxy
Installation
The documentation contains a complete installation guide with examples for the three different implementations.
Running tests
There are some tests that use etcdctl command line client for etcd. Make sure
to set environment variable ETCDCTL_API=3 before running the tests, so that
the v3 API to be used, e.g.:
$ export ETCDCTL_API=3
You can then run the all the test suite from the traefik-proxy directory with:
$ pytest -v ./tests
Or you can run a specific test file with:
$ pytest -v ./tests/<test-file-name>
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jupyterhub-traefik-proxy-1.0.0.tar.gz.
File metadata
- Download URL: jupyterhub-traefik-proxy-1.0.0.tar.gz
- Upload date:
- Size: 34.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7161fb4c9dda4407e53ec8d3c631b7e26c23fe691dd241d4e0af483b51c64191 |
|
| MD5 | 23594984f662c56cbb377e06dc8593fc |
|
| BLAKE2b-256 | a4058a44f168c5a2aac2522380554d4e5726b7eefe1f6edb9ddad2628f328803 |
Provenance
File details
Details for the file jupyterhub_traefik_proxy-1.0.0-py3-none-any.whl.
File metadata
- Download URL: jupyterhub_traefik_proxy-1.0.0-py3-none-any.whl
- Upload date:
- Size: 32.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cdbbe226c874270d10066f168fefc2295193b4f99356d3f5c341541ddb6462bc |
|
| MD5 | 47ad33f5c4f588b79eb5bb12df2ec02a |
|
| BLAKE2b-256 | 494bdcb1242ea708f729248889a3cff30f733fbdf79b8724c2edb10c3c35ce68 |
