Skip to content

Commit 2d20a11

Browse files
committed
new worker vm instructions
1 parent 7e00252 commit 2d20a11

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

_docs/developer/getting_started/worker_vm.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,36 @@ machines* in addition to your primary vagrant virtual machine.
1111

1212
## Automated Worker Installation
1313

14-
These steps will create a worker machine alongside the normal Submitty machine.
15-
1. Make sure to destroy any existing vagrant machines with
16-
```
17-
vagrant destroy
18-
```
19-
20-
2. Ensure you have [Python 3](https://www.python.org/downloads/) installed on your machine
21-
22-
3. Generate configuration for the desired number of worker machines
14+
1. Make sure to destroy any existing worker machines before generating a new worker configuration.
15+
Failure to do this could result in 'hidden' worker machines from the previous configuration
16+
still running on your computer, taking up disk space and resources.
2317
```
24-
python3 generate_workers.py [-n NUM] [--ip-range IP_RANGE] [--base-port PORT]
18+
vagrant workers destroy
2519
```
26-
This will create or update a configuration file stored at `.vagrant/workers.json`.
27-
Now you can create the virtual machines with:
20+
21+
2. Ensure you have [Python 3](https://www.python.org/downloads/) installed on your machine.
22+
`python3 --version`
23+
24+
3. Generate configuration for the worker machine(s).
2825
```
29-
vagrant up
26+
vagrant workers generate
3027
```
28+
For multiple workers, use the `-n` flag. (ex. `-n 3` for 3 machines).
3129

32-
If you happen to encounter error messages regarding IP addresses or port conflicts, you can manually edit the `workers.json` file as needed.
33-
34-
__NOTE__: Do not edit the `workers.json` configuration file or run the aforementioned python script if there are any existing vagrant machines in your project. This can result in the existing VMs continuing to run in the background or storing their data with no clean way to remove them.
30+
If using a provider other than the default for your system, use the `--provider` flag.
31+
(ex. `--provider parallels`)
3532

36-
4. To delete the worker machines and revert to a normal development setup, you can first run
33+
4. If you are on MacOS running QEMU, make sure to restart the network socket.
3734
```
38-
vagrant destroy
35+
vagrant workers socket restart
3936
```
40-
And confirm to delete all the existing virtual machines.
37+
If the VM runs into errors when attempting to reach the internet, try starting the socket
38+
in public mode. (`--public`)
4139

42-
Next, you can delete the `workers.json` file, which will remove the worker configuration from your project.
43-
The next `vagrant up` should only create the primary development virtual machine without any workers.
40+
5. Now you can provision the virtual machines with:
41+
```
42+
vagrant workers up
43+
```
4444

4545
---
4646

0 commit comments

Comments
 (0)