From e6a6a0ccf613ed68401d4fb05f3b14653caf8c05 Mon Sep 17 00:00:00 2001 From: liivw <164842155+liivw@users.noreply.github.com> Date: Fri, 22 Nov 2024 11:53:28 +0800 Subject: [PATCH] doc update - Workflow and Task Status - Using Workers --- .../workflow-and-task-status.md | 42 ++++++++++++++++++ docs/developer-guides/building-workflows.mdx | 5 +++ .../task-and-workflow-status-in-conductor.md | 30 ------------- docs/developer-guides/using-workers.md | 17 +++---- docs/faqs/img/task_states.png | Bin 37523 -> 0 bytes sidebars.js | 21 ++++++--- .../workflow_lifecyle-task_states.png | Bin 0 -> 30007 bytes 7 files changed, 69 insertions(+), 46 deletions(-) create mode 100644 docs/conceptual-guides/workflow-and-task-status.md delete mode 100644 docs/developer-guides/task-and-workflow-status-in-conductor.md delete mode 100644 docs/faqs/img/task_states.png create mode 100644 static/img/conceptual-guides/workflow_lifecyle-task_states.png diff --git a/docs/conceptual-guides/workflow-and-task-status.md b/docs/conceptual-guides/workflow-and-task-status.md new file mode 100644 index 00000000..80f68ed7 --- /dev/null +++ b/docs/conceptual-guides/workflow-and-task-status.md @@ -0,0 +1,42 @@ +--- +slug: "/developer-guides/task-and-workflow-status-in-conductor" +description: "Find out the different workflow and task status in Conductor." +--- + +# Workflow and Task Status + +The workflow and task statuses are crucial to understanding the execution mechanism in Conductor. You can check a workflow execution’s current status and task status [from the Conductor UI](debugging-workflows#searching-and-viewing-workflow-executions) or [using API](/reference-docs/api/workflow/search-workflow-executions). + +## Workflow status + +Once started, a workflow execution will either be in an ongoing or terminal status. + +| Status | Description | +| --------------------------------- | --------------------------------- | +| RUNNING | The workflow is in progress. | +| PAUSED | The workflow is paused by a user or external event, and is waiting for a manual action to resume. | +| COMPLETED | Terminal status where all the tasks in the workflow are completed. | +| TIMED_OUT | Terminal status where one of the workflow tasks has timed out. | +| TERMINATED | Terminal status where an incomplete workflow has been terminated by a user, event, or another workflow. | +| FAILED | Terminal status where the workflow has encountered an error and failed. You can [retry the workflow execution from the failed task](debugging-workflows#recovering-from-failures). | + +## Task state transitions + +During a workflow execution, each task will go through the state transitions illustrated in the figure below. These states roughly correspond to the nine task statuses in Conductor. + +
+ +### Task status +Each task will be in a scheduled, ongoing, or terminal status. + +| Status | Description | +| --------------------------------- | --------------------------------- | +| SCHEDULED | The task has been scheduled to be picked up by a worker. | +| IN_PROGRESS | The task is being executed by a worker. | +| SKIPPED | The task is skipped without executing, and the workflow continues to the subsequent tasks.E``Et
zys0ghKN~N>E_tZtsr6n4piGy*g!gQ^j&`v1JjK*pZG@L;@3Yr& coZKz?Pxq@^4E>8zbX&)@hwV09J=8;-wTlrmS=x*|WW0ZvJqAXC~77K+A
zW&wQ}QM>(w0+3yC&OTe@PN|=pXBR{;B*ONmf(ToBew{MVrul?PVLv>7+&o{d-Hqam
z1MF~g6n3#W87fm-Jb>A~Pc}>!v$bGKE9g&BA_R)Op7gzl*aC2A0$bbJ;RodYg;T@%
ztx5zPBA~jDaJT9F^IY7g3h%Q~jS5NgA__s=w8H@=7VH3_Ead+g$|xy)Xq4WupYJph
zBz5Y58ajxzT0 sb8P`q>(2~EvLFrPq?r})^1%6W3AwChWdnvQ4vw|g=GuB?yC?Per%(>0{fedGj*9+lvo5R>kgvLH-nJJ>R=rjhXtdAG^_Z
z&A3C1I|Zxew)D1tyjJGw#u!leT}KB+qFbA6<1>DWhiNfjV2){#VJU9Dke%c_AdWUa
zmr<&e9IE9@qIr3}xJ#@`wq82+l|D4e4QcEnSIpDIO(xgc5*0n2u-}Qj5*Qr5C~4Nu
z;GM~6-PT#kf$6&%8{Ns-yoq(jc>_y`19FWIvId2UIMI@qaDh??h6|JQcVef_ph^%k
zzoEfxR`{QMxPta4iiclgsfT0mo$Yd2(ISVBLvX0^2;-i$u+Px0a{01XQ(h;n#{%^e
zafU$YxCu^~s&b02BOw<4jQ6nX=p83C*<{;M%dR8@lghwB>UP`YmUp;5J%Y_YOq5j2
zsP`HH2IvfFEfrIxRsypYQgP#78;U~9
!}M7;6Q@QDc8^f6pdTF~A^ojw#qWZ!E|ZW`9cL>I_TVpSagl!5
zjfrfUW#v(z|0Lh!SzlK2zRK)wYr0+9+wy(u%C1rG#veWT1Tv<`WH}r?`hma+;6LJD
zr3cVeXTMXKC-T$`1nhNDls)VjO&|l$!cMW|G{J}hgW>HPQGidz*~7=>gu}<(%+pZW
z8e%5`qwU@NIP#8k{D)|dIPpU<6%{{TP|-*i1g{I7m-^%Pgmo2!r>H_ljSB_%%QbA)zI
zwDp@@tH?TDMB>766_If*%^9U1{_F=tUJbyC=~|fMVaYf#?6B|at$g4Es;;g?zLkWk
zsXHwLrFM@S+X;Tlk)p`2Ux!5sCg9huP$d8pX)==96t8E^uQ|r?V3-O&yAnRH|)8
zdN_Uq^_j(N;^UF;BN>UIL*3uai*)X|2HRMSY~O{Q&s(is38kn+jAqY+76)$}*3VIu
zg^9gJzF{`!dye=EiIFfH!7o=TOcY+YN&%0l%&BwT77ok{gyrjJ^tzd@uqw2YK%wM;
z=2YXTaQUme9m9&bhgC-Kd@0|#8{YlE8U=6Xyew$uqgc2h;d4Hs7`F3AYIwuDfy}$1
z#Ve^JdH>N&J1=uxZnvxG2_F5b2Buo~-&sXzy=F*ZU}G{WT9AN0drFxg9XlrKjXM|Kb%>I4>)(z7)jQRrsTVnm0FJ_Q_s
7P|BW+CVl!K?D3%DGp6Mrz84UT9d0v)uI0YG1W;|lZ_B;ANcmf{x!Y{@`
zwm5}Q|9#Jgh`Xowuk@(W5)lUNdU6ros{T5X!EytVVknp-?;Zg2D$+b#=
zcW*JD43c&-Mle%w