Newer
Older
_A container-centric Science Platform_
Rosetta makes it easy to run graphical interactive workloads on batch and remote computing systems using Docker and Singularity containers.
Rosetta licensed under the Apache License 2.0, unless otherwise specificed.
## Quickstart
Requirements:
Bash, Git and Docker. Runs on Linux, Mac or Windows*.
*Windows not fully supported in development mode due to lack of support for symbolic links.
Setup
$ rosetta/setup
Build
$ rosetta/build
Run
$ rosetta/run
$ rosetta/populate
# You can now point your browser to http://localhost:8080
# Log in using "testuser@rosetta.platform""and password "testpass"
# To run Slurm jobs, use partition name "partition1"
Clean
# rosetta/clean
Example Webapp configuraion:
Stefano Alberto Russo
committed
- DJANGO_DEV_SERVER=True
- DJANGO_DEBUG=True
- DJANGO_LOG_LEVEL=ERROR
- ROSETTA_LOG_LEVEL=ERROR
- ROSETTA_TUNNEL_HOST=localhost # Not http or https
- ROSETTA_WEBAPP_HOST=
- ROSETTA_WEBAPP_PORT=8080
- LOCAL_DOCKER_REGISTRY_HOST=
- LOCAL_DOCKER_REGISTRY_PORT=5000
Stefano Alberto Russo
committed
- DJANGO_EMAIL_SERVICE=Sendgrid
- DJANGO_EMAIL_APIKEY=
- DJANGO_EMAIL_FROM="Rosetta <notifications@rosetta.local>"
- DJANGO_PUBLIC_HTTP_HOST=http://localhost # Public facing, with http or https
- OIDC_RP_CLIENT_ID=""
- OIDC_RP_CLIENT_SECRET=""
- OIDC_OP_AUTHORIZATION_ENDPOINT=""
- OIDC_OP_TOKEN_ENDPOINT=""
- OIDC_OP_JWKS_ENDPOINT=""
Stefano Alberto Russo
committed
- DISABLE_LOCAL_AUTH=False
In Rosetta, only power users can:
- set custom task passwords
- choose task access methods other than the default one (bypassing HTTP proxy + auth)
- add containers with interface protocols other than the HTTP
### Building errors
It is common for the build process to fail with a "404 not found" error on an apt-get instrucions, as apt repositories often change their IP addresses. In such case, try:
$ rosetta/build nocache
### Development mode
Django development server is running on port 8080 of the "webapp" service.
To enable live code changes, add or comment out the following in docker-compose.yaml under the "volumes" section of the "webapp" service:
Stefano Alberto Russo
committed
- ./services/webapp/code:/opt/code
This will mount the code from services/webapp/code as a volume inside the webapp container itself allowing to make immediately effective codebase edits.
Stefano Alberto Russo
committed
Note that when you edit the Django ORM model, you need to make migrations and apply them to migrate the database:
Stefano Alberto Russo
committed
$ rosetta/makemigrations
$ rosetta/migrate
### Logs and testing
Run Web App unit tests (with Rosetta running)
$ rosetta/logs webapp
$ rosetta/logs webapp startup
$ rosetta/logs webapp server
Stefano Alberto Russo
committed
$ rosetta/test
Stefano Alberto Russo
committed
.singularity in user home with limited space
Some Docker versions (e.g. old-ish on Mac) do not let podman work due to fuse permissions
SSH computing resources require python3 and wget installed, or will raise (empty) errors when submitting tasks. . Check 127 error codes.