📖 refactor: finalizer in CronJob example #4397

lorenzofelletti · 2024-11-26T22:28:23Z

Description

Refactor CronJob sample code to follow the structure and best practices introduced by the DeployImage plugin.

Motivation

Follow best practices, and provide an example that works without incurring in errors like trying to do a second update without re-fetching the resource.

References

Refactor CronJob and MultiVersion Sample Code to Align with DeployImage Plugin Scaffold Structure #4291.

k8s-ci-robot · 2024-11-26T22:28:28Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: lorenzofelletti
Once this PR has been reviewed and has the lgtm label, please assign camilamacedo86 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2024-11-26T22:28:32Z

Hi @lorenzofelletti. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

camilamacedo86 · 2024-11-27T02:52:27Z

docs/book/src/cronjob-tutorial/testdata/finalizer_example.go

+			if err := r.Get(ctx, req.NamespacedName, cronJob); err != nil {
+				log.Error(err, "unable to fetch CronJob")
+				return ctrl.Result{}, client.IgnoreNotFound(err)
+			}


Thank you for the contribution 🥇

See that:

We need to change the code under hack/docs so that when we run make generate-docs we re-scaffold all and just add the right code on top to ensure that all is always updated.

Therefore, can you please add the code there and run the command to ensure that all is fine?

Indeed it will result in multi-version and crojob tutorial changed when you run make generate-docs

camilamacedo86

Really thank you to looking on that, see: https://github.com/kubernetes-sigs/kubebuilder/pull/4397/files#r1859746824

mateusoliveira43 · 2024-11-27T20:02:32Z

docs/book/src/cronjob-tutorial/testdata/finalizer_example.go

+			log.Info("Adding Finalizer for CronJob")
+			if ok := controllerutil.AddFinalizer(cronJob, myFinalizerName); !ok {
+				log.Error(err, "Failed to add finalizer into the custom resource")
+				return ctrl.Result{Requeue: true}, nil


would not be semantically better to error out here? For example

return ctrl.Result{}, fmt.Errorf("message")

We have no error acctually, right?
The code should create an error and then return as you suggested
@mateusoliveira43 would you like to help us by doing this change in the deploy image plugin?

sure, will try to make changes there

mateusoliveira43 · 2024-11-27T20:04:02Z

docs/book/src/cronjob-tutorial/testdata/finalizer_example.go

+			// state of the resource, and avoid the error "the object has been modified,
+			// please apply your changes to the latest version and try again".
+			if err := r.Get(ctx, req.NamespacedName, cronJob); err != nil {
+				log.Error(err, "unable to fetch CronJob")


would be better to say re-fetch here?

mateusoliveira43 · 2024-11-27T20:06:55Z

docs/book/src/cronjob-tutorial/testdata/finalizer_example.go

+			// please apply your changes to the latest version and try again".
+			if err := r.Get(ctx, req.NamespacedName, cronJob); err != nil {
+				log.Error(err, "unable to fetch CronJob")
+				return ctrl.Result{}, client.IgnoreNotFound(err)


would not be better to always error out here?

Yes you are right. We need to change it in the deploy image too.

may I ask why? If in the meantime the resource was deleted shouldn't that be ignored?

On top we should have : https://github.com/kubernetes-sigs/kubebuilder/blob/cbc6e383c342f1337ab37ee4aa0755957a01f9c7/testdata/project-v4-with-plugins/internal/controller/busybox_controller.go#L84C2-L99C3

If the resource is deleted, then the reconciliation stop at this point.

What we need to do is fix the tutorials to have the structure of https://github.com/kubernetes-sigs/kubebuilder/blob/master/testdata/project-v4-with-plugins/internal/controller/busybox_controller.go

The changes here seems for me either incomplete if we address only the finalizer

lorenzofelletti · 2024-11-28T23:13:05Z

Since there's a lot of rework to do on this one, I'll convert it to a draft for the moment

camilamacedo86 · 2024-11-29T17:58:38Z

docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller.go

+			log.Error(err, "Failed to re-fetch CronJob")
+			return ctrl.Result{}, err
+		}
+	}


@lorenzofelletti Yep, that is the idea!!!
Thank you a lot

mateusoliveira43 · 2024-12-02T18:50:20Z

My bad, this PR should not be closed, but I referenced a comment from it and bot closed it

@lorenzofelletti can you reopen it?

lorenzofelletti · 2024-12-02T19:03:49Z

don't have the permissions to re-open it haha

camilamacedo86 · 2024-12-11T05:08:33Z

docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller.go

@@ -500,7 +536,7 @@ func (r *CronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 	// +kubebuilder:docs-gen:collapse=constructJobForCronJob

 	// actually make the job...
-	job, err := constructJobForCronJob(&cronJob, missedRun)
+	job, err := constructJobForCronJob(cronJob, missedRun)


Hi @lorenzofelletti

In a way that I would do that is: (see that this task is not so trivial, you need attention to details and use a lot the IDE to compare)

Do the changes in the testdata samples directly as you are doing

It is possible compare the code implementation of the book samples with the samples under testdata/p see the code for Memcached and busybox which uses the deploy image plugin and is generated by: https://github.com/kubernetes-sigs/kubebuilder/blob/master/test/testdata/generate.sh

Then, you can push a PR against your on fork.
See that the samples are tested in the CI here: https://github.com/kubernetes-sigs/kubebuilder/blob/master/.github/workflows/test-e2e-book.yml

If this workflow passes, then you can use the code changes.
Note that the test data check will fail because we generate the code of the book samples by running the commands and injecting the code on top. The whole code implementation for it is here: https://github.com/kubernetes-sigs/kubebuilder/tree/master/hack/docs/internal

When we call make generate-docs, the scripts are called, the projects generated, and the changes made afterwards; it ensures that the docs are always updated with the latest changes.

But we can do it step by step.

Hi @camilamacedo86!

Thanks for taking the time to write these instructions. I'll follow them and come back when I have something to share.

lorenzofelletti added 2 commits November 19, 2024 23:47

refactor: finalizer example

99da1bb

refactor: finalizer example to re-fetch after updating resource

5bdafe0

k8s-ci-robot requested a review from camilamacedo86 November 26, 2024 22:28

k8s-ci-robot requested a review from varshaprasad96 November 26, 2024 22:28

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 26, 2024

camilamacedo86 reviewed Nov 27, 2024

View reviewed changes

camilamacedo86 requested changes Nov 27, 2024

View reviewed changes

mateusoliveira43 reviewed Nov 27, 2024

View reviewed changes

lorenzofelletti marked this pull request as draft November 28, 2024 23:13

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 28, 2024

feat: add status condition to CronJob example

c767eca

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 28, 2024

mateusoliveira43 mentioned this pull request Nov 29, 2024

✨ (deployimage/v1alpha1): Improve error handling and pointer usage for value setting in controller #4399

Merged

camilamacedo86 reviewed Nov 29, 2024

View reviewed changes

k8s-ci-robot closed this in #4399 Dec 2, 2024

camilamacedo86 reopened this Dec 2, 2024

fix: remove double reference

44088d9

camilamacedo86 reviewed Dec 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 refactor: finalizer in CronJob example #4397

📖 refactor: finalizer in CronJob example #4397

lorenzofelletti commented Nov 26, 2024 •

edited

Loading

k8s-ci-robot commented Nov 26, 2024

k8s-ci-robot commented Nov 26, 2024

camilamacedo86 Nov 27, 2024 •

edited

Loading

camilamacedo86 Nov 27, 2024

camilamacedo86 left a comment

mateusoliveira43 Nov 27, 2024

camilamacedo86 Nov 27, 2024

mateusoliveira43 Nov 28, 2024

mateusoliveira43 Nov 27, 2024

mateusoliveira43 Nov 27, 2024

camilamacedo86 Nov 27, 2024

lorenzofelletti Nov 28, 2024

camilamacedo86 Nov 28, 2024

lorenzofelletti commented Nov 28, 2024

camilamacedo86 Nov 29, 2024

mateusoliveira43 commented Dec 2, 2024

lorenzofelletti commented Dec 2, 2024

camilamacedo86 Dec 11, 2024

lorenzofelletti Dec 11, 2024

📖 refactor: finalizer in CronJob example #4397

Are you sure you want to change the base?

📖 refactor: finalizer in CronJob example #4397

Conversation

lorenzofelletti commented Nov 26, 2024 • edited Loading

Description

Motivation

References

k8s-ci-robot commented Nov 26, 2024

k8s-ci-robot commented Nov 26, 2024

camilamacedo86 Nov 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lorenzofelletti commented Nov 28, 2024

Choose a reason for hiding this comment

mateusoliveira43 commented Dec 2, 2024

lorenzofelletti commented Dec 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lorenzofelletti commented Nov 26, 2024 •

edited

Loading

camilamacedo86 Nov 27, 2024 •

edited

Loading