chore: update installation.md for ARM user (#245)

* chore: update installation.md Signed-off-by: namkyu1999 <[email protected]> * chore: delete specific image info Signed-off-by: namkyu1999 <[email protected]> * chore: fix typos and add hyperlink Signed-off-by: namkyu1999 <[email protected]> --------- Signed-off-by: namkyu1999 <[email protected]>
litmuschaos · Oct 25, 2023 · 6c65876 · 6c65876
1 parent 529168b
commit 6c65876
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/website/docs/getting-started/installation.md b/website/docs/getting-started/installation.md
@@ -73,6 +73,16 @@ helm install chaos litmuschaos/litmus --namespace=litmus --set portal.frontend.s
 
 > **Note:** If your Kubernetes cluster isn't local, you may want not to expose Litmus via `NodePort`. If so, remove `--set portal.frontend.service.type=NodePort` option. To connect to Litmus UI from your laptop, you can use `port-forward svc/chaos-litmus-frontend-service 9091:9091`. Then you can use your browser and open `127.0.0.1:9091`.
 
+- Litmus helm chart depends on `bitnami/mongodb` [helm chart](https://github.com/bitnami/charts/tree/main/bitnami/mongodb), which uses a mongodb image not supported on ARM. If you want to install Litmus on an ARM-based server, please replace the default one with your custom mongodb arm image as shown below.
+
+  ```bash
+  helm install chaos litmuschaos/litmus --namespace=litmus \
+  --set portal.frontend.service.type=NodePort \
+  --set mongodb.image.registry=<put_registry> \
+  --set mongodb.image.repository=<put_image_repository> \
+  --set mongodb.image.tag=<put_image_tag>
+  ```
+
 <span style={{color: 'green'}}><b>Expected Output</b></span>
 
 ```

diff --git a/website/versioned_docs/version-3.0.0/getting-started/installation.md b/website/versioned_docs/version-3.0.0/getting-started/installation.md
@@ -73,6 +73,16 @@ helm install chaos litmuschaos/litmus --namespace=litmus --set portal.frontend.s
 
 > **Note:** If your Kubernetes cluster isn't local, you may want not to expose Litmus via `NodePort`. If so, remove `--set portal.frontend.service.type=NodePort` option. To connect to Litmus UI from your laptop, you can use `port-forward svc/chaos-litmus-frontend-service 9091:9091`. Then you can use your browser and open `127.0.0.1:9091`.
 
+- Litmus helm chart depends on `bitnami/mongodb` [helm chart](https://github.com/bitnami/charts/tree/main/bitnami/mongodb), which uses a mongodb image not supported on ARM. If you want to install Litmus on an ARM-based server, please replace the default one with your custom mongodb arm image as shown below.
+
+  ```bash
+  helm install chaos litmuschaos/litmus --namespace=litmus \
+  --set portal.frontend.service.type=NodePort \
+  --set mongodb.image.registry=<put_registry> \
+  --set mongodb.image.repository=<put_image_repository> \
+  --set mongodb.image.tag=<put_image_tag>
+  ```
+
 <span style={{color: 'green'}}><b>Expected Output</b></span>
 
 ```