🐛 Make kubebuilder go install-able #4481

migueleliasweb · 2025-01-10T03:11:57Z

This PR makes kubebuilder go installable.

Changes:

Renamed main package originally from cmd/ to cmd
Renamed main function previously inside cmd/cmg.go to Run - following Go Cobra's pattern
Created new main file at the root of the project
Renamed package on doc.go to main
Fixed building make build target
Fixed GoReleaser config

k8s-ci-robot · 2025-01-10T03:12:07Z

Welcome @migueleliasweb!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-01-10T03:12:07Z

Hi @migueleliasweb. 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.

doc.go

Makefile

camilamacedo86 · 2025-01-12T12:27:54Z

/ok-to-test

camilamacedo86 · 2025-01-12T12:34:00Z

Hi @migueleliasweb

You can see that the changes made broke the e2e tests.
The [pull-kubebuilder-e2e-k8s-1-32-0](https://prow.k8s.io/view/gs/kubernetes-ci-logs/pr-logs/pull/kubernetes-sigs_kubebuilder/4481/pull-kubebuilder-e2e-k8s-1-32-0/1878418648549298176) you can ignore because it is a bug with prow and the 1.32 is not working yet.

But all other failures would be required be solved

migueleliasweb · 2025-01-12T12:46:27Z

I'll have a look at the failing tests tomorrow 🫡

cmd/version.go

camilamacedo86

Hi @migueleliasweb

I think to get this one merged we just need:

a) address this comment https://github.com/kubernetes-sigs/kubebuilder/pull/4481/files#r1920699959.

b) can you please squash the commits? we have the policy of 1 commit per PR

c) we should get this one merged #4504 and then this one here rebased with so you will add the main.go in the root. If we need to revert for any reason that will be helpful, thank you a lot 🥇

Than you a lot for your help here.

cmd/version.go

camilamacedo86 · 2025-01-19T23:11:52Z

Hi @migueleliasweb

Can you please squash the commits so we can get this one merged?

migueleliasweb · 2025-01-19T23:51:22Z

Hi @migueleliasweb

Can you please squash the commits so we can get this one merged?

Will do!

Do you think, maybe after this PR is merged, small changes to the docs should be done to mention the new installation method?

Closes 4079 (Make kubebuilder go install-able) Signed-off-by: Miguel Elias dos Santos <[email protected]>

camilamacedo86 · 2025-01-20T11:39:08Z

Hi @migueleliasweb you can ignore the fail on 1.32 :
The issue is in the prown: https://kubernetes.slack.com/archives/C09QZ4DQB/p1737373079194649

camilamacedo86 · 2025-01-20T13:55:45Z

Hi @migueleliasweb

I am thinking about how we can test this one.
So, could you please let us know how you check that after those changes would be able to go install the project?

migueleliasweb · 2025-01-21T00:51:48Z

Hi @migueleliasweb

I am thinking about how we can test this one. So, could you please let us know how you check that after those changes would be able to go install the project?

Hi @camilamacedo86 . I reckon the quickest option here would be to merge and then get the hash of the commit so we can then issue a: go install -v sigs.k8s.io/kubebuilder/v4@<hash>. We can then quickly check if the binary is installed and named correctly.

The slightly more safe option would be to merge this onto a separate branch within kubebuilder. This would be enough for us to test it with: go install -v sigs.k8s.io/kubebuilder/v4@<branch-name>. Note that we can do this today with: go install -v sigs.k8s.io/kubebuilder/v4/[email protected] but the outcode is a cmd binary instead of kubebuilder 😬 .

Given the current setup we have in cmd/version.go some build info might not be set correctly.

I've made a POC in https://github.com/migueleliasweb/go-installable/ so you can see how we would get as much information as possible from the build info during a go install.

The TL;DR is that we have a few ways to run kubebuilder:

With go run locally after cloning the repo
With go build -o kubebuilder and then ./kubebuilder
With go install sigs.k8s.io/kubebuilder/v4@<commit-hash-ref> (should generate a bin named kubebuilder)
With go install sigs.k8s.io/kubebuilder/v4@<release-ref> (should generate a bin named kubebuilder)

Give it a go with my POC and see how the behaviour is.

Try running:

go install -v github.com/migueleliasweb/[email protected]
go install -v github.com/migueleliasweb/go-installable@d91d9ebe30f987e0b9cc2690fd99c7f92ac1807a (this is the same commit hash as the tag v1.0.5)
go build -o go-installable and then go-installable
go run main.go

The same logic can be ported to kubebuilder if you think it's worth it.

camilamacedo86 · 2025-01-21T08:05:04Z

/override pull-kubebuilder-e2e-k8s-1-32-0

k8s-ci-robot · 2025-01-21T08:05:07Z

@camilamacedo86: Overrode contexts on behalf of camilamacedo86: pull-kubebuilder-e2e-k8s-1-32-0

In response to this:

/override pull-kubebuilder-e2e-k8s-1-32-0

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

/lgtm

k8s-ci-robot · 2025-01-21T08:56:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, migueleliasweb

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [camilamacedo86]

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

camilamacedo86 · 2025-01-21T09:03:05Z

/override pull-kubebuilder-e2e-k8s-1-32-0

k8s-ci-robot · 2025-01-21T09:03:08Z

@camilamacedo86: Overrode contexts on behalf of camilamacedo86: pull-kubebuilder-e2e-k8s-1-32-0

In response to this:

/override pull-kubebuilder-e2e-k8s-1-32-0

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.

* Make kubebuilder go-installable Closes 4079 (Make kubebuilder go install-able) Signed-off-by: Miguel Elias dos Santos <[email protected]> * 🐛 Fix Kubernetes version in the goreleaser by upgrading it from 1.31.0 to 1.32.0 * fix: webhook testEnv Signed-off-by: Mateus Oliveira <[email protected]> * fix: disallow files containing unwanted extension files when initializing a project * 📖 Bump sigs.k8s.io/kubebuilder/v4 Bumps [sigs.k8s.io/kubebuilder/v4](https://github.com/kubernetes-sigs/kubebuilder) from 4.4.0 to 4.5.0. - [Release notes](https://github.com/kubernetes-sigs/kubebuilder/releases) - [Changelog](https://github.com/kubernetes-sigs/kubebuilder/blob/master/RELEASE.md) - [Commits](v4.4.0...v4.5.0) --- updated-dependencies: - dependency-name: sigs.k8s.io/kubebuilder/v4 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * test: add to commmon.sh the latest k8s release 1.32 * Update yamllint target to handle missing dist/chart * doc: update the Artifacts with the latest changes on the EnvTest Makefile target configurations * ✨ Upgrade controller-runtime from v0.20.0 to v0.20.1 (#4528) Upgrade controller-runtime from v0.20.0 to v0.20.1 * 📖 bump github.com/spf13/pflag Bumps [github.com/spf13/pflag](https://github.com/spf13/pflag) from 1.0.5 to 1.0.6. - [Release notes](https://github.com/spf13/pflag/releases) - [Commits](spf13/pflag@v1.0.5...v1.0.6) --- updated-dependencies: - dependency-name: github.com/spf13/pflag dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * 🌱 bump github.com/spf13/pflag from 1.0.5 to 1.0.6 Bumps [github.com/spf13/pflag](https://github.com/spf13/pflag) from 1.0.5 to 1.0.6. - [Release notes](https://github.com/spf13/pflag/releases) - [Commits](spf13/pflag@v1.0.5...v1.0.6) --- updated-dependencies: - dependency-name: github.com/spf13/pflag dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * fix: correct minor typos in documentation * Removed Prometheus dependency from e2e scaffolds * 🐛(kustomize/v2): fix ServiceMonitor with TLS kustomize scaffolding * 📖 Remove simplistic advice about multiple controllers reconciling same CR (#4537) Remove simplistic advice about multiple controllers reconciling same CR This advice is simplyfing things and making an "It depends" situation look like there was a clear good and a clear bad way that is the same in all situations. Pretty much none of the issues stated will get better if each controller gets its own CR: * Race conditions: Conflict errors can always happen and all controllers need to be able to deal with them. If a full reconciliation is too expensive, they can use something like `retry.OnConflict` * Concurrency issues with different interpretations of state: This example sounds like just buggy software. Copying the state to a new CR doesn't eliminate this problem * Maintenance and support difficulties: This is definitely not going to get any better by adding more CRDs into the mix, if anything, it will get more complicated * Status tracking complications: This is why conditions exist and Kubernetes api guidelines explicitly state that controllers need to ignore unknown conditions: `Objects may report multiple conditions, and new types of conditions may be added in the future or by 3rd party controllers.`, [ref][0] * Performance issues: If multiple controllers do the same thing, that is a bug regardless of all other considerations and can easily lead to correctness and performance issues. The `workqueue` locks items while they are reconciled to avoid exactly that, but obviously it doesn't work cross-controller To illustrate the situation, think about the `Pod` object, in the lifecycle of a pod we usually have at least cluster-autoscaler, scheduler and kubelet. Making cluster-autoscaler act on a `PodScaleRequest` and scheduler on a `PodScheduleRequest` would be a complication, not a simplification. [0]: https://github.com/kubernetes/community/blob/322066e7dba7c5043071392fec427a57f8660734/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties * 🌱 ci: fix testdata - issues caused by some merge conflict with go mod (#4538) ci: fix testdata - issues caused by some merge conflict with go mod * Revert "Merge pull request #4512 from sarthaksarthak9/lint" (#4539) This reverts commit ded393e, reversing changes made to 543b4a1. * add context.Context to EnqueuRequestsFromMapFunc The underlying `TypedMapFunc` requires this argument, reference https://github.com/kubernetes-sigs/controller-runtime/blob/main/pkg/handler/enqueue_mapped.go#L36 * 🌱 bump golang.org/x/text from 0.21.0 to 0.22.0 Bumps [golang.org/x/text](https://github.com/golang/text) from 0.21.0 to 0.22.0. - [Release notes](https://github.com/golang/text/releases) - [Commits](golang/text@v0.21.0...v0.22.0) --- updated-dependencies: - dependency-name: golang.org/x/text dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * handle missing boilerplate file gracefully * 📖 Fix grammar in lets -> let's. * Update controller-runtime version used in the common.sh tests * Update Roadmap 2025 with latest status * 🌱 Improve samples linting & fix samples lint issues This commit includes: - Fix linter issues - Refactor fetchCronJob in sample controller reconcile func - Fix getting-started tutorial lint issues - Fix multiversion tutorial lint issues - Fix cronjob-tutorial lint issues - Refactor cronjob controller reconcile to reduce cyclomatic complexity * Revert "🐛 (kustomize/v2): fix ServiceMonitor with TLS kustomize scaffolding" * 🌱 Bump golang.org/x/tools from 0.29.0 to 0.30.0 Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.29.0 to 0.30.0. - [Release notes](https://github.com/golang/tools/releases) - [Commits](golang/tools@v0.29.0...v0.30.0) --- updated-dependencies: - dependency-name: golang.org/x/tools dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * ✨ Upgrade controller-gen from v0.17.1 to v0.17.2 (#4553) Upgrade controller-gen from v0.17.1 to v0.17.2 * (go/v4,ksutomize/v2,helm/v1-alpha): Fix prometheus integration with TLS check Co-Author: Abhisek Dwivedi <[email protected]> * Update alpha generate command so that --repo is always included when running kubebuilder init to fix issue when not on GOPATH * 🌱 fix testdata generation (#4569) fix testdata generation * 🌱 Bump github.com/spf13/cobra from 1.8.1 to 1.9.1 Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.8.1 to 1.9.1. - [Release notes](https://github.com/spf13/cobra/releases) - [Commits](spf13/cobra@v1.8.1...v1.9.1) --- updated-dependencies: - dependency-name: github.com/spf13/cobra dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * ✨ Upgrade controller-runtime from v0.20.1 to v0.20.2 (#4570) Upgrade controller-runtime from v0.20.1 to v0.20.2 and K8s version from v1.32.0 to 1.32.1 * Added e2e tests for alpha generate command for scaffolded data under testdata changes due to running make generate * Revert ":bug: Make kubebuilder go install-able" --------- Signed-off-by: Miguel Elias dos Santos <[email protected]> Signed-off-by: Mateus Oliveira <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Miguel Elias dos Santos <[email protected]> Co-authored-by: Kubernetes Prow Robot <[email protected]> Co-authored-by: Mateus Oliveira <[email protected]> Co-authored-by: Afzal Ansari <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: sarthaksarthak9 <[email protected]> Co-authored-by: sapphire <[email protected]> Co-authored-by: Anshuman <[email protected]> Co-authored-by: Abhisek Dwivedi <[email protected]> Co-authored-by: Alvaro Aleman <[email protected]> Co-authored-by: mwdomino <[email protected]> Co-authored-by: Thomas Guettler <[email protected]> Co-authored-by: Wazery <[email protected]> Co-authored-by: Freddy Esteban Perez <[email protected]> Co-authored-by: Manali Latkar <[email protected]>

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 10, 2025

k8s-ci-robot requested review from camilamacedo86 and varshaprasad96 January 10, 2025 03:12

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 10, 2025

migueleliasweb commented Jan 10, 2025

View reviewed changes

doc.go Outdated Show resolved Hide resolved

migueleliasweb changed the title ~~(:bug:) Make kubebuilder go install-able~~ 🐛 Make kubebuilder go install-able Jan 10, 2025

camilamacedo86 reviewed Jan 12, 2025

View reviewed changes

Makefile Show resolved Hide resolved

migueleliasweb requested a review from camilamacedo86 January 12, 2025 11:35

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 12, 2025

migueleliasweb force-pushed the make-go-install-able branch from a9a0a70 to cb4d09d Compare January 12, 2025 12:40

dmvolod reviewed Jan 16, 2025

View reviewed changes

cmd/version.go Show resolved Hide resolved

camilamacedo86 reviewed Jan 17, 2025

View reviewed changes

camilamacedo86 mentioned this pull request Jan 17, 2025

🌱 CLI: Remove unused doc.go #4504

Merged

camilamacedo86 requested a review from dmvolod January 17, 2025 22:07

migueleliasweb force-pushed the make-go-install-able branch from a1dee55 to 21ffbec Compare January 17, 2025 23:03

migueleliasweb requested a review from camilamacedo86 January 17, 2025 23:24

dmvolod reviewed Jan 18, 2025

View reviewed changes

cmd/version.go Outdated Show resolved Hide resolved

migueleliasweb requested a review from dmvolod January 18, 2025 12:33

migueleliasweb force-pushed the make-go-install-able branch from 459b70b to d6b316c Compare January 19, 2025 23:56

k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 19, 2025

Make kubebuilder go-installable

82fa6bb

Closes 4079 (Make kubebuilder go install-able) Signed-off-by: Miguel Elias dos Santos <[email protected]>

migueleliasweb force-pushed the make-go-install-able branch from d6b316c to 82fa6bb Compare January 20, 2025 00:00

k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 20, 2025

camilamacedo86 approved these changes Jan 21, 2025

View reviewed changes

k8s-ci-robot assigned camilamacedo86 Jan 21, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 21, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 21, 2025

k8s-ci-robot merged commit 7ee23df into kubernetes-sigs:master Jan 21, 2025
7 checks passed

This was referenced Feb 21, 2025

Unable to use Kubebuilder as go module and Version Injection Broken After PR #4481 with solution to allow it #4575

Closed

🐛 Revert "Make kubebuilder go install-able" #4576

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 Make kubebuilder go install-able #4481

🐛 Make kubebuilder go install-able #4481

migueleliasweb commented Jan 10, 2025

k8s-ci-robot commented Jan 10, 2025

k8s-ci-robot commented Jan 10, 2025

camilamacedo86 commented Jan 12, 2025

camilamacedo86 commented Jan 12, 2025

migueleliasweb commented Jan 12, 2025

camilamacedo86 left a comment

camilamacedo86 commented Jan 19, 2025

migueleliasweb commented Jan 19, 2025

camilamacedo86 commented Jan 20, 2025

camilamacedo86 commented Jan 20, 2025

migueleliasweb commented Jan 21, 2025 •

edited

Loading

camilamacedo86 commented Jan 21, 2025

k8s-ci-robot commented Jan 21, 2025

camilamacedo86 left a comment

k8s-ci-robot commented Jan 21, 2025

camilamacedo86 commented Jan 21, 2025

k8s-ci-robot commented Jan 21, 2025

🐛 Make kubebuilder go install-able #4481

🐛 Make kubebuilder go install-able #4481

Conversation

migueleliasweb commented Jan 10, 2025

k8s-ci-robot commented Jan 10, 2025

k8s-ci-robot commented Jan 10, 2025

camilamacedo86 commented Jan 12, 2025

camilamacedo86 commented Jan 12, 2025

migueleliasweb commented Jan 12, 2025

camilamacedo86 left a comment

Choose a reason for hiding this comment

camilamacedo86 commented Jan 19, 2025

migueleliasweb commented Jan 19, 2025

camilamacedo86 commented Jan 20, 2025

camilamacedo86 commented Jan 20, 2025

migueleliasweb commented Jan 21, 2025 • edited Loading

camilamacedo86 commented Jan 21, 2025

k8s-ci-robot commented Jan 21, 2025

camilamacedo86 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 21, 2025

camilamacedo86 commented Jan 21, 2025

k8s-ci-robot commented Jan 21, 2025

migueleliasweb commented Jan 21, 2025 •

edited

Loading