Update Cronjob and Multiversion Tutorials samples to Use Status Conditions

[camilamacedo86]

What do you want to happen?

Currently, we have two samples used in the docs that share the same base:

• Cronjob: Cronjob Tutorial
• Multiversion: Multiversion Tutorial

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:

• Example Status Conditions in API

And here is how status conditions are handled in the controller:

• Example Status Conditions in Controller (Setting Status)
• Example Status Conditions in Controller (Updating Status)

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-L84

Extra Labels

No response

[lohitslohit]

@camilamacedo86 I am working on this..

[Bharadwajshivam28]

@camilamacedo86 I am working on this..
/assign

[chethanm99]

Hi @Bharadwajshivam28 are you still working on this issue ?

[chethanm99]

Hi @camilamacedo86 the example which is mentioned in the above issue which states the usage of status condition in the API definition shows not found, also there is no file such as project -v4-with-deploy-image within the testdata

[camilamacedo86]

Hi @chethanm99

The sample which uses the Deploy Image now is the with-plugins, the examples are:

• To update the status:

kubebuilder/testdata/project-v4-with-plugins/internal/controller/busybox_controller.go

Lines 102 to 119 in 9932c89

	// Let's just set the status as Unknown when no status is available
	if len(busybox.Status.Conditions) == 0 {
	meta.SetStatusCondition(&busybox.Status.Conditions, metav1.Condition{Type: typeAvailableBusybox, Status: metav1.ConditionUnknown, Reason: "Reconciling", Message: "Starting reconciliation"})
	if err = r.Status().Update(ctx, busybox); err != nil {
	log.Error(err, "Failed to update Busybox status")
	return ctrl.Result{}, err
	}
	// Let's re-fetch the busybox Custom Resource after updating the status
	// so that we have the latest state of the resource on the cluster and we will avoid
	// raising the error "the object has been modified, please apply
	// your changes to the latest version and try again" which would re-trigger the reconciliation
	// if we try to update it again in the following operations
	if err := r.Get(ctx, req.NamespacedName, busybox); err != nil {
	log.Error(err, "Failed to re-fetch busybox")
	return ctrl.Result{}, err
	}
	}

• To define in the API:

kubebuilder/testdata/project-v4-with-plugins/api/v1alpha1/busybox_types.go

Lines 41 to 52 in 9932c89

	type BusyboxStatus struct {
	// Represents the observations of a Busybox's current state.
	// Busybox.status.conditions.type are: "Available", "Progressing", and "Degraded"
	// Busybox.status.conditions.status are one of True, False, Unknown.
	// Busybox.status.conditions.reason the value should be a CamelCase string and producers of specific
	// condition types may define expected values and meanings for this field, and whether the values
	// are considered a guaranteed API.
	// Busybox.status.conditions.Message is a human readable message indicating details about the transition.
	// For further information see: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
	}