Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor gateway kernel management to achieve a degree of consistency #483

Merged
merged 9 commits into from
May 4, 2021
Merged

Refactor gateway kernel management to achieve a degree of consistency #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fc8a057
Rename GatewayKernelManager to GatewayKernelManagers
kevin-bates Mar 31, 2021
062b5f4
Restructure files
kevin-bates Mar 31, 2021
e537be5
Refactor to more closely model standard kernel managers
kevin-bates Apr 3, 2021
992d7ae
Update with latest, handle case where GatewayKM has no parent
kevin-bates Apr 19, 2021
1200ffb
Address code analysis issues
kevin-bates Apr 20, 2021
3877a2c
Merge branch 'master' into refactor-gateway-km
kevin-bates Apr 21, 2021
b71bf81
Rename GatewayKernelManagers to GatewayMappingKernelManager
kevin-bates Apr 22, 2021
827fc6a
Merge branch 'master' into refactor-gateway-km
kevin-bates May 1, 2021
f4ba1ce
Resolve conflict due to anyio updates
kevin-bates May 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/source/other/full-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1178,19 +1178,19 @@ NotebookNotary.store_factory : Callable
A callable returning the storage backend for notebook signatures.
The default uses an SQLite database.

GatewayKernelManager.allow_tracebacks : Bool
GatewayMappingKernelManager.allow_tracebacks : Bool
Default: ``True``

Whether to send tracebacks to clients on exceptions.

GatewayKernelManager.allowed_message_types : List
GatewayMappingKernelManager.allowed_message_types : List
Default: ``[]``

White list of allowed kernel message types.
When the list is empty, all message types are allowed.


GatewayKernelManager.buffer_offline_messages : Bool
GatewayMappingKernelManager.buffer_offline_messages : Bool
Default: ``True``

Whether messages from kernels whose frontends have disconnected should be buffered in-memory.
Expand All @@ -1202,36 +1202,36 @@ GatewayKernelManager.buffer_offline_messages : Bool
no frontends are connected.


GatewayKernelManager.cull_busy : Bool
GatewayMappingKernelManager.cull_busy : Bool
Default: ``False``

Whether to consider culling kernels which are busy.
Only effective if cull_idle_timeout > 0.

GatewayKernelManager.cull_connected : Bool
GatewayMappingKernelManager.cull_connected : Bool
Default: ``False``

Whether to consider culling kernels which have one or more connections.
Only effective if cull_idle_timeout > 0.

GatewayKernelManager.cull_idle_timeout : Int
GatewayMappingKernelManager.cull_idle_timeout : Int
Default: ``0``

Timeout (in seconds) after which a kernel is considered idle and ready to be culled.
Values of 0 or lower disable culling. Very short timeouts may result in kernels being culled
for users with poor network connections.

GatewayKernelManager.cull_interval : Int
GatewayMappingKernelManager.cull_interval : Int
Default: ``300``

The interval (in seconds) on which to check for idle kernels exceeding the cull timeout value.

GatewayKernelManager.default_kernel_name : Unicode
GatewayMappingKernelManager.default_kernel_name : Unicode
Default: ``'python3'``

The name of the default kernel to start

GatewayKernelManager.kernel_info_timeout : Float
GatewayMappingKernelManager.kernel_info_timeout : Float
Default: ``60``

Timeout for giving up on a kernel (in seconds).
Expand All @@ -1244,24 +1244,24 @@ GatewayKernelManager.kernel_info_timeout : Float
and the ZMQChannelsHandler (which handles the startup).


GatewayKernelManager.kernel_manager_class : DottedObjectName
GatewayMappingKernelManager.kernel_manager_class : DottedObjectName
Default: ``'jupyter_client.ioloop.IOLoopKernelManager'``

The kernel manager class. This is configurable to allow
subclassing of the KernelManager for customized behavior.


GatewayKernelManager.root_dir : Unicode
GatewayMappingKernelManager.root_dir : Unicode
Default: ``''``

No description

GatewayKernelManager.shared_context : Bool
GatewayMappingKernelManager.shared_context : Bool
Default: ``True``

Share a single zmq.Context to talk to all my kernels

GatewayKernelManager.traceback_replacement_message : Unicode
GatewayMappingKernelManager.traceback_replacement_message : Unicode
Default: ``'An exception occurred at runtime, which is not shown due to ...``

Message to print when allow_tracebacks is False, and an exception occurs
Expand Down
Loading