Skip to main content

JupyterHub Spawner for Kubernetes

Project description

kubespawner (jupyterhub-kubespawner @ PyPI)

Documentation status GitHub Workflow Status Code coverage

The kubespawner (also known as JupyterHub Kubernetes Spawner) enables JupyterHub to spawn single-user notebook servers on a Kubernetes cluster.

See the KubeSpawner documentation for more information about features and usage. In particular, here is a list of all the spawner options.

Features

Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications. If you want to run a JupyterHub setup that needs to scale across multiple nodes (anything with over ~50 simultaneous users), Kubernetes is a wonderful way to do it. Features include:

  • Easily and elasticly run anywhere between 2 and thousands of nodes with the same set of powerful abstractions. Scale up and down as required by simply adding or removing nodes.

  • Run JupyterHub itself inside Kubernetes easily. This allows you to manage many JupyterHub deployments with only Kubernetes, without requiring an extra layer of Ansible / Puppet / Bash scripts. This also provides easy integrated monitoring and failover for the hub process itself.

  • Spawn multiple hubs in the same kubernetes cluster, with support for namespaces. You can limit the amount of resources each namespace can use, effectively limiting the amount of resources a single JupyterHub (and its users) can use. This allows organizations to easily maintain multiple JupyterHubs with just one kubernetes cluster, allowing for easy maintenance & high resource utilization.

  • Provide guarantees and limits on the amount of resources (CPU / RAM) that single-user notebooks can use. Kubernetes has comprehensive resource control that can be used from the spawner.

  • Mount various types of persistent volumes onto the single-user notebook's container.

  • Control various security parameters (such as userid/groupid, SELinux, etc) via flexible Pod Security Policies.

  • Run easily in multiple clouds (or on your own machines). Helps avoid vendor lock-in. You can even spread out your cluster across multiple clouds at the same time.

In general, Kubernetes provides a ton of well thought out, useful features - and you can use all of them along with this spawner.

Requirements

Kubernetes

Everything should work from Kubernetes v1.6+.

The Kube DNS addon is not strictly required - the spawner uses environment variable based discovery instead. Your kubernetes cluster will need to be configured to support the types of volumes you want to use.

If you are just getting started and want a kubernetes cluster to play with, Google Container Engine is probably the nicest option. For AWS/Azure, kops is probably the way to go.

Getting help

We encourage you to ask questions on the Jupyter mailing list. You can also participate in development discussions or get live help on Gitter.

License

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

All code is licensed under the terms of the revised BSD license.

Resources

JupyterHub and kubespawner

Jupyter

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

jupyterhub-kubespawner-1.1.1.tar.gz (46.6 kB view details)

Uploaded Source

Built Distribution

jupyterhub_kubespawner-1.1.1-py3-none-any.whl (49.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyterhub-kubespawner-1.1.1.tar.gz.

File metadata

  • Download URL: jupyterhub-kubespawner-1.1.1.tar.gz
  • Upload date:
  • Size: 46.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for jupyterhub-kubespawner-1.1.1.tar.gz
Algorithm Hash digest
SHA256 b61af128c1b9a65d98773d4ba1d3e93454edea3ba39d9d7a2a28f65131faca23
MD5 b4d754bbedd1a15935535f126cb1acf4
BLAKE2b-256 e8a08b624261495aedf52863cc099299a4212394c89c932b3d97d54a57b5de38

See more details on using hashes here.

Provenance

File details

Details for the file jupyterhub_kubespawner-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: jupyterhub_kubespawner-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 49.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for jupyterhub_kubespawner-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0838151b657d35be486511e5cfa2f2f0c8068788d9587e718aff45fb2cf05256
MD5 ba07a82dd3830fab0fa28f291c250552
BLAKE2b-256 b25c3fe7d9c38f168e031aafe24a2710a4a3ca930c3568fc13f711a1c3727187

See more details on using hashes here.

Provenance

Supported by

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