Skip to content

Commit 3318340

Browse files
committed
Add pros/cons and minor section title adjustment
1 parent 3eb712f commit 3318340

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

jupyter-enterprise-gateway-incorporation/jupyter-enterprise-gateway-incorporation.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@ into the main Jupyter organization as an official Subproject.
2525

2626
## Detailed Explanation
2727

28-
29-
30-
28+
Please see below detailed project information.
3129

3230
### Current and Potential Use Cases
3331

@@ -74,13 +72,13 @@ Jupyter Enterprise Gateway support for Kubernetes enables decoupling the Jupyter
7472
![Jupyter Enterprise Gateway enable remote kernels on Kubernetes cluster](jupyter_enterprise_gateway_on_kubernetes.png)
7573

7674

77-
### Criteria for Incorporation
75+
## Criteria for Incorporation
7876

79-
#### Have an active developer community that offers a sustainable model for future development.
77+
### Have an active developer community that offers a sustainable model for future development.
8078

8179
The enterprise gateway reuses and extends classes from the Jupyter `kernel_gateway` and `notebook` Python package. By virtue of this implementation, it is largely sustained by development of the `jupyter/notebook` project. Minimal maintenance is required to ensure the enterprise gateway codebase continues to interoperate with future releases of the `notebook` package.
8280

83-
#### Have an active user community.
81+
### Have an active user community.
8482

8583
Enterprise gateway is a fundamental component in multiple IBM Cloud offerings, and has also been adopted in a few large companies that are providing Analytical and/or AI platform for it's internal/external customers.
8684

@@ -94,7 +92,7 @@ Other then that, below are some stats that have been collected from the Jupyter
9492
- 26 Forks
9593
- 10K+ pulls of primary docker image
9694

97-
#### Use solid software engineering with documentation and tests hosted with appropriate technologies.
95+
### Use solid software engineering with documentation and tests hosted with appropriate technologies.
9896

9997
The Enterprise Gateway has a suite of unit and integration tests that are run automatically on Travis on every PR and any commits to master.
10098

@@ -108,31 +106,33 @@ The Jupyter Enterprise Gateway community provides multiple resources that both u
108106
- Related Docker Images available at Elyra organization at DockerHub: https://hub.docker.com/u/elyra/dashboard/
109107

110108

111-
#### Demonstrate continued growth and development.
109+
### Demonstrate continued growth and development.
112110

113111
See "Have an active developer community that offers a sustainable model for future development" and "Have an active user community" sections above.
114112

115-
#### Integrate well with other official Subprojects.
113+
### Integrate well with other official Subprojects.
116114

117115
The Enterprise Gateway is a `jupyter/jupyter_core#Application` that uses programmatic APIs from `jupyter/notebook` to enable communication with Jupyter kernels like `ipython/ipykernel`. By definition, it integrates with other official Subprojects.
118116

119117
We are also looking for investigating deep integration with `JupyterHib` to decouple the kernel instances into specific pods in a kubernetes environment.
120118

121-
#### Be developed according to the Jupyter governance and contribution model.
119+
### Be developed according to the Jupyter governance and contribution model.
122120

123121
The Enterprise Gateway is in the Jupyter Incubator, and under the Jupyter governance and contribution model since its inception.
124122

125-
#### Have a well-defined scope.
123+
### Have a well-defined scope.
126124

127125
Jupyter Enterprise Gateway enables Jupyter Notebook to launch remote kernels in a distributed cluster, including Apache Spark managed by YARN, IBM Spectrum Conductor or Kubernetes.
128126

129-
#### Be packaged using appropriate technologies such as pip, conda, npm, bower, docker, etc.
127+
### Be packaged using appropriate technologies such as pip, conda, npm, bower, docker, etc.
130128

131129
The Enterprise Gateway is packaged using setup tools, released in both source and wheel format on PyPI, and installable using `pip`. It is also available in conda forge.
132130

133131
## Pros and Cons
134132

135-
133+
Pro: Extend Jupyter Stack to support distributed/remote Kernels
134+
Pro: The runtime can easily be extensible to support new cluster resource managers
135+
Con: Still requires couple extensions (e.g. NB2KG) to connect to the gateway
136136

137137
## Interested Contributors
138138

0 commit comments

Comments
 (0)