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

📖 add clarification about if is possible to migrate from V0 to V1 #1502

Merged

Conversation

camilamacedo86
Copy link
Contributor

In order to try to be more transparent about our goals and current state.

@camilamacedo86 camilamacedo86 requested a review from a team as a code owner November 26, 2024 20:04
Copy link

netlify bot commented Nov 26, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit e7ee005
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/675af783ed22860008ab0071
😎 Deploy Preview https://deploy-preview-1502--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@camilamacedo86
Copy link
Contributor Author

@joelanford @LalatenduMohanty
I was thinking of something like that so that we can make it clear.
WDYT?

docs/index.md Outdated

OLMv1 is actively evolving towards adopting more common package formats widely used by the community,
such as **HelmCharts**. Until OLMv1 achieves key milestones on its [roadmap—such](project/olmv1_roadmap.md) as support for **Webhooks**,
**HelmCharts**, and other critical features—we strongly recommend that users **do not migrate from OLMv0 to OLMv1** at this time.
Copy link
Contributor

@everettraven everettraven Nov 26, 2024

Choose a reason for hiding this comment

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

Strongly recommended that users don't migrate from OLMv0 to OLMv1 feels like a stretch to me. What if someone if using OLMv0 in a way that is totally compatible with the limitations of OLMv1? Should we provide them details on how to go from using OLMv0 to OLMv1 in that case?

The migration story right now feels much more nuanced than I think that this messaging conveys.

Copy link
Contributor Author

@camilamacedo86 camilamacedo86 Nov 27, 2024

Choose a reason for hiding this comment

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

OLMv0 in a way that is totally compatible with the limitations of OLMv1?

it is very hard to ensure or map all possible scenarios
it has many caveats.

Should we provide them details on how to go from using OLMv0 to OLMv1 in that case?

We do not have the migration steps and we have not implemented what we need to be there yet. As we discussed yesterday in the community meeting, we want to address more aspects before starting to work on the migration guidance to ensure it is done properly. (I.,e We want to support HelmChart and etc) We might want to encourage people use HelmChart with OLMv1 and not CSV

The idea here is to make this clear for both us and the community. Better wording suggestions are very welcome. However, at this moment, I understand that we convey we strongly recommend against using OLMv1 in production or starting any migration.

Copy link
Contributor Author

@camilamacedo86 camilamacedo86 Nov 27, 2024

Choose a reason for hiding this comment

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

Btw, we might want to better clarify here that registry+v1/CSV is deprecated and we are moving towards HelmCharts.

Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't spent any time thinking of better wording yet, but will plan to make some suggestions later today.

However, at this moment, I understand that we convey we strongly recommend against using OLMv1 in production or starting any migration

In my opinion, this is a bad precedent to set. It sounds like we have prematurely released v1.0.0 if we say that it isn't recommended to use in production. I think we do recommend using it in production for the use cases and workflows that are currently enabled by the features we have in place. We can separately state that we do not currently have any migration strategies in place for going from OLMv0 --> OLMv1.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. Think about how we can convey the way in a way that is nice and transparent
Open to suggestions !!!

@camilamacedo86 camilamacedo86 changed the title 📖 add clarification about current state of OLMv1 at upstream WIP 📖 add clarification about current state of OLMv1 at upstream Nov 27, 2024
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 27, 2024
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@LalatenduMohanty
Copy link
Member

@joelanford PTAL and let us know if you are fine with the language we have used.

@camilamacedo86
Copy link
Contributor Author

Hi @LalatenduMohanty

It is with your suggestion now, so it seems good to fly 🚀

@camilamacedo86 camilamacedo86 changed the title WIP 📖 add clarification about current state of OLMv1 at upstream 📖 add clarification about if is possible to migrate from V0 to V1 Dec 12, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 12, 2024
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.68%. Comparing base (610fff9) to head (e7ee005).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1502   +/-   ##
=======================================
  Coverage   74.68%   74.68%           
=======================================
  Files          42       42           
  Lines        3271     3271           
=======================================
  Hits         2443     2443           
  Misses        652      652           
  Partials      176      176           
Flag Coverage Δ
e2e 52.15% <ø> (ø)
unit 57.99% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@LalatenduMohanty LalatenduMohanty left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 12, 2024
@camilamacedo86 camilamacedo86 added this pull request to the merge queue Dec 12, 2024
Merged via the queue into operator-framework:main with commit 45f86cb Dec 12, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants