Skip to content

Commit ae4a6a9

Browse files
authored
Update worker_vm.md
1 parent 2d20a11 commit ae4a6a9

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

_docs/developer/getting_started/worker_vm.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,28 @@ machines* in addition to your primary vagrant virtual machine.
2727
```
2828
For multiple workers, use the `-n` flag. (ex. `-n 3` for 3 machines).
2929

30+
This command will generate workers for `virtualbox`, or `qemu` if you are on M-series macOS.
3031
If using a provider other than the default for your system, use the `--provider` flag.
31-
(ex. `--provider parallels`)
32+
(ex. `--provider my-custom-provider`)
3233

33-
4. If you are on MacOS running QEMU, make sure to restart the network socket.
34+
5. If you are on MacOS running QEMU, make sure to restart the network socket.
3435
```
3536
vagrant workers socket restart
3637
```
3738
If the VM runs into errors when attempting to reach the internet, try starting the socket
38-
in public mode. (`--public`)
39+
in public mode. (`vagrant workers socket restart --public`)
3940

40-
5. Now you can provision the virtual machines with:
41+
6. Now you can create the worker machine(s) with:
4142
```
4243
vagrant workers up
4344
```
45+
Do not use the --provider flag with this command, since it will conflict with the
46+
provider generated in step 3.
47+
48+
7. Once all the workers are fully set up and running, `vagrant ssh` into the main VM and run:
49+
```
50+
refresh_vagrant_workers
51+
```
4452

4553
---
4654

@@ -50,14 +58,15 @@ If you would like to ensure the worker is functioning properly, or enter the wor
5058

5159
To connect to a worker machine through SSH, run:
5260
```
53-
vagrant ssh <worker-name>
61+
vagrant workers ssh <worker-name>
5462
```
5563

5664
If you want to test the connection between the primary VM and a worker, you can first `vagrant ssh` into the primary machine and then run this command to SSH into the worker from there:
5765
```
58-
su submitty_daemon -c ssh submitty@<ip-address>
66+
su submitty_daemon -c ssh <worker-name>
5967
```
60-
The IP address of the worker machine will be indicated in the `.vagrant/workers.json` file.
68+
69+
The list of worker names can be displayed with `vagrant workers status`.
6170

6271
__NOTE__: Depending on the performance of your computer and the size of the autograding queue passed to the worker, the SSH command may hang for some time.
6372

0 commit comments

Comments
 (0)