✨ (go/v3) - Update kustomize from v3.8.7 to v4.4.1 and use replacements instead of vars

[afritzler]

Since the usage of vars in kustomize will be deprecated soon it would make sense to use replacements instead as advised in the warning:

WARNING: There are plans to deprecate vars. For existing users of vars, we recommend migration to replacements as early as possible. There is a guide for convering vars to replacements at the bottom of this page under “convert vars to replacements”. For new users, we recommend never using vars, and starting with replacements to avoid migration in the future.

Another issue we were facing was vars-name collisions when using multiple kubebuilder based controllers in one root kustomization as vars are being propagated to the top.

To test the correct behaviour you can run

diff <(kustomize build ../MY_OLD_DEPLOYMENT/config/default/) <(kustomize build config/default/)

to make sure that the expected result matches the one from the original var based one. (of course make sure that the webhook configuration is commented out)

[k8s-ci-robot]

Welcome @afritzler!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @afritzler. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[afritzler]

I guess it also makes sense to remove the vars in annotations in the following files:

crd/patches/enablecainjection_patch.go
kdefault/enablecainection_patch.go

as those are not really needed anymore.

[afritzler]

Also how about all the test data and the documentation (book)? Those CERTIFICATE_NAMESPACE, CERTIFICATE_NAME, SERVICE_NAMESPACE and SERVICE_NAME are used all over the place and are not really needed when using the replacements approach.

[camilamacedo86]

/ok-to-test

[camilamacedo86]

/test pull-kubebuilder-e2e-k8s-1-15-12

[camilamacedo86]

Great contribution 🥇

The appdiff ci checker is failing in this case because of the kustomize update.
It is fine.

The changes here shows fine for me.
/approved

It would be nice to get a second reviewer as well

[coderanger]

For the record this will make the default skeleton incompatible with kubectl -k in Kubernetes 1.20 and 1.21. Because of how Kubectl versioning works this isn't a full blocker (even if it was, standalone Kustomize would still be an option), but it should be added to the release notes that this requires Kustomize >= 4.1.3 or Kubectl >= 1.22.0

[camilamacedo86]

Hi @coderanger,

Thank you for your help:

For the record this will make the default skeleton incompatible with kubectl -k in Kubernetes 1.20 and 1.21.
#2498

Hi @afritzler,

Based on the above comment, we cannot move with this one. We need support for the latest 3 k8s versions at least.

/hold

Also, in this case, it shows that we would need to address them via go/v4 plugin instead.

I think we need:

• Raise an issue to track this need
• Add to the go/v4 milestone
• Link this PR with the solution
• Also, we need to improve the e2e tests these changes should make the e2e tests fail on the previous k8s versions since are not compatible with them. (this one we can do now) -> e2e tests should fail if default skeleton began to be incompatible with the k8s versions used #2504

I did the above actions see: #2503

In this way, are you ok with we closing this PR?

[camilamacedo86]

/approved cancel

Since it was identified that would mean no longer support k8s < 1.22

[camilamacedo86]

/approved cancel

[camilamacedo86]

/hold

we checked that we cannot move forward with.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: afritzler
To complete the pull request process, please assign estroz after the PR has been reviewed.
You can assign the PR to them by writing /assign @estroz in a comment when ready.

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

[afritzler]

@camilamacedo86 as replacements have been introduced in Kustomize v4.1.3 and given your support strategy I guess it is valid to sit this one out. Thanks a lot for your supporting me on that one!

Maybe we can revisit this one once k8s v1.25 hits the road. :-)

[coderanger]

@afritzler If you want to release it before then, you can make your own Kubebuilder layout plugin that extends the core one maybe? :)

[afritzler]

@coderanger I thought about it - but then you have the maintenance effort. We fixed it now via documentation™️ for us 😄

[camilamacedo86]

HI @afritzler,

Thank you a lot for your contribution. 🥇
It will not be lost, asap we are able to do this update we can use the changes made in this PR.

I am closing this one for now.