Skip to content

Commit

Permalink
Merge pull request #483 from kevin-bates/refactor-gateway-km
Browse files Browse the repository at this point in the history
Refactor gateway kernel management to achieve a degree of consistency
  • Loading branch information
blink1073 authored May 4, 2021
2 parents a0135ca + f4ba1ce commit fa12a2e
Show file tree
Hide file tree
Showing 6 changed files with 810 additions and 464 deletions.
26 changes: 13 additions & 13 deletions docs/source/other/full-config.rst
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

0 comments on commit fa12a2e

Please sign in to comment.