🐛 Extend Helm related docs (#848)

This should clarify some situations. Fixes: mondoohq/server#6272 Related-to: mondoohq/server#6267 Signed-off-by: Christian Zunker <[email protected]>
mondoohq · Sep 5, 2023 · 5676da6 · 5676da6
1 parent 39f3398
commit 5676da6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/operator-upgrades.md b/docs/operator-upgrades.md
@@ -8,6 +8,14 @@ You can skip Mondoo Operator patch and minor versions.
 
 As of version 1.0, the Mondoo Operator can be upgraded from major version to major version as long as each major version is visited during the upgrade. For example, if you are on version 1.3.2 and wanted to upgrade to version 3.0.5, you should first upgrade to a 2.y.z release to ensure any migrations that need to take place from 1.x to 2.x are completed before upgrading to 3.x. Jumping from any 1.x to any 2.x is a safe operation.
 
+### Updating an operator deployed with Helm
+
+Two update your operator installed with Helm, you have two options:
+
+- Upgrade the Helm chart to the [latest release](https://github.com/mondoohq/mondoo-operator/releases/latest)
+- Update the [values](https://github.com/mondoohq/mondoo-operator/blob/main/charts/mondoo-operator/values.yaml#L17) for the Helm chart to the latest image tag which matched the latest Helm chart release.
+  You can also find it [here](https://github.com/mondoohq/mondoo-operator/pkgs/container/mondoo-operator/versions?filters%5Bversion_type%5D=tagged)
+
 ## Pre 1.0
 
 For pre-1.0 releases, we don't recommend skipping minor versions. For example, if you upgrade from `v0.2.0` directly to `v0.4.0`, the Mondoo Operator may not behave as expected, and you may leave behind unused resources in the cluster. Skipping a minor version may require manual actions to ensure the Mondoo Operator is fully functional.

diff --git a/docs/user-manual.md b/docs/user-manual.md
@@ -46,6 +46,13 @@ Preconditions:
    helm install mondoo-operator mondoo/mondoo-operator --namespace mondoo-operator --create-namespace
    ```
 
+#### Customization
+
+In case you set the Chart name to a different name, this will break parts of the operator, unless you also set:
+```
+fullnameOverride=mondoo-operator
+```
+
 ### Installing with Operator Lifecycle Manager (OLM)
 
 Follow these steps to set up the Mondoo Operator using [Operator Lifecycle Manager (OLM)](https://olm.operatorframework.io/):