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

Remove package-wide kubebuilder:validation:optional annotation #4674

Merged
merged 3 commits into from
Jul 12, 2024

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Jun 25, 2024

Description

Kubebuilder will deduce the optional attribute from the JSON annotations, if unspecified. Add all the missing omitempty JSON annotations for truly optional fields, which is the right choice in 99% of the cases anyway. Also add some missing default annotations along the way.

Overall, this brings the CRDs more in sync to what k0s actually expects at runtime, while omitting the rendering of useless zero values in JSON/ YAML representations.

Convert the config in k0s config create to unstructured to be able to tweak the actual YAML. Remove the creationTimestamp from the output. Remove all the parts from the docs that don't show up in reality.

See:

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@twz123 twz123 added the chore label Jun 25, 2024
@twz123 twz123 force-pushed the kubebuilder-no-optional branch 3 times, most recently from 229e2f7 to d4e7a48 Compare June 28, 2024 11:10
@twz123 twz123 marked this pull request as ready for review June 28, 2024 12:21
@twz123 twz123 requested a review from a team as a code owner June 28, 2024 12:21
@twz123 twz123 requested review from kke and makhov June 28, 2024 12:21
Copy link
Contributor

github-actions bot commented Jul 5, 2024

This pull request has merge conflicts that need to be resolved.

Copy link
Contributor

This pull request has merge conflicts that need to be resolved.

Convert the config to unstructured to be able to tweak the actual YAML.
Remove the creationTimestamp from the output. Remove the omitempty
flag from the NLLB enabled field, so that it's false value makes it
into the output. Remove all the parts from the docs that don't show up
in reality.

Signed-off-by: Tom Wieczorek <[email protected]>
They had no effect on code generation, either because they repeated
contextual defaults or because they weren't applicable per se.

Signed-off-by: Tom Wieczorek <[email protected]>
Kubebuilder will deduce the optional attribute from the JSON
annotations, if unspecified. Add all the missing omitempty JSON
annotations for truly optional fields, which is the right choice in 99%
of the cases anyway. Also add some missing default annotations along the way.

Overall, this brings the CRDs more in sync to what k0s actually expects
at runtime, while omitting the rendering of useless zero values in JSON/
YAML representations.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 merged commit 2d3d216 into k0sproject:main Jul 12, 2024
83 checks passed
@twz123 twz123 deleted the kubebuilder-no-optional branch July 12, 2024 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants