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

Tutorial and install docs don't work well. #6589

Closed
schichtnudelauflauf opened this issue Oct 2, 2023 · 5 comments
Closed

Tutorial and install docs don't work well. #6589

schichtnudelauflauf opened this issue Oct 2, 2023 · 5 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Milestone

Comments

@schichtnudelauflauf
Copy link

What is the URL of the document?

https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/
https://sdk.operatorframework.io/docs/installation/

Which section(s) is the issue in?

Create new API
and install itself

What needs fixing?

Create new API:
The thing requires "make" which is not in default install of many distros.
It fails in an annoying way because it already creates a resource in kubernetes but fails the go stuff.
If you call the command
'' $ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource --controller) ''
again it will fail because it exists.
--force will override that and its kinda obvious but its annoying.

Install itself:
There is also a prebuilt package for Archlinux.

Additional context

None

@schichtnudelauflauf schichtnudelauflauf added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 2, 2023
@varshaprasad96
Copy link
Member

@schichtnudelauflauf Having GNU make installed is usually a common practice and is implied that any operator author would be having it which is why it is not explicitly mentioned. But if that's the case otherwise, please feel free to submit a PR that adds it to the documentation.

'' $ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource --controller) ''
again it will fail because it exists.

Regarding this, it is expected from SDK to fail when a user tries to create an API which already exists and is being tracked in the PROJECT file.

@varshaprasad96 varshaprasad96 added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Oct 2, 2023
@varshaprasad96 varshaprasad96 added this to the Backlog milestone Oct 2, 2023
@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 1, 2024
@openshift-bot
Copy link

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jan 31, 2024
@openshift-bot
Copy link

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

@openshift-ci openshift-ci bot closed this as completed Mar 2, 2024
Copy link

openshift-ci bot commented Mar 2, 2024

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
None yet
Development

No branches or pull requests

3 participants