Skip to content

Commit

Permalink
Update upgrade.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@christinaausley
christinaausley authored Apr 8, 2024
1 parent 748a375 commit 9bff25c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/self-managed/setup/upgrade.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ For more details on the Keycloak upgrade path, you can also read the [Bitnami Ke

## Version update instructions

As of the 8.4 release, the Camunda 8 **Helm chart** version is decoupled from the version of the application. The Helm chart release still follows the applications release cycle, but it has an independent version. (e.g., in the application release cycle 8.4, the chart version is 9.0.0).
As of the 8.4 release, the Camunda 8 **Helm chart** version is decoupled from the version of the application. The Helm chart release still follows the applications release cycle, but it has an independent version. (for example, in the application release cycle 8.4, the chart version is 9.0.0).

For more details about the applications version included in the Helm chart, review the [full version matrix](https://helm.camunda.io/camunda-platform/version-matrix/).

Expand All @@ -115,13 +115,13 @@ helm search repo camunda/camunda-platform --versions
The Camunda Helm chart v10.0.0 has major changes in the values file structure. Follow the upgrade steps for each component before starting the chart upgrade.
:::

#### Deprecation Notes
#### Deprecation notes

The following keys in the values file have been changed in Camunda Helm chart v10.0.0. For compatibility, they are deprecated in the Camunda release cycle 8.5 and they will be removed in the Camunda 8.6 release (October 2024).

We highly recommend updating the keys in your values file and don't wait till the 8.6 release.
We highly recommend updating the keys in your values file now, rather than waiting until the 8.6 release.

| Component | Old Key | New Key |
| Component | Old key | New key |
| ------------- | ---------------------------------- | ----------------------------------- |
| Identity |
| | `identity.keycloak` | `identityKeycloak` |
Expand All @@ -147,7 +147,7 @@ The Camunda Identity component was formerly a sub-chart of the Camunda Helm char
There are no changes in the Identity keys, but since the `LabelSelector` and `MatchLabels` of a Kubernetes resource are immutable, its deployment should be deleted as the label `app.kubernetes.io/name` has been changed from `identity` to `camunda-platform`.

:::caution Downtime
This step will lead to temporary downtime in Camunda 8 till the actual upgrade happens.
This step will lead to temporary downtime in Camunda 8 until the actual upgrade occurs.
:::

```shell
Expand All @@ -156,11 +156,11 @@ kubectl -n camunda delete -l app.kubernetes.io/name=identity deployment

#### Identity - Keycloak

In Camunda Helm chart v10.0.0, the Identity Keycloak Helm chart has been upgraded from [v17.3.6](https://artifacthub.io/packages/helm/bitnami/keycloak/17.3.6) to [v19.4.1](https://artifacthub.io/packages/helm/bitnami/keycloak/19.4.1). Which has different defaults.
In Camunda Helm chart v10.0.0, the Identity Keycloak Helm chart has been upgraded from [v17.3.6](https://artifacthub.io/packages/helm/bitnami/keycloak/17.3.6) to [v19.4.1](https://artifacthub.io/packages/helm/bitnami/keycloak/19.4.1), which has different defaults.

If, **and only if**, you make a full copy of the Camunda Helm chart values file instead of just overwriting the default value, you need to update your values files and use the new default values.
If, **and only if**, you make a full copy of the Camunda Helm chart values file instead of just overwriting the default value, update your values files and use the new default values.

Namely, the following volumes should be removed from the values since they are now part of the upstream chart:
Namely, the following volumes should be removed from the values as they are now part of the upstream chart:

```yaml
# Note: Since v10.0.0 the Keycloak "identity.keycloak" has been renamed to "identityKeycloak".
Expand All @@ -185,11 +185,11 @@ identity:
#### Elasticsearch
In Camunda Helm chart v10.0.0, the Elasticsearch Helm chart has been upgraded from [v19.19.4](https://artifacthub.io/packages/helm/bitnami/elasticsearch/19.19.4) to [v20.0.0](https://artifacthub.io/packages/helm/bitnami/elasticsearch/20.0.0). Which has different defaults.
In Camunda Helm chart v10.0.0, the Elasticsearch Helm chart has been upgraded from [v19.19.4](https://artifacthub.io/packages/helm/bitnami/elasticsearch/19.19.4) to [v20.0.0](https://artifacthub.io/packages/helm/bitnami/elasticsearch/20.0.0), which has different defaults.
If, **and only if**, you make a full copy of the Camunda Helm chart values file instead of just overwriting the default value, you need to update your values files and use the new default values.
If, **and only if**, you make a full copy of the Camunda Helm chart values file instead of just overwriting the default value, update your values files and use the new default values.
Namely, the following volumes should be removed from the values since they are now part of the upstream chart:
Namely, the following volumes should be removed from the values as they are now part of the upstream chart:
```yaml
elasticsearch:
Expand Down

0 comments on commit 9bff25c

Please sign in to comment.