Skip to content

Commit

Permalink
Add the docs about kernel_launch_terminate_on_events to `RemoteMapp…
Browse files Browse the repository at this point in the history
…ingKernelManager` cli options.
  • Loading branch information
OrenZ1 committed Jun 25, 2024
1 parent cc4c650 commit 686b342
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/operators/config-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,4 +366,14 @@ RemoteMappingKernelManager(AsyncMappingKernelManager) options
--RemoteMappingKernelManager.shared_context=<Bool>
Share a single zmq.Context to talk to all my kernels
Default: True
--RemoteMappingKernelManager.kernel_launch_terminate_on_events=<list-item-1>...
Comma-separated list of dictionaries, each describing an event by `type`, `reason`, and `timeout_in_seconds`
(e.g. [{"type": "Warning", "reason": "FailedMount", "timeout_in_seconds": 0}]).
Kernel pod events will be sampled during startup, and if an event described in this list is detected,
the kernel launch will be terminated after the set timeout.
Only available for container kernels.
Make sure to provide the exact event type and reason as it appears in your container platform,
A guide to finding the event type and reason in kubernetes can be found here:
`https://www.bluematador.com/blog/kubernetes-events-explained`
Default: []
```

0 comments on commit 686b342

Please sign in to comment.