Skip to content

Commit

Permalink
docs: Add dev setup instructions for Apple silicon Macs
Browse files Browse the repository at this point in the history
Signed-off-by: Michi Mutsuzaki <[email protected]>
  • Loading branch information
michi-covalent committed Dec 17, 2024
1 parent 85686f2 commit 5047c19
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/content/en/docs/contribution-guide/development-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,31 @@ If you are getting an error, you can try to run `sudo launchctl load
/Library/LaunchDaemons/org.virtualbox.startup.plist` (from [a Stackoverflow
answer](https://stackoverflow.com/questions/18149546/macos-vagrant-up-failed-dev-vboxnetctl-no-such-file-or-directory)).

## Local Development with Apple Silicon Mac

Use [Lima](https://lima-vm.io/) to create a Linux VM if you are using a Mac with
Apple silicon. For example:

```shell
brew install lima
limactl create --mount-writable --tty=false --name=tetragon
limactl start tetragon
limactl shell tetragon
sudo add-apt-repository -y ppa:longsleep/golang-backports
sudo apt update
sudo apt install -y golang-1.23 libelf-dev libcap-dev make
export CONTAINER_ENGINE=nerdctl
export PATH=$PATH:/usr/lib/go-1.23/bin
make tetragon-bpf tetragon tetra
```

> ⚠️ **IMPORTANT**: This creates a VM, and make the mount for your home
> directory on the host writable. Tweak `~/.lima/tetragon/lima.yaml` if you
> prefer to only mount Tetragon directory as writable.
> 💡 **TIP**: This installs Golang 1.23. You may want to install a newer version
> if it's available in https://launchpad.net/~longsleep/+archive/ubuntu/golang-backports.
## What's next

- See how to [make your first changes](/docs/contribution-guide/making-changes).
Expand Down

0 comments on commit 5047c19

Please sign in to comment.