Skip to content

📖[Docs] How-to: Z-stream Automatic Updates #1219

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 6, 2024
Merged

📖[Docs] How-to: Z-stream Automatic Updates #1219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/drafts/how-to-z-stream-upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## How-to: Z-Stream Automatic Updates

To restrict automatic updates to only z-stream patches and avoid breaking changes, use the `"~"` version range operator when setting the version for the desired package in Catalog source.

Example:

```yaml
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
name: argocd
spec:
source:
sourceType: Catalog
catalog:
packageName: argocd-operator
version: “~2.3" # Automatically upgrade patch releases for v2.3
Copy link
Contributor

Choose a reason for hiding this comment

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

is 2.3.x equivalent to this?

Should we document all the semantic ways to achieve "z-stream automatic updates"?

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to document the synonyms for a particular version range. I think one example is sufficient here. The API reference will document all the ways.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, that was my thought process as well. I think it's best to give folks one way of doing things (even if there are multiple - and document that elsewhere). Options lead to stress XD - having said that, is 2.3.x prettier?

Copy link
Contributor

Choose a reason for hiding this comment

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

i think ~2.3 is fine. it's 1 character shorter :P

install:
namespace: argocd
serviceAccount:
name: argocd-installer
```

For more information on SemVer version ranges see [version ranges](version-ranges.md)