Update Cronjob and Multiversion Tutorials samples to Use Status Conditions #4019
Labels
help wanted
Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
kind/feature
Categorizes issue or PR as related to a new feature.
lifecycle/frozen
Indicates that an issue or PR should not be auto-closed due to staleness.
What do you want to happen?
Currently, we have two samples used in the docs that share the same base:
In order to follow Kubernetes API Conventions and promote best practices, the status fields in these examples should use status conditions similar to those scaffolded by the Deploy Image Plugin.
Here is an example of using status conditions in the API definition:
And here is how status conditions are handled in the controller:
Proposal:
Update the Cronjob and Multiversion tutorials to incorporate StatusConditions as demonstrated in the examples provided. This will ensure that these tutorials are aligned with Kubernetes API conventions and serve as better references for best practices.
Important
See that for we change the CronjobTutorial we need to change the values in the hack. https://github.com/kubernetes-sigs/kubebuilder/tree/master/hack/docs/internal/cronjob-tutorial. The samples are generated and the code with the docs info is added on top when we run
make generate
. See the makefile target: https://github.com/kubernetes-sigs/kubebuilder/blob/master/Makefile#L82-L84Extra Labels
No response
The text was updated successfully, but these errors were encountered: