Skip to content

Update Mac user setup instructions in getting-started guides #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 7, 2025
Merged

Update Mac user setup instructions in getting-started guides #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions versioned_docs/version-v0.3.x/getting-started/multi-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 4 additions & 13 deletions versioned_docs/version-v0.3.x/getting-started/quick-start-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<Tabs>
<TabItem value="docker-desktop" label="Docker Desktop" default>
Go to Docker Desktop Settings → General → Enable "Use Rosetta for x86/amd64 emulation on Apple Silicon"
</TabItem>
<TabItem value="colima" label="Colima">
Start Colima with Rosetta: `colima start --vm-type=vz --vz-rosetta`
</TabItem>
<TabItem value="rancher" label="Rancher Desktop">
Go to Rancher Desktop Settings → Container Engine → Enable "Use Rosetta for x86_64 emulation"
</TabItem>
</Tabs>
- **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
Expand Down
4 changes: 4 additions & 0 deletions versioned_docs/version-v0.3.x/getting-started/single-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down