JupyterHub proxy implementation with traefik
Project description
JupyterHub Traefik Proxy
An implementation of the JupyterHub proxy api with traefik: an extremely lightweight, portable reverse proxy implementation, that supports load balancing and can configure itself automatically and dynamically.
There are three versions for the proxy, depending on how traefik stores the routes:
- for smaller, single-node deployments:
- TraefikTomlProxy
- for distributed setups:
- TraefikEtcdProxy
- TraefikConsulProxy
Instalation
You can find a complete installation guide here.
Documentation
The latest documentation is available at: https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/.
Running the 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 with:
$ pytest -v ./tests/<test-file-name>
Example setups:
- For TraefikTomlProxy: https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/toml.html#example-setup
- For TraefikEtcdProxy: https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/etcd.html#example-setup
- For TraefikConsulProxy: https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/consul.html#example-setup
JupyterHub configuration examples
You can use the configuration examples in the examples directory in order to configure JupyterHub to run with TraefikProxy.
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
Hashes for jupyterhub-traefik-proxy-0.1.4.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f1d677e297c1c5912df4ffab9733c934c610398df4ac397990c476962cdfaac7 |
|
| MD5 | 59ba0a8e59fc8b0c8d6c5d7da1958e2e |
|
| BLAKE2b-256 | 3d4c0cdda35af2fca6ad023bac3129debac143450cfbb8a03801e7c5030e67ee |
Hashes for jupyterhub_traefik_proxy-0.1.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4e3b3190988e8e79aba96992ca52b9e1adca60f3addb8b85f2fc60e2f7934660 |
|
| MD5 | e83f4f164c4f6e5f7b5b846f18d6044e |
|
| BLAKE2b-256 | efda86150770ed3f745877b6c1fae25a1b633ae3865de35deab8af3bb369b50b |
