Difference between revisions of "Users"

From Mufasa (BioHPC)
Jump to navigation Jump to search
 
(96 intermediate revisions by the same user not shown)
Line 1: Line 1:
Only Mufasa users (i.e., people with a user account on Mufasa) can [[System#Accessing Mufasa|access the machine]] and interact with it.
= Requesting a new user of Mufasa =


Only people with a '''Linux user account''' on Mufasa can [[System#Accessing Mufasa|access the machine]] and interact with it. Only Linux users registered to SLURM's accounting system can [[System#The_SLURM_job_scheduling_system|use SLURM]] to run jobs.


= Creating new Mufasa users =
All requests for the creation of new users and their registration to SLURM's accounting must be '''authorized by a member of the academic staff''' in charge of Mufasa.
Enabling a person to run jobs on Mufasa requires two steps:


; Step 1: the person must be [[Users#Creating a new Linux user|'''assigned a new Linux user''']] on Mufasa
Requests are done by writing an email
: Creation of new Linux users is done either by [[Roles|Job Administrators]] or by specially designated users within each research group


; Step 2: the new Linux user must be [[Users#Providing a user with access to SLURM|'''registered in SLURM's accounting system''']]
: '''TO:''' [[User:GiulioFontana|Giulio Fontana]]
: This operation must necessarily be performed by [[Roles|Job Administrators]]
: '''CC:''' the person who authorizes the request


Step 1 enables the person to interact with Mufasa via SSH and to execute basic activities, such as uploading data and code in their <code>/home</code> directory. The second operation is needed to enable the person to fully exploit Mufasa's computational resources, which requires using [[System#The SLURM job scheduling system|SLURM]].
The email must provide the following 5 pieces of information:


== Requesting user creation and/or registration ==
# '''name and surname''' of the person that the new Linux user is associated to
To request the creation of a new Linux user and/or to ask for its registration in SLURM's accounting system, a person belonging to the academic staff in charge of Mufasa should [[Special:Emailuser/GiulioFontana|write to Giulio Fontana]].
# (POLIMI) '''email address''' of the person
# '''user category''', which can be either ''student'' (for M.Sc. students) or ''researcher'' (for everyone else, including Ph.D. students)
# '''research group''' that the person belongs to (see [[Users#Usernames and group names|below]])


The request needs to specify what follows:
= Usernames and group names =
Mufasa usernames have the form <code>xyyyyyyyy</code> (all lowercase), where <code>x</code> is the first letter of the first name of the person, and <code>yyyyyyyy</code> is their surname (or part of it if it's too long). For instance, a person called Giuseppe Brambilla will be assigned username <code>gbrambill</code>.


* name and surname of the person that the Linux user is associated to
On Linux machines, users belong to ''groups''. On Mufasa, groups are used to identify research groups. Assigment of Mufasa's users to groups follow these rules:
* email of the person
* if such person is an M.Sc. student or a researcher (the latter include Ph.D. students)
* what research group the person belongs to, among those listed in [[Users#Group names|Group names]]
* (if already created) name of the Linux user corresponding to the person


= Creating a new Linux user =
* All users corresponding to physical people belong to group <code>'''users'''</code>
[[Roles|Job Administrators]] and specially designated users within each research group can create new Linux users on Mufasa.  
* Additionally, each user must belong to ''one and only one'' of the following groups:
** <code>'''cartcas'''</code>, i.e. [http://www.cartcas.polimi.it/ CartCasLab] (prof. Cerveri);
** <code>'''biomech'''</code>, i.e. [http://www.biomech.polimi.it/ Biomechanics Research Group] (prof. Votta);
** <code>'''nearmrs'''</code>, i.e. [https://nearlab.polimi.it/medical/ Medical Robotics Section of NearLab] (prof. De Momi);
** <code>'''nearnes'''</code>, i.e. [https://nearlab.polimi.it/neuroengineering/ NeuroEngineering Section of NearLab] (prof. Ferrante);
** <code>'''bio'''</code>, for BioEngineering users not belonging to any of the research groups listed above.


User creation is done with command
The person cited within brackets is the faculty who is in charge of Mufasa for each research group.


<pre style="color: lightgrey; background: black;">
= Removing inactive usernames =
sudo  /opt/share/sbin/add_user.sh -u <username> -g users,<research_group>
Mufasa usernames that are not in use anymore '''must be removed'''. Typically, these correspond either to M.Sc. students who graduated or to researchers who left POLIMI.
</pre>


where <code><username></code> and <code><research_group></code> are chosen as explained below (see [[Users#Usernames|Usernames]] and [[Users#Group names|Group names]]).
Removing a username means:
* '''deleting the username''' from the Linux system
* '''deleting the home directory''' from the filesystem


For instance, in order to create a user on Mufasa for a person named Mario Rossi belonging to research group CartCasLab, the following command will be used:
Removing inactive usernames is necessary to preserve Mufasa's safety and to avoid wasting resources (e.g., disk space).


: <code>sudo  /opt/share/sbin/add_user.sh -u mrossi -g users,cartcas</code>
Whenever a person ceases to use Mufasa, '''the member of staff responsible for them''' (e.g.: professor, Ph.D) '''must''':
 
# (optional) check the home directory and copy any useful leftovers somewhere else
At first login, new users will be asked to change the password initially assigned to them. For security reason, it is important that such first login occurs as soon as possible after user creation.
# write an email to [[User:GiulioFontana|Giulio Fontana]]
 
== Usernames ==
Mufasa usernames have the form <code>xyyy</code> (all lowercase), where <code>x</code> is the first letter of the first name of the person, and <code>yyy</code> is their complete surname. For instance, a person called Mario Rossi will be assigned username <code>mrossi</code>.
 
If multiple users with the same surname ''and'' first letter of the first name exist, those created after the very first one are given usernames including a two-digit counter: <code>mrossi</code>, <code>mrossi01</code>, <code>mrossi02</code> and so on.
 
== Group names ==
On Mufasa, Linux groups are used to identify the research group that a specific user is part of.
 
In the command [[Users#Creating a new Linux user|above]], <code><research_group></code> must be one of the following:
 
* <code>'''cartcas'''</code> for research group [http://www.cartcas.polimi.it/ CartCasLab] (prof. Cerveri);
* <code>'''biomech'''</code> for research group [http://www.biomech.polimi.it/ Biomechanics Research Group] (prof. Votta);
* <code>'''nearmrs'''</code> for research group [https://nearlab.polimi.it/medical/ Medical Robotics Section of NearLab] (prof. De Momi);
* <code>'''nearnes'''</code> for research group [https://nearlab.polimi.it/neuroengineering/ NeuroEngineering Section of NearLab] (prof. Ferrante);
* <code>'''bio'''</code>, for BioEngineering users not belonging to any of the research groups listed above.
 
The person cited within brackets is the faculty who is in charge of Mufasa for each group.
 
Note that by using the command [[Users#Creating a new Linux user|above]], all users are also assigned group <code>'''users'''</code>, which is common to all Mufasa users corresponding to physical people.
 
= Providing a user with access to SLURM =
New users are not able to [[User Jobs#Executing jobs on Mufasa|execute jobs via SLURM]] until they are properly registered in SLURM's accounting system. This operation must necessarily be performed by  [[Roles|Job Administrators]].
 
See [[Users#Requesting user creation and/or registration|Requesting user creation and/or registration]] for details.

Latest revision as of 16:40, 10 April 2024

Requesting a new user of Mufasa

Only people with a Linux user account on Mufasa can access the machine and interact with it. Only Linux users registered to SLURM's accounting system can use SLURM to run jobs.

All requests for the creation of new users and their registration to SLURM's accounting must be authorized by a member of the academic staff in charge of Mufasa.

Requests are done by writing an email

TO: Giulio Fontana
CC: the person who authorizes the request

The email must provide the following 5 pieces of information:

  1. name and surname of the person that the new Linux user is associated to
  2. (POLIMI) email address of the person
  3. user category, which can be either student (for M.Sc. students) or researcher (for everyone else, including Ph.D. students)
  4. research group that the person belongs to (see below)

Usernames and group names

Mufasa usernames have the form xyyyyyyyy (all lowercase), where x is the first letter of the first name of the person, and yyyyyyyy is their surname (or part of it if it's too long). For instance, a person called Giuseppe Brambilla will be assigned username gbrambill.

On Linux machines, users belong to groups. On Mufasa, groups are used to identify research groups. Assigment of Mufasa's users to groups follow these rules:

The person cited within brackets is the faculty who is in charge of Mufasa for each research group.

Removing inactive usernames

Mufasa usernames that are not in use anymore must be removed. Typically, these correspond either to M.Sc. students who graduated or to researchers who left POLIMI.

Removing a username means:

  • deleting the username from the Linux system
  • deleting the home directory from the filesystem

Removing inactive usernames is necessary to preserve Mufasa's safety and to avoid wasting resources (e.g., disk space).

Whenever a person ceases to use Mufasa, the member of staff responsible for them (e.g.: professor, Ph.D) must:

  1. (optional) check the home directory and copy any useful leftovers somewhere else
  2. write an email to Giulio Fontana