Setup nbgrader in one class, one grader mode #155
Conversation
…terhub_config.py in `systemctl status jupyterhub`
ERROR! [DEPRECATED]: ansible.builtin.include has been removed. Use include_tasks or import_tasks instead. This feature was removed from ansible-core in a release after 2023-05-16. Please update your playbooks. Ansible failed to complete successfully. Any error output should be visible above. Please fix these errors and try again.
Use value from defaults
There was a problem hiding this comment.
Very cool stuff! I managed to start up a local infra with vagrant and become my own teacher 😎 Approving as it works and is ready to use, but you may still consider the few comments I had at your own discretion.
- As a student I don't have permission to see the contents of /var/local/nbgrader/exchange/course1/inbound/, as a teacher I do. This seems good.
- As a student, I am able to open the formgrader, which, even if it's not a problem, I found confusing, to say the least.
- As a student, I also have the right hand side tab to "create assignment", which doesn't really make sense either, or does it?
- Have you considered moving all the teaching-specific config from README.md to TEACH.md?
roles/grader/README.md
Outdated
| License | ||
| ------- | ||
|
|
||
| BSD |
There was a problem hiding this comment.
I was wondering where this is documented. Is it standard practice to follow the license of the main third-party software?
README.md
Outdated
| The value should be a JSON string in format of `[["username1", "password1"]]`. | ||
| - Add `course_repo` parameter with git repository url of the course source material. | ||
| Use default value of `https://github.com/eWaterCycle/teaching.git` | ||
| - Add `course_version` paramneter with the version,branch or tag of the course repository to use. |
There was a problem hiding this comment.
| - Add `course_version` paramneter with the version,branch or tag of the course repository to use. | |
| - Add `course_version` parameter with the version, branch or tag of the course repository to use. |
TEACH.md
Outdated
| @@ -0,0 +1,28 @@ | |||
| # Teaching with eWaterCycle infra | |||
There was a problem hiding this comment.
Refer to this file from README?
Also, the readme already contains teaching-specific instructions, might that fit better here?
README.md
Outdated
| # Vagrant user is instructor | ||
| # The students defined below can be used to login as a student | ||
| students: '[["student1", "student1"], ["student2", "student2"]]' |
There was a problem hiding this comment.
Now the readme contains teaching specific instructions. For me it's okay to have two versions of README, one for standard and one for teaching. But perhaps we should add a note here that these instructions are specifically for teaching, and if you want standard infra, you should check out the other branch (and vice versa)?
TEACH.md
Outdated
| During creation you can set the `students` parameter to create local posix accounts for students. | ||
| The value for the `students` parameter can be generated by running [create_student_passwords.py](create_student_passwords.py) script with list of username (one on each line) as input. See docs in script for more details. The passwords generated by the script should be distributed to the students. |
There was a problem hiding this comment.
| During creation you can set the `students` parameter to create local posix accounts for students. | |
| The value for the `students` parameter can be generated by running [create_student_passwords.py](create_student_passwords.py) script with list of username (one on each line) as input. See docs in script for more details. The passwords generated by the script should be distributed to the students. | |
| During creation you can set the `students` parameter to create local posix accounts for students. | |
| The value for the `students` parameter is a list of [student, password] values. You can use the python script [create_student_passwords.py](create_student_passwords.py) to generate passwords. To use it, create a file "usernames.txt" with one username on each line. Then call the script to generate passwords. They will be stored in a new file called `students.json`. See docs in script for more details. The passwords generated by the script should be distributed to the students. |
roles/grader/tasks/main.yml
Outdated
| - name: Add students to course | ||
| when: students is defined | ||
| ansible.builtin.command: '{{ conda_environment_bin }}/nbgrader db student add "{{ item[0] }}"' | ||
| environment: | ||
| PATH: "{{ conda_environment_bin }}:{{ ansible_env.PATH }}" | ||
| loop: "{{ students | from_json }}" | ||
| args: | ||
| chdir: "/home/{{ grader_user }}/{{ course_id }}" | ||
| become: true | ||
| become_user: "{{ grader_user }}" |
There was a problem hiding this comment.
Are new student accounts that are added e.g. through sram automatically added to the course?
There was a problem hiding this comment.
This task is runs once during provisioning.
I could add add command to user sync cron job script , but that will be very flaky.
So I would rather wait for the lms integration where we will fetch usernames from lms and create them in VM.
worker_ip_addresses is not passed to https://gitlab.com/rsc-surf-nl/plugins/plugin-external-plugin/-/blob/main/plugin-external-plugin.yml?ref_type=heads#L156
Also disables vbguest to speed up start up.
As it was not replaced in the ansible task.
Seems SRC is running old jinja2 template:
template error while templating string: no filter named \'split\'. String: {{ students | split(\',\') | default([]) }}\\"
|
Setup seems to work for the lesson development. Hopefully also when the students access it 🤞 We discussed limiting the students on their memory & cpu use to reduce the chance of a single student locking up a server. That could still be nice to add. |
Workaround for when /home/student1 exists and student1 user does not exist.
We are using pam auth, so it is ok that everyone with local account can login. See https://jupyterhub.readthedocs.io/en/latest/howto/upgrading-v5.html#authenticator-allow-all-and-allow-existing-users
have not tested without the plugin installed
For testing locally please upgrade vagrant to latest version.
Uses https://github.com/eWaterCycle/teaching/tree/nbgrader-quickstart as course material source.
This PR also includes some linting and deprecation fixes.