Skip to content

Commit 53f97ab

Browse files
committed
Update extension upgrade tutorial doc
With the addition of the CRD Upgrade Safety preflight check, our existing example of upgrading argocd from 0.5.0 to 0.6.0 no longer serves as a good example. This commit changes the example to use an update from 0.2.0 to 0.2.1 which no longer fails the CRD Upgrade check, and also doesn't violate our restriction on automatic upgrades between minor versions with a major version of 0. Signed-off-by: Tayler Geiger <[email protected]>
1 parent 5445800 commit 53f97ab

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

docs/tutorials/upgrade-extension.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ For information on downgrading an extension, see [Downgrade an Extension](downgr
1111

1212
## Prerequisites
1313

14-
* You have an extension installed
14+
* You have a ClusterExtension installed
1515
* The target version is compatible with OLM v1 (see [OLM v1 limitations](../project/olmv1_limitations.md))
16-
* CRD compatibility between the versions being upgraded or downgraded (see [CRD upgrade safety](../concepts/crd-upgrade-safety.md))
17-
* The installer service account's RBAC permissions are adequate for the target version (see [Minimal RBAC for Installer Service Account](../howto/derive-service-account.md))
16+
* Any changes to the CustomResourceDefinition in the new version meet compatibility requirements (see [CRD upgrade safety](../concepts/crd-upgrade-safety.md))
17+
* The installer ServiceAccount's RBAC permissions are adequate for the target version (see [Minimal RBAC for Installer Service Account](../howto/derive-service-account.md))
1818

1919
For more detailed information see [Upgrade Support](../concepts/upgrade-support.md).
2020

2121
## Procedure
2222

23-
Suppose we have successfully created and installed v0.5.0 of the ArgoCD operator with the following `ClusterExtension`:
23+
Suppose we have successfully created and installed v0.2.0 of the ArgoCD operator with the following `ClusterExtension`:
2424

2525
``` yaml title="Example CR"
2626
apiVersion: olm.operatorframework.io/v1
@@ -35,7 +35,7 @@ spec:
3535
sourceType: Catalog
3636
catalog:
3737
packageName: argocd-operator
38-
version: 0.5.0
38+
version: 0.2.0
3939
```
4040
4141
* Update the version field in the ClusterExtension resource:
@@ -54,7 +54,7 @@ spec:
5454
sourceType: Catalog
5555
catalog:
5656
packageName: argocd-operator
57-
version: 0.6.0 # Update to version 0.6.0
57+
version: 0.2.1 # Update to version 0.2.1
5858
EOF
5959
```
6060

@@ -66,27 +66,14 @@ spec:
6666
Alternatively, you can use `kubectl patch` to update the version field:
6767

6868
``` terminal
69-
kubectl patch clusterextension <extension_name> --type='merge' -p '{"spec": {"source": {"catalog": {"version": "<target_version>"}}}}'
70-
```
71-
72-
`extension_name`
73-
: Specifies the name defined in the `metadata.name` field of the extension's CR.
74-
75-
`target_version`
76-
: Specifies the version to upgrade or downgrade to.
77-
78-
For example:
79-
``` terminal
80-
kubectl patch clusterextension argocd --type='merge' -p '{"spec": {"source": {"catalog": {"version": "0.6.0"}}}}'
69+
kubectl patch clusterextension argocd --type='merge' -p '{"spec": {"source": {"catalog": {"version": "0.2.1"}}}}'
8170
```
8271

8372
!!! success
8473
``` text title="Example output"
8574
clusterextension.olm.operatorframework.io/argocd patched
8675
```
8776

88-
### Verification
89-
9077
* Verify that the Kubernetes extension is updated:
9178

9279
``` terminal

0 commit comments

Comments
 (0)