Kubebuilder: Missing Kustomize Dependency for `make install`

[kris-nova]

Fresh linux system, trying to go through the getting started

[nova@nova kapad]$ make install
/home/nova/go/bin/controller-gen "crd:trivialVersions=true" rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
kustomize build config/crd | kubectl apply -f -
/bin/sh: kustomize: command not found
error: no objects passed to apply
make: *** [Makefile:30: install] Error 1

Either docs that mention this, a check in make install, a better error message with a path forward, or including kustomize in the build/bin/ directory of a release

/kind bug

[droot]

Kubebuilder book mentions kustomize in prerequisites section in quick-start-guide.

Though better error message pointing to kustomize install page would be great help here.

[bharathi-tenneti]

/assign

[bharathi-tenneti]

@droot
Did you mean the check to be done in this file?
P.S New to this repo.

[camilamacedo86]

HI @bharathi-tenneti,

It is not about the makefile of the kubebuilder project. The makefile in the kubebuilder project are targets which are helpful for who will contribute with the project.

In this scenario, the user says Fresh linux system, trying to go through the getting started which means that he is following the Quick Started and the issue is faced in the step:

So, what @droot is suggesting here as the solution is:

Improve the error face in this scenario in order to allow users to know that the prerequisite kustomize is not installed. Also, I would recommend we solve it by checking the pre-requirement is install as we do for the Go version see: https://github.com/kubernetes-sigs/kubebuilder/blob/master/cmd/internal/go_version.go

[Adirio]

I agree with @camilamacedo86 that checking the dependency could be done. I don't think there is any other easy way to improve the error message, as it is a OS error not one we are printing, so we need to check for it before running any kustomize command.

[bharathi-tenneti]

@Adirio I agree that checking dependency can be done for kustomize.
However, if we go down the path, Should we go ahead an check for other pre-reqs as well?
Do we want to do that ?

[camilamacedo86]

@bharathi-tenneti,

Feel free to do. the. other checks if you see that would be nice. To close this one IHMO doing it for kustomize only would be enough.

[Adirio]

I also wanted to move this check out of kubebuilder init just to any kubebuilder command so that when you git clone an already init project you still get this check done for you.
I was working on this, but don't have the PR ready yet. Feel free to submit a PR with the fix, I didn't realize you had it assigned to yourself. I will do then the PR moving the checks to any command and also a small refactor to the go version check.

[dmizelle]

Eek. I didn't realize this was assigned to someone else (its 2AM here and I'm unable to sleep)

Didn't mean to step on someone else that was interested in doing this. I ran into this issue tonight as I just rely on kustomize built into kubectl usually. If you've already done this (or are working on it) just feel free to close my PR. :)

[bharathi-tenneti]

@dmizelle no worries, I have not got around to it yet, so go ahead.

[Adirio]

He made a proposal on #1427 and I made mine in #1428.

[toonsevrin]

Once #1430 is merged, kustomize will be installed automatically when not present in PATH.

[Adirio]

So we could either install or just check for the dependency. Both aproaches are being used currently: go version is checked while controller-gen is installed if not present. I'm not sure which of them feels better.

@mengqiy @droot @DirectXMan12 what approach do you prefer?

• Install the dependency: @camilamacedo86
• Check for the dependency but delegate installing to user:

[camilamacedo86]

Hi @Adirio,

I think that go is a pre-requirement that could not be changed. However, doing it by the Makefile allows the user to customize it which shows more appropriate in this case. So, I am inclined to say for we forward with #1430.

[toonsevrin]

I've commented this on #1430, but ideally the dependencies like controller-gen and kustomize should only be installed locally (eg. local to the project). This could be in ${PROJECT_DIR}/bin for example.

As they are internal dependencies in my opinion, they should not change the external environment (and ideally not be influenced by it either, all though that would break backwards compatibility).

Anyways, this is perfectionistic, so I would simply go with #1430 as well!

[Adirio]

I do agree that having a bin folder with local dependencies sounds better than globally installed. But until we opt into thta approach, I would not install things for users, I would just check if they are installed. Basically because we are changing their global system and not just our local directory.

[camilamacedo86]

IHMO, the kustomize is a requirement dependence such as the controller-gen and the solution in #1430 make it easier for the users and bring better experience, also address the issue raised here and still allowing users customize it according to their needs since the implementation is in the makefile. Then, I cannot see any reason why not move forward with #1430.

@mengqiy @DirectXMan12 wdyt ?

[Adirio]

@droot @mengqiy @DirectXMan12 would you mind answering the poll raised in this https://github.com/kubernetes-sigs/kubebuilder/issues/1371#issuecomment-599045994?

[camilamacedo86]

/close

It was solved with https://github.com/kubernetes-sigs/kubebuilder/pull/1430

[k8s-ci-robot]

@camilamacedo86: Closing this issue.

In response to this:

/close

It was solved with https://github.com/kubernetes-sigs/kubebuilder/pull/1430

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/test-infra repository.