From b2c56ceb1571ee6c42bf81a10bd1d08aaa808591 Mon Sep 17 00:00:00 2001 From: Adi Sage Date: Tue, 23 May 2023 22:21:41 +0530 Subject: [PATCH 1/5] Documenting descriptions for Job and Task Statuses in the documentation webpage. This is a comprehensive list of all possible statuses, along with a brief description of each status and a list of possible next statuses. --- .../usage/jobs-tasks-commands/_index.md | 23 +++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/web/project-website/content/usage/jobs-tasks-commands/_index.md b/web/project-website/content/usage/jobs-tasks-commands/_index.md index f4255635..d5a112c3 100644 --- a/web/project-website/content/usage/jobs-tasks-commands/_index.md +++ b/web/project-website/content/usage/jobs-tasks-commands/_index.md @@ -5,6 +5,23 @@ weight: 5 TODO: write about the pipeline from job submission to command execution. +## Job Statuses + +The following table shows the meaning of the different job statuses: + +| Status | Meaning | Possible next status | +| ------------------------- | ------- | ----------- | +| `under-construction` | Preparing job for execution | `queued`, `active` | +| `queued` | Ready to be assigned to an available workers | `active`, `canceled` | +| `active` | Tasks assigned to workers for execution | `completed`, `canceled`, `failed` | +| `completed` | All tasks executed successfully | `requeued` | +| `failed` | Execution of one or more tasks failed after multiple retries by different workers | `???`, `???` | +| `cancel-requested` | Request for job cancellation raised by user | `canceled` | +| `canceled` | Canceled by the user, job terminated immediately on all workers | `requeued` | +| `requeueing` | Request for requeueing of job raised by user | `???`, `???` | +| `archiving` | Archiving job details | `???`, `???` | +| `archived` | Job details archived in history for future reference | `???`, `???` | +| `paused` | Not yet implemented | | ## Task Statuses @@ -12,8 +29,10 @@ The following table shows the meaning of the different task statuses: | Status | Meaning | Possible next status | | ------------- | ------- | ----------- | -| `queued` | Ready to be worked on by a Worker | `active`, `canceled` | +| `queued` | Ready to be assigned to an available Worker | `active`, `canceled` | | `active` | Assigned to a worker for execution | `completed`, `canceled`, `failed`, `soft-failed` | +| `completed`   | Worker executed the task succesfully | `requeued` | | `soft-failed` | Same as `queued`, but has been failed by a worker in an earlier execution | `completed`, `failed`, `canceled` | -| `completed` | Worker executed the task succesfully | `requeued` | +| `failed` | Execution failed after multiple retries by different workers | `requeued` | +| `canceled` | Canceled by the user, task terminated immediately | `requeued` | | `paused` | Not yet implemented | | -- 2.30.2 From 9fb44b4f89bc75847958b7630b5e201cf78aa6d8 Mon Sep 17 00:00:00 2001 From: Adi Sage Date: Tue, 23 May 2023 22:37:16 +0530 Subject: [PATCH 2/5] Documenting descriptions for Job and Task Statuses in the documentation webpage. This is a comprehensive list of all possible statuses, along with a brief description of each status and a list of possible next statuses. --- .../usage/jobs-tasks-commands/_index.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/web/project-website/content/usage/jobs-tasks-commands/_index.md b/web/project-website/content/usage/jobs-tasks-commands/_index.md index d5a112c3..01ec64f8 100644 --- a/web/project-website/content/usage/jobs-tasks-commands/_index.md +++ b/web/project-website/content/usage/jobs-tasks-commands/_index.md @@ -12,14 +12,14 @@ The following table shows the meaning of the different job statuses: | Status | Meaning | Possible next status | | ------------------------- | ------- | ----------- | | `under-construction` | Preparing job for execution | `queued`, `active` | -| `queued` | Ready to be assigned to an available workers | `active`, `canceled` | -| `active` | Tasks assigned to workers for execution | `completed`, `canceled`, `failed` | +| `queued` | Ready to be assigned to available Workers | `active`, `canceled` | +| `active` | Tasks assigned to Workers for execution | `completed`, `canceled`, `failed` | | `completed` | All tasks executed successfully | `requeued` | -| `failed` | Execution of one or more tasks failed after multiple retries by different workers | `???`, `???` | +| `failed` | Execution of one or more tasks failed after multiple retries by different Workers | `???`, `???` | | `cancel-requested` | Request for job cancellation raised by user | `canceled` | -| `canceled` | Canceled by the user, job terminated immediately on all workers | `requeued` | -| `requeueing` | Request for requeueing of job raised by user | `???`, `???` | -| `archiving` | Archiving job details | `???`, `???` | +| `canceled` | Canceled by the user, job terminated immediately on all Workers | `requeued` | +| `requeueing` | Request for requeueing of job raised by user | `queued` | +| `archiving` | Archiving job details | `archived` | | `archived` | Job details archived in history for future reference | `???`, `???` | | `paused` | Not yet implemented | | @@ -30,9 +30,9 @@ The following table shows the meaning of the different task statuses: | Status | Meaning | Possible next status | | ------------- | ------- | ----------- | | `queued` | Ready to be assigned to an available Worker | `active`, `canceled` | -| `active` | Assigned to a worker for execution | `completed`, `canceled`, `failed`, `soft-failed` | -| `completed`   | Worker executed the task succesfully | `requeued` | -| `soft-failed` | Same as `queued`, but has been failed by a worker in an earlier execution | `completed`, `failed`, `canceled` | -| `failed` | Execution failed after multiple retries by different workers | `requeued` | -| `canceled` | Canceled by the user, task terminated immediately | `requeued` | +| `active` | Assigned to a Worker for execution | `completed`, `canceled`, `failed`, `soft-failed` | +| `completed`   | Task executed succesfully | `queued` | +| `soft-failed` | Same as `queued`, but has been failed by a Worker in an earlier execution | `completed`, `failed`, `canceled` | +| `failed` | Execution failed after multiple retries by different Workers | `queued` | +| `canceled` | Canceled by the user, task terminated immediately | `queued` | | `paused` | Not yet implemented | | -- 2.30.2 From 4d45613044c75f8c01904566404f8baf4da2a8b6 Mon Sep 17 00:00:00 2001 From: Adi Sage Date: Tue, 23 May 2023 22:44:14 +0530 Subject: [PATCH 3/5] Replacing 'requeued' with 'queued' as the former is not a valid status. Also fixing a few other typos. --- .../content/usage/jobs-tasks-commands/_index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/web/project-website/content/usage/jobs-tasks-commands/_index.md b/web/project-website/content/usage/jobs-tasks-commands/_index.md index 01ec64f8..f918adf5 100644 --- a/web/project-website/content/usage/jobs-tasks-commands/_index.md +++ b/web/project-website/content/usage/jobs-tasks-commands/_index.md @@ -14,13 +14,13 @@ The following table shows the meaning of the different job statuses: | `under-construction` | Preparing job for execution | `queued`, `active` | | `queued` | Ready to be assigned to available Workers | `active`, `canceled` | | `active` | Tasks assigned to Workers for execution | `completed`, `canceled`, `failed` | -| `completed` | All tasks executed successfully | `requeued` | -| `failed` | Execution of one or more tasks failed after multiple retries by different Workers | `???`, `???` | +| `completed` | All tasks executed successfully | `queued` | +| `failed` | Execution of one or more tasks failed after multiple retries by different Workers | `queued`, `canceled` | | `cancel-requested` | Request for job cancellation raised by user | `canceled` | -| `canceled` | Canceled by the user, job terminated immediately on all Workers | `requeued` | +| `canceled` | Canceled by the user, job terminated immediately on all Workers | `queued` | | `requeueing` | Request for requeueing of job raised by user | `queued` | | `archiving` | Archiving job details | `archived` | -| `archived` | Job details archived in history for future reference | `???`, `???` | +| `archived` | Job details archived in history for future reference | `queued` | | `paused` | Not yet implemented | | ## Task Statuses @@ -31,8 +31,8 @@ The following table shows the meaning of the different task statuses: | ------------- | ------- | ----------- | | `queued` | Ready to be assigned to an available Worker | `active`, `canceled` | | `active` | Assigned to a Worker for execution | `completed`, `canceled`, `failed`, `soft-failed` | -| `completed`   | Task executed succesfully | `queued` | +| `completed` | Task executed succesfully | `queued` | | `soft-failed` | Same as `queued`, but has been failed by a Worker in an earlier execution | `completed`, `failed`, `canceled` | -| `failed` | Execution failed after multiple retries by different Workers | `queued` | +| `failed` | Execution failed after multiple retries by different Workers | `queued`, `canceled` | | `canceled` | Canceled by the user, task terminated immediately | `queued` | | `paused` | Not yet implemented | | -- 2.30.2 From b509dbe36e88febe0137cdf4ad8756d403ddc853 Mon Sep 17 00:00:00 2001 From: Adi Sage Date: Tue, 20 Jun 2023 23:34:05 +0530 Subject: [PATCH 4/5] Updating and adding notes - Added helpful notes for what happens when a under-execution or completed job is requeued by the users. - Added 'queued' as a possible next status for 'soft-failed' --- .../content/usage/jobs-tasks-commands/_index.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/web/project-website/content/usage/jobs-tasks-commands/_index.md b/web/project-website/content/usage/jobs-tasks-commands/_index.md index f918adf5..fc64195b 100644 --- a/web/project-website/content/usage/jobs-tasks-commands/_index.md +++ b/web/project-website/content/usage/jobs-tasks-commands/_index.md @@ -19,10 +19,12 @@ The following table shows the meaning of the different job statuses: | `cancel-requested` | Request for job cancellation raised by user | `canceled` | | `canceled` | Canceled by the user, job terminated immediately on all Workers | `queued` | | `requeueing` | Request for requeueing of job raised by user | `queued` | -| `archiving` | Archiving job details | `archived` | -| `archived` | Job details archived in history for future reference | `queued` | | `paused` | Not yet implemented | | +NOTE : +- Requeueing a job after it is `completed` will requeue all its tasks. +- Requeueing a job while it is being executed will requeue the pending tasks only. The `completed` tasks will not be requeued. + ## Task Statuses The following table shows the meaning of the different task statuses: @@ -32,7 +34,7 @@ The following table shows the meaning of the different task statuses: | `queued` | Ready to be assigned to an available Worker | `active`, `canceled` | | `active` | Assigned to a Worker for execution | `completed`, `canceled`, `failed`, `soft-failed` | | `completed` | Task executed succesfully | `queued` | -| `soft-failed` | Same as `queued`, but has been failed by a Worker in an earlier execution | `completed`, `failed`, `canceled` | +| `soft-failed` | Same as `queued`, but has been failed by a Worker in an earlier execution | `queued`, `completed`, `failed`, `canceled` | | `failed` | Execution failed after multiple retries by different Workers | `queued`, `canceled` | | `canceled` | Canceled by the user, task terminated immediately | `queued` | | `paused` | Not yet implemented | | -- 2.30.2 From f0e98832a13ec0aa14faa511fc6b49b91c00d649 Mon Sep 17 00:00:00 2001 From: Adi Sage Date: Thu, 22 Jun 2023 22:36:47 +0530 Subject: [PATCH 5/5] Updating notes The note added in previous commit has been revised to be more clear and accurate as per Dr Sybren's suggestions. --- .../content/usage/jobs-tasks-commands/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/project-website/content/usage/jobs-tasks-commands/_index.md b/web/project-website/content/usage/jobs-tasks-commands/_index.md index fc64195b..1d074b89 100644 --- a/web/project-website/content/usage/jobs-tasks-commands/_index.md +++ b/web/project-website/content/usage/jobs-tasks-commands/_index.md @@ -22,8 +22,8 @@ The following table shows the meaning of the different job statuses: | `paused` | Not yet implemented | | NOTE : -- Requeueing a job after it is `completed` will requeue all its tasks. -- Requeueing a job while it is being executed will requeue the pending tasks only. The `completed` tasks will not be requeued. +- Requeueing a job when it is `completed`, i.e. when all its tasks are `completed`, will requeue all its tasks. +- Requeueing a job when some of its tasks are not `completed` will requeue these tasks only. The `completed` tasks will not be requeued, and will remain at `completed` status. ## Task Statuses -- 2.30.2