Updated to docs to include minikube and SBOM (#53)

zetane · May 17, 2024 · e889a8f · e889a8f
1 parent d5cd2c3
commit e889a8f
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/docs/assets/disable-SBOM.png b/docs/assets/disable-SBOM.png
diff --git a/docs/disabling-sbom.md b/docs/disabling-sbom.md
@@ -0,0 +1,16 @@
+# Disabling SBOM indexing
+
+Docker Desktop provides a service to analyse security vulnerabilities in images called [Docker Scout](https://docs.docker.com/scout).
+
+Zetaforge pipelines can make multiple image builds at once which can cause Docker Scout to trigger multiple times an create unwanted lag.
+As such, we recommend disabling SBOM indexing, which is used by Docker Scout, to reduce this lag.
+
+# Steps
+
+- On Docker Desktop, go into Settings.
+- In the General tab, scroll down if necessary.
+- Uncheck `SBOM indexing`.
+- Press `Apply & restart`.
+
+![disable-SBOM.png](assets%2Fdisable-SBOM.png)
+
diff --git a/docs/installation.md b/docs/installation.md
@@ -11,8 +11,16 @@ You need to install Docker Desktop or any other container runtime that includes
 Follow the instructions to [install Docker Desktop](https://docs.docker.com/desktop/) from their official website.
 You will need to [enable Kubernetes](https://docs.docker.com/desktop/kubernetes/) to use ZetaForge.
 
+> Note: We recommend [disabling SBOM indexing](disabling-sbom.md) on Docker Desktop for performance reasons.
+
 > Note: We recommend [OrbStack](https://orbstack.dev/download) to macOS users for efficiency and performance reasons.
 
+If enabling Kubernetes is not possible or you would rather not, you can install [Minikube](https://minikube.sigs.k8s.io/docs/start) instead.
+Once installed, run the following command in a terminal to verify the installation:
+```
+minikube version
+```
+
 ## Install ZetaForge
 You can get ZetaForge by downloading the application or installing ZetaForge Python package through pip.