Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update lecturer_s_procedure_ #375

Merged
merged 12 commits into from
Jan 10, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -3,54 +3,39 @@
Lecturer's procedure to request student accounts (KU Leuven/UHasselt)
=====================================================================

In order to smoothly go through account creation for students process
several actions from the lecturer are required.
We support using HPC for educational purposes, and we fully assist the lecturers
with all aspects of using HPC in the classroom, such as creating studing accounts,
granting credits, resource reservation (if needed), and also live technical support
during the trainings.

#. Submit the request to
In order to make this experience as convenient as possible for the students and the
for the lecturer, it is requested that the lecturer (or any course responsible) would
take the following actions:

#. Submit a request to
`[email protected] <mailto:[email protected]?subject=Accounts%20requests%20for%20students%20attending%20the%20course>`_
providing a short description of the course and explanation why HPC
facilities are necessary for teaching the course. Please also add the
attachment with the list of students attending the course (2 weeks
before the beginning of the course).
#. Send the information to students that they have 1 week time window to
mselwa marked this conversation as resolved.
Show resolved Hide resolved
apply for the account (the last day when account creating can be
processed is the day before the course starts). Students should
follow the :ref:`generic procedure <generic access procedure>`, that
starts with
generating private-public key pair and ends with submitting the
public key via the `VSC account page`_. After 1 week the
lists of students that already submitted the request for the account
and corresponding vsc-account numbers will be send to the lecturer.
#. The students should be informed to bring the private key with them to
be able to connect and attend the course.
#. Since introductory credits are supposed to be used for private
projects (e.g. master thesis computations) we encourage to create the
project which will be used for computations related to the course.
This will also give a lecturer an opportunity of tracing the use of
the cluster during the course. For more information about the
procedure of creating the project please refer to the page
1-2 weeks before the beginning of the course.
Please provide a short description of the course, and explain why the HPC
facilities are necessary for teaching the course. It is mandatory to provide a list
of students with their full names, KU Leuven/UHasselt email addresses, and their student number.
For KU Leuven students, you may convert the students' q-number to their r-/s-number using the export
tool on Toledo (Administrations -> Convert user-ids (q-numbers))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just jumping in to mention that once https://gitea.icts.kuleuven.be/foz/foz-vsc-accountpage-automation/pulls/7 is approved, the conversion of q-numbers is no longer necessary: the updated account creation script can deal with q-numbers.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, this page will require another quick fix after that PR is merged and comes into production.

#. We advise to use :ref:`Open OnDemand <ood_t2_leuven>` service for the student to get access to the
login nodes, file browser and the job submission. For using Open OnDemand only, the accounts
are provisioned without students being involved in the procedure. Hence, students login only
through the KU Leuven :ref:`Multi Factor Authentication (MFA) <mfa_leuven>`
#. We encourage to create a specific project for the course, with the project name starting with
``p_edu_``. We will assign compute credits to this project, and add the students to the account. The
course lecturer will be the moderator of the project. This gives the lecturer an opportunity
to track the use of the Tier-2 clusters by individual users during the course.
For more information about the procedure of requesting the project please refer to the page
:ref:`Slurm accounting <accounting_leuven>`.
Once the project is accepted, the students that already applied for
mselwa marked this conversation as resolved.
Show resolved Hide resolved
the account need to be added to the project (1 week before
the beginning of the course).
#. Students that failed to submit request in a given time will have to
follow regular procedure of applying for the account involving
communication with the HPC support staff and delaying the account
creation process (these students will have to motivate the reason of
applying for the account and send a request for using the project
credits). Students that submit the requests later than 2 days before
the beginning of the course are not guaranteed to get the account in
time.
#. Both the accounts and the generated key-pairs are strictly PRIVATE
and students are not supposed to share the accounts, not even for the
purpose of the course.
#. Please remember to instruct your students to bring the private key to
the class. Students may forget it and without the key they will not
be able to login to the cluster even if they have the accounts.
#. If the reservation of few nodes is necessary during the exercise
classes please let us know 1 week before the exercise class, so that
it can be scheduled. To submit the job during the class the following
command should be used:
#. To ensure that students jobs do not wait in the queue during the hands-on sessions, we offer
to reserve some limited resources during the session. In that case, please submit your exact
resource requirements one week before the training, by latest.
We will communicate the ``<reservation_name>`` with you for every exercise session.
To submit the job during the class to the reserved resources, the ``--reservation`` argument
needs to be used, e.g.:

::

Expand All @@ -60,9 +45,12 @@ several actions from the lecturer are required.
the purpose of the course, and the ``<reservation_name>`` refers to an
existing reservation on the system for the spcific course.

#. Make sure that the software to connect to the cluster (Putty, Xming,
FileZilla, NX) is available in the PC-class that will be used during the
course. For KU Leuven courses: please follow the procedure at
https://icts.kuleuven.be/sc/pcklas/ictspcklassen
(1 month before the beginning of the course).

#. In case your workflow requires extra access to the cluster with other applications (such as NX,
FileZilla, etc.) the students need to :ref:`generate private-public key pair <generic access procedure>`,
and add the public key it to their VSC account via the `VSC account page`_.
#. If you are not using Open OnDemand, make sure that the software to connect to the cluster
(Putty, MobaXterm, Xming, FileZilla, NX) is available in the PC-class that will be used during the
course. For KU Leuven courses, please follow the procedure at
https://icts.kuleuven.be/sc/pcklas/ictspcklassen (1 month before the beginning of the course).