feat(CLI-alpha): support backfill for cron workflow. Part of #2706 #13999

shuangkun · 2024-12-15T12:19:45Z

Airflow is easy to backfill. Simplify the use of backfill on Argo.

Support：

Provide CLI like argo corn backfill <cronworkflow name> --name <backfill name> --start <startdate> --end <enddate>

Part of #2706

Motivation

Modifications

Verification

U-4YKHFNR6-2229 cron-backfill % ./argo cron backfill daily-job --start "Wed, 21 Oct 2024 15:28:00 GMT" --end "Wed, 28 Oct 2024 15:28:00 GMT" --argname data --parallel true
Created 28816 Backfill task for Cronworkflow daily-job
==================================================
Backfill Period :
Start Time : Wed, 21 Oct 2024 15:28:00 GMT
  End Time : Wed, 28 Oct 2024 15:28:00 GMT
Total Backfill Schedule: 7
==================================================
Backfill Workflows:
   NAMESPACE	 WORKFLOW:
1. argo 	 backfill-wf-jhmpr
tianshuangkun@U-4YKHFNR6-2229 cron-backfill % ./argo get backfill-wf-jhmpr
Name:                backfill-wf-jhmpr
Namespace:           argo
ServiceAccount:      unset (will run with the default ServiceAccount)
Status:              Running
Conditions:
 PodRunning          True
Created:             Tue Dec 17 14:44:02 +0800 (10 seconds ago)
Started:             Tue Dec 17 14:44:02 +0800 (10 seconds ago)
Duration:            10 seconds
Progress:            0/7

STEP                                                     TEMPLATE         PODNAME                                       DURATION  MESSAGE
 ● backfill-wf-jhmpr                                     main
 └─┬─● create-workflow(0:2024-10-22 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-3441413642  10s
   ├─● create-workflow(1:2024-10-23 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2444440844  10s
   ├─● create-workflow(2:2024-10-24 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2857101642  10s
   ├─● create-workflow(3:2024-10-25 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2922680488  10s
   ├─● create-workflow(4:2024-10-26 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-4231395098  10s
   ├─● create-workflow(5:2024-10-27 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2220838812  10s
   └─● create-workflow(6:2024-10-28 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-1221315226  10s
U-4YKHFNR6-2229 cron-backfill % argo list
NAME                             STATUS      AGE   DURATION   PRIORITY   MESSAGE
daily-job-backfill-28816-njt45   Running     11s   11s        0
daily-job-backfill-28816-shk9g   Running     11s   11s        0
daily-job-backfill-28816-vk79g   Running     11s   11s        0
backfill-wf-jhmpr                Running     13s   13s        0
daily-job-backfill-28816-k5wcm   Succeeded   11s   7s         0
daily-job-backfill-28816-q949s   Succeeded   11s   7s         0
daily-job-backfill-28816-xssbb   Succeeded   11s   7s         0
daily-job-backfill-28816-csfld   Succeeded   11s   6s         0
U-4YKHFNR6-2229 cron-backfill % argo list
NAME                             STATUS      AGE   DURATION   PRIORITY   MESSAGE
backfill-wf-jhmpr                Succeeded   34s   30s        0
daily-job-backfill-28816-vk79g   Succeeded   32s   22s        0
daily-job-backfill-28816-shk9g   Succeeded   32s   17s        0
daily-job-backfill-28816-njt45   Succeeded   32s   13s        0
U-4YKHFNR6-2229 cron-backfill % ./argo get backfill-wf-jhmpr
Name:                backfill-wf-jhmpr
Namespace:           argo
ServiceAccount:      unset (will run with the default ServiceAccount)
Status:              Succeeded
Conditions:
 PodRunning          False
 Completed           True
Created:             Tue Dec 17 14:44:02 +0800 (37 seconds ago)
Started:             Tue Dec 17 14:44:02 +0800 (37 seconds ago)
Finished:            Tue Dec 17 14:44:32 +0800 (7 seconds ago)
Duration:            30 seconds
Progress:            7/7
ResourcesDuration:   9s*(1 cpu),1m7s*(100Mi memory)

STEP                                                     TEMPLATE         PODNAME                                       DURATION  MESSAGE
 ✔ backfill-wf-jhmpr                                     main
 └─┬─✔ create-workflow(0:2024-10-22 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-3441413642  23s
   ├─✔ create-workflow(1:2024-10-23 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2444440844  13s
   ├─✔ create-workflow(2:2024-10-24 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2857101642  28s
   ├─✔ create-workflow(3:2024-10-25 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2922680488  18s
   ├─✔ create-workflow(4:2024-10-26 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-4231395098  13s
   ├─✔ create-workflow(5:2024-10-27 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-2220838812  13s
   └─✔ create-workflow(6:2024-10-28 02:00:00 +0000 GMT)  create-workflow  backfill-wf-jhmpr-create-workflow-1221315226  13s

tczhao

I wonder if we should have a way to label this as something like a alpha feature,
so that we don't need to maintain backward compatibility incase there's a significant change later on

tczhao · 2024-12-19T12:10:51Z

test/e2e/fixtures/e2e_suite.go

+			Namespace:         Namespace,
+			LabelRequirements: parse,
+		})
+		s.CheckError(err)


should we check backfill workflow actually exist, incase this returns empty list

I referred to the previous implementation of cleaning/test label. If there is no error here, it doesn’t matter even if an empty list is returned. If the range of the subsequent loop is empty, delete will not be executed.

docs/cli/argo_cron_backfill.md

cmd/argo/commands/cron/backfill.go

tczhao · 2024-12-19T12:46:37Z

cmd/argo/commands/cron/backfill.go

+	var scheList []string
+	wf := common.ConvertCronWorkflowToWorkflow(cronWF)
+	paramArg := `{{inputs.parameters.backfillscheduletime}}`
+	wf.GenerateName = cronWF.Name + "-backfill-" + strings.ToLower(cliOps.name) + "-"


we may want to truncate this in case this gets too long

Add a function GenerateBackfillWorkflowPrefix

tczhao · 2024-12-19T12:51:00Z

docs/cli/argo_cron_backfill.md

+### Options
+
+```
+      --argname string   Schedule time argument name for workflow (default "cronScheduleTime")


wondering if we really need this, it's only for parent workflow, right?

Yes，This is useful when the sub-workflow needs to accept time parameters, such as pulling data based on time parameters.

tczhao · 2024-12-19T12:55:53Z

cmd/argo/commands/cron/backfill.go

+`
+
+func CreateMonitorWf(ctx context.Context, wf, namespace, cronWFName string, scheTime []string, wfClient workflow.WorkflowServiceClient, cliOps backfillOpts) error {
+	const maxWfCount = 1000


need to expose this as an argument?

Set it as a parameter

shuangkun · 2025-01-05T04:04:17Z

I wonder if we should have a way to label this as something like a alpha feature, so that we don't need to maintain backward compatibility incase there's a significant change later on

Yes, it would be better if there could be an alpha feature label. I have now added an alpha field in the pr title.

tczhao · 2025-01-06T03:14:53Z

I wonder if we should have a way to label this as something like a alpha feature, so that we don't need to maintain backward compatibility incase there's a significant change later on

Yes, it would be better if there could be an alpha feature label. I have now added an alpha field in the pr title.

Perhaps let's add it to the CLI Short/Long description

Co-authored-by: Saravanan Balasubramanian <[email protected]> Co-authored-by: shuangkun <[email protected]> Signed-off-by: shuangkun <[email protected]>

Signed-off-by: shuangkun <[email protected]>

Co-authored-by: Tianchu Zhao <[email protected]> Signed-off-by: shuangkun tian <[email protected]>

Signed-off-by: shuangkun <[email protected]>

shuangkun · 2025-01-06T15:56:37Z

I wonder if we should have a way to label this as something like a alpha feature, so that we don't need to maintain backward compatibility incase there's a significant change later on

Yes, it would be better if there could be an alpha feature label. I have now added an alpha field in the pr title.

Perhaps let's add it to the CLI Short/Long description

Added alpha to CLI short description

Signed-off-by: shuangkun <[email protected]>

shuangkun marked this pull request as draft December 15, 2024 12:19

shuangkun marked this pull request as ready for review December 17, 2024 06:33

shuangkun changed the title ~~feat(CLI): support backfill for cron workflow.~~ feat(CLI): support backfill for cron workflow. Part of #2706 Dec 17, 2024

tczhao reviewed Dec 19, 2024

View reviewed changes

shuangkun changed the title ~~feat(CLI): support backfill for cron workflow. Part of #2706~~ feat(CLI-alpha): support backfill for cron workflow. Part of #2706 Jan 5, 2025

shuangkun requested a review from tczhao January 5, 2025 04:19

shuangkun added area/cli The `argo` CLI area/cron-workflows labels Jan 5, 2025

shuangkun and others added 20 commits January 6, 2025 23:53

feat(CLI): support backfill for cron workflow.

d14749c

Co-authored-by: Saravanan Balasubramanian <[email protected]> Co-authored-by: shuangkun <[email protected]> Signed-off-by: shuangkun <[email protected]>

fix: test.

a9e1b80

Signed-off-by: shuangkun <[email protected]>

fix: set parallel to true.

05162ee

Signed-off-by: shuangkun <[email protected]>

fix: add sleep time.

c880bea

Signed-off-by: shuangkun <[email protected]>

fix: check daily job status.

e116bab

Signed-off-by: shuangkun <[email protected]>

fix: reduce data number.

41e4ccb

Signed-off-by: shuangkun <[email protected]>

fix: add job template for lint.

f4d1e39

Signed-off-by: shuangkun <[email protected]>

fix: clean daily job and backfill wf.

44c2b84

Signed-off-by: shuangkun <[email protected]>

fix: move backfill test.

97e91b3

Signed-off-by: shuangkun <[email protected]>

fix: add label filter.

db516d4

Signed-off-by: shuangkun <[email protected]>

fix: add test label.

fa3365f

Signed-off-by: shuangkun <[email protected]>

fix: delete cron backfill workflows.

a5929b7

Signed-off-by: shuangkun <[email protected]>

fix: delete cron backfill workflows.

0c041d3

Signed-off-by: shuangkun <[email protected]>

Update docs/cli/argo_cron_backfill.md

21c5a2b

Co-authored-by: Tianchu Zhao <[email protected]> Signed-off-by: shuangkun tian <[email protected]>

Update cmd/argo/commands/cron/backfill.go

2268f94

Co-authored-by: Tianchu Zhao <[email protected]> Signed-off-by: shuangkun tian <[email protected]>

fix: comments.

e601155

Signed-off-by: shuangkun <[email protected]>

fix: docs

36d6fc6

Signed-off-by: shuangkun <[email protected]>

fix: docs lint.

fcfbb6c

Signed-off-by: shuangkun <[email protected]>

fix: docs

c4dbf3f

Signed-off-by: shuangkun <[email protected]>

fix: add short descriptation.

4d304e1

Signed-off-by: shuangkun <[email protected]>

shuangkun force-pushed the backfill branch from 3f98afa to 4d304e1 Compare January 6, 2025 15:53

fix: docs.

510eb1b

Signed-off-by: shuangkun <[email protected]>

tczhao approved these changes Jan 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(CLI-alpha): support backfill for cron workflow. Part of #2706 #13999

feat(CLI-alpha): support backfill for cron workflow. Part of #2706 #13999

shuangkun commented Dec 15, 2024 •

edited

Loading

tczhao left a comment

tczhao Dec 19, 2024

shuangkun Jan 5, 2025

tczhao Dec 19, 2024

shuangkun Jan 2, 2025

tczhao Dec 19, 2024

shuangkun Jan 5, 2025

tczhao Dec 19, 2024

shuangkun Jan 2, 2025

shuangkun commented Jan 5, 2025

tczhao commented Jan 6, 2025

shuangkun commented Jan 6, 2025

feat(CLI-alpha): support backfill for cron workflow. Part of #2706 #13999

Are you sure you want to change the base?

feat(CLI-alpha): support backfill for cron workflow. Part of #2706 #13999

Conversation

shuangkun commented Dec 15, 2024 • edited Loading

Motivation

Modifications

Verification

tczhao left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shuangkun commented Jan 5, 2025

tczhao commented Jan 6, 2025

shuangkun commented Jan 6, 2025

shuangkun commented Dec 15, 2024 •

edited

Loading