Skip to content

📖 Fix docs: "How to" section #1463

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
Nov 14, 2024
Merged

📖 Fix docs: "How to" section #1463

Show file tree
Hide file tree
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
20 changes: 10 additions & 10 deletions docs/howto/how-to-channel-based-upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,18 @@ kind: ClusterExtension
metadata:
name: argocd
spec:
namespace: argocd
serviceAccount:
name: argocd-installer
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.
Note that the `version` field also supports [version pinning](./how-to-pin-version.md) and [version ranges](./how-to-version-range-upgrades.md) to further restrict the set of possible upgradable operator versions.

Example:

Expand All @@ -32,14 +31,15 @@ kind: ClusterExtension
metadata:
name: argocd
spec:
namespace: argocd
serviceAccount:
name: argocd-installer
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
version: "!=1.3.2" # Don’t allow version 1.3.2
Copy link
Member Author

Choose a reason for hiding this comment

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

I panicked because of this doc today:

  1. It was using ! instead of !=.
  2. After fixing it - it did not work because of “ instead of "

I thought we had a regression in version field validation somewhere.

```

For more information on SemVer version ranges see [version ranges](../concepts/version-ranges.md)
7 changes: 3 additions & 4 deletions docs/howto/how-to-pin-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ kind: ClusterExtension
metadata:
name: argocd
spec:
namespace: argocd
serviceAccount:
name: argocd-installer
source:
sourceType: Catalog
catalog:
packageName: argocd-operator
version: 0.6.0 # Pin argocd-operator to v0.6.0
install:
namespace: argocd
serviceAccount:
name: argocd-installer
```

For more information on SemVer version ranges see [version ranges](../concepts/version-ranges.md)
7 changes: 3 additions & 4 deletions docs/howto/how-to-version-range-upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ kind: ClusterExtension
metadata:
name: argocd
spec:
namespace: argocd
serviceAccount:
name: argocd-installer
source:
sourceType: Catalog
catalog:
packageName: argocd-operator
version: ">=3.0, <3.6" # Install versions from v3.0.0 up to, but not including, v3.6.0
install:
namespace: argocd
serviceAccount:
name: argocd-installer
```

For more information on SemVer version ranges see [version-ranges](../concepts/version-ranges.md)
9 changes: 4 additions & 5 deletions docs/howto/how-to-z-stream-upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ kind: ClusterExtension
metadata:
name: argocd
spec:
namespace: argocd
serviceAccount:
name: argocd-installer
source:
sourceType: Catalog
catalog:
packageName: argocd-operator
version: “~2.3" # Automatically upgrade patch releases for v2.3
install:
namespace: argocd
serviceAccount:
name: argocd-installer
version: "~2.3" # Automatically upgrade patch releases for v2.3
```

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