Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GA: Promote Kustomization API to kustomize.toolkit.fluxcd.io/v1 #822

Merged
merged 11 commits into from
Apr 3, 2023

Conversation

stefanprodan
Copy link
Member

@stefanprodan stefanprodan commented Mar 29, 2023

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 <[email protected]>
@stefanprodan stefanprodan added this to the Bootstrap GA milestone Mar 29, 2023
@stefanprodan stefanprodan added area/docs Documentation related issues and pull requests area/kustomize Kustomize related issues and pull requests labels Mar 29, 2023
@aryan9600 aryan9600 force-pushed the api-v1 branch 2 times, most recently from a091558 to 67f19f2 Compare March 30, 2023 05:19
docs/spec/v1/kustomization.md Show resolved Hide resolved
docs/api/kustomize.md Show resolved Hide resolved
Sanskar Jaiswal and others added 2 commits March 30, 2023 19:42
Signed-off-by: Sanskar Jaiswal <[email protected]>
Signed-off-by: Stefan Prodan <[email protected]>
config/testdata/dependencies/source.yaml Outdated Show resolved Hide resolved
config/testdata/impersonation/test.yaml Show resolved Hide resolved
config/testdata/overlays/production.yaml Show resolved Hide resolved
main.go Show resolved Hide resolved
@stefanprodan stefanprodan marked this pull request as ready for review March 31, 2023 09:24
@hiddeco hiddeco force-pushed the api-v1 branch 2 times, most recently from e56c397 to 9764b8d Compare March 31, 2023 11:14
Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🙇 🥇

api/v1/inventory_types.go Outdated Show resolved Hide resolved
api/v1/kustomization_types.go Outdated Show resolved Hide resolved
api/v1/reference_types.go Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/README.md Show resolved Hide resolved
internal/decryptor/decryptor.go Outdated Show resolved Hide resolved
@aryan9600
Copy link
Member

aryan9600 commented Mar 31, 2023

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
Copy link
Member

hiddeco commented Mar 31, 2023

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.

docs/spec/v1/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
docs/spec/v1/kustomization.md Outdated Show resolved Hide resolved
@hiddeco hiddeco force-pushed the api-v1 branch 3 times, most recently from 2fc216b to a91e6a6 Compare March 31, 2023 15:22
Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@stefanprodan stefanprodan dismissed aryan9600’s stale review April 1, 2023 08:14

docs index is now fixed

@stefanprodan stefanprodan merged commit 6f8514b into main Apr 3, 2023
@stefanprodan stefanprodan deleted the api-v1 branch April 3, 2023 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests area/kustomize Kustomize related issues and pull requests
Projects
Archived in project
5 participants