Skip to content

Commit

Permalink
Fix docs: "How to" section (#1463)
Browse files Browse the repository at this point in the history
There were several intentional breaking changes in the API
which are now included in v0.18.0 release.

This commit mostly focuses on updating the documentation to
reflect API changes. This includes making sure that snippets
and example outputs match the current state of the project.

Relevant PRs:
* #1439
* #1434

Signed-off-by: Mikalai Radchuk <mradchuk@redhat.com>
  • Loading branch information
m1kola authored Nov 14, 2024
1 parent dd2074b commit 0931d5b
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 23 deletions.
20 changes: 10 additions & 10 deletions docs/howto/how-to-channel-based-upgrades.md
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
```

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
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
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
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)

0 comments on commit 0931d5b

Please sign in to comment.