Add README steps to upgrade Timesketch DB (#162)

* Add steps to upgrade Timesketch DB * bumping chart version --------- Signed-off-by: Janosch <[email protected]>
google · Aug 30, 2024 · 9a85fd3 · 9a85fd3
1 parent d20a1c0
commit 9a85fd3
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 1 deletion.
diff --git a/charts/timesketch/Chart.yaml b/charts/timesketch/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: timesketch
-version: 1.0.5
+version: 1.0.6
 description: A Helm chart for Timesketch Kubernetes deployments.
 keywords:
 - timesketch

diff --git a/charts/timesketch/README.md b/charts/timesketch/README.md
@@ -357,6 +357,42 @@ image tag to `latest` and increasing persistent volume size of an existing volum
 to 10 Terabytes. Note that existing data will not be deleted and instead triggers an expansion
 of the volume that backs the underlying PersistentVolume. See [here](https://kubernetes.io/docs/concepts/storage/persistent-volumes/).
 
+### Upgrade Timesketch Database Schema
+
+From time to time, a Timesketch release requires a manual database upgrade if
+the schema has changed.
+The [Timesketch release page](https://github.com/google/timesketch/releases)
+will indicate if a database upgrade is required.
+
+Follow these steps to upgrade the database on your Kubernetes deployment:
+
+1. **Upgrade Timesketch (if not already done):**
+   - Upgrade your Timesketch deployment to the desired release version:
+
+     ```bash
+     helm upgrade my-release osdfir-charts/timesketch --set image.tag=<VERSION> --set image.pullPolicy=Always
+     ```
+
+2. **Connect to Timesketch Pod:**
+   - Once the upgraded pods are ready, shell into the Timesketch pod:
+
+     ```bash
+     kubectl exec -it my-release-timesketch-<RANDOM> -- /bin/bash
+     ```
+
+     - Find your pod name using `kubectl get pods`.
+
+3. **Perform Database Upgrade:**
+   - Follow the detailed steps in the [Timesketch documentation to upgrade your database](https://timesketch.org/guides/admin/upgrade/#upgrade-the-database-schema).
+
+4. **Restart Timesketch (Recommended):**
+   - After a successful database upgrade, it is recommended to restart your
+   Timesketch deployment for the changes to take full effect:
+
+      ```bash
+      kubectl rollout restart deployment my-release-timesketch-web
+      ```
+
 ## Troubleshooting
 
 There is a known issue causing PostgreSQL authentication to fail. This occurs