chore: apple silicon instructions for CONTRIBUTING.md & vagrant/READM…

…E.md (#3691) * chore: apple silicon instructions for CONTRIBUTING.md & vagrant/README.md Signed-off-by: Justin Kolberg <[email protected]> * changelog Signed-off-by: Justin Kolberg <[email protected]> --------- Signed-off-by: Justin Kolberg <[email protected]>
SumoLogic · Jun 5, 2024 · a6f2453 · a6f2453
1 parent f7bafe0
commit a6f2453
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 7 deletions.
diff --git a/.changelog/3691.added.txt b/.changelog/3691.added.txt
@@ -0,0 +1 @@
+chore: apple silicon instructions for CONTRIBUTING.md & vagrant/README.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,8 +16,23 @@ There is a prepared Vagrant environment with [microk8s](https://microk8s.io/) se
 You'll need to use QEMU instead of VirtualBox to use Vagrant on ARM. The following instructions will assume an M1 Mac as the host:
 
 1. Install QEMU: `brew install qemu`
-2. Install the QEMU vagrant provider: `vagrant plugin install vagrant-qemu`
-3. Provision the VM with the provider: `vagrant up --provider=qemu`
+1. Install the QEMU vagrant provider: `vagrant plugin install vagrant-qemu`
+1. Set the default Vagrant provider to QEMU:
+
+```bash
+echo 'export VAGRANT_DEFAULT_PROVIDER=qemu' >> ~/.zshrc
+source ~/.zshrc
+```
+
+1. Enable SMB sharing:
+
+```bash
+sudo launchctl load -w /System/Library/LaunchDaemons/com.apple.smbd.plist
+```
+
+1. Provision the VM with the provider: `vagrant up`
+
+If asked for a username and password, enter your macOS user credentials.
 
 ### Using nix
 

diff --git a/vagrant/README.md b/vagrant/README.md
@@ -2,18 +2,48 @@
 
 ## Prerequisites
 
-Please install the following:
+### MacOS (Intel processors)
 
-- [VirtualBox](https://www.oracle.com/virtualization/technologies/vm/downloads/virtualbox-downloads.html)
-- [Vagrant](https://www.vagrantup.com/)
+```bash
+brew install --cask virtualbox
+brew install --cask vagrant
+```
+
+### MacOS (Apple Silicon processors)
 
-### MacOS
+1. Install prerequesites:
 
 ```bash
-brew install --cask virtualbox
+brew install qemu
 brew install --cask vagrant
 ```
 
+1. Install the QEMU vagrant provider:
+
+```bash
+vagrant plugin install vagrant-qemu
+```
+
+1. Set the default Vagrant provider to QEMU:
+
+```bash
+echo 'export VAGRANT_DEFAULT_PROVIDER=qemu' >> ~/.zshrc
+source ~/.zshrc
+```
+
+1. Enable SMB sharing:
+
+```bash
+sudo launchctl load -w /System/Library/LaunchDaemons/com.apple.smbd.plist
+```
+
+### Other
+
+Please install Vagrant and a Vagrant-compatible provider such as VirtualBox:
+
+- [VirtualBox](https://www.oracle.com/virtualization/technologies/vm/downloads/virtualbox-downloads.html)
+- [Vagrant](https://www.vagrantup.com/)
+
 ## Setting up
 
 You can set up the Vagrant environment with just one command:
@@ -22,6 +52,8 @@ You can set up the Vagrant environment with just one command:
 vagrant up
 ```
 
+If asked for a username and password, enter your macOS user credentials.
+
 If you experience following error (MacOS specific)
 
 ````