CryoSPARC for Open OnDemand

This is the code for the CryoSPARC+FRP OpenOndemand implementation presented at the SigHPC SysPros workshop at SC25.

Requirements

• FRP
• Passwordless SSH from Compute Node to OOD host
• A range of ports open to external access on the OOD host
• Secondary reolved domain name for OOD host

Instructions

1. Download the FRP binaries from https://github.com/fatedier/frp. v0.64.0 is validated, but later versions should work as well.
2. Place the FRP binaries in a shared directory accessible cluster-wide.
3. Clone this repo
4. Copy the FRP configs from CS-Master/fileconfigs/ to a separate directory
5. Modify the frpc.toml and replace the dummy domain with your secondary domain name for the OOD host
6. Modify any variables in the scripts that need changing (list below)
7. Copy both directories to your OOD instance and restart the web server

You should now see CryoSPARC as an option in your interactive apps

Variables you will need to change

These are the variables/config options you will need (at minimum) to modify for your environment

1. Cluster name in form.yml
2. The following variables in CS-Master/templates/before.sh.erb: FRPBIN FRPTOML
3. The following variables in every file within CS-Master/templates/: TOPCSPATH MASTERPATH
4. Modify the --initial-email argument in CS-Master/templates/script.sh.erb to reflect your institution.
5. The following variables in CS-Worker/templates/script.sh.erb: TOPCSPATH WORKERPATH
6. The url in CS-Master/view.html.erb

Note: You may want to update the csoutport variable in CS-Master/templates/before.sh.erb to restrict which ports FRP can listen on.