Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupyter-server/enterprise_gateway
A lightweight, multi-tenant, scalable and secure gateway that enables Jupyter Notebooks to share resources across distributed clusters such as Apache Spark, Kubernetes and others.
https://github.com/jupyter-server/enterprise_gateway
enterprise gateway hacktoberfest jupyter jupyter-enterprise-gateway jupyter-kernels jupyter-notebook kernel kubernetes remote-kernels spark spark-on-kubernetes yarn
Last synced: 1 day ago
JSON representation
A lightweight, multi-tenant, scalable and secure gateway that enables Jupyter Notebooks to share resources across distributed clusters such as Apache Spark, Kubernetes and others.
- Host: GitHub
- URL: https://github.com/jupyter-server/enterprise_gateway
- Owner: jupyter-server
- License: other
- Created: 2017-04-21T16:05:14.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-13T15:01:05.000Z (7 months ago)
- Last Synced: 2025-01-24T06:06:19.742Z (8 days ago)
- Topics: enterprise, gateway, hacktoberfest, jupyter, jupyter-enterprise-gateway, jupyter-kernels, jupyter-notebook, kernel, kubernetes, remote-kernels, spark, spark-on-kubernetes, yarn
- Language: Python
- Homepage: https://jupyter-enterprise-gateway.readthedocs.io/en/latest/
- Size: 7.45 MB
- Stars: 629
- Watchers: 41
- Forks: 221
- Open Issues: 87
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 9% open · ⏱️ 22.08.2022): (Jupyter内核)
README
**[Website](https://jupyter-enterprise-gateway.readthedocs.io/)** |
**[Technical Overview](#technical-overview)** |
**[Installation](#installation)** |
**[System Architecture](#system-architecture)** |
**[Contributing](#contributing)**
# Jupyter Enterprise Gateway
[](https://github.com/jupyter-server/enterprise_gateway/actions)
[](https://badge.fury.io/py/jupyter-enterprise-gateway)
[](https://pepy.tech/project/jupyter-enterprise-gateway)
[](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/?badge=latest)
[](https://groups.google.com/forum/#!forum/jupyter)
Jupyter Enterprise Gateway enables Jupyter Notebook to launch remote kernels in a distributed cluster,
including Apache Spark managed by YARN, IBM Spectrum Conductor, Kubernetes or Docker Swarm.
It provides out of the box support for the following kernels:
- Python using IPython kernel
- R using IRkernel
- Scala using Apache Toree kernel
Full Documentation for Jupyter Enterprise Gateway can be found [here](https://jupyter-enterprise-gateway.readthedocs.io/en/latest)
Jupyter Enterprise Gateway does not manage multiple Jupyter Notebook deployments, for that
you should use [JupyterHub](https://github.com/jupyterhub/jupyterhub).
## Technical Overview
Jupyter Enterprise Gateway is a web server that provides headless access to Jupyter kernels within
an enterprise. Inspired by Jupyter Kernel Gateway, Jupyter Enterprise Gateway provides feature parity with Kernel Gateway's [jupyter-websocket mode](https://jupyter-kernel-gateway.readthedocs.io/en/latest/websocket-mode.html) in addition to the following:
- Adds support for remote kernels hosted throughout the enterprise where kernels can be launched in
the following ways:
- Local to the Enterprise Gateway server (today's Kernel Gateway behavior)
- On specific nodes of the cluster utilizing a round-robin algorithm
- On nodes identified by an associated resource manager
- Provides support for Apache Spark managed by YARN, IBM Spectrum Conductor, Kubernetes or Docker Swarm out of the box. Others can be configured via Enterprise Gateway's extensible framework.
- Secure communication from the client, through the Enterprise Gateway server, to the kernels
- Multi-tenant capabilities
- Persistent kernel sessions
- Ability to associate profiles consisting of configuration settings to a kernel for a given user (see [Project Roadmap](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/contributors/roadmap.html))
## Installation
Detailed installation instructions are located in the
[Users Guide](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/users/index.html)
of the project docs. Here's a quick start using `pip`:
```bash
# install from pypi
pip install --upgrade jupyter_enterprise_gateway
# show all config options
jupyter enterprisegateway --help-all
# run it with default options
jupyter enterprisegateway
```
Please check the [configuration options within the Operators Guide](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/operators/index.html#configuring-enterprise-gateway)
for information about the supported options.
## System Architecture
The [System Architecture page](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/contributors/system-architecture.html)
includes information about Enterprise Gateway's remote kernel, process proxy, and launcher frameworks.
## Contributing
The [Contribution page](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/contributors/contrib.html) includes
information about how to contribute to Enterprise Gateway along with our roadmap. While there, you'll want to
[set up a development environment](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/contributors/devinstall.html) and check out typical developer tasks.