GA: Promote Kustomization API to `kustomize.toolkit.fluxcd.io/v1` by stefanprodan · Pull Request #822 · fluxcd/kustomize-controller

stefanprodan · 2023-03-29T13:37:13Z

API changes

The Kustomization kind was promoted from v1beta2 to v1 (GA) and deprecated fields were removed.

The kustomizations.source.toolkit.fluxcd.io CRD contains the following versions:

v1 (storage version)
v1beta2 (deprecated)
v1beta1 (deprecated)

Upgrade

The Kustomization v1 API is backwards compatible with v1beta2 with the following exceptions:

the deprecated field .spec.validation was removed
the deprecated field .spec.patchesStrategicMerge was removed (replaced by .spec.patches)
the deprecated field .spec.patchesJson6902 was removed (replaced by .spec.patches)

To upgrade from v1beta2, after deploying the new CRD and controller, set apiVersion: kustomize.toolkit.fluxcd.io/v1 in the YAML files that contain Kustomization definitions and remove the deprecated fields if any. Bumping the API version in manifests can be done gradually. It is advised to not delay this procedure as the beta versions will be removed after 6 months.

Closes: #755
Closes: #664

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

hiddeco

This looks good enough to me to be released.

In terms of the spec doc, I think it could use another proof read to see if more interlinking between sections is possible, and to align tone of voice between different sections. In addition to reducing the usage of "kustomize-controller" as at some point based on the context it can just be called "controller", and other nits like this. But not blocking to move forward, as structure wise it's 💯.

Thanks @stefanprodan and @aryan9600 🙇 🥇

aryan9600 · 2023-03-31T11:42:38Z

I think it could use another proof read to see if more interlinking between sections is possible

i completely agree. one particular instance that comes to mind is how can we make the sops guide and the decryption section more compatible/co-existent?

hiddeco · 2023-03-31T11:48:05Z

Another thing I ran into is that we first talk about

By default, a Kustomization apply runs under the cluster admin account [...]

but then later have a section on how this default can be changed. I think this should eventually be rewritten in a way which brings the override more to the foreground, as people who read lazily may have had their alarm bells ring before they actually notice this.

darkowlzz

Left some suggestions in the API spec doc. There are some references of GitRepository instead of Kustomization which need to be fixed, but the other suggestions can be used or ignored as they may be subjective.

Signed-off-by: Hidde Beydals <hidde@hhh.computer>

darkowlzz

LGTM!

docs index is now fixed

Promote Kustomization API to v1

29d25a4

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

stefanprodan added this to the Bootstrap GA milestone Mar 29, 2023

stefanprodan mentioned this pull request Mar 29, 2023

GA: Promote Receiver API to notification.toolkit.fluxcd.io/v1 fluxcd/notification-controller#498

Merged

2 tasks

stefanprodan added area/docs Documentation related issues and pull requests area/kustomize Kustomize related issues and pull requests labels Mar 29, 2023

aryan9600 force-pushed the api-v1 branch from 898a270 to 309abca Compare March 29, 2023 17:16

aryan9600 reviewed Mar 29, 2023

View reviewed changes

Comment thread docs/spec/v1/kustomization.md Outdated

aryan9600 force-pushed the api-v1 branch 2 times, most recently from a091558 to 67f19f2 Compare March 30, 2023 05:19

makkes reviewed Mar 30, 2023

View reviewed changes

Comment thread docs/spec/v1/kustomization.md

Comment thread docs/api/kustomize.md

Sanskar Jaiswal and others added 2 commits March 30, 2023 19:42

docs: add Kustomization v1 docs

793450f

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

Version API generated docs

172adf6

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

aryan9600 force-pushed the api-v1 branch from 8a19967 to 172adf6 Compare March 30, 2023 14:12

darkowlzz reviewed Mar 30, 2023

View reviewed changes

Comment thread api/v1/condition_types.go Outdated

stefanprodan force-pushed the api-v1 branch from 75ed2ab to 03041eb Compare March 30, 2023 14:38

darkowlzz reviewed Mar 30, 2023

View reviewed changes

Comment thread api/v1/groupversion_info.go Outdated

darkowlzz reviewed Mar 30, 2023

View reviewed changes

Comment thread api/v1/kustomization_types.go Outdated

stefanprodan force-pushed the api-v1 branch from 03041eb to 82d4733 Compare March 30, 2023 15:00

Update Source APIs to v1.0.0-rc.1

4ed5082

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

stefanprodan force-pushed the api-v1 branch from 82d4733 to 4ed5082 Compare March 30, 2023 15:25

stefanprodan added 2 commits March 30, 2023 18:45

Use conditions from fluxcd/pkg/apis/meta@v1.0.0

d6c69d4

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

Update e2e tests to v1 APIs

d456f31

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

darkowlzz reviewed Mar 30, 2023

View reviewed changes

Comment thread config/testdata/dependencies/source.yaml

Comment thread config/testdata/impersonation/test.yaml

Comment thread config/testdata/overlays/production.yaml

Comment thread main.go

aryan9600 added 4 commits March 31, 2023 13:14

update config/testdata to use source v1 and kustomize v1

7df47e6

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

register source v1beta2 scheme

acead16

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

remove deprecated field validation from test data

794558e

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

change path to root for e2e oci test

f8711dc

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

stefanprodan marked this pull request as ready for review March 31, 2023 09:24

hiddeco force-pushed the api-v1 branch 2 times, most recently from e56c397 to 9764b8d Compare March 31, 2023 11:14

hiddeco approved these changes Mar 31, 2023

View reviewed changes

Comment thread api/v1/inventory_types.go Outdated

Comment thread api/v1/kustomization_types.go Outdated

Comment thread api/v1/reference_types.go Outdated

Comment thread docs/spec/v1/kustomization.md Outdated

darkowlzz reviewed Mar 31, 2023

View reviewed changes

Comment thread docs/spec/v1/README.md

Comment thread internal/decryptor/decryptor.go

aryan9600 reviewed Mar 31, 2023

View reviewed changes

Comment thread docs/spec/v1/kustomization.md

aryan9600 previously requested changes Mar 31, 2023

View reviewed changes

Comment thread docs/spec/v1/README.md Outdated

darkowlzz reviewed Mar 31, 2023

View reviewed changes

hiddeco force-pushed the api-v1 branch 3 times, most recently from 2fc216b to a91e6a6 Compare March 31, 2023 15:22

api/docs: various nits and typos

ae00400

Signed-off-by: Hidde Beydals <hidde@hhh.computer>

hiddeco force-pushed the api-v1 branch from a91e6a6 to ae00400 Compare March 31, 2023 15:24

darkowlzz approved these changes Mar 31, 2023

View reviewed changes

stefanprodan requested a review from aryan9600 March 31, 2023 16:59

aryan9600 approved these changes Apr 1, 2023

View reviewed changes

stefanprodan merged commit 6f8514b into main Apr 3, 2023

stefanprodan deleted the api-v1 branch April 3, 2023 06:56

Conversation

stefanprodan commented Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API changes

Upgrade

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hiddeco left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aryan9600 commented Mar 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hiddeco commented Mar 31, 2023

Uh oh!

Uh oh!

Uh oh!

darkowlzz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

darkowlzz left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

stefanprodan commented Mar 29, 2023 •

edited

Loading

hiddeco left a comment •

edited

Loading

aryan9600 commented Mar 31, 2023 •

edited

Loading