Skip to content

Commit 3783a50

Browse files
Merge pull request #107 from VajiraPrabuddhaka/update-mac-setup-instructions
Update Mac user setup instructions in getting-started guides
2 parents a47a4bc + 717668e commit 3783a50

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

versioned_docs/version-v0.3.x/getting-started/multi-cluster.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ This guide walks you through step-by-step instructions for deploying OpenChoreo
1616
- **Docker** – Just have it installed on your machine, and you're good to go.
1717
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
1818
- Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker).
19+
- **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`
20+
:::note
21+
If you encounter issues with other Docker alternatives (Docker Desktop, Rancher Desktop, etc.), please [report them on GitHub](https://github.com/openchoreo/openchoreo/issues).
22+
:::
1923
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) v0.20+ installed
2024
- [kubectl](https://kubernetes.io/docs/tasks/tools/) v1.32+ installed
2125
- [Helm](https://helm.sh/docs/intro/install/) v3.12+ installed

versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,10 @@ To get started, you'll need:
2323
- **Docker** – Have it installed on your machine, and you're good to go.
2424
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
2525
- Allocate at least **4 GB of RAM** and **2 CPU** cores to Docker (or the VM running Docker).
26-
- **Important**: For Mac users, enable Rosetta emulator instead of QEMU to ensure buildpacks work correctly:
27-
28-
<Tabs>
29-
<TabItem value="docker-desktop" label="Docker Desktop" default>
30-
Go to Docker Desktop Settings → General → Enable "Use Rosetta for x86/amd64 emulation on Apple Silicon"
31-
</TabItem>
32-
<TabItem value="colima" label="Colima">
33-
Start Colima with Rosetta: `colima start --vm-type=vz --vz-rosetta`
34-
</TabItem>
35-
<TabItem value="rancher" label="Rancher Desktop">
36-
Go to Rancher Desktop Settings → Container Engine → Enable "Use Rosetta for x86_64 emulation"
37-
</TabItem>
38-
</Tabs>
26+
- **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`
27+
:::note
28+
If you encounter issues with other Docker alternatives (Docker Desktop, Rancher Desktop, etc.), please [report them on GitHub](https://github.com/openchoreo/openchoreo/issues).
29+
:::
3930
- **5–10 minutes of your time** – Setup is quick and depends on your internet connection speed.
4031

4132
## Start the Dev Container

versioned_docs/version-v0.3.x/getting-started/single-cluster.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ This guide provides step-by-step instructions for setting up a local development
1616
- **Docker** – Just have it installed on your machine, and you're good to go.
1717
- We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/).
1818
- Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker).
19+
- **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`
20+
:::note
21+
If you encounter issues with other Docker alternatives (Docker Desktop, Rancher Desktop, etc.), please [report them on GitHub](https://github.com/openchoreo/openchoreo/issues).
22+
:::
1923
- **[Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)** v0.20+ installed
2024
- **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed
2125
- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed

0 commit comments

Comments
 (0)