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.

Github stars Tracking Chart

Website, Technical Overview, Features, Installation, System Architecture, Contributing, # Jupyter Enterprise Gateway

PyPI version
Downloads
Build Status
Documentation Status
Coverage Status
Google Group Join the chat at https://gitter.im/jupyter/enterprise_gateway

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

Jupyter Enterprise Gateway does not manage multiple Jupyter Notebook deployments, for that
you should use 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 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)

Deployment Diagram

Features

See Enterprise Gateway Features in the
documentation for a list of Jupyter Enterprise Gateway features.

Installation

Detailed installation instructions are located in the
Getting Started page
of the project docs. Here's a quick start using pip:

# 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 page
for information about the supported options.

System Architecture

The System Architecture page
includes information about Enterprise Gateway's remote kernel, process proxy, and launcher frameworks.

Contributing

The Contribution page includes
information about how to contribute to Enterprise Gateway along with our roadmap. While there, you'll want to
set up a development environment and check out typical developer tasks.

Main metrics

Overview
Name With Ownerjupyter-server/enterprise_gateway
Primary LanguagePython
Program languageMakefile (Language Count: 11)
Platform
License:Other
所有者活动
Created At2017-04-21 16:05:14
Pushed At2025-07-01 04:56:19
Last Commit At
Release Count38
Last Release Namev3.2.3 (Posted on )
First Release Namev0.6.0 (Posted on )
用户参与
Stargazers Count648
Watchers Count38
Fork Count234
Commits Count1.4k
Has Issues Enabled
Issues Count582
Issue Open Count78
Pull Requests Count523
Pull Requests Open Count15
Pull Requests Close Count250
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private