Repository files navigation

Website |Technical Overview |Installation |System Architecture |Contributing

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 foundhere

Jupyter Enterprise Gateway does not manage multiple Jupyter Notebook deployments, for thatyou should useJupyterHub.

Jupyter Enterprise Gateway is a web server that provides headless access to Jupyter kernels withinan enterprise. Inspired by Jupyter Kernel Gateway, Jupyter Enterprise Gateway provides feature parity with Kernel Gateway'sjupyter-websocket mode in addition to the following:

• Adds support for remote kernels hosted throughout the enterprise where kernels can be launched inthe 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 (seeProject Roadmap)

Detailed installation instructions are located in theUsers Guideof the project docs. Here's a quick start usingpip:

# install from pypipip install --upgrade jupyter_enterprise_gateway# show all config optionsjupyter enterprisegateway --help-all# run it with default optionsjupyter enterprisegateway

Please check theconfiguration options within the Operators Guidefor information about the supported options.

TheSystem Architecture pageincludes information about Enterprise Gateway's remote kernel, process proxy, and launcher frameworks.

TheContribution page includesinformation about how to contribute to Enterprise Gateway along with our roadmap. While there, you'll want toset up a development environment and check out typical developer tasks.