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

doc: gator.md go get gator cli from source erroring out #3155

Closed
mjscalexander opened this issue Nov 8, 2023 · 6 comments · Fixed by #3325
Closed

doc: gator.md go get gator cli from source erroring out #3155

mjscalexander opened this issue Nov 8, 2023 · 6 comments · Fixed by #3325
Assignees
Labels
docs Pure prose triaged
Milestone

Comments

@mjscalexander
Copy link

What steps did you take and what happened:

When i try to install gator CLI from source using using go 1.21.3 based on the recommended method, I get the following error:

go get github.com/open-policy-agent/gatekeeper/cmd/gator
go: downloading github.com/open-policy-agent/gatekeeper v3.0.3+incompatible
go: module github.com/open-policy-agent/gatekeeper@upgrade found (v3.0.3+incompatible), but does not contain package github.com/open-policy-agent/gatekeeper/cmd/gator

Also I don’t believe go get is used any longer. it is recommended to use go install instead.

What did you expect to happen:
I expected the install process to work without any errors

Anything else you would like to add:

Nope.

Environment:
NA

  • Gatekeeper version: NA
  • Kubernetes version: (use kubectl version): NA
@mjscalexander mjscalexander added the bug Something isn't working label Nov 8, 2023
@davis-haba
Copy link
Contributor

davis-haba commented Nov 8, 2023

Thanks for bringing this to our attention.

If you specify a version, e.g. go get github.com/open-policy-agent/gatekeeper/cmd/gator@master, that should work. Agreed we should switch to go install, we will look into updating the install docs. We also have a docker image for the CLI, which we will look into documenting.

@mjscalexander
Copy link
Author

mjscalexander commented Nov 9, 2023

@davis-haba Thank you fore reviewing this. I didn’t realize there was a docker image for the CLI. Thanks for pointing that out!

Copy link

stale bot commented Jan 17, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 17, 2024
@sozercan
Copy link
Member

sozercan commented Jan 18, 2024

I thought we could do this now with /v3 in go.mod but replace (for the controller-runtime fork) seems to be breaking go install

go install github.com/open-policy-agent/gatekeeper/v3/cmd/gator@v3.14.0
go: github.com/open-policy-agent/gatekeeper/v3/cmd/gator@v3.14.0 (in github.com/open-policy-agent/gatekeeper/v3@v3.14.0):
        The go.mod file for the module providing named packages contains one or
        more replace directives. It must not contain directives that would cause
        it to be interpreted differently than if it were the main module.

we should update the docs to remove the go get section now. after #3111 merges, we can introduce back with go install as i think that'll resolve the issue
https://open-policy-agent.github.io/gatekeeper/website/docs/gator

@stale stale bot removed the stale label Jan 18, 2024
@sozercan sozercan added docs Pure prose and removed bug Something isn't working labels Jan 18, 2024
@sozercan sozercan added this to the v3.16.0 milestone Jan 18, 2024
Copy link

stale bot commented Mar 18, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Mar 18, 2024
@sozercan sozercan added triaged and removed stale labels Mar 18, 2024
@sozercan sozercan self-assigned this Mar 18, 2024
@sozercan
Copy link
Member

@mjscalexander docs will be updated with a way to go install in the next release

we don't have a published stable release yet but you can either do go install github.com/open-policy-agent/gatekeeper/v3/cmd/gator@master or go install github.com/open-policy-agent/gatekeeper/v3/cmd/gator@v3.16.0-beta.1 today

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Pure prose triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants