Skip to content

add deprication warning for operator version 1.0.0 #66

Merged
miyunari merged 2 commits intomainfrom
feat/operator_deprication_message
Jan 13, 2025
Merged

add deprication warning for operator version 1.0.0 #66
miyunari merged 2 commits intomainfrom
feat/operator_deprication_message

Conversation

@miyunari
Copy link
Contributor

@miyunari miyunari commented Jan 7, 2025

Updated the operator catalog with deprecation warnings:

Deprecation warning for operator-v1.0.0:
Added a message recommending users to upgrade to operator-v1.1.0 for continued support.

Deprecation warning for stable-v1.0 channel:
Added a message recommending users to switch to the newer stable-v1.1 channel.

I used this schema.

@miyunari miyunari self-assigned this Jan 7, 2025
Copy link
Member

@JasonPowr JasonPowr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is done correctly, I think you need to add something like this (not sure if the wording is correct or I missed something)

---
schema: olm.deprecations
package: rhtas-operator
entries:
  - reference:
      schema: olm.channel
      name: stable-v1.0
    message: channel stable-v1.0 is no longer supported.  Please switch to channel 'stable' or channel 'stable-v1.1'.
  - reference:
      schema: olm.bundle
      name: rhtas-operator.v1.0.0
    message: rhtas-operator.v1.0.0 is deprecated. Uninstall and install rhtas-operator.v1.1.0 for support.
  - reference:
      schema: olm.bundle
      name: rhtas-operator.v1.0.1
    message: rhtas-operator.v1.0.1 is deprecated. Uninstall and install rhtas-operator.v1.1.0 for support.
  - reference:
      schema: olm.bundle
      name: rhtas-operator.v1.0.2
    message: rhtas-operator.v1.0.2 is deprecated. Uninstall and install rhtas-operator.v1.1.0 for support.
---

to each of the graph.yaml files then you can re render the catalog.json with opm

@JasonPowr
Copy link
Member

Screencast.from.2025-01-08.12-11-03.mp4

This is what it will look like :)

Signed-off-by: Janine Olear <pninak@web.de>
@miyunari miyunari force-pushed the feat/operator_deprication_message branch from b1450c2 to 61b6963 Compare January 9, 2025 16:28
@miyunari
Copy link
Contributor Author

miyunari commented Jan 9, 2025

Thank you for the great description @JasonPowr and the video ❤️ ! I changed it to what you've suggested, please double check again if it makes sense now 😄

@miyunari miyunari requested a review from JasonPowr January 9, 2025 16:29
v4.13/graph.yaml Outdated
- reference:
schema: olm.bundle
name: rhtas-operator.v1.0.1
message: rhtas-operator.v1.0.1 is deprecated. Uninstall and install rhtas-operator.v1.1.0 for support.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
message: rhtas-operator.v1.0.1 is deprecated. Uninstall and install rhtas-operator.v1.1.0 for support.
message: rhtas-operator.v1.0.1 is deprecated. Uninstall and install rhtas-operator.v1.1.1 for support.

I think we should change this as 1.1.1 will be the latest version of the operator

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha yes, good point 😅

Comment on lines 12 to 13
"name": "rhtas-operator.v1.0.0",
"message": "This version is deprecated. Please upgrade to rhtas-operator.v1.1.0."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please correct me if I am wrong, but I believe you are making these changes manually ?, The catalog.json file is something that is generated using the opm tool, you can find more info here in the FBC bits

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I did these changes manually 😄 I changed it now :)

@miyunari
Copy link
Contributor Author

I used the opm tool now to generate the catalog.json file and changed the version typo in the graph.yaml file, @JasonPowr do you see anything else which could be an issue? :)
ty for your help! :)

@miyunari miyunari requested a review from JasonPowr January 13, 2025 12:18
Copy link
Member

@JasonPowr JasonPowr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just this one thing related to the related images sections of the catalog.json and your good to go :)

{
"name": "",
"image": "registry.redhat.io/rhtas/rhtas-rhel9-operator@sha256:2d2a22420249890a64b42c663d57c4b5c6638e0597fe74b01b275ba915e53ea2"
},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these related images have been deleted, for this issue the only change made to the catalog.json file should be the addition of the olm.deprecations :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh no - I didn't see that 👍 I will change it in a bit :)

Signed-off-by: Janine Olear <pninak@web.de>
@miyunari miyunari force-pushed the feat/operator_deprication_message branch from c304afc to 9632324 Compare January 13, 2025 12:52
@miyunari miyunari requested a review from JasonPowr January 13, 2025 12:53
Copy link
Member

@JasonPowr JasonPowr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm Nice Work :)

@miyunari miyunari merged commit cbfe85c into main Jan 13, 2025
10 checks passed
@miyunari miyunari deleted the feat/operator_deprication_message branch January 13, 2025 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants