diff --git a/versioned_docs/version-v0.3.x/getting-started/multi-cluster.mdx b/versioned_docs/version-v0.3.x/getting-started/multi-cluster.mdx index d0de49a..7932800 100644 --- a/versioned_docs/version-v0.3.x/getting-started/multi-cluster.mdx +++ b/versioned_docs/version-v0.3.x/getting-started/multi-cluster.mdx @@ -16,6 +16,10 @@ This guide walks you through step-by-step instructions for deploying OpenChoreo - **Docker** – Just have it installed on your machine, and you're good to go. - We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/). - Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker). + - **Important for Mac users**: We recommend using [Colima](https://github.com/abiosoft/colima) with VZ Rosetta support for optimal compatibility. Start Colima with: `colima start --vm-type=vz --vz-rosetta --cpu 4 --memory 8` + :::note + If you encounter issues with other Docker alternatives (Docker Desktop, Rancher Desktop, etc.), please [report them on GitHub](https://github.com/openchoreo/openchoreo/issues). + ::: - [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) v0.20+ installed - [kubectl](https://kubernetes.io/docs/tasks/tools/) v1.32+ installed - [Helm](https://helm.sh/docs/intro/install/) v3.12+ installed diff --git a/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx b/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx index 6651630..4614fea 100644 --- a/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx +++ b/versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx @@ -23,19 +23,10 @@ To get started, you'll need: - **Docker** – Have it installed on your machine, and you're good to go. - We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/). - Allocate at least **4 GB of RAM** and **2 CPU** cores to Docker (or the VM running Docker). - - **Important**: For Mac users, enable Rosetta emulator instead of QEMU to ensure buildpacks work correctly: - - - - Go to Docker Desktop Settings → General → Enable "Use Rosetta for x86/amd64 emulation on Apple Silicon" - - - Start Colima with Rosetta: `colima start --vm-type=vz --vz-rosetta` - - - Go to Rancher Desktop Settings → Container Engine → Enable "Use Rosetta for x86_64 emulation" - - + - **Important for Mac users**: We recommend using [Colima](https://github.com/abiosoft/colima) with VZ Rosetta support for optimal compatibility. Start Colima with: `colima start --vm-type=vz --vz-rosetta --cpu 2 --memory 4` + :::note + If you encounter issues with other Docker alternatives (Docker Desktop, Rancher Desktop, etc.), please [report them on GitHub](https://github.com/openchoreo/openchoreo/issues). + ::: - **5–10 minutes of your time** – Setup is quick and depends on your internet connection speed. ## Start the Dev Container diff --git a/versioned_docs/version-v0.3.x/getting-started/single-cluster.mdx b/versioned_docs/version-v0.3.x/getting-started/single-cluster.mdx index bc843d2..b265c0d 100644 --- a/versioned_docs/version-v0.3.x/getting-started/single-cluster.mdx +++ b/versioned_docs/version-v0.3.x/getting-started/single-cluster.mdx @@ -16,6 +16,10 @@ This guide provides step-by-step instructions for setting up a local development - **Docker** – Just have it installed on your machine, and you're good to go. - We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/). - Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker). + - **Important for Mac users**: We recommend using [Colima](https://github.com/abiosoft/colima) with VZ Rosetta support for optimal compatibility. Start Colima with: `colima start --vm-type=vz --vz-rosetta --cpu 4 --memory 8` + :::note + If you encounter issues with other Docker alternatives (Docker Desktop, Rancher Desktop, etc.), please [report them on GitHub](https://github.com/openchoreo/openchoreo/issues). + ::: - **[Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)** v0.20+ installed - **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed - **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed