Skip to content

Commit f456098

Browse files
Barb CutlerBarb Cutler
authored andcommitted
Merge remote-tracking branch 'origin/main' into redactions
2 parents 5e588b5 + 37c0fea commit f456098

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+706
-94
lines changed

Gemfile.lock

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ GEM
4040
faraday-net_http (3.1.1)
4141
net-http
4242
ffi (1.17.0-arm64-darwin)
43+
ffi (1.17.0-x64-mingw-ucrt)
4344
ffi (1.17.0-x86_64-linux-gnu)
4445
forwardable-extended (2.6.0)
4546
gemoji (4.1.0)
@@ -219,7 +220,7 @@ GEM
219220
gemoji (>= 3, < 5)
220221
html-pipeline (~> 2.2)
221222
jekyll (>= 3.0, < 5.0)
222-
json (2.12.2)
223+
json (2.13.0)
223224
kramdown (2.4.0)
224225
rexml
225226
kramdown-parser-gfm (1.1.0)
@@ -240,6 +241,8 @@ GEM
240241
uri
241242
nokogiri (1.16.7-arm64-darwin)
242243
racc (~> 1.4)
244+
nokogiri (1.16.7-x64-mingw-ucrt)
245+
racc (~> 1.4)
243246
nokogiri (1.16.7-x86_64-linux)
244247
racc (~> 1.4)
245248
octokit (4.25.1)
@@ -277,18 +280,21 @@ GEM
277280
concurrent-ruby (~> 1.0)
278281
unicode-display_width (1.8.0)
279282
uri (0.13.0)
283+
wdm (0.2.0)
280284
webrick (1.9.1)
281285
yell (2.2.2)
282286

283287
PLATFORMS
284288
arm64-darwin-22
285289
arm64-darwin-23
290+
x64-mingw-ucrt
286291
x86_64-linux
287292

288293
DEPENDENCIES
289294
github-pages (= 232)
290295
html-proofer (~> 3.19.4)
291296
json
297+
wdm (>= 0.1.1)
292298
webrick (~> 1.9)
293299

294300
BUNDLED WITH

_docs/developer/development_instructions/automated_grading.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,14 @@ number:
118118

119119
---
120120

121-
## Debugging
121+
## Debugging
122122

123123
To debug new features for autograding, it can be helpful to run
124124
`submitty_autograding_shipper.py` and `submitty_autograding_worker.py`
125125
interactively and inspect the output.
126126

127+
_NOTE: A cron job runs hourly to detect autograding shipper outages on the primary machine. To avoid interference during debugging, this job should be disabled before proceeding. See [Capture Cron Error Messages](/sysadmin/installation/system_customization#capture-cron-error-messages) for instructions on disabling the script._
128+
127129
To do this:
128130

129131
1. Stop the daemons (on each server, as appropriate)

_docs/developer/development_instructions/migrations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ own unique list of migrations. They are:
2424
* course
2525

2626
Where `system` migrations should deal mainly with package installation/changes,
27-
system changes, new dependencies, etc. `master` migraitons deals with changes to the master Submitty
27+
system changes, new dependencies, etc. `master` migrations deal with changes to the master Submitty
2828
database. `course` migrations are applied individually to each course
2929
detected in `/var/local/submitty/courses` and can be used to adjust the
3030
courses' DB, config files, etc.

_docs/developer/getting_started/make_a_pull_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Be sure to read the [Suggestions for New Developers](/developer/getting_started/
6868
6969
* `Submission` (includes bulk uploads, teams, late days, notebook gradeables, and other student features),
7070
* `Autograding` (includes router, container/docker),
71-
* `Forum`,
71+
* `Forum` (Includes Live Chat),
7272
* `Notifications` (includes email and grade inquiries),
7373
* `TAGrading` (includes PDF annotation, peer grading),
7474
* `InstructorUI` (includes course and gradeable configuration),

_docs/developer/getting_started/vm_install_using_vagrant.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ M-Series ARM MacOS machines.*
121121
* You will need:
122122
* [Ruby](https://www.ruby-lang.org/en/downloads)
123123
* [Git](https://git-scm.com/downloads)
124-
* [Vagrant](https://www.vagrantup.com)
124+
* [Vagrant](https://developer.hashicorp.com/vagrant/install)
125125
* *M-SERIES ARM MacOS:* [QEMU](https://www.qemu.org)
126126
* *EVERYONE ELSE:* [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
127127
* Ensure VirtualBox version is compatible with Vagrant.
@@ -146,8 +146,8 @@ M-Series ARM MacOS machines.*
146146
```
147147
148148
* **Windows**
149-
*You can just go to the respective sites and download the necessary binaries.*
150-
149+
Download the latest Vagrant AMD64 binary for windows.
150+
*As of Vagrant version 2.4.7, Virtualbox 7.1.10 is compatible.*
151151
152152
* **Ubuntu/Debian**
153153
@@ -611,3 +611,15 @@ please follow the step below:
611611
The script should automatically handle the upgrading and issuing a self-signed
612612
certificate. If your browser complains about the security, please head to
613613
[WebSocket](/developer/developing_the_php_site/websocket).
614+
615+
---
616+
617+
## Increasing VM Resources
618+
If you find that the VM is running slowly, you can increase the resources allocated to it. By default the VM is allocated 2GB of RAM and 2 CPUs. You can increase these values by setting the `VM_MEMORY` and `VM_CPUS` environment variables before running `vagrant up`. For example, to allocate 4GB of RAM and 4 CPUs, you can run:
619+
620+
```sh
621+
export VM_MEMORY=4096
622+
export VM_CPUS=4
623+
vagrant up
624+
```
625+
If your system has 8GB of RAM it is recommended to set `VM_MEMORY` to 4096 (4GB) and `VM_CPUS` to 2 or 4. If your system has more RAM, you can increase these values further, but be careful not to allocate too much RAM as it may cause your host system to become unresponsive.

_docs/developer/getting_started/worker_vm.md

Lines changed: 56 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,70 @@ 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-
```
14+
1. First set up your main/primary machine by following the normal
15+
[VM Install using Vagrant](/developer/getting_started/vm_install_using_vagrant) instructions.
16+
17+
2. Ensure you have [Python 3](https://www.python.org/downloads/) installed on your machine, run:
18+
```
19+
python3 --version
20+
```
21+
22+
3. To generate configuration for a worker machine, run:
23+
```
24+
vagrant workers generate
25+
```
26+
27+
If instead you need multiple workers, append the `-n` flag, ex. for 3 machines:
28+
```
29+
vagrant workers generate -n 3
30+
```
1931

20-
2. Ensure you have [Python 3](https://www.python.org/downloads/) installed on your machine
32+
_NOTE: This will create the vagrant configuration file: `.vagrant/workers.json`._
2133

22-
3. Generate configuration for the desired number of worker machines
34+
35+
4. If you are on MacOS running QEMU, restart the network socket in public mode:
2336
```
24-
python3 generate_workers.py [-n NUM] [--ip-range IP_RANGE] [--base-port PORT]
37+
vagrant workers socket restart --public
2538
```
26-
This will create or update a configuration file stored at `.vagrant/workers.json`.
27-
Now you can create the virtual machines with:
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:
2850
```
29-
vagrant up
51+
vagrant workers up
3052
```
53+
_NOTE: Do not use the --provider flag with this command, since it will conflict with the
54+
provider of the main virtual machine._
3155

32-
If you happen to encounter error messages regarding IP addresses or port conflicts, you can manually edit the `workers.json` file as needed.
56+
When this is finished, you should see the Submitty duck ASCII art for each new worker machine.
57+
58+
7. You can verify that all the worker machines are running with:
59+
```
60+
vagrant workers status
61+
```
3362

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.
63+
8. `vagrant ssh` into the main virtual machine and run:
64+
```
65+
refresh_vagrant_workers # (runs python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/bin/refresh_vagrant_workers.py)
66+
submitty_install
67+
```
3568

36-
4. To delete the worker machines and revert to a normal development setup, you can first run
69+
9. To stop the worker machines, you can run:
3770
```
38-
vagrant destroy
71+
vagrant workers halt
72+
vagrant workers socket stop
3973
```
40-
And confirm to delete all the existing virtual machines.
4174

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.
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+
4478

4579
---
4680

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

5185
To connect to a worker machine through SSH, run:
5286
```
53-
vagrant ssh <worker-name>
87+
vagrant workers ssh <worker-name>
5488
```
5589

5690
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:
5791
```
58-
su submitty_daemon -c ssh submitty@<ip-address>
92+
su submitty_daemon -c ssh <worker-name>
5993
```
60-
The IP address of the worker machine will be indicated in the `.vagrant/workers.json` file.
94+
95+
The list of worker names can be displayed with `vagrant workers status`.
6196

6297
__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.
6398

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Alexander Lavallee
3+
category: Developer > Rensselaer Center for Open Source (RCOS) > Summer 2025
4+
---
5+
6+
coming soon
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Christopher Poon
3+
category: Developer > Rensselaer Center for Open Source (RCOS) > Summer 2025
4+
---
5+
6+
coming soon
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Giancarlo Martinelli
3+
category: Developer > Rensselaer Center for Open Source (RCOS) > Summer 2025
4+
---
5+
6+
coming soon
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Jeffrey Cordero
3+
category: Developer > Rensselaer Center for Open Source (RCOS) > Summer 2025
4+
---
5+
6+
coming soon

0 commit comments

Comments
 (0)