Skip to content

Commit 7e31eb0

Browse files
committed
Mark virtualbox as only supported provider including arm
1 parent 020140d commit 7e31eb0

File tree

4 files changed

+20
-74
lines changed

4 files changed

+20
-74
lines changed

Gemfile.lock

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ GEM
3939
logger
4040
faraday-net_http (3.1.1)
4141
net-http
42+
ffi (1.17.2-aarch64-linux-gnu)
4243
ffi (1.17.2-arm64-darwin)
4344
ffi (1.17.2-x64-mingw-ucrt)
4445
ffi (1.17.2-x86_64-linux-gnu)
@@ -239,6 +240,8 @@ GEM
239240
mutex_m (0.2.0)
240241
net-http (0.4.1)
241242
uri
243+
nokogiri (1.18.9-aarch64-linux-gnu)
244+
racc (~> 1.4)
242245
nokogiri (1.18.9-arm64-darwin)
243246
racc (~> 1.4)
244247
nokogiri (1.18.9-x64-mingw-ucrt)
@@ -284,6 +287,7 @@ GEM
284287
yell (2.2.2)
285288

286289
PLATFORMS
290+
aarch64-linux-gnu
287291
arm64-darwin-22
288292
arm64-darwin-23
289293
arm64-darwin-24

_docs/developer/getting_started/vm_install_using_vagrant.md

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ Machine (VM) on your computer and the VM will use the Ubuntu GNU/Linux
1515
operating system.
1616

1717
***NOTE:** We only officially support and test development using
18-
VirtualBox for AMD and Intel machines and QEMU for
19-
M-Series ARM MacOS machines.*
18+
VirtualBox.*
2019

2120
---
2221

@@ -51,14 +50,7 @@ M-Series ARM MacOS machines.*
5150
platform and prevent VirtualBox from working correctly. It is recommended to not install
5251
or use WSL2 alongside VirtualBox for now.*
5352

54-
5. If you're on an M-series ARM MacOS (e.g., M1, M2, M3),
55-
you will be using QEMU with SMB file sharing.
56-
To enable this, open **System Settings** and navigate to **General > Sharing**.
57-
Press the (i) button next to **File Sharing**, and in the popup window
58-
click "Options...". Then turn on "Share files and folders using SMB" and
59-
check the box next to your name in the list below.
60-
61-
6. The complete installation process could take an hour or more and
53+
5. The complete installation process could take an hour or more and
6254
will probably fail if paused or interrupted. Make
6355
sure your internet connection is strong and consistent. You'll
6456
probably want to plug in your laptop power cord. Check your
@@ -122,24 +114,14 @@ M-Series ARM MacOS machines.*
122114
* [Ruby](https://www.ruby-lang.org/en/downloads)
123115
* [Git](https://git-scm.com/downloads)
124116
* [Vagrant](https://developer.hashicorp.com/vagrant/install)
125-
* *M-SERIES ARM MacOS:* [QEMU](https://www.qemu.org)
126-
* *EVERYONE ELSE:* [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
117+
* [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
127118
* Ensure VirtualBox version is compatible with Vagrant.
128119

129120

130121
* **MacOS**
131122
You can either go to respective sites and download the necessary binaries or
132123
install [Homebrew](http://brew.sh/), if you don't have it, and then:
133124

134-
If you have an M-series ARM Mac, run:
135-
```
136-
brew install --cask vagrant
137-
brew install qemu
138-
vagrant plugin install vagrant-qemu
139-
```
140-
141-
Or if you have an older Intel-based Mac, run:
142-
143125
```
144126
brew install --cask vagrant
145127
brew install --cask virtualbox
@@ -243,9 +225,6 @@ M-Series ARM MacOS machines.*
243225
244226
245227
* **Build pre-packaged VM**
246-
247-
*NOTE: The pre-packaged Submitty VM is not (yet)
248-
available for QEMU / M-Series ARM Mac machines.*
249228
250229
If you are using VirtualBox as your provider, you will by default
251230
use a pre-packaged Submitty VM. This will have all of Submitty
@@ -285,13 +264,8 @@ M-Series ARM MacOS machines.*
285264
286265
287266
* **Build from scratch**
288-
289-
* Using QEMU on an M-Series Arm MacOS, type:
290-
```
291-
vagrant up --provider=qemu
292-
```
293267
294-
* On Linux or Intel-based Mac, type:
268+
* On Linux or Mac, type:
295269
```
296270
FROM_SCRATCH=1 vagrant up --provider=virtualbox
297271
```
@@ -326,12 +300,7 @@ M-Series ARM MacOS machines.*
326300
creation of these sample submissions and their autograding and
327301
decrease the time to complete installation.
328302
329-
* On M-series ARM Mac:
330-
```
331-
NO_SUBMISSIONS=1 vagrant up --provider=qemu
332-
```
333-
334-
* On Linux or Intel-based Mac:
303+
* On Linux or Mac:
335304
```
336305
NO_SUBMISSIONS=1 FROM_SCRATCH=1 vagrant up --provider=virtualbox
337306
```

_docs/developer/getting_started/worker_vm.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,7 @@ machines* in addition to your primary vagrant virtual machine.
3131

3232
_NOTE: This will create the vagrant configuration file: `.vagrant/workers.json`._
3333

34-
35-
4. If you are on MacOS running QEMU, restart the network socket in public mode:
36-
```
37-
vagrant workers socket restart --public
38-
```
39-
_NOTE: Using the `--public` flag will make your worker VMs accessible to anyone
40-
on your local network, which may be a modest security concern.
41-
We suggest this to minimize possibility of errors while creating the
42-
worker machines and will revert this in a later step._
43-
44-
_NOTE: Running a socket command while a worker machine is running can detach the
45-
process, making the VM inaccessible to vagrant. If this happens and you are unable
46-
to `vagrant workers halt`, then you may run `pkill -15 -f qemu-system-` to kill
47-
all virtual machines running on your computer (including the main Submitty VM)._
48-
49-
6. Now you can create the worker machine(s) with:
34+
4. Now you can create the worker machine(s) with:
5035
```
5136
vagrant workers up
5237
```
@@ -55,26 +40,23 @@ machines* in addition to your primary vagrant virtual machine.
5540

5641
When this is finished, you should see the Submitty duck ASCII art for each new worker machine.
5742

58-
7. You can verify that all the worker machines are running with:
43+
5. You can verify that all the worker machines are running with:
5944
```
6045
vagrant workers status
6146
```
6247

63-
8. `vagrant ssh` into the main virtual machine and run:
48+
6. `vagrant ssh` into the main virtual machine and run:
6449
```
6550
refresh_vagrant_workers # (runs python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/bin/refresh_vagrant_workers.py)
6651
submitty_install
6752
```
6853

69-
9. To stop the worker machines, you can run:
54+
7. To stop the worker machines, you can run:
7055
```
7156
vagrant workers halt
7257
vagrant workers socket stop
7358
```
7459

75-
_For MacOS QEMU users: Once the virtual machine(s) are halted, if you would like to restart under
76-
private networking, you may do so by omitting the `--public` flag from the `vagrant workers socket start` command._
77-
7860

7961
---
8062

_docs/developer/troubleshooting/installation_troubleshooting.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ References and useful links: [https://gist.github.com/pjdietz/5768124](https://g
190190
191191
## SSH connection was unexpectedly closed
192192
193-
* If you see an error similar to on ARM64 Machine (Apple Silicon):
193+
* If you see an error similar to:
194194
195195
```
196196
The SSH connection was unexpectedly closed by the remote end. This
@@ -219,19 +219,10 @@ References and useful links: [https://gist.github.com/pjdietz/5768124](https://g
219219
vagrant box update
220220
```
221221
222-
* Verify qemu is install correctly
223-
224-
* Firstly, use this command will display the installed version of QEMU for ARM64.
225-
```
226-
qemu-system-aarch64 --version
227-
```
228-
229-
* Secondly, Verify that the QEMU binary for ARM64 is accessible in your system's PATH by running:
230-
```
231-
which qemu-system-aarch64
232-
```
233-
234-
*Note: This command will display the path to the QEMU ARM64 binary (e.g., /opt/homebrew/bin/qemu-system-aarch64)
222+
* Verify Virtualbox is install correctly
223+
```
224+
VirtualBox -h
225+
```
235226
236227
* Verify Vagrant Installation
237228
```
@@ -262,9 +253,9 @@ References and useful links: [https://gist.github.com/pjdietz/5768124](https://g
262253
vagrant destroy
263254
```
264255
265-
* Boots up a new Vagrant environment using the QEMU provider
256+
* Boots up a new Vagrant environment
266257
```
267-
vagrant up --provider=qemu
258+
vagrant up --provider=virtualbox
268259
```
269260
270261
---

0 commit comments

Comments
 (0)