Skip to content

Commit 9ecac97

Browse files
author
Mikalai Radchuk
committed
Fix docs: "How to" section
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 <[email protected]>
1 parent 9c394f1 commit 9ecac97

File tree

4 files changed

+20
-23
lines changed

4 files changed

+20
-23
lines changed

docs/howto/how-to-channel-based-upgrades.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,18 @@ kind: ClusterExtension
1010
metadata:
1111
name: argocd
1212
spec:
13+
namespace: argocd
14+
serviceAccount:
15+
name: argocd-installer
1316
source:
1417
sourceType: Catalog
1518
catalog:
1619
packageName: argocd-operator
1720
# Automatically upgrade to the latest version found in the preview and dev-preview channels
1821
channels: [dev-preview, preview]
19-
install:
20-
namespace: argocd
21-
serviceAccount:
22-
name: argocd-installer
2322
```
2423
25-
Note that the `version` field also accepts a version range to further restrict the set of possible upgradable operator versions.
24+
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.
2625

2726
Example:
2827

@@ -32,14 +31,15 @@ kind: ClusterExtension
3231
metadata:
3332
name: argocd
3433
spec:
34+
namespace: argocd
35+
serviceAccount:
36+
name: argocd-installer
3537
source:
3638
sourceType: Catalog
3739
catalog:
3840
packageName: argocd-operator
3941
channels: [stable] # Automatically upgrade to the latest version found in ‘stable’
40-
version: “!1.3.2” # Don’t allow version 1.3.2
41-
install:
42-
namespace: argocd
43-
serviceAccount:
44-
name: argocd-installer
42+
version: "!=1.3.2" # Don’t allow version 1.3.2
4543
```
44+
45+
For more information on SemVer version ranges see [version ranges](../concepts/version-ranges.md)

docs/howto/how-to-pin-version.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,14 @@ kind: ClusterExtension
1010
metadata:
1111
name: argocd
1212
spec:
13+
namespace: argocd
14+
serviceAccount:
15+
name: argocd-installer
1316
source:
1417
sourceType: Catalog
1518
catalog:
1619
packageName: argocd-operator
1720
version: 0.6.0 # Pin argocd-operator to v0.6.0
18-
install:
19-
namespace: argocd
20-
serviceAccount:
21-
name: argocd-installer
2221
```
2322
2423
For more information on SemVer version ranges see [version ranges](../concepts/version-ranges.md)

docs/howto/how-to-version-range-upgrades.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,14 @@ kind: ClusterExtension
1010
metadata:
1111
name: argocd
1212
spec:
13+
namespace: argocd
14+
serviceAccount:
15+
name: argocd-installer
1316
source:
1417
sourceType: Catalog
1518
catalog:
1619
packageName: argocd-operator
1720
version: ">=3.0, <3.6" # Install versions from v3.0.0 up to, but not including, v3.6.0
18-
install:
19-
namespace: argocd
20-
serviceAccount:
21-
name: argocd-installer
2221
```
2322
2423
For more information on SemVer version ranges see [version-ranges](../concepts/version-ranges.md)

docs/howto/how-to-z-stream-upgrades.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,14 @@ kind: ClusterExtension
1010
metadata:
1111
name: argocd
1212
spec:
13+
namespace: argocd
14+
serviceAccount:
15+
name: argocd-installer
1316
source:
1417
sourceType: Catalog
1518
catalog:
1619
packageName: argocd-operator
17-
version: “~2.3" # Automatically upgrade patch releases for v2.3
18-
install:
19-
namespace: argocd
20-
serviceAccount:
21-
name: argocd-installer
20+
version: "~2.3" # Automatically upgrade patch releases for v2.3
2221
```
2322
2423
For more information on SemVer version ranges see [version ranges](../concepts/version-ranges.md)

0 commit comments

Comments
 (0)