docs(self-managed): Optimize and Helm chart 8.2.9 compatibility (#2536)

* docs(self-managed): Optimize and Helm chart 8.2.9 compatibility * style(formatting): technical review * add announcements notes --------- Co-authored-by: Christina Ausley <[email protected]>
camunda · Sep 11, 2023 · eaa7b4b · eaa7b4b
1 parent a334602
commit eaa7b4b
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 0 deletions.
diff --git a/docs/reference/announcements.md b/docs/reference/announcements.md
@@ -51,6 +51,15 @@ As Camunda Platform 8.2.7 was already released on Tuesday Jun 13th, you can just
 
 - Operate version 8.2+ support OpenSearch 1.3.x. However, 8.2.x patches will only be released on the OS 1.3 branch until end of 2023 given that OS 1.3 maintenance period ends by then. We recommend customers to go to 8.3.x which supports OS 2.5+.
 
+### Optimize and Helm chart compatibility
+
+For Optimize 3.10.1, a new environment variable introduced redirection URL. However, the change is not compatible with Camunda Helm charts until it is fixed in 3.10.3 (and Helm chart 8.2.9). Therefore, those versions are coupled to certain Camunda Helm chart versions:
+
+| Optimize version                  | Camunda Helm chart version |
+| --------------------------------- | -------------------------- |
+| Optimize 3.10.1 & Optimize 3.10.2 | 8.2.0 - 8.2.8              |
+| Optimize 3.10.3                   | 8.2.9+                     |
+
 ## Camunda Platform 8.1
 
 Release date: 11th of October 2022

diff --git a/docs/self-managed/platform-deployment/helm-kubernetes/upgrade.md b/docs/self-managed/platform-deployment/helm-kubernetes/upgrade.md
@@ -131,6 +131,19 @@ zeebe:
     runAsUser: 0
 ```
 
+### v8.2.9
+
+#### Optimize
+
+For Optimize 3.10.1, a new environment variable introduced redirection URL. However, the change is not compatible with Camunda Helm charts until it is fixed in 3.10.3 (and Helm chart 8.2.9). Therefore, those versions are coupled to certain Camunda Helm chart versions:
+
+| Optimize version                  | Camunda Helm chart version |
+| --------------------------------- | -------------------------- |
+| Optimize 3.10.1 & Optimize 3.10.2 | 8.2.0 - 8.2.8              |
+| Optimize 3.10.3                   | 8.2.9+                     |
+
+No action is needed if you use Optimize 3.10.3 (shipped with this Helm chart version by default), but this Optimize version cannot be used out of the box with previous Helm chart versions.
+
 ### v8.2.3
 
 #### Zeebe Gateway

diff --git a/optimize/self-managed/optimize-deployment/migration-update/3.9-to-3.10.md b/optimize/self-managed/optimize-deployment/migration-update/3.9-to-3.10.md
@@ -19,6 +19,15 @@ Here you will find information about:
 
 ## Changes in supported environments
 
+### Helm chart
+
+For Optimize 3.10.1, a new environment variable introduced redirection URL. However, the change is not compatible with Camunda Helm charts until it is fixed in 3.10.3 (and Helm chart 8.2.9). Therefore, those versions are coupled to certain Camunda Helm chart versions:
+
+| Optimize version                  | Camunda Helm chart version |
+| --------------------------------- | -------------------------- |
+| Optimize 3.10.1 & Optimize 3.10.2 | 8.2.0 - 8.2.8              |
+| Optimize 3.10.3                   | 8.2.9+                     |
+
 ### Elasticsearch
 
 Optimize now supports Elasticsearch `8.5` and `8.6`, but it requires at least Elasticsearch `7.16.2`.

diff --git a/versioned_docs/version-8.2/reference/announcements.md b/versioned_docs/version-8.2/reference/announcements.md
@@ -36,6 +36,15 @@ As Camunda 8.2.7 was already released on Tuesday Jun 13th, you can just update t
 
 - Operate version 8.2+ support OpenSearch 1.3.x. However, 8.2.x patches will only be released on the OS 1.3 branch until end of 2023 given that OS 1.3 maintenance period ends by then. We recommend customers to go to 8.3.x which supports OS 2.5+.
 
+### Optimize and Helm chart compatibility
+
+For Optimize 3.10.1, a new environment variable introduced redirection URL. However, the change is not compatible with Camunda Helm charts until it is fixed in 3.10.3 (and Helm chart 8.2.9). Therefore, those versions are coupled to certain Camunda Helm chart versions:
+
+| Optimize version                  | Camunda Helm chart version |
+| --------------------------------- | -------------------------- |
+| Optimize 3.10.1 & Optimize 3.10.2 | 8.2.0 - 8.2.8              |
+| Optimize 3.10.3                   | 8.2.9+                     |
+
 ## Camunda 8.1
 
 Release date: 11th of October 2022

diff --git a/...ed_docs/version-8.2/self-managed/platform-deployment/helm-kubernetes/upgrade.md b/...ed_docs/version-8.2/self-managed/platform-deployment/helm-kubernetes/upgrade.md
@@ -93,6 +93,19 @@ For more details on the Keycloak upgrade path, you can also read the [Bitnami Ke
 
 ## Version update instructions
 
+### v8.2.9
+
+#### Optimize
+
+For Optimize 3.10.1, a new environment variable introduced redirection URL. However, the change is not compatible with Camunda Helm charts until it is fixed in 3.10.3 (and Helm chart 8.2.9). Therefore, those versions are coupled to certain Camunda Helm chart versions:
+
+| Optimize version                  | Camunda Helm chart version |
+| --------------------------------- | -------------------------- |
+| Optimize 3.10.1 & Optimize 3.10.2 | 8.2.0 - 8.2.8              |
+| Optimize 3.10.3                   | 8.2.9+                     |
+
+No action is needed if you use Optimize 3.10.3 (shipped with this Helm chart version by default), but this Optimize version cannot be used out of the box with previous Helm chart versions.
+
 ### v8.2.3
 
 #### Zeebe Gateway