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

Upgrade instructions unclear #2998

Closed
IBMRob opened this issue May 8, 2020 · 6 comments
Closed

Upgrade instructions unclear #2998

IBMRob opened this issue May 8, 2020 · 6 comments
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. olm-integration Issue relates to the OLM integration triage/support Indicates an issue that is a support question.
Milestone

Comments

@IBMRob
Copy link

IBMRob commented May 8, 2020

Bug Report

What did you do?

Currently we use the following command to create a manifest directory which contains the csv and CRDs of the operator in question operator-sdk generate csv --csv-version=1.0.0 --update-crds
After this we then use operator-sdk bundle create image:1.0.0 --directory deploy/olm-catalog/operator/ --package operator --channels stable,beta --default-channel stable to generate our OLM bundle

When running operator-sdk generate csv` it produces the following warning

[Deprecation Notice] Package manifests are deprecated. Run `operator-sdk bundle create --generate-only` to create operator metadata. Refer to the version upgrade guide for more information: https://operator-sdk.netlify.com/docs/migration/version-upgrade-guide

Following the link produced doesn't include any information on how to migrate the current mechanism to the new one.

What did you expect to see?
Example commands on how to use the new commands.

What did you see instead? Under which circumstances?
No clear instructions.

I did attempt to use operator-sdk bundle create --generate-only but it returned the error:

operator-sdk bundle create --generate-only 
FATA[0000] error generating bundle image files: stat /Users/convery/Documents/GitHub-IBM/ACEcc/ibm-appconnect-operator/stable/ibm-appconnect-bundle/operators/ibm-appconnect/deploy/olm-catalog/ibm-appconnect/manifests: no such file or directory 

which is correct, that directory didn't exist (previously the operator-sdk generate csv command created it)

Environment

  • operator-sdk version: 0.17
  • go version: go version go1.13.5 darwin/amd64
  • Kubernetes version information: v1.17.1
  • Kubernetes cluster kind: OCP 4.4
  • Are you writing your operator in ansible, helm, or go? Go

Possible Solution

Additional context
Add any other context about the problem here.

@camilamacedo86
Copy link
Contributor

HI @IBMRob,

  • Regards the warning :

Note that the deprecated message will be revert. More info: #2967 (comment)

  • Regards the bundle command:

By using the SDK 0.17 when you run operator-sdk generate csv --csv-version=1.0.0 --update-crds it will generate the manifest dir in for example : ./deploy/olm-catalog/memcached-operator/

So, when you run the command operator-sdk bundle create --generate-only it expects the manifest in the above directory. However, you are also able to use the flag to inform the manifest dir location as for example:

  $ operator-sdk bundle create \
      --generate-only \
      --directory ./deploy/olm-catalog/test-operator/

Also, note that the PR: #2905 is open for we are able to improve the command info. Please, feel free to check it and also contribute by giving your feedback.

Please, let us know if the above information helps you with and let you work with.

@camilamacedo86 camilamacedo86 self-assigned this May 10, 2020
@camilamacedo86 camilamacedo86 added olm-integration Issue relates to the OLM integration triage/support Indicates an issue that is a support question. labels May 10, 2020
@estroz estroz added the kind/documentation Categorizes issue or PR as related to documentation. label May 11, 2020
@estroz estroz added this to the v0.18.0 milestone May 11, 2020
@estroz
Copy link
Member

estroz commented May 11, 2020

/assign

@estroz
Copy link
Member

estroz commented May 11, 2020

@IBMRob some instructions on migrating: #2977. More to come.

@estroz estroz modified the milestones: v0.18.0, Backlog May 22, 2020
@estroz
Copy link
Member

estroz commented May 26, 2020

Update: we recently removed the deprecation notice for package manifests, since they are not deprecated in operator-framework tooling (yet).

@camilamacedo86
Copy link
Contributor

I think it can be closed with the changes made so far.
Also, we have the #2977.

@camilamacedo86
Copy link
Contributor

HI @IBMRob,

The information in the docs and command was updated, Also, as described above:

Update: we recently removed the deprecation notice for package manifests, since they are not deprecated in operator-framework tooling (yet).

So, I understand that we can close this one. However, please feel free to ping us to re-open if you see that something still missing is addressed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. olm-integration Issue relates to the OLM integration triage/support Indicates an issue that is a support question.
Projects
None yet
Development

No branches or pull requests

3 participants