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

📖[Docs] How-to: Channel-Based Automatic Updates #1220

Merged
Changes from all commits
Commits
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
45 changes: 45 additions & 0 deletions docs/drafts/how-to-channel-based-upgrades.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## How-to: Channel-Based Automatic Upgrades

A "channel" is a package author defined stream of updates for an extension. A set of channels can be set in the Catalog source to restrict automatic updates to the set of versions defined in those channels.

Example:

```yaml
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
name: argocd
spec:
source:
sourceType: Catalog
catalog:
packageName: argocd-operator
# Automatically upgrade to the latest version found in the preview and dev-preview channels
channels: [dev-preview, preview]
install:
namespace: argocd
serviceAccount:
name: argocd-installer
```

Note that the `version` field also accepts a version range to further restrict the set of possible upgradable operator versions.

Example:

```yaml
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
name: argocd
spec:
source:
sourceType: Catalog
catalog:
packageName: argocd-operator
channels: [stable] # Automatically upgrade to the latest version found in ‘stable’
version: “!1.3.2” # Don’t allow version 1.3.2
install:
namespace: argocd
serviceAccount:
name: argocd-installer
```