Developer documentation

This is the developer documenation for this repository. See primer SURF ResearchCloud for end-user documentation).

Below is a section for playbooks and a section for roles. The playbook can be used stand-alone (run them locally on the target host) or as a SURF ResearchCloud plugin.

The roles serve as reusable building blocks for these playbooks.

Contributed playbooks and roles should meet criteria specified in our item quality checklist.

When adding documentation, please consider to format your text using the file template-playbooks.md to document a playbook or the file template-roles.md to document a role.

Playbooks

The status of a playbook is either Experimental or Supported. Supported playbooks are subjected to automated testing and must be fully documented.

For public items in the SURF Research Cloud catalog, this status should be indicated in the description field of the catalog plugin item.

Supported

aptly serve apt repositories on the workspace
ibridges userfriendly commandline client for iRODS
icommands commandline tools for iRODS data grid
miniconda Python development
python-workbench Python development
security_updates automatic updates for Ubuntu
shared_directories create shared data directories for regular users
reverse_proxy add reverse proxies to the SRC-Nginx environment

Experimental

anaconda python data science development
asreview machine-learning powered application for systematic reviews
camunda a business process workflow suite
camunda-modeler part of the camunda suite
docker application container management
ephor selected roles for ephor use-case
irods-desktop desktop application tools for iRODS data grid
keycloak OpenIDConnect/SAML Server
matlab Data analysis and simulation suite
miniconda-base Python application development
robotuser agent used for remote filesystem mounts
transferuser dedicated user for file exchange with remote host

Roles

The status of a role is either Experimental or Supported. Supported roles are subjected to automated testing and must be fully documented.

Supported

aptly_add add packages to Aptly repositories on the workspace
default_group set desired groups as default for regular users
fact_regular_users facts about users on the system
fact_workspace_info facts about the workspace, and groups and users from the CO (SRAM)
install_role
miniconda
nginx-reverse_proxy
poetry
pip
pip_install_systemwide install pip packages in a shared directory for all users
pyenv
python