add clear warning about upgrading crossplane one minor version at a time

Signed-off-by: Jared Watts <jbw976@gmail.com>
This commit is contained in:
Jared Watts 2025-09-03 16:52:11 -07:00
parent 622a3c343f
commit a810503b66
No known key found for this signature in database
GPG Key ID: 0467EEAE3B6EC0D2
2 changed files with 24 additions and 4 deletions

View File

@ -7,10 +7,20 @@ description: "Upgrade Crossplane to newer versions"
The recommended upgrade method for an existing Crossplane install is to use The recommended upgrade method for an existing Crossplane install is to use
[Helm](http://helm.io). [Helm](http://helm.io).
<!-- vale write-good.Weasel = NO -->
{{<hint "important" >}}
Always upgrade Crossplane **one minor version at a time**, using the most recent
patch version available for each.
For example, if you are on `v1.18` and want to upgrade to `v2.0`, you should
first upgrade to `v1.19`, then `v1.20`, before finally upgrading to `v2.0`. The
upgrade path in this example looks like `v1.18``v1.19``v1.20``v2.0`.
{{</hint>}}
<!-- vale write-good.Weasel = YES -->
## Prerequisites ## Prerequisites
* [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later * [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later
## Add the Crossplane Helm repository ## Add the Crossplane Helm repository
Verify Helm has the Crossplane repository. Verify Helm has the Crossplane repository.
@ -29,7 +39,7 @@ helm repo update
{{<hint "important" >}} {{<hint "important" >}}
Upgrading Crossplane without updating the Helm chart installs the last version Upgrading Crossplane without updating the Helm chart installs the last version
available in the locally cached Helm chart. available in the locally cached Helm chart.
{{< /hint >}} {{</hint>}}
## Upgrade Crossplane ## Upgrade Crossplane

View File

@ -7,10 +7,20 @@ description: "Upgrade Crossplane to newer versions"
The recommended upgrade method for an existing Crossplane install is to use The recommended upgrade method for an existing Crossplane install is to use
[Helm](http://helm.io). [Helm](http://helm.io).
<!-- vale write-good.Weasel = NO -->
{{<hint "important" >}}
Always upgrade Crossplane **one minor version at a time**, using the most recent
patch version available for each.
For example, if you are on `v1.18` and want to upgrade to `v2.0`, you should
first upgrade to `v1.19`, then `v1.20`, before finally upgrading to `v2.0`. The
upgrade path in this example looks like `v1.18``v1.19``v1.20``v2.0`.
{{</hint>}}
<!-- vale write-good.Weasel = YES -->
## Prerequisites ## Prerequisites
* [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later * [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later
## Add the Crossplane Helm repository ## Add the Crossplane Helm repository
Verify Helm has the Crossplane repository. Verify Helm has the Crossplane repository.
@ -29,7 +39,7 @@ helm repo update
{{<hint "important" >}} {{<hint "important" >}}
Upgrading Crossplane without updating the Helm chart installs the last version Upgrading Crossplane without updating the Helm chart installs the last version
available in the locally cached Helm chart. available in the locally cached Helm chart.
{{< /hint >}} {{</hint>}}
## Upgrade Crossplane ## Upgrade Crossplane