From 686b3420ff4b0634c20f11873cd9119c396ce69b Mon Sep 17 00:00:00 2001 From: Oren Zigdon Date: Tue, 25 Jun 2024 13:16:24 +0300 Subject: [PATCH] Add the docs about `kernel_launch_terminate_on_events` to `RemoteMappingKernelManager` cli options. --- docs/source/operators/config-cli.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/source/operators/config-cli.md b/docs/source/operators/config-cli.md index 39c44ae4e..5a815a5f2 100644 --- a/docs/source/operators/config-cli.md +++ b/docs/source/operators/config-cli.md @@ -366,4 +366,14 @@ RemoteMappingKernelManager(AsyncMappingKernelManager) options --RemoteMappingKernelManager.shared_context= Share a single zmq.Context to talk to all my kernels Default: True +--RemoteMappingKernelManager.kernel_launch_terminate_on_events=... + 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: [] ```