Instructor API for the JupyterHub and Canvas Cluster POC
Description
An API to interact with the file system hosting the JupyterHub home directories. It allows Instructors to Snapshot their Students Home Drives for deadlines via an API call. These Snapshots can be triggered via an API call initiaated from a Canvas Assignment deadline. Instructors can create multiple Snapshots with custom names for each student or sets of students. Instructors can retrieve the Snapshots via a ZIP file of the whole Snapshot or by specifing specfic files within the Snapshot. Instryctors can also Put grading reports into the Students Home Directory by an API call.
Jupyter Hub Integration
Canvas LTI Integration
Headers & Post Variables
Header: X-Api-Key
This is a security header that allows users to interact with the API. Generally speaking this should be 16 to 32 characters long.
Post Variable: STUDENT_ID
This POST variable is used to target a specfic student via many of the API Routes. This refers to the Canvas Student ID.
Post Variable: SNAPSHOT_NAME
This POST variable is represents a name of a student's home directories file system snapshot, it is used by many API routes when creating or accessing snapshots.
Post Varible: SNAPSHOT_FILENAME
Post Variable: UPLOAD_FILE
This Post Variable holds a file being uploaded to the API. To pass files in
API Curl Usage Examples
You must update the URI for the API call to the one provided by the Team responsible for managing the application.
Each API call also requires the API Key (), which will also be provided on an as needed bases by the Team responsible for managing the application.
Get Snapshot List ( https://{HOST}:{PORT}/get_snapshot_list )
Retrieve a list of Snapshots for a specified Canvas student.
Required Headers & Post Variables:
X-Api-Key | Header Variable | The API Key is Provided by UBC IT |
STUDENT_ID | Post Variable | The Student's Canvas ID |
In the following example(s) we will use an X-Api-Key of '12345', a Student_ID of '31387714', and a URL of https://api.example.com:5000/get_snapshot_list
- curl -H "X-Api-Key: 12345" --data "STUDENT_ID=31387714" https://api.example.com:5000/get_snapshot_list
- curl -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714" https://api.example.com:5000/get_snapshot_list
- curl -H "X-Api-Key: 12345" -F "STUDENT_ID=31387714" https://api.example.com:5000/get_snapshot_list
Example:
user@host:~$ curl -H "X-Api-Key: 1234567" -d "STUDENT_ID=31387714" https://api.example.com:5000/get_snapshot_list
["assignment-3_2021-09-09","assignment-2_2021-09-09","assignment-1_2021-09-09","flocking-test-call_2021-09-09","exam_work_2021-09-10"]
user@host:~$
Get Snapshot File List ( https://{HOST}:{PORT}/get_snapshot_file_list )
Retrieve a list of files within the specified Canvas students' Snapshot.
Required Headers & Post Variables:
X-Api-Key | Header Variable | The API Key is Provided by UBC IT |
STUDENT_ID | Post Variable | The Student's Canvas ID |
SNAPSHOT_NAME | Post Variable | The Name of the Snapshot |
In the following example(s) we will use an X-Api-Key of '12345', a Student_ID of '31387714', a SNAPSHOT_NAME of 'assignment-1_2021-09-09', and a URL of https://api.example.com:5000/get_snapshot_file_list
- curl -H "X-Api-Key: 12345" --data "STUDENT_ID=31387714&SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_file_list
- curl -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714" -d "SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_file_list
- curl -H "X-Api-Key: 12345" -F "STUDENT_ID=31387714" -F "SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_file_list
Example
user@host:~$ curl -H "X-Api-Key: 1234567" -d "STUDENT_ID=31387714" -d "SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_file_list
["assignment-1.ipynb","assignment-2.ipynb","exercise-1.ipynb","practice/practice-1.ipynb","practice/practice-2.ipynb","assignment-1-grades.html"]
user@host:~$
Get Snapshot Zip File
Required Headers & Post Variables:
X-Api-Key | Header Variable | The API Key is Provided by UBC IT |
STUDENT_ID | Post Variable | The Student's Canvas ID |
SNAPSHOT_NAME | Post Variable | The Name of the Snapshot |
In the following example(s) we will use an X-Api-Key of '12345', a Student_ID of '31387714', a SNAPSHOT_NAME of 'assignment-1_2021-09-09', and a URL of https://api.example.com:5000/get_snapshot_zip
- curl -OJ -H "X-Api-Key: 12345" --data "STUDENT_ID=31387714&SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_zip
- curl -OJ -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714" -d "SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_zip
- curl -OJ -H "X-Api-Key: 12345" -F "STUDENT_ID=31387714" -F "SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_zip
Example
user@host:~$ curl -OJ -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714" -d "SNAPSHOT_NAME=assignment-1_2021-09-09" https://api.example.com:5000/get_snapshot_zip
curl: Saved to filename '31387714_assignment-1_2021-09-09.zip'
user@host:~$
Get Snapshot File
Required Headers & Post Variables:
X-Api-Key | Header Variable | The API Key is Provided by UBC IT |
STUDENT_ID | Post Variable | The Student's Canvas ID |
SNAPSHOT_NAME | Post Variable | The Name of the Snapshot |
SNAPSHOT_FILENAME | Post Variable | The Name and Location of the Snapshot file being downloaded |
In the following example(s) we will use an X-Api-Key of '12345', a Student_ID of '31387714', a SNAPSHOT_NAME of 'assignment-1_2021-09-09', a SNAPSHOT_FILENAME of 'practice/practice-1.ipynb', and a URL of https://api.example.com:5000/get_snapshot_file
- curl -OJ -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714" -d "SNAPSHOT_NAME=12-08-2021" -d "SNAPSHOT_FILENAME=practice/practice-1.ipynb" https://api.example.com:5000/get_snapshot_file
- curl -OJ -H "X-Api-Key: 12345" -F "STUDENT_ID=31387714" -F "SNAPSHOT_NAME=12-08-2021" -F "SNAPSHOT_FILENAME=practice/practice-1.ipynb" https://api.example.com:5000/get_snapshot_file
- curl -OJ -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714&SNAPSHOT_NAME=12-08-2021&SNAPSHOT_FILENAME=practice/practice-1.ipynb" https://api.example.com:5000/get_snapshot_file
- curl -OJ -H "X-Api-Key: 12345" --data "STUDENT_ID=31387714&SNAPSHOT_NAME=12-08-2021&SNAPSHOT_FILENAME=practice/practice-1.ipynb" https://api.example.com:5000/get_snapshot_file
Example
user@host:~$ curl -OJ -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714" -d "SNAPSHOT_NAME=12-08-2021" -d "SNAPSHOT_FILENAME=practice/practice-1.ipynb" https://api.example.com:5000/get_snapshot_file
curl: Saved to filename 'practice-1.ipynb'
user@host:~$
Upload File To Student Home Directory
Required Headers & Post Variables:
X-Api-Key | Header Variable | The API Key is Provided by UBC IT |
STUDENT_ID | Post Variable | The Student's Canvas ID |
UPLOAD_FILE | Post Variable | The location and file to be uploaded, preceded by an @ symbol |
- curl -X POST -H "X-Api-Key: 12345" -F "STUDENT_ID=31387714" -F "[email protected]" https://api.example.com:5000/put_student_report
- curl -X POST -H "X-Api-Key: 12345" -d "STUDENT_ID=31387714" -d "[email protected]" https://api.example.com:5000/put_student_report
- curl -X POST -H "X-Api-Key: 12345" -data "STUDENT_ID=31387714&[email protected]" https://api.example.com:5000/put_student_report
Example
user@host:~$ curl -X POST -H "X-Api-Key: 12345" -F "STUDENT_ID=31387714" -F "[email protected]" https://api.example.com:5000/put_student_report
Success - File Uploaded - assignment-1-grades.html
user@host:~$
Create Snapshot for Student
Required Headers & Post Variables:
X-Api-Key | Header Variable | The API Key is Provided by UBC IT |
STUDENT_ID | Post Variable | The Student's Canvas ID |
SNAPSHOT_NAME | Post Variable | The Name of the Snapshot |
- curl -X POST -H "X-Api-Key: 12345" -F "STUDENT_ID=31387714" -F "SNAPSHOT_NAME=Assignment-1-snap" http://localhost:5000/snapshot
Create Snapshot for All Students
Required Headers & Post Variables:
X-Api-Key | Header Variable | The API Key is Provided by UBC IT |
SNAPSHOT_NAME | Post Variable | The Name of the Snapshot |
- curl -X POST -H "X-Api-Key: 12345" -F "STUDENT_NAME=assignment-1-snap-all" http://localhost:5000/snapshot_all
- curl -X POST -H "X-Api-Key: 12345" -d "STUDENT_NAME=assignment-1-snap-all" http://localhost:5000/snapshot_all
- curl -X POST -H "X-Api-Key: 12345" -data "STUDENT_NAME=assignment-1-snap-all" http://localhost:5000/snapshot_all
Repo Files
Enviroment Variables
Enviroment Variable | Required | Default Value | Description |
---|---|---|---|
DEBUG | TRUE | Enables Dubug output within the API code | |
JUPYTER_API_PORT | 5000 | The Port Number of the API | |
JUPYTER_API_HOST | 0.0.0.0 | The IP the API is being served on | |
JUPYTER_API_KEY | ✓ | 12345 | The API Key |
JNOTE_HOME | ✓ | {No Default Value} | The location of Jupyter Notebooks' user Home directory |
JNOTE_SNAP | ✓ | {No Default Value} | The location of Jupyter Notebooks final Snapshot directory |
JNOTE_INTSNAP | ✓ | {No Default Value} | The location of Jupyter Notebooks internal Snapshot directory |
JNOTE_COURSE_CODE | ✓ | {No Default Value} | The Course Code |
Docker Deployments
Virtual Machine Deployments
This deployment has been tested on Ubuntu 20.04, however it should work with previos versions of Ubuntu and Debain.
# Prep System
sudo apt update
sudp apy upgrade
sudo apt install python3 python3-pip curl rsync git
# Get This Repo
cd /tmp
git clone https://github.com/ubc/jupyter-canvas-api.git
cd jupyter-canvas-api
sudo mkdir /usr/share/jupyter-canvas-api/
# Copy Files
sudo cp usr/share/jupyter-canvas-api/api-server.py /usr/share/jupyter-canvas-api/api-server.py
sudo cp usr/share/jupyter-canvas-api/requirements.txt /usr/share/jupyter-canvas-api/requirements.txt
sudo cp usr/local/bin/hourly-rsync.sh /usr/local/bin/hourly-rsync.sh
sudo cp etc/systemd/system/jupyter-canvas-api.service /etc/systemd/system/jupyter-canvas-api.service
sudo cp etc/systemd/system/jupyter-rsync.service /etc/systemd/system/jupyter-rsync.service
sudo cp etc/systemd/system/jupyter-rsync.timer /etc/systemd/system/jupyter-rsync.timer
sudo cp etc/systemd/system/mnt-efs.mount /etc/systemd/system/mnt-efs.mount
sudo chmod +x /usr/local/bin/hourly-rsync.sh
# SystemD
systemctl daemon-reload
systemctl enable jupyter-rsync.timer
systemctl enable jupyter-canvas-api.service
# Update the following mount to fit your needs, or add the Jupyter Lab home directory mount point to /etc/fstab
#systemctl enable mnt-efs.mount
# Setup Python
sudo pip3 install -r /usr/share/jupyter-canvas-api/requirements.txt
# Add Enviroment Variables (Update These To Fit Your Needs)
sudo echo 'JUPYTER_API_PORT="5000"' >> /etc/environment
sudo echo 'JUPYTER_API_HOST="0.0.0.0"' >> /etc/environment
sudo echo 'JUPYTER_API_KEY="12345"' >> /etc/environment
sudo echo 'JNOTE_HOME="/mnt/efs/stat-100a-home/"' >> /etc/environment
sudo echo 'JNOTE_SNAP="/mnt/efs/stat-100a-snap/"' >> /etc/environment
sudo echo 'JNOTE_INTSNAP="/mnt/efs/stat-100a-internal/"' >> /etc/environment
sudo echo 'JNOTE_COURSE_CODE="STAT100a"' >> /etc/environment
# Reboot
sudo reboot now
Kubernetes Pod Deployments
Notes
- The API needs to be run as Root, as such the Enviroment Variables need to be accessable by Root.
- On the Virtual Machine Deployment, the hourly rsync script is controlled by a SystemD Timer, rather than a cronjob.
- On the docker/kubernetes deployment the hourly rsync script is controlled via cron. A script is placed into /etc/cron.hourly, and the /etc/crontab for that directory is triggered on the 17th minute.
- When running the API call /snapshot_all there is a 1 hour cool down. If run sooner, it can take along time to complete.
Support
As this is a Proof of Concept project no support is going to be provided unless you are an Instructor or UBC Staff member participating in the trial.
That being said, feel free to contact Rahim Khoja [email protected] in the offchance he feels like providing additional support.