Kubebuilder is not listed in prerequisites

[deepak1725]

Bug Report

Kubebuilder is Tightly coupled in requirements, which is fine but...

1. kubebuilder is not listed in Prerequisites
2. make docker-build ... expects kubebuilder in usr/local/kubebuilder only otherwise it raises an error, which I don't think is a good idea. User may have kubebuilder anywhere in PATH.

What did you do?
make docker-build $IMG

What did you expect to see?
resolves kubebuilder from $PATH not from any Specific Location.

What did you see instead? Under which circumstances?

Failure [0.002 seconds]
[BeforeSuite] BeforeSuite 
/home/deepak/projects/go/src/operator/newoperator3/final/crda-operator/controllers/suite_test.go:52

  Unexpected error:
      <*fmt.wrapError | 0xc00046c2a0>: {
          msg: "failed to start the controlplane. retried 5 times: fork/exec /usr/local/kubebuilder/bin/etcd: no such file or directory",
          err: {
              Op: "fork/exec",
              Path: "/usr/local/kubebuilder/bin/etcd",
              Err: 0x2,
          },
      }
      failed to start the controlplane. retried 5 times: fork/exec /usr/local/kubebuilder/bin/etcd: no such file or directory
  occurred

  /home/deepak/projects/go/src/operator/newoperator3/final/crda-operator/controllers/suite_test.go:62
------------------------------


Ran 0 of 0 Specs in 0.002 seconds
FAIL! -- 0 Passed | 0 Failed | 0 Pending | 0 Skipped
--- FAIL: TestAPIs (0.00s)
FAIL
coverage: 0.0% of statements
FAIL    github.com/deepak1725/crda-operator/controllers 0.010s
FAIL
make: *** [Makefile:30: test] Error 1

Environment

• operator-sdk version: 0.19

• go version: 0.14

• Kubernetes version information: 1.18

• Kubernetes cluster kind: minikube

• Are you writing your operator in ansible, helm, or go? go

Possible Solution

Additional context
Add any other context about the problem here.

[camilamacedo86]

Hi @deepak1725,

I am unable to reproduce this issue. Kubebuilder should not be a pre-requirement and shows that your project is asking its binary to setup the Env Test.

Could you please let us know the steps performed to generate this issue? Could you please let me know if you have kubebuilder installed when you create the project?

[deepak1725]

@camilamacedo86
My System didn't had kubebuilder

Steps:

• I tried make docker-build $IMG

• Got Error: As Specified above.

• then I installed it in the separate Path than specified in Official Kubebuilder docs.
  ie. I installed in /usr/local/bin/kubebuilder instead of /usr/local/kubebuilder/

• Exported Kubebuilder and it is recognized from every end of PC.

• I tried again make docker-build $IMG, but the error was still not resolved.

• Finally I have moved binaries from my custom path to officially specified Kubebuilder path, which finally Resolves Error.

• Conclusion acc. to me:
  SDK has Hard-Coded Kubebuilder path which relies solely on Official specified Path.

[camilamacedo86]

Hi @deepak1725,

Really thank you for raise that. As you know, SDK is in a process to be integrated with KB which means that its project layouts will be aligned. More info : Integrating Kubebuilder and Operator SDK. But, IMHO kubebuilder cannot be set as a pre-requirement because the kubebuilder version used by SDK as dependency can be diff of the version installed.

The problem faced by you is because Env Test requires the apiserver, kubectl and etcd binaries to run and these are shipped with kubebuilder binary. You can customize its set up to use them from another location as well. To understand it further as to see how you can change its conjugation see: kubernetes-sigs/kubebuilder#686 (comment).

We will discuss this scenario in the bug triage meeting on Monday. Feel free to attend if you wish.

[camilamacedo86]

PR to fix it for v3 in Kubebuilder; kubernetes-sigs/kubebuilder#1600

[camilamacedo86]

Hi @deepak1725,

See that we added a script to upstream to do this setup and we have a pr against master #3510 and against 0.19.x #3517 to update the docs.