Skip to content

Commit f0260b4

Browse files
akila-iyashodgayashan
authored andcommitted
docs: update upgrade instructions for Observability Plane and related modules
Signed-off-by: Akila-I <akila.99g@gmail.com>
1 parent 3c3dd21 commit f0260b4

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

docs/platform-engineer-guide/upgrades.mdx

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,66 @@ kubectl rollout status deployment -n openchoreo-control-plane
119119

120120
**4. Observability Plane (if installed)**
121121

122+
:::warning Observer deployment strategy change may cause Helm upgrade failure
123+
Observer deployment rolling strategy is conditionally being set based on the alertStoreBackend since v1.0.0.
124+
If you are using the `sqlite` as the alert store backend (which is the default), execute the following patch
125+
command before upgrading the observability plane to avoid Helm upgrade failures:
126+
127+
```bash
128+
kubectl patch deployment observer -n openchoreo-observability-plane \
129+
-p '{"spec":{"strategy":{"type":"Recreate","rollingUpdate":null}}}'
130+
```
131+
132+
:::
133+
122134
<CodeBlock language="bash">
123135
{`helm upgrade openchoreo-observability-plane ${versions.helmSource}/openchoreo-observability-plane \\
124136
--version ${versions.helmChart} \\
125137
--namespace openchoreo-observability-plane \\
126138
--reset-then-reuse-values`}
127139
</CodeBlock>
128140

141+
If you are using the default logs, metrics, and traces modules with the versions specified in OpenChoreo v1.0.0 documentation,
142+
you may also need to upgrade them to the versions compatible with OpenChoreo {versions.helmChart} as well.
143+
144+
- Observability Logs OpenSearch module: v0.3.11 -> v0.4.0
145+
146+
```bash
147+
helm upgrade --install observability-logs-opensearch \
148+
oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \
149+
--create-namespace \
150+
--namespace openchoreo-observability-plane \
151+
--version 0.4.0 \
152+
--reset-then-reuse-values \
153+
--set openSearchSetup.openSearchSecretName="opensearch-admin-credentials" \
154+
--set adapter.openSearchSecretName="opensearch-admin-credentials"
155+
```
156+
157+
- Observability Traces OpenSearch module: v0.3.11 -> v0.4.1
158+
159+
```bash
160+
helm upgrade --install observability-traces-opensearch \
161+
oci://ghcr.io/openchoreo/helm-charts/observability-tracing-opensearch \
162+
--create-namespace \
163+
--namespace openchoreo-observability-plane \
164+
--version 0.4.1 \
165+
--reset-then-reuse-values \
166+
--set openSearch.enabled=false \
167+
--set openSearchSetup.openSearchSecretName="opensearch-admin-credentials"
168+
```
169+
170+
- Observability Metrics Prometheus module: v0.2.5 -> v0.6.1
171+
172+
```bash
173+
helm upgrade --install observability-metrics-prometheus \
174+
oci://ghcr.io/openchoreo/helm-charts/observability-metrics-prometheus \
175+
--create-namespace \
176+
--namespace openchoreo-observability-plane \
177+
--version 0.6.1 \
178+
--reset-then-reuse-values \
179+
--set adapter.image.tag=""
180+
```
181+
129182
### Multi Cluster Deployment
130183

131184
Follow the same order, but use `--kube-context` for each cluster:

0 commit comments

Comments
 (0)