Setup ( one-off)
A sandbox directory must be provisioned to enable app development in Open OnDemand (OOD).
First, we need to allow the user to create sandbox apps by creating a symlink to point to the homedir:
...
When accessing https://ondemand.eri.agresearch.co.nz via the default, it uses an Azure Application proxy that doesn’t allow all cookies to pass through! A known issue is that the WebSocket connects are breaking.
Developing an app
...
Developing an app can be done on either on OOD web interface OR develop it on Github/Gitlab first and then clone it as per Step 3 under Adding an existing Github/lab repo. We recommend latter for better tracking and transparency over building it directly via the interface.
Github vs Gitlab
We have started building few staging apps on https://gitlab.com/nesi1 but attempts to clone it to OOD interface failed ( time outs,etc)
Therefore, switched to Github ( https://github.com/nesi public repo) which we think is a better choice anyway as it will allow us to get assistance from OOD community when needed. Also, app configs don’t have any sensitive information in general which eliminates it’s requirement to be on https://gitlab.com/nesi1 private group. Having said that, if there are any cluster specific configs which should not be in public domain, build the app in https://gitlab.com/nesi1 ( we can’t host private repositories on NeSI GH)
...
- Example template for an app
and we can try to sort of the issues related to cloning
Naming convention for a Repo OR a branch
It should be
clustername-ood-appname-app
ORmachinename-ood-appname-app
ORservicename-ood-appname-app
. For an example, RStudio app for eRI iseri-ood-rstudio-server-app
and for Mahuikamahuika-ood-rstuido-server-app
. ( Refer to https://github.com/nesi/eri-ood-rstudio-server
clustername-ood-app
-app )
If the repository is a template for all clusters/machines and we need separate branches for cluster/machine specific configs , name the branch after the cluster/machine/service name
Adding from an existing Github/lab repo
...
Delete an exiting App
\
\