@@ -8,13 +8,13 @@ This information is useful for developers who want to understand how Jupyter
8
8
Server components are connected and how the principal workflows look like.
9
9
10
10
To make changes for these diagrams, use `the Draw.io <https://app.diagrams.net/ >`_
11
- open source tool.
11
+ open source tool to edit the png file .
12
12
13
13
14
14
Jupyter Server Architecture
15
15
---------------------------
16
16
17
- The Jupyter Server system can be seen in figure bellow :
17
+ The Jupyter Server system can be seen in figure below :
18
18
19
19
.. image :: ../images/jupyter-server-architecture.drawio.png
20
20
:alt: Jupyter Server Architecture
@@ -31,32 +31,43 @@ Jupyter Server contains the following components:
31
31
SererApp settings. Follow :ref: `the Config File Guide <other-full-config >` to
32
32
learn about configuration settings and how to build custom config.
33
33
34
- - **Custom Extensions ** allow to create the custom Server's REST API endpoint .
34
+ - **Custom Extensions ** allow you to create the custom Server's REST API endpoints .
35
35
Follow :ref: `the Extension Guide <extensions >` to know more about extending
36
36
ServerApp with extra request handlers.
37
37
38
- - **Kernel Gateway ** is the web server that provides access to Jupyter Kernels.
39
- There are different ways to create this gateway. If your ServerApp needs to
40
- communicate with remote Kernels, you can use
41
- `the Enterprise Gateway <https://github.com/jupyter-server/enterprise_gateway >`_,
42
- otherwise you can use `the Kernel Gateway <https://github.com/jupyter-server/kernel_gateway >`_.
38
+ - **Gateway Server ** is a web server that, when configured, provides access to
39
+ Jupyter Kernels running on other hosts. There are different ways to create a
40
+ gateway server. If your ServerApp needs to communicate with remote Kernels
41
+ residing within resource-managed clusters, you can use
42
+ `Enterprise Gateway <https://github.com/jupyter-server/enterprise_gateway >`_,
43
+ otherwise, you can use
44
+ `Kernel Gateway <https://github.com/jupyter-server/kernel_gateway >`_, where
45
+ Kernels run locally to the gateway server.
43
46
44
47
- **Contents Manager and File Contents Manager ** are responsible for serving
45
48
Notebook on the file system. Session Manager uses Contents Manager to receive
46
49
Kernel path. Follow :ref: `the Contents API guide <contents_api >` to learn
47
50
about Contents Manager.
48
51
49
- - **Session Manager ** processes users Sessions. When user starts a new Kernel,
52
+ - **Session Manager ** processes users' Sessions. When a user starts a new Kernel,
50
53
Session Manager starts a process to provision Kernel for the user and generates
51
54
a new Session ID. Each opened Notebook has a separate Session, but different
52
- Notebook Kernels can use the same Session. That is useful if user wants to
55
+ Notebook Kernels can use the same Session. That is useful if the user wants to
53
56
share data across various opened Notebooks. Session Manager uses SQLite3
54
- DataBase to store the Sessions.
57
+ DataBase to store the Session information. The database is stored in memory by
58
+ default, but can be configured to save to disk.
55
59
56
- - **Mapping Kernel Manager ** is responsible to operate multiple Kernels in the
57
- ServerApp. It starts a new Kernel for a user's Session and generates a
58
- new Kernel ID .
60
+ - **Mapping Kernel Manager ** is responsible for managing the lifecycles of the
61
+ Kernels running within the ServerApp. It starts a new Kernel for a user's Session
62
+ and facilitates interrupt, restart, and shutdown operations against the Kernel .
59
63
60
- - **Kernel Spec Manager ** parses file with JSON specification for a Kernel.
61
- To know more about Kernel Spec, follow
62
- `the Jupyter Client guide <https://jupyter-client.readthedocs.io/en/stable/kernels.html#kernel-specs >`_.
64
+ - **Jupyter Client ** library is used by Jupyter Server to work with the Notebook
65
+ Kernels.
66
+
67
+ - **Kernel Manager ** manages a single Kernel for the Notebook. To know more about
68
+ Kernel Manager, follow
69
+ `the Jupyter Client APIs documentation <https://jupyter-client.readthedocs.io/en/latest/api/manager.html#jupyter_client.KernelManager >`_.
70
+
71
+ - **Kernel Spec Manager ** parses files with JSON specification for a Kernels,
72
+ and provides a list of available Kernel configurations. To learn about
73
+ Kernel Spec, check `the Jupyter Client guide <https://jupyter-client.readthedocs.io/en/stable/kernels.html#kernel-specs >`_.
0 commit comments