Skip to content

Kustomize KEP cleanup #2758

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jun 4, 2021
Merged

Kustomize KEP cleanup #2758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a103222
Update KEP 993
KnVerey May 19, 2021
69759a4
Update KEP 1802
KnVerey May 19, 2021
c25d222
Update KEP 2206
KnVerey May 19, 2021
621de99
Update KEP 2299
KnVerey May 19, 2021
5f679e9
Update KEP 2377
KnVerey May 19, 2021
f53995b
Update KEP 2383
KnVerey May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions keps/sig-cli/1802-kustomize-components/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,9 +605,9 @@ Add unit tests for all the points raised in the "Design details" section.

#### Alpha -> Beta

- [ ] Implement the necessary functionality for this feature
- [ ] Write the appropriate unit tests, and make the
[`TestComplexComposition_*`] tests now pass
- [x] Implement the necessary functionality for this feature
- [x] Write the appropriate unit tests, and make the
[`TestComplexComposition_*`](https://github.com/kubernetes-sigs/kustomize/blob/701973b73ecfb2b96f53cb3f080b9caaa662a01f/api/krusty/complexcomposition_test.go) tests now pass
- [x] Add a [user story] in Kustomize's examples
- [ ] Extend Kustomize's glossary with a reference to components, as well as
other places where overlays are mentioned
Expand All @@ -619,6 +619,8 @@ Add unit tests for all the points raised in the "Design details" section.

## Implementation History

- Available in Kustomize's alpha API group (`kustomize.config.k8s.io/v1alpha1`) in v3.7.0+. https://kubectl.docs.kubernetes.io/guides/config_management/components/

## Alternatives

Since the creation of the
Expand Down
16 changes: 7 additions & 9 deletions keps/sig-cli/1802-kustomize-components/kep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,13 @@ owning-sig: sig-cli
participating-sigs:
- sig-cli
reviewers:
- n/a
- "@pwittrock"
- "@monopole"
approvers:
- n/a
- "@pwittrock"
- "@monopole"
creation-date: 2020-05-20
last-updated: 2020-05-20
status: provisional
see-also:
- n/a
replaces:
- n/a
superseded-by:
- n/a
status: implemented
Copy link
Contributor

Choose a reason for hiding this comment

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

KEPs stay as implementable until they have graduated to stable. So this should move to implementable

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(ref #2758 (comment)) This one is a separate KRM type that you can import from a Kustomization. It has its own API version, which is alpha, but the kustomize CLI doesn't require any flags to use it. The author already closed the tracking issue on this repo.

Copy link
Member

Choose a reason for hiding this comment

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

Q: how does this move from provisional to implemented without passing through implementable? provisional means that it was not targeting to a release by the sig and that it wasn't officially approved for inclusion in a release.

Copy link
Member

Choose a reason for hiding this comment

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

Q: how does this move from provisional to implemented without passing through implementable? provisional means that it was not targeting to a release by the sig and that it wasn't officially approved for inclusion in a release.

I believe consensus was reached in the sig to move forward with this, the KEP just wasn't updated.

stage: alpha
latest-milestone: "v1.19"
12 changes: 7 additions & 5 deletions keps/sig-cli/2206-openapi-features-in-kustomize/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,11 +435,11 @@ Below are some examples to consider, in addition to the aforementioned [maturity

#### Alpha -> Beta Graduation

- Complete features required for this functionality
- read schema from openapi field of kustomization
- kustomize openapi fetch command
- Write appropriate unit tests for the above features
- Add documentation for these features
- [x] Complete features required for this functionality
- [x] Read schema from openapi field of kustomization
- [x] kustomize openapi fetch command
- [x] Write appropriate unit tests for the above features
- [x] Add documentation for these features


<!--
Expand Down Expand Up @@ -468,4 +468,6 @@ Major milestones might include:
- when the KEP was retired or superseded
-->

- The `openapi` field is available in Kustomization as of kustomize [v4.1.0](https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.1.0)


15 changes: 5 additions & 10 deletions keps/sig-cli/2206-openapi-features-in-kustomize/kep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,11 @@ reviewers:
- "@monopole"
- "@pwittrock"
approvers:
- n/a
- "@monopole"
- "@pwittrock"
creation-date: 2020-12-21
last-updated: 2020-01-15
status: implementable
see-also:
- n/a
replaces:
- n/a
superseded-by:
- n/a
status: implemented
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment about KEP status, applies to any that are not stable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TBH I find these values kinda tough to determine for Kustomize. Kustomize the CLI is stable (v4), but its main API, Kustomization, is beta, and almost all features are part of that API. To further complicate things, the API module for using Kustomize in other programs has its own version and is alpha. None of these versions are actually tied to the k/k release cycle... but periodically (very infrequently in the past, but hopefully that's changing) the version of kustomize in kubectl gets bumped. So... it's complicated, and doesn't line up super nicely with the lifecycle Enhancements was designed for. 😅

This particular feature is a field in Kustomization. It has been implemented and documented, and works without any feature gates. I'm sure it will evolve in small ways like any piece of code, but there's no major work remaining afaik. Therefore I don't see much value in holding the KEP open.

Copy link
Contributor

Choose a reason for hiding this comment

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

agree with @KnVerey, the work we intended to do with this KEP is done so I think it can be closed


latest-milestone: "0.0"
stage: "alpha"
latest-milestone: "1.22"
stage: "beta"
2 changes: 2 additions & 0 deletions keps/sig-cli/2299-kustomize-plugin-composition/kep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,7 @@ reviewers:
approvers:
- "@monopole"
- "@pwittrock"
see-also:
- "/keps/sig-cli/993-kustomize-generators-transformers"
stage: alpha
latest-milestone: "v1.22"
2 changes: 1 addition & 1 deletion keps/sig-cli/2377-Kustomize/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ better work with one another through transformation to a common format.
## Implementation History

kustomize was implemented in the kubectl repo before subprojects became a first class thing in Kubernetes.
The code has been fully implemented, but it must be moved to a proper location.
It was later moved to its own repo: https://github.com/kubernetes-sigs/kustomize. It is published as an independent CLI, and `kustomize build` is also available as `kubectl kustomize`. Some kubectl subcommands (e.g. apply) support Kustomization input via the `-k` flag.

## Drawbacks

Expand Down
8 changes: 5 additions & 3 deletions keps/sig-cli/2383-extend-kustomize-patches-to-multiple-targets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,11 @@ Update Kustomize and Kubectl docs with this new capability.
Unit test matching Resources and performing customizations.

## Implementation History
- Add `Patch` struct in `Kustomization` type.
- Update the patching transformer to recognize `Patch` and match
- [x] Add `Patch` struct in `Kustomization` type.
- [x] Update the patching transformer to recognize `Patch` and match
multiple resources
- Add unit test and integration test
- [x] Add unit test and integration test

This feature was released in [v3.1.0](https://kubernetes-sigs.github.io/kustomize/blog/2019/07/26/v3.1.0/) of kustomize.

## Alternatives
11 changes: 3 additions & 8 deletions keps/sig-cli/2383-extend-kustomize-patches-to-multiple-targets/kep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ approvers:
editor: "@Liujingfang1"
creation-date: 2019-03-14
last-updated: 2019-03-18
status: implementable
see-also:
replaces:
superseded-by:
- n/a

latest-milestone: "0.0"
stage: "alpha"
status: implemented
latest-milestone: "1.16"
stage: "beta"
1 change: 1 addition & 0 deletions keps/sig-cli/993-kustomize-generators-transformers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,7 @@ NA - Client side only

## Implementation History

- Alpha available in Kustomize (standalone binary, not kubectl kustomize) v2.1.0+ behind the `--enable-alpha-plugins` flag. https://kubectl.docs.kubernetes.io/blog/2019/06/18/v2.1.0/#generator-and-transformer-plugins
Copy link
Contributor Author

@KnVerey KnVerey May 19, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

@monopole can you confirm what the exact state is? I thought we had disabled plugins in kubectl entirely, but that's not the case. It seems like we removed --enable-star and --enable-exec specifically, but not the more general --enable-alpha-plugins gate. I manually checked that container-based transformers work. Do the legacy-style exec transformers work? Was that the intent? I'd like to leave a better note about this state here.


## Drawbacks [optional]

Expand Down
5 changes: 3 additions & 2 deletions keps/sig-cli/993-kustomize-generators-transformers/kep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ reviewers:
- "@sethpollack"
approvers:
- "@monopole"
editor: TBD
see-also:
- "/keps/sig-cli/2299-kustomize-plugin-composition"
creation-date: 2019-03-25
last-updated: 2019-04-30
status: implementable
status: implemented
latest-milestone: "1.20"
stage: "alpha"