Skip to content

Commit 404e515

Browse files
authored
Update worker_vm.md
1 parent 04d941e commit 404e515

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

_docs/developer/getting_started/worker_vm.md

+19-7
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ machines* in addition to your primary vagrant virtual machine.
1919
python3 --version
2020
```
2121

22-
3. Generate configuration for the worker machine(s).
22+
3. To generate configuration for a worker machine, run:
2323
```
2424
vagrant workers generate
2525
```
2626

27-
For multiple workers, append the `-n` flag. (ex. `-n 3` for 3 machines).
27+
If instead you need multiple workers, append the `-n` flag, ex. for 3 machines:
2828
```
2929
vagrant workers generate -n 3
3030
```
@@ -41,10 +41,12 @@ machines* in addition to your primary vagrant virtual machine.
4141
We suggest this to minimize possibility of errors while creating the
4242
worker machines and will revert this in a later step._
4343

44-
__NOTE__: Never interact with the socket while a worker machine is running.
45-
This can make the machine inaccessible.
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 halt
47+
the worker machine._
4648

47-
5. Now you can create the worker machine(s) with:
49+
6. Now you can create the worker machine(s) with:
4850
```
4951
vagrant workers up
5052
```
@@ -53,17 +55,27 @@ machines* in addition to your primary vagrant virtual machine.
5355

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

56-
6. You can verify that all the worker machines are running with:
58+
7. You can verify that all the worker machines are running with:
5759
```
5860
vagrant workers status
5961
```
6062

61-
7. `vagrant ssh` into the main virtual machine and run:
63+
8. `vagrant ssh` into the main virtual machine and run:
6264
```
6365
refresh_vagrant_workers # (runs python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/bin/refresh_vagrant_workers.py)
6466
submitty_install
6567
```
6668

69+
9. To stop the worker machines, you can run:
70+
```
71+
vagrant workers halt
72+
vagrant workers socket stop
73+
```
74+
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+
78+
6779
---
6880

6981
## Connecting to the Worker Machine

0 commit comments

Comments
 (0)