generate DRA job configs from a Jinja template #34010

bart0sh · 2024-12-19T13:34:54Z

Implemented job configs generation
added make rules to generate and verify generated jobs
generated DRA canary jobs

/cc @pohly @kannon92 @SergeyKanzhelev @haircommander

k8s-ci-robot · 2024-12-19T13:34:56Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

config/jobs/kubernetes/sig-node/dynamic-resource-allocation-canary.ini

pohly · 2024-12-19T15:00:27Z

config/jobs/kubernetes/sig-node/dynamic-resource-allocation-canary.ini

+# on a kind cluster with containerd updated to a version with CDI support.
+#
+# Compared to ci-kind-dra, this one enables all DRA-related features.
+[ci-kind-dra-all]


Can we make it so that we have common settings for normal periodics, normal presubmits, and canary presubmits?

There's still going to be a lot of duplication if we have to have three copies of this section and the ones below.

The same applies to the actual .jinja template. The entries in the periodics and presubmits should be built from a single source.

Thank you. This makes sense. Will do.

Updated. Now gen.py generates 3 files: dynamic-resource-allocation-canary.yaml, dynamic-resource-allocation-pull.yaml and dynamic-resource-allocation-ci.yaml from dynamic-resource-allocation.conf and dynamic-resource-allocation.jinja

PTAL.

pohly

Looks very promising.

How to solve indention was my biggest concern when thinking about how to use Jinja. I am not sure whether this is addressed here (need to check test results).

config/jobs/kubernetes/sig-node/Makefile

config/jobs/kubernetes/sig-node/dynamic-resource-allocation.conf

config/jobs/kubernetes/sig-node/dynamic-resource-allocation.jinja

pohly · 2024-12-20T19:30:30Z

config/jobs/kubernetes/sig-node/dynamic-resource-allocation.jinja

+      testgrid-tab-name: {{job_name}}
+      description: {{description}}
+      testgrid-alert-email: {{testgrid_alert_email}}
+      fork-per-release: "true"


Canaries shouldn't get forked.

config/jobs/kubernetes/sig-node/dynamic-resource-allocation.jinja

bart0sh · 2024-12-20T21:27:36Z

@pohly @kannon92 @SergeyKanzhelev @haircommander

Looks very promising.

Thank you. After fixing review comments, I'm going to remove -pull and -ci yamls from this PR, so we can only test -canary.
It would be great if SIG-Node folks would look at this and confirm that this approach is at least acceptable.

I personally like it. Using it would allow us to

have presubmit job for every periodic
keep them synchronized
easily generate canary jobs for testing purposes (e.g. kubetest2)
make less mistakes as job configs are automatically generated
do less typing and copypasting :)
etc.

WDYT guys?

bart0sh · 2025-01-04T12:02:28Z

@pohly

Can we make this PR complete (= generates everything) and then merge the generated canary jobs in advance via a second PR?

done: #34070

bart0sh · 2025-01-04T12:08:55Z

@pohly BTW, current implementation makes canary job changes a bit awkward. We'll have to either complicate template with {%- if kind == "canary" %} blocks or create PRs without changes in the template and the config, as I did in #34070.

Does this make sense to you?

pohly · 2025-01-04T13:48:52Z

There's a genuine unit test failure:

hack/generate-jobs.py:79:0: W0311: Bad indentation. Found 25 spaces, expected 24 (bad-indentation)

pohly · 2025-01-04T13:52:49Z

BTW, current implementation makes canary job changes a bit awkward. We'll have to either complicate template with {%- if kind == "canary" %} blocks or create PRs without changes in the template and the config

If someone modifies the template locally and then submits only the updated canary YAML, it is impossible for others to review or replicate how they where generated. It may also be harder to verify that the changes for the canary jobs then get applied as tested to the actual jobs.

I think I prefer the approach with {%- if kind == "canary" %}. Moving experimental changes from the canary jobs to the production jobs then should consists only of removing those if checks and the else branch.

@elieser1101 can be our first ~~guinea pig~~ user of this approach for producing canary jobs which use kubetest2.

config/jobs/kubernetes/sig-node/dra-ci.yaml

pohly · 2025-01-04T17:01:51Z

config/jobs/kubernetes/sig-node/dra.jinja

@@ -0,0 +1,120 @@
+{%- if header %}{%- if kind == "ci" %}periodics:{%- else %}presubmits:


Can this {%- if header %} be dropped?

Can you suggest how to do it? I don't like this trick either, but couldn't find a better way to make periodics: and presubmits: appear in a result content only once, at the beginning of the file.

So that is the purpose - that wasn't clear to me. Can you perhaps add a comment to the dra.jinja explaining this trick?

I don't have a better alternative.

renamed the variable and added a comment

config/jobs/kubernetes/sig-node/dra.jinja

pohly · 2025-01-04T17:06:49Z

config/jobs/kubernetes/sig-node/dra.jinja

+          curl -sSL https://kind.sigs.k8s.io/dl/latest/linux-amd64.tgz | tar xvfz - -C "${PATH%%:*}/" kind
+          kind build node-image --image=dra/node:latest .
+          trap 'kind export logs "${ARTIFACTS}/kind"; kind delete cluster' EXIT
+          {%- if kind == "canary" %}


Why does this check "canary"?

This seems to overload the meaning of "canary":

For canary PR jobs (= dra-canary.yaml).

The "all features enabled" CI and presubmit jobs.

Let's use "canary" for "part of dra-canary.yaml" and something else for feature gates. How about "alpha"?

with_all_features was set to true only for two canary jobs in your PR.
However, I agree that a separate option would be more appropriate here. How about all_features?

Works for me.

pohly · 2025-01-04T17:09:02Z

hack/make-rules/verify/generated-jobs.sh

+
+echo "Verifying generated jobs"
+hack/run-in-python-container.sh \
+    python3 hack/generate-jobs.py config/jobs/kubernetes/sig-node/*.conf --only-verify


We can start with only working on "our" (= SIG Node) jobs here for now. But in a future PR this should get extended to other generated jobs.

Yes. Fortunately it's just a matter of adding new patterns to the command line. generate-jobs.py already supports this.

k8s-ci-robot · 2025-01-07T09:37:13Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: bart0sh
Once this PR has been reviewed and has the lgtm label, please assign mpherman2 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

bart0sh · 2025-01-07T11:18:30Z

/hold
until all canary jobs pass for the test PR

bart0sh · 2025-01-07T11:20:39Z

@pohly Can you look at failing canary jobs and suggest how to fix them? I'm looking as well, but couldn't find a reason yet.

pohly · 2025-01-07T11:49:50Z

config/jobs/kubernetes/sig-node/dra.jinja

@@ -0,0 +1,129 @@
+{# `beginning` variable is set to `true` by the generate-job.py for the first processed job and to `false` for the rest of the jobs #}
+{%- if beginning %}{%- if kind == "ci" %}periodics:{%- else %}presubmits:


I actually like header better: "head" and "tail" is used for the top and bottom of files, but "beginning" could be for anything.

Perhaps set "header" to:

# GENERATED FILE - DO NOT EDIT! # # Instead, modify dra.jinja and run `make generate-jobs`.

and then inject that value here if non-empty?

Thank you for the suggestion. Done. I defined header in the script as it's generic enough. Previously it was defined for the first job in the template, which is harder to understand in my opinion.

pohly · 2025-01-07T19:31:20Z

config/jobs/kubernetes/sig-node/dra-canary.yaml

        command:
        - runner.sh
        args:
-        - /bin/sh
+        - /bin/bash


This should fix the https://prow.k8s.io/view/gs/kubernetes-ci-logs/pr-logs/directory/canary-kind-dra/1875675905863454720 failure:

/bin/sh: 6: Syntax error: "(" unexpected

Arrays are a bash feature, so features=( ... ) only works in bash.

pohly · 2025-01-07T19:45:15Z

hack/generate-jobs.py

+            with tmp:
+                header = (
+                    "# GENERATED FILE - DO NOT EDIT!\n#\n# "
+                    "Instead, modify template and run `make generate-jobs`.\n"


Someone not familiar with this mechanism will have to ask "which template?"

Let's answer that right away:

Suggested change

"Instead, modify template and run `make generate-jobs`.\n"

"Instead, modify %s and run `make generate-jobs`.\n" % os.path.basename(template_path)

I think dropping the path is okay because generated file and template will typically (always?) be in the same directory.

k8s-ci-robot requested review from haircommander, kannon92, pohly and SergeyKanzhelev December 19, 2024 13:34

bart0sh force-pushed the PR060-generate-job-configs branch from 7c3a83c to 2f75bbd Compare December 19, 2024 13:37

bart0sh mentioned this pull request Dec 19, 2024

DRA: add canary jobs and sync mechanism #33993

Open

bart0sh force-pushed the PR060-generate-job-configs branch 3 times, most recently from d030275 to c5999e8 Compare December 19, 2024 14:13

pohly reviewed Dec 19, 2024

View reviewed changes

bart0sh force-pushed the PR060-generate-job-configs branch 3 times, most recently from 3259e4d to 499379c Compare December 20, 2024 12:38

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 20, 2024

bart0sh force-pushed the PR060-generate-job-configs branch from 499379c to 2e1e253 Compare December 20, 2024 15:08

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Dec 20, 2024

pohly reviewed Dec 20, 2024

View reviewed changes

bart0sh force-pushed the PR060-generate-job-configs branch 2 times, most recently from 4234630 to 28eda1b Compare December 20, 2024 21:33

k8s-ci-robot added the area/testgrid label Jan 4, 2025

pohly mentioned this pull request Jan 4, 2025

dra --label-filter matches nonkubetes2 jobs #34068

Open

bart0sh force-pushed the PR060-generate-job-configs branch from 2ed5a55 to 1da3e45 Compare January 4, 2025 14:54

pohly reviewed Jan 4, 2025

View reviewed changes

bart0sh force-pushed the PR060-generate-job-configs branch from 1da3e45 to 5f4f709 Compare January 7, 2025 09:37

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 7, 2025

bart0sh force-pushed the PR060-generate-job-configs branch 2 times, most recently from 5e5c437 to 51f4171 Compare January 7, 2025 11:17

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 7, 2025

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 7, 2025

pohly reviewed Jan 7, 2025

View reviewed changes

bart0sh force-pushed the PR060-generate-job-configs branch from 51f4171 to 7f1008f Compare January 7, 2025 12:52

hack: implement job config generator

c3537b8

bart0sh force-pushed the PR060-generate-job-configs branch 3 times, most recently from 0981b0d to ecd5495 Compare January 7, 2025 13:28

bart0sh mentioned this pull request Jan 7, 2025

re-generated DRA canary jobs #34088

Open

bart0sh added 3 commits January 7, 2025 15:53

sig-node: generate DRA jobs

c10980a

Makefile: generate DRA jobs

ce87e7d

Makefile: verify generated jobs

34b1edd

bart0sh force-pushed the PR060-generate-job-configs branch from ecd5495 to 34b1edd Compare January 7, 2025 14:41

pohly reviewed Jan 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

generate DRA job configs from a Jinja template #34010

generate DRA job configs from a Jinja template #34010

bart0sh commented Dec 19, 2024 •

edited

Loading

k8s-ci-robot commented Dec 19, 2024

pohly Dec 19, 2024

bart0sh Dec 19, 2024

bart0sh Dec 20, 2024

pohly left a comment

pohly Dec 20, 2024

bart0sh Dec 22, 2024

bart0sh commented Dec 20, 2024 •

edited

Loading

bart0sh commented Jan 4, 2025

bart0sh commented Jan 4, 2025

pohly commented Jan 4, 2025

pohly commented Jan 4, 2025

pohly Jan 4, 2025

bart0sh Jan 7, 2025

pohly Jan 7, 2025

bart0sh Jan 7, 2025

pohly Jan 4, 2025

bart0sh Jan 7, 2025

pohly Jan 7, 2025

pohly Jan 4, 2025

bart0sh Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

bart0sh commented Jan 7, 2025

bart0sh commented Jan 7, 2025

pohly Jan 7, 2025

bart0sh Jan 7, 2025

pohly Jan 7, 2025

pohly Jan 7, 2025

		@@ -0,0 +1,120 @@
		{%- if header %}{%- if kind == "ci" %}periodics:{%- else %}presubmits:

		@@ -0,0 +1,129 @@
		{# `beginning` variable is set to `true` by the generate-job.py for the first processed job and to `false` for the rest of the jobs #}
		{%- if beginning %}{%- if kind == "ci" %}periodics:{%- else %}presubmits:

	"Instead, modify template and run `make generate-jobs`.\n"
	"Instead, modify %s and run `make generate-jobs`.\n" % os.path.basename(template_path)

generate DRA job configs from a Jinja template #34010

Are you sure you want to change the base?

generate DRA job configs from a Jinja template #34010

Conversation

bart0sh commented Dec 19, 2024 • edited Loading

k8s-ci-robot commented Dec 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pohly left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bart0sh commented Dec 20, 2024 • edited Loading

bart0sh commented Jan 4, 2025

bart0sh commented Jan 4, 2025

pohly commented Jan 4, 2025

pohly commented Jan 4, 2025

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

k8s-ci-robot commented Jan 7, 2025

bart0sh commented Jan 7, 2025

bart0sh commented Jan 7, 2025

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

bart0sh commented Dec 19, 2024 •

edited

Loading

bart0sh commented Dec 20, 2024 •

edited

Loading