Skip to content

Commit 333718e

Browse files
authored
[Documentation:Developer] from scratch worker install (#765)
The developer instructions concerning the installation of worker VMs did not mention that it would be possible / situationally necessary to install the workers from scratch. I have added a note about this. I opted not to describe what the from scratch option actually does as it is documented in VM Install using Vagrant. Screenshot: <img width="1920" height="951" alt="image" src="https://github.com/user-attachments/assets/fa3dcf5c-a8b9-4333-ae8c-a182cc0e4b8c" /> Additionally, I am also adding a note about how to remove the worker VMs, since there is nothing about that either. Screenshot: <img width="1920" height="951" alt="image" src="https://github.com/user-attachments/assets/ae9752b7-e24f-4b18-8eb1-adf06dd2b52e" />
1 parent a920b6d commit 333718e

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

_docs/developer/getting_started/worker_vm.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,18 @@ machines* in addition to your primary vagrant virtual machine.
3535
```
3636
vagrant workers up
3737
```
38+
Alternatively, if you are testing the worker install process, it may be helpful to install the worker machine(s) from scratch.
39+
40+
On Linux or Mac type:
41+
```
42+
FROM_SCRATCH=1 vagrant workers up
43+
```
44+
On Windows with `cmd` type:
45+
```
46+
SET FROM_SCRATCH=1
47+
vagrant workers up
48+
```
49+
3850
_NOTE: Do not use the --provider flag with this command, since it will conflict with the
3951
provider of the main virtual machine._
4052

@@ -80,6 +92,24 @@ __NOTE__: Depending on the performance of your computer and the size of the auto
8092

8193
---
8294

95+
## Removing Worker Machine(s)
96+
97+
If you would like to remove your worker machine(s), run:
98+
```
99+
vagrant workers destroy
100+
```
101+
For each worker machine, you will be prompted on whether you would like to remove it.
102+
103+
Alternatively, you can also destroy worker machines individually using:
104+
```
105+
vagrant destroy 1a2b3c4d
106+
```
107+
Where `1a2b3c4d` is the id of the machine.
108+
109+
_Note: You can find a list of all vagrant machines and their ids using `vagrant global-status` ._
110+
111+
---
112+
83113
## Manual Worker Installation (VirtualBox)
84114

85115
1. Open the Virtual Box application.

0 commit comments

Comments
 (0)