Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Dev-docs is not clear about how to install correct controller-gen binary #633

Closed
prashao opened this issue Jan 11, 2021 · 3 comments
Labels
area/documentation Issues or PRs related to documentation and examples

Comments

@prashao
Copy link
Contributor

prashao commented Jan 11, 2021

Describe the bug
The developer docs are not very clear on how to install the correct controller-gen binary. There are a couple of issues #234 and #259 that attempt to address it but they don't offer absolute clarity.

Steps to reproduce

  • GOPATH should be set

  • Because of improves dev preview docs concerning controller-gen #259 one would try to install controller-gen directly from https://github.com/kubernetes-sigs/controller-tools as -
    go get github.com/kubernetes-sigs/controller-tools/cmd/controller-gen
    But it leads to following errors
    $ go get github.com/kubernetes-sigs/controller-tools
    go: github.com/kubernetes-sigs/controller-tools upgrade => v0.4.1
    go get: github.com/kubernetes-sigs/controller-tools@v0.4.1: parsing go.mod:
    module declares its path as: sigs.k8s.io/controller-tools
    but was required as: github.com/kubernetes-sigs/controller-tools

  • This issue is of kubernetes-sigs repo and can be resolved in the following way
    go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1

  • Now the problem is that aws-controller-k8s requires controller-gen v0.4.0
    $ make build-controller SERVICE=s3
    building ack-generate ... ok.
    FATAL: Existing version of controller-gen Version: v0.4.1, required version is v0.4.0.
    FATAL: Please uninstall controller-gen and install the required version with scripts/install-controller-gen.sh.

  • Now the user has to remove v0.4.1 and run scripts/install-controller-gen.sh to get the desired version.

Expected outcome
I think the docs should have indicated to use scripts/install-controller-gen.sh in the Prerequisites section where it mentions kubernetes-sigs/controller-tools
It should also indicate that just the controller-gen binary is required from controller-tools.

Environment
Linux

  • Kubernetes version
  • Using EKS (yes/no), if so version?
  • AWS service targeted (S3, RDS, etc.)
@prashao prashao added the kind/bug Categorizes issue or PR as related to a bug. label Jan 11, 2021
@prashao prashao changed the title Dev-docs is not clear about how to install correct controller-gen binary [Documentation] Dev-docs is not clear about how to install correct controller-gen binary Jan 11, 2021
@jaypipes jaypipes added area/documentation Issues or PRs related to documentation and examples and removed kind/bug Categorizes issue or PR as related to a bug. labels Jan 14, 2021
@jaypipes
Copy link
Collaborator

@prashao are you interested in submitting a PR that updates our docs here?

@prashao
Copy link
Contributor Author

prashao commented Jan 14, 2021

Yeah. I will submit a PR for this one.
What about the other issues related to cluster reuse I told you about? Should I submit issues & PR for those as well?

@prashao
Copy link
Contributor Author

prashao commented Jan 20, 2021

Fixed through #651

@prashao prashao closed this as completed Jan 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation and examples
Projects
None yet
Development

No branches or pull requests

2 participants