📖 Update extension upgrade tutorial doc #1469
Conversation
openshift-ci
bot
added
the
do-not-merge/work-in-progress
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1469 +/- ##
==========================================
- Coverage 74.73% 74.69% -0.04%
==========================================
Files 42 42
Lines 3241 3241
==========================================
- Hits 2422 2421 -1
- Misses 646 647 +1
Partials 173 173
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
trgeiger
force-pushed
the
docs-1459
branch
2 times, most recently
from
72d38af
to
4713083
Compare
With the addition of the CRD Upgrade Safety preflight check, our existing example of upgrading argocd from 0.5.0 to 0.6.0 no longer serves as a good example. This commit changes the example to use an update from 0.2.0 to 0.2.1 which no longer fails the CRD Upgrade check, and also doesn't violate our restriction on automatic upgrades between minor versions with a major version of zero. Signed-off-by: Tayler Geiger <[email protected]>
|
Should we change the ClusterExtension sample argocd manifest to match our docs at version 0.2.0 or 0.2.1? Or is it good enough to make these docs examples just work and leave the manifest alone at 0.6.0? |
|
|
||
| ```bash | ||
| # Update to v0.11.0 | ||
| kubectl patch clusterextension argocd --type='merge' -p '{"spec": {"source": {"catalog": {"version": "0.11.0"}}}}' | ||
| kubectl patch clusterextension argocd --type='merge' -p '{"spec": {"source": {"catalog": {"version": "0.2.1"}}}}' |
There was a problem hiding this comment.
Will this work?
I believe https://raw.githubusercontent.com/operator-framework/operator-controller/main/config/samples/olm_v1_clusterextension.yaml is currently installing 0.6.0.
So if as a previous step we install 0.6.0 then here we effectively are trying to downgrade to 0.2.1.
There was a problem hiding this comment.
Yeah, that's why I have my comment/question above about if we should change the sample manifest. The existing example of using 0.11.0 doesn't work either because it's attempting to upgrade a minor version within a zero major version which we don't support.
This specific line in 'olmv1_getting_started.md' technically isn't part of any tutorial or anything, but rather a one-off example of what an upgrade command might look like. So I think we could get away with whatever we want here, although having it be functional and not show an example of non-functional minor version upgrade attempts would probably be best. I could rewrite it to not have any actual version in the command, maybe, but rather some placeholder?
There was a problem hiding this comment.
@m1kola @everettraven so given we are adding a 0.2.0 manifest to the upgrade tutorial, should we just leave this line in olmv1_getting_started the same at 0.11.0 or maybe some other change?
There was a problem hiding this comment.
I don't like that we have duplication of content. Maybe we should consolidate the tutorial and getting started somehow?
trgeiger
force-pushed
the
docs-1459
branch
3 times, most recently
from
6a07c32
to
c0dcefa
Compare
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
|
Admonition added at the beginning of the tutorial with the v0.2.0 manifests. Admonition added at the very end explaining the possible discrepancy in last-applied-configuration depending on if you applied a new yaml file or used patch/edit to upgrade the ClusterExtension. |
|
|
||
| ```bash | ||
| # Update to v0.11.0 | ||
| kubectl patch clusterextension argocd --type='merge' -p '{"spec": {"source": {"catalog": {"version": "0.11.0"}}}}' | ||
| kubectl patch clusterextension argocd --type='merge' -p '{"spec": {"source": {"catalog": {"version": "0.2.1"}}}}' |
There was a problem hiding this comment.
I don't like that we have duplication of content. Maybe we should consolidate the tutorial and getting started somehow?
m1kola
added
documentation
|
I agree re: consolidating content. I actually opened #1480 to address that issue more broadly with duplicate content between How-To Guides and Tutorials. Maybe we can address this duplicate upgrade command when we hit that ticket. |
|
@trgeiger makes senes. Should we revert / partially revert |
trgeiger
force-pushed
the
docs-1459
branch
2 times, most recently
from
e20b9e2
to
6b59582
Compare
For our examples to work, we need to use a very specific version of our example operator. The upgrade from 0.2.0 to 0.2.1 functions properly for our purposes, but we don't want to affect the sample operator in config/samples so we are adding the example manifest for 0.2.0 directly to this tutorial. Signed-off-by: Tayler Geiger <[email protected]>
6995bc4
With the addition of the CRD Upgrade Safety preflight check, our existing example of upgrading argocd from 0.5.0 to 0.6.0 no longer serves as a good example. This commit changes the example to use an update from 0.2.0 to 0.2.1 which no longer fails the CRD Upgrade check, and also doesn't violate our restriction on automatic upgrades between minor versions with a major version of 0.
Addresses #1459
Description
Reviewer Checklist