|
1 | 1 | ---
|
2 | 2 | title: Upgrade Crossplane
|
3 | 3 | weight: 200
|
4 |
| -draft: true |
5 | 4 | ---
|
6 | 5 |
|
7 |
| -Install, Uninstall, Upgrade |
| 6 | +The recommended upgrade method for an existing Crossplane install is to use |
| 7 | +[Helm](http://helm.io). |
| 8 | + |
| 9 | +## Prerequisites |
| 10 | +* [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later |
| 11 | + |
| 12 | + |
| 13 | +## Add the Crossplane Helm repository |
| 14 | +Verify Helm has the Crossplane repository. |
| 15 | + |
| 16 | +```shell |
| 17 | +helm repo add crossplane-stable https://charts.crossplane.io/stable |
| 18 | +``` |
| 19 | + |
| 20 | +## Update the Helm repository |
| 21 | + |
| 22 | +Update the local Crossplane Helm chart with `helm repo update`. |
| 23 | + |
| 24 | +```shell |
| 25 | +helm repo update |
| 26 | +``` |
| 27 | + |
| 28 | +{{<hint "important" >}} |
| 29 | +Upgrading Crossplane without updating the Helm chart installs the last version |
| 30 | +available in the locally cached Helm chart. |
| 31 | +{{< /hint >}} |
| 32 | + |
| 33 | +## Upgrade Crossplane |
| 34 | + |
| 35 | +Upgrade Crossplane with `helm upgrade`, providing the Crossplane namespace. |
| 36 | +By default, Crossplane installs into the `crossplane-system` |
| 37 | +namespace. |
| 38 | + |
| 39 | +```shell |
| 40 | +helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane |
| 41 | +``` |
| 42 | + |
| 43 | +Helm preserves any arguments or flags originally used when installing |
| 44 | +Crossplane. |
| 45 | + |
| 46 | +Crossplane uses any new default behaviors unless they're changed in the `helm |
| 47 | +upgrade` command. |
| 48 | + |
| 49 | +For example, in v1.15.0 Crossplane changed the default image registry from |
| 50 | +`index.docker.io` to `xpkg.upbound.io`. Upgrading Crossplane from a version |
| 51 | +before v1.15.0 updates the default package registry. |
| 52 | + |
| 53 | +Override new defaults by |
| 54 | +[customizing the Helm chart](https://docs.crossplane.io/v1.15/software/install/#customize-the-crossplane-helm-chart) |
| 55 | +with the upgrade command. |
| 56 | + |
| 57 | +For example, to maintain the original image registry use |
| 58 | +```shell |
| 59 | +helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane `--set 'args={"--registry=index.docker.io"}' |
| 60 | +``` |
0 commit comments