Add Annotation to Control Inline List Conversion in Kustomize Resources" #5745

isarns · 2024-08-11T14:46:43Z

This PR introduces a new annotation to Kustomize resources: kustomize.config.k8s.io/convertToInlineList. When set to false, this annotation prevents objects with names ending in "List" from being converted to inline resources, allowing them to be treated at face value.

Changes:

Added the kustomize.config.k8s.io/convertToInlineList: false annotation.
Updated the handling logic to respect this annotation and avoid converting specified lists into inline resources.

Example:

For example, the resource definition ManagedPrefixList does not require conversion to an inline list, and with this annotation, Kustomize will respect its original format.

Issues Addressed:

Fixes issue Custom Resources with a Kind Ending in "List" are Silently Ignored #5042
Fixes issue krusty Ignores Resources with "List" Suffix in Kind Name Without Warning #5485
Heavily inspired by issue Don't Remove Kind with Suffix List if Empty #5045

Feedback Request:

As someone new to Golang, I understand that this PR might not be perfect. I welcome any guidance, suggestions, or improvements from the community to refine this feature further.

linux-foundation-easycla · 2024-08-11T14:46:50Z

The committers listed above are authorized under a signed CLA.

✅ login: isarns / name: Isar_NS (a5f43ec, 77daec8, bbb0b08, e6266d4, a1fd6ef)

k8s-ci-robot · 2024-08-11T14:46:52Z

Hi @isarns. 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-sigs/prow repository.

koba1t · 2024-08-12T19:43:32Z

Hi @isarns
Thanks for your contribution!

I read the issue, but I think we should try another approach from this PR.
I think the current problem is that kustomize recognizes it as a List resource for all resources with a name of the *List.
ref: #5042 (comment)

I believe the better way is the cailynse's approach that changes to recognize *List.
Due to
#5045

kustomize/api/resource/factory.go

Line 193 in cc9dd34

if !strings.HasSuffix(kind, "List") {

FYI: We already have API schemes on here.

Could you change to use the above approach to this PR?
I appreciate you taking this Problem!

k8s-ci-robot · 2024-08-13T11:35:54Z

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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-sigs/prow repository.

isarns · 2024-08-13T11:37:37Z

@koba1t Thanks for the reply.

I have refactored my PR.
Added another test that take a "Real" list object and check that kustomize create the individual resources from it.

koba1t

@isarns
Thanks for fixing your PR!
I added one comment. Could you check that?

api/resource/factory.go

isarns · 2024-08-18T11:59:52Z

@koba1t Thanks.

I checked what current kustomize does with an empty “real” list, and it returns an empty response (No resource).
The same happens with my PR.

chkp-tron · 2024-08-22T08:41:38Z

Really looking forward to this

isarns · 2024-09-08T07:03:14Z

Hey @koba1t.

Can you have another look, please?

koba1t · 2024-09-08T20:50:10Z

@isarns
Sorry for delay to review.
Thank you for your response. I'll check.

koba1t · 2024-09-08T20:50:40Z

/ok-to-test

koba1t · 2024-09-08T20:52:57Z

Hi @isarns
Could you fix lint errors and test failure?

isarns · 2024-09-09T11:03:39Z

Hi @isarns Could you fix lint errors and test failure?

Thanks! Fixed those.

koba1t · 2024-09-12T17:48:45Z

@isarns
Thanks for your contribution!

/lgtm
/approve

k8s-ci-robot · 2024-09-12T17:48:57Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: isarns, koba1t

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~~ [koba1t]

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

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [kubernetes-sigs/kustomize](https://github.com/kubernetes-sigs/kustomize) | minor | `v5.4.3` -> `v5.5.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>kubernetes-sigs/kustomize (kubernetes-sigs/kustomize)</summary> ### [`v5.5.0`](https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize/v5.5.0) [Compare Source](kubernetes-sigs/kustomize@kustomize/v5.4.3...kustomize/v5.5.0) ### Breaking change A starlark support for krm functions was removed to cleanup dependencies. kubernetes-sigs/kustomize#5768 This feature was deprecated 3 years ago and removed because there was no desire to continue using it. kubernetes-sigs/kustomize#5768 (comment) #### Feature [#5751](kubernetes-sigs/kustomize#5751): Add `--helm-debug` Flag to Kustomize for Enhanced Helm Debugging #### Fix Bugs [#5458](kubernetes-sigs/kustomize#5458): Sort built-in Namespace kind before CRDs with the same name [#5745](kubernetes-sigs/kustomize#5745): Add Annotation to Control Inline List Conversion in Kustomize Resources" #### Dependencies [#5763](kubernetes-sigs/kustomize#5763): Update go 1.22.7 [#5781](kubernetes-sigs/kustomize#5781): Update kyaml to v0.18.1 [#5782](kubernetes-sigs/kustomize#5782): Update cmd/config to v0.15.0 [#5783](kubernetes-sigs/kustomize#5783): Update api to v0.18.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

feat: annotation to disable list conversion

a1fd6ef

k8s-ci-robot requested review from koba1t and stormqueen1990 August 11, 2024 14:46

refactor: inlineAnyEmbeddedLists

77daec8

koba1t requested changes Aug 16, 2024

View reviewed changes

api/resource/factory.go Show resolved Hide resolved

test: add empty list test

bbb0b08

isarns requested a review from koba1t September 2, 2024 09:11

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 8, 2024

isarns added 2 commits September 9, 2024 13:26

refactor: fix test with not 'items:'

e6266d4

style: linting

a5f43ec

k8s-ci-robot assigned koba1t Sep 12, 2024

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

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

k8s-ci-robot merged commit c3872ce into kubernetes-sigs:master Sep 12, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Annotation to Control Inline List Conversion in Kustomize Resources" #5745

Add Annotation to Control Inline List Conversion in Kustomize Resources" #5745

isarns commented Aug 11, 2024

linux-foundation-easycla bot commented Aug 11, 2024 •

edited

Loading

k8s-ci-robot commented Aug 11, 2024

koba1t commented Aug 12, 2024

k8s-ci-robot commented Aug 13, 2024

isarns commented Aug 13, 2024

koba1t left a comment

isarns commented Aug 18, 2024

chkp-tron commented Aug 22, 2024

isarns commented Sep 8, 2024

koba1t commented Sep 8, 2024 •

edited

Loading

koba1t commented Sep 8, 2024

koba1t commented Sep 8, 2024 •

edited

Loading

isarns commented Sep 9, 2024

koba1t commented Sep 12, 2024

k8s-ci-robot commented Sep 12, 2024

Add Annotation to Control Inline List Conversion in Kustomize Resources" #5745

Add Annotation to Control Inline List Conversion in Kustomize Resources" #5745

Conversation

isarns commented Aug 11, 2024

Changes:

Example:

Issues Addressed:

Feedback Request:

linux-foundation-easycla bot commented Aug 11, 2024 • edited Loading

k8s-ci-robot commented Aug 11, 2024

koba1t commented Aug 12, 2024

k8s-ci-robot commented Aug 13, 2024

isarns commented Aug 13, 2024

koba1t left a comment

Choose a reason for hiding this comment

isarns commented Aug 18, 2024

chkp-tron commented Aug 22, 2024

isarns commented Sep 8, 2024

koba1t commented Sep 8, 2024 • edited Loading

koba1t commented Sep 8, 2024

koba1t commented Sep 8, 2024 • edited Loading

isarns commented Sep 9, 2024

koba1t commented Sep 12, 2024

k8s-ci-robot commented Sep 12, 2024

linux-foundation-easycla bot commented Aug 11, 2024 •

edited

Loading

koba1t commented Sep 8, 2024 •

edited

Loading

koba1t commented Sep 8, 2024 •

edited

Loading