Skip to content

⚡ Short workshop to start Data Science applications on the Data Science Research Infrastructure at Maastricht University

License

Notifications You must be signed in to change notification settings

MaastrichtU-IDS/dsri-workshop-start-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 

Repository files navigation

A workshop to get started with the Data Science Research Infrastructure (DSRI) in an hour 🕐 (hopefully)!

During this workshop, you will:

  • Access the Data Science Research Infrastructure web UI
  • Create a new application from a template in the catalog (RStudio, JupyterLab or VScode )
  • Access the application
  • Add source code and data in the application
  • Optionally install the oc command line interface

Prerequisites:

  • A web browser (Chrome preferably, as some other web browsers have issues with the VSCode terminal)
  • An account on the DSRI with your UM email
  • Access to the UM VPN, or direct connection to UMnet or eduroam at Maastricht University

Access the DSRI 🔑

📖 The DSRI documentation can be found at https://maastrichtu-ids.github.io/dsri-documentation

  1. Connect to the UM VPN.

    sudo openconnect --passwd-on-stdin -u YOUR.UM.USER --authgroup 01-Employees vpn-rw1.maastrichtuniversity.nl
  2. Access the DSRI OpenShift web UI

  3. 👩‍💻 Go to the workspace-workshop project in the OpenShift web UI


Start an application 🚀

Start a JupyterLab/RStudio/VSCode application from the DSRI catalog in ids-projects

📖 See how to deploy JupyterLab, RStudio, VSCode and lots more.

  1. 👨‍💻 Use your name to generate a unique Application name, e.g. rstudio-vemonet

  2. Persistent storage will create automatically.

  3. Access the application you just started


Upload files 🗂️

👨‍💻 For small and medium size files you can simply drag and drop files and folder in the application web UI, or use the Upload files button in RStudio.

This solution works for files up to a few hundred MBs (depending on the application, use it until it fails!).


Upload your code 📜

We recommend you to use git with GitHub or GitLab, you can use it directly from the terminal in all applications, or use the web UI integration each app proposes.

📖 See the documentation for each application:


Upload large data files 📦

For large data files you will need to install the oc command line interface.

If you have the time it can be quickly installed on MacOS, Linux (works with WSL):

  • On Linux 🐧
wget https://github.com/openshift/origin/releases/download/v3.11.0/openshift-origin-client-tools-v3.11.0-0cbc58b-linux-64bit.tar.gz
tar xvf openshift-origin-client-tools*.tar.gz
cd openshift-origin-client*/
sudo mv oc kubectl /usr/local/bin/
  • On Mac 🍎
brew install openshift-cli

📖 See the complete documentation to upload large data file

💡 You will have a better connection when directly connected to the UMnet network (or eduroam at UM) to upload large data file. Even better if you can use ethernet wires.


Stop and delete your application ❌

👨‍💻 Stop your application from the OpenShift web UI Topology page:

You can use the Filter by name search box to quickly find your application based on the name you gave it.

Stop your application

Note: creating more than one pod ("Scale up") is useless for most data science applications, such as RStudio, VSCode or JupyterLab. It is only relevant for applications running as a cluster, like Apache Flink or Apache Spark, or web application with a lot of traffic (OpenShift will redirect the traffic depending on pod availability, and start new pods if required, aka. horizontal scaling).

👩‍💻 Delete your application:

  • If you installed the oc command line interface, it is easier to use it to delete all the objects related to your application:
oc delete all,secret,configmaps,serviceaccount,rolebinding --selector app=my-application

Replace my-application by the Application name you defined.

  • Otherwise you will need to manually delete a few objects related to your application in the OpenShift web UI, it can be done easily from the Overview page:
    1. Delete the Route
    2. Delete the Service
    3. Delete the Deployment Config

Delete application from the web UI

📖 See the complete documentation to delete an application.


See you soon! 👋

📝 Fill this form to help us create a project for you on the Data Science Research Infrastructure for a longer term!

About

⚡ Short workshop to start Data Science applications on the Data Science Research Infrastructure at Maastricht University

Topics

Resources

License

Stars

Watchers

Forks