Fix Kustomization Warnings #4859

nawazkh · 2024-05-16T21:48:03Z

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
This PR is intended to fix Kustomization warnings seen on running make generate.
The warnings I see are

# Warning: 'patchesStrategicMerge' is deprecated. Please use 'patches' instead. Run 'kustomize edit fix' to update your Kustomization automatically.
Flag --reorder has been deprecated, use the new 'sortOptions' field in kustomization.yaml instead.

Which issue(s) this PR fixes:

Fixes #4752

Special notes for your reviewer:

cherry-pick candidate

TODOs:

squashed commits
includes documentation
adds unit tests

Release note:

NONE

k8s-ci-robot · 2024-05-16T21:48:05Z

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

codecov · 2024-05-16T21:55:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.01%. Comparing base (31dd10c) to head (f0f1853).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4859   +/-   ##
=======================================
  Coverage   62.01%   62.01%           
=======================================
  Files         201      201           
  Lines       16862    16862           
=======================================
  Hits        10457    10457           
  Misses       5622     5622           
  Partials      783      783

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nawazkh

Self notes.

config/capz/kustomization.yaml

config/certmanager/kustomization.yaml

config/crd/kustomization.yaml

config/default/kustomization.yaml

config/manager/kustomization.yaml

config/webhook/kustomization.yaml

templates/test/dev/custom-builds-machine-pool/kustomization.yaml

templates/test/dev/custom-builds/kustomization.yaml

hack/update_kustomize.sh

config/aso/kustomization.yaml

mboersma

I think the goal of this PR should be just to change any kustomization.yaml files (and the Makefile, etc.) but not have any of the generated templates change. At least that's what I was attempting in #4753. You may have to add

sortOptions:
  order: fifo

to ensure things stay stable.

config/capz/kustomization.yaml

nawazkh · 2024-05-17T20:05:37Z

I think the goal of this PR should be just to change any kustomization.yaml files (and the Makefile, etc.) but not have any of the generated templates change. At least that's what I was attempting in #4753. You may have to add
sortOptions:
  order: fifo
to ensure things stay stable.

order: fifo did the trick. Thank you for suggesting it.
The changes are now local to "*kustomization.yaml".
For my better understanding, apart from lowering the churn created with generated templates, is there any other reason to choose "fifo" over default "legacy" sortOptions?

nawazkh · 2024-05-17T22:41:47Z

/test pull-cluster-api-provider-azure-e2e-aks
pull-cluster-api-provider-azure-e2e-aks appears to be a time out error.

nawazkh · 2024-05-17T22:42:57Z

/test pull-cluster-api-provider-azure-conformance-ipv6-with-ci-artifacts
pull-cluster-api-provider-azure-conformance-ipv6-with-ci-artifacts also appears to be a timeout error.

mboersma · 2024-05-17T23:06:02Z

is there any other reason to choose "fifo" over default "legacy" sortOptions?

AFAICT sortOptions: fifo keeps the template YAML in the order it was defined, same as --reorder none did. I assume we did this to make it easier to compare the sources with the generated templates, or to avoid unneeded diffs.

templates/test/dev/cluster-template-custom-builds-machine-pool.yaml

mboersma

/lgtm

k8s-ci-robot · 2024-05-17T23:18:01Z

LGTM label has been added.

Git tree hash: 2375193756d1d0846b09f8102138dca6528e8d13

willie-yao · 2024-05-18T02:55:46Z

/retest

willie-yao

Overall looks good! Will run this locally to verify and I'll approve it then

/lgtm

willie-yao · 2024-05-18T03:19:49Z

hack/gen-flavors.sh

 done

 for name in $(find "${dev_dir}"* -maxdepth 0 -type d -print0 | xargs -0 -I {} basename {} | grep -v patches); do
-  ${KUSTOMIZE} build --load-restrictor LoadRestrictionsNone --reorder none "${dev_dir}${name}" > "${dev_dir}cluster-template-${name}.yaml"


Just for my own understanding: why is --reorder none removed here?

kustomize v5.4.1 complained on using reorder flag. It said Flag --reorder has been deprecated, use the new 'sortOptions' field in kustomization.yaml instead

So we removed --reorder flag and are using sortOptions instead in the kustomization files

nawazkh · 2024-05-20T17:09:14Z

/hold

pull-cluster-api-provider-azure-verify seems to be generating a diff for the filetemplates/test/dev/cluster-template-custom-builds-machine-pool.yaml which should not be happening. I will investigate on why this is happening.

- config folder - templates/addons - templates/azure-cluster-identity - templates/flavors - templates/test/ci - templates/test/dev - hack/observabilty - test/e2e/data remove --reorder none flag from the kustomize command and add sortOption:legacy to below folder - flavors - test/ci - test/dev

nawazkh · 2024-05-20T17:58:24Z

templates/test/dev/custom-builds-machine-pool/kustomization.yaml

+- path: ../patches/control-plane-custom-builds.yaml
+- path: patches/machine-pool-deployment-pr-version-windows.yaml
+- path: patches/custom-builds.yaml
+- path: ../../../test/ci/prow-ci-version/patches/oot-credential-provider-kcp.yaml


Since the sortOrder is set to fifo, a change in the order of listing these patch files generates a different cluster-template-custom-builds-machine-pool.yaml

nawazkh · 2024-05-20T17:59:43Z

/hold

pull-cluster-api-provider-azure-verify seems to be generating a diff for the filetemplates/test/dev/cluster-template-custom-builds-machine-pool.yaml which should not be happening. I will investigate on why this is happening.

/unhold
This should now be resolved since I have restored the original order for the patch files in templates/test/dev/custom-builds-machine-pool/kustomization.yaml

nawazkh · 2024-05-20T18:01:30Z

/hold
pull-cluster-api-provider-azure-verify seems to be generating a diff for the filetemplates/test/dev/cluster-template-custom-builds-machine-pool.yaml which should not be happening. I will investigate on why this is happening.

/unhold This should now be resolved since I have restored the original order for the patch files in templates/test/dev/custom-builds-machine-pool/kustomization.yaml

And I do not believe we need to worry about restoring the order of patch files in other kustomization.yaml files since make generate no longer generates a diff for the generated flavors.

nawazkh · 2024-05-20T18:34:45Z

/test pull-cluster-api-provider-azure-conformance-with-ci-artifacts

mboersma

/lgtm

k8s-ci-robot · 2024-05-20T21:27:11Z

LGTM label has been added.

Git tree hash: ddbf42e15e90aac3e2e8eee41be84bc860ce055f

willie-yao

/lgtm
/approve

k8s-ci-robot · 2024-05-20T22:43:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: willie-yao

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [willie-yao]

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

k8s-ci-robot requested review from jackfrancis and Jont828 May 16, 2024 21:48

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 16, 2024

nawazkh commented May 16, 2024

View reviewed changes

nawazkh force-pushed the fix_kustomization_warnings branch 2 times, most recently from 16b457d to de1b168 Compare May 16, 2024 22:28

nawazkh commented May 16, 2024

View reviewed changes

hack/update_kustomize.sh Outdated Show resolved Hide resolved

nawazkh force-pushed the fix_kustomization_warnings branch from de1b168 to 28c3efb Compare May 17, 2024 00:07

nawazkh marked this pull request as ready for review May 17, 2024 00:07

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 17, 2024

k8s-ci-robot requested review from nojnhuh and willie-yao May 17, 2024 00:07

nawazkh added this to the v1.16 milestone May 17, 2024

mboersma reviewed May 17, 2024

View reviewed changes

config/aso/kustomization.yaml Show resolved Hide resolved

mboersma mentioned this pull request May 17, 2024

Fix kustomize deprecations #4753

Closed

4 tasks

nawazkh force-pushed the fix_kustomization_warnings branch from 28c3efb to 2570c4d Compare May 17, 2024 17:12

mboersma reviewed May 17, 2024

View reviewed changes

config/capz/kustomization.yaml Outdated Show resolved Hide resolved

config/capz/kustomization.yaml Outdated Show resolved Hide resolved

nawazkh force-pushed the fix_kustomization_warnings branch 2 times, most recently from 0d199ff to 390d257 Compare May 17, 2024 19:45

mboersma reviewed May 17, 2024

View reviewed changes

templates/test/dev/cluster-template-custom-builds-machine-pool.yaml Outdated Show resolved Hide resolved

nawazkh force-pushed the fix_kustomization_warnings branch 2 times, most recently from 20e44c1 to 596da46 Compare May 17, 2024 23:15

mboersma approved these changes May 17, 2024

View reviewed changes

k8s-ci-robot assigned mboersma May 17, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 17, 2024

willie-yao reviewed May 18, 2024

View reviewed changes

k8s-ci-robot assigned willie-yao May 18, 2024

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

nawazkh force-pushed the fix_kustomization_warnings branch from 596da46 to f0f1853 Compare May 20, 2024 17:52

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 20, 2024

k8s-ci-robot requested review from mboersma and willie-yao May 20, 2024 17:52

nawazkh commented May 20, 2024

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 20, 2024

mboersma reviewed May 20, 2024

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 20, 2024

willie-yao approved these changes May 20, 2024

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 20, 2024

k8s-ci-robot merged commit 76240e7 into kubernetes-sigs:main May 21, 2024
27 checks passed

nawazkh deleted the fix_kustomization_warnings branch May 21, 2024 18:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Kustomization Warnings #4859

Fix Kustomization Warnings #4859

nawazkh commented May 16, 2024 •

edited by mboersma

k8s-ci-robot commented May 16, 2024

codecov bot commented May 16, 2024 •

edited

nawazkh left a comment

mboersma left a comment •

edited

nawazkh commented May 17, 2024 •

edited

nawazkh commented May 17, 2024

nawazkh commented May 17, 2024

mboersma commented May 17, 2024

mboersma left a comment

k8s-ci-robot commented May 17, 2024

willie-yao commented May 18, 2024

willie-yao left a comment

willie-yao May 18, 2024

nawazkh May 20, 2024

nawazkh May 20, 2024

nawazkh commented May 20, 2024

nawazkh May 20, 2024

nawazkh commented May 20, 2024

nawazkh commented May 20, 2024

nawazkh commented May 20, 2024

mboersma left a comment

k8s-ci-robot commented May 20, 2024

willie-yao left a comment

k8s-ci-robot commented May 20, 2024

Fix Kustomization Warnings #4859

Fix Kustomization Warnings #4859

Conversation

nawazkh commented May 16, 2024 • edited by mboersma

k8s-ci-robot commented May 16, 2024

codecov bot commented May 16, 2024 • edited

Codecov Report

nawazkh left a comment

Choose a reason for hiding this comment

mboersma left a comment • edited

Choose a reason for hiding this comment

nawazkh commented May 17, 2024 • edited

nawazkh commented May 17, 2024

nawazkh commented May 17, 2024

mboersma commented May 17, 2024

mboersma left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 17, 2024

willie-yao commented May 18, 2024

willie-yao left a comment

Choose a reason for hiding this comment

willie-yao May 18, 2024

Choose a reason for hiding this comment

nawazkh May 20, 2024

Choose a reason for hiding this comment

nawazkh May 20, 2024

Choose a reason for hiding this comment

nawazkh commented May 20, 2024

nawazkh May 20, 2024

Choose a reason for hiding this comment

nawazkh commented May 20, 2024

nawazkh commented May 20, 2024

nawazkh commented May 20, 2024

mboersma left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 20, 2024

willie-yao left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 20, 2024

nawazkh commented May 16, 2024 •

edited by mboersma

codecov bot commented May 16, 2024 •

edited

mboersma left a comment •

edited

nawazkh commented May 17, 2024 •

edited