From 0277ffb3c563674832a3b135747e5ccd714d24da Mon Sep 17 00:00:00 2001 From: Stephan Behnke Date: Mon, 21 Oct 2024 10:21:02 -0700 Subject: [PATCH] Fix Update eviction documentation (#6681) WISOTT --- docs/architecture/workflow-update.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/architecture/workflow-update.md b/docs/architecture/workflow-update.md index a12cecccc37..0b821104d2c 100644 --- a/docs/architecture/workflow-update.md +++ b/docs/architecture/workflow-update.md @@ -161,7 +161,8 @@ API caller and subsequent internal retries recreate the Update in the Registry. Also, it is important to note that the Workflow context itself is stored in the Workflow cache and might be evicted any time. Therefore, the Workflow Update feature relies on a properly configured cache size. If the cache is too small, it will evict Workflow contexts too soon and their -Update Registry will be lost. Then, the `UpdateWorkflowExecutions` API call will time out. +Update Registry will be cleared. Note that in that case, all in-flight Updates are aborted with a +retryable error; and the frontend will retry the `UpdateWorkflowExecution` call. ## `UpdateWorkflowExecutions` and `PollWorkflowExecutionUpdate` APIs The Workflow Update feature exposes two APIs: `UpdateWorkflowExecution` to send Update requests