Helix/Login: Difference between revisions
S Richling (talk | contribs) |
K Siegmund (talk | contribs) |
||
(68 intermediate revisions by 2 users not shown) | |||
Line 7: | Line 7: | ||
If you are outside the BelWü network (e.g. at home), a VPN (virtual private network) connection to your University network must be established first. Please consult the VPN documentation of your University. |
If you are outside the BelWü network (e.g. at home), a VPN (virtual private network) connection to your University network must be established first. Please consult the VPN documentation of your University. |
||
|} |
|} |
||
⚫ | |||
'''Prerequisites for successful login:''' |
'''Prerequisites for successful login:''' |
||
Line 17: | Line 15: | ||
* registered a token for the [[Registration/2FA|two factor authentication (2FA)]]. |
* registered a token for the [[Registration/2FA|two factor authentication (2FA)]]. |
||
⚫ | |||
Login to bwForCluster Helix is only possible with a Secure Shell (SSH) client for which you must know your username on the cluster and the hostname of the login nodes. |
|||
⚫ | |||
== Username == |
== Username == |
||
Your username on bwForCluster Helix consists of a prefix and your local username. |
|||
For prefixes please refer to the [[Registration/Login/Username| |
For prefixes please refer to the [[Registration/Login/Username|Username Guide]]. |
||
Example: If your local username at your University is <code>ab123</code> and you are a user from Heidelberg University |
Example: If your local username at your University is <code>ab123</code> and you are a user from Heidelberg University, your username on the cluster is: <code>hd_ab123</code>. |
||
== Hostnames == |
== Hostnames == |
||
bwForCluster Helix has two login nodes. We use so-called DNS round-robin scheduling to load-balance the incoming connections between the nodes. If you open multiple SSH sessions, these sessions may run on different login nodes, so processes started in one session might not be visible in other sessions. |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Hostname !! |
! Hostname !! Destination |
||
|- |
|- |
||
| '''helix.bwservices.uni-heidelberg.de''' || |
| '''helix.bwservices.uni-heidelberg.de''' || one of the two login nodes |
||
|} |
|} |
||
== Login with SSH command (Linux, Mac, Windows) == |
|||
== SSH Clients == |
|||
⚫ | |||
⚫ | |||
Most Unix and Unix-like operating systems like Linux or MacOS come with a built-in SSH client provided by the OpenSSH project. |
Most Unix and Unix-like operating systems like Linux or MacOS come with a built-in SSH client provided by the OpenSSH project. |
||
⚫ | |||
For login use one of the following ssh commands: |
|||
ssh <username>@helix.bwservices.uni-heidelberg.de |
ssh <username>@helix.bwservices.uni-heidelberg.de |
||
ssh -l <username> helix.bwservices.uni-heidelberg.de |
ssh -l <username> helix.bwservices.uni-heidelberg.de |
||
To run graphical applications, you |
To run graphical applications on the cluster, you need to enable X11 forwarding with the <code>-X</code> flag: |
||
ssh - |
ssh -X -l <username> helix.bwservices.uni-heidelberg.de |
||
== Login |
== Login with graphical SSH client (Windows) == |
||
For Windows we suggest using MobaXterm for login and file transfer. |
For Windows we suggest using MobaXterm for login and file transfer. |
||
⚫ | |||
After installing a linux system with WSL use the instructions for linux. |
|||
Start |
Start MobaXterm and fill in the following fields: |
||
<pre> |
<pre> |
||
Remote name : helix.bwservices.uni-heidelberg.de |
Remote name : helix.bwservices.uni-heidelberg.de |
||
Line 63: | Line 63: | ||
</pre> |
</pre> |
||
After that click on 'ok'. Then a terminal will |
After that click on 'ok'. Then a terminal will open where you can enter your credentials. |
||
'''Note''': When using File transfer with MobaXterm version >=23.3, the following configuration change has to be made: In the settings in the tab "SSH", change the option "SSH engine" from "<new>" to "<legacy>". Then restart MobaXterm. |
|||
⚫ | |||
⚫ | |||
After registration bwForCluster Helix can be accessed via Secure Shell (SSH). Only SSH is allowed for login. |
|||
To login to bwForCluster Helix, proceed as follows: |
|||
From Linux machines, you can log in using the following command: |
|||
# Login with SSH command or MoabXterm as shown above. |
|||
# The system will ask for a one-time password <code>Your OTP:</code>. Please enter your OTP and confirm it with Enter/Return. The OTP is not displayed when typing. If you do not have a second factor yet, please create one (see [[Registration/2FA]]). |
|||
# The system will ask you for your service password <code>Password:</code>. Please enter it and confirm it with Enter/Return. The password is not displayed when typing. If you do not have a service password yet or have forgotten it, please create one (see [[Registration/Password]]). |
|||
# You will be greeted by the cluster, followed by a shell. |
|||
<pre> |
|||
⚫ | |||
Your OTP: |
|||
Password: |
|||
******************************************************************************** |
|||
⚫ | |||
* * |
|||
* Baden-Wuerttemberg HPC Cluster for * |
|||
* Structural and Systems Biology, Medical Science, * |
|||
* Soft Matter, Computational Humanities, and * |
|||
* Mathematics and Computer Science * |
|||
* * |
|||
* bwForCluster * |
|||
* _ _ _ _ * |
|||
* | | | | | | (_) * |
|||
* | |__| | ___ | | _ __ __ * |
|||
* | __ | / _ \ | | | | \ \/ / * |
|||
* | | | | | __/ | | | | > < * |
|||
* |_| |_| \___| |_| |_| /_/\_\ * |
|||
* * |
|||
* * |
|||
* (xCAT 2.16.4 / RHEL 8.8 / GPFS 5.1.8) * |
|||
* * |
|||
* * |
|||
* bwHPC Wiki : https://wiki.bwhpc.de/e/Helix * |
|||
* Ticket System : https://www.bwhpc.de/supportportal * |
|||
* Job Monitoring : https://helix-monitoring.bwservices.uni-heidelberg.de * |
|||
* E-learning : https://training.bwhpc.de/ * |
|||
* -> 'Introduction to bwForCluster Helix' * |
|||
* * |
|||
******************************************************************************** |
|||
Last login: ... |
|||
To run graphical applications, you need to enable X11 forwarding with the -X option: |
|||
[hd_ab123@login ~]$ |
|||
</pre> |
|||
⚫ | |||
<code> ssh -X <UserID>@helix.bwservices.uni-heidelberg.de</code> |
|||
{|style="background:#deffee; width:100%;" |
|||
For SSH client programs with graphical user interfaces, fill in UserID and login server name accordingly. For Windows you can use [https://www.putty.org/ PuTTY] or [https://mobaxterm.mobatek.net/ MobaXterm]. The later comes with an integrated X11 server which is necessary for the work with graphical applications. |
|||
|style="padding:5px; background:#cef2e0; text-align:left"| |
|||
[[Image:Attention.svg|center|25px]] |
|||
|style="padding:5px; background:#cef2e0; text-align:left"| |
|||
To guarantee usability for all users you must not run your compute jobs on the login nodes. |
|||
Compute jobs must be submitted as batch jobs. |
|||
Any compute job running on the login nodes will be terminated without notice. |
|||
Long-running compilation or long-running pre- or post-processing tasks must also be submitted as batch jobs. |
|||
|} |
|||
⚫ | |||
The bwForCluster Helix has serveral login nodes. The selection of the login node is done automatically. If you log in multiple times, different sessions might run on different login nodes. In general, you should use the generic hostname given above to allow us to balance the load over the login nodes. |
|||
These nodes are shared with all users. Hence, your activities on the login nodes are primarily limited to setting up your batch jobs. |
|||
Your activities may also be: |
|||
⚫ | |||
⚫ | |||
We advise to use [[Helix/Slurm#Interactive_Jobs|interactive batch jobs]] for compute and memory intensive compilation and pre- and post-processing tasks. |
|||
⚫ | |||
= Related Information = |
|||
The login nodes are the access point to the compute system and to your $HOME directory. The login nodes are shared with all the users of the cluster. Therefore, your activities on the login nodes are limited to primarily set up your batch jobs. Your activities may also be: |
|||
⚫ | |||
⚫ | |||
* If you want to reset your service password, consult the [[Registration/Password|Password Guide]]. |
|||
To guarantee usability for all the users of the bwForCluster you must not run your compute jobs on the login nodes. Compute jobs must be submitted as Batch Jobs. Any compute job running on the login nodes will be terminated without notice. |
|||
* If you want to register a new token for the two factor authentication (2FA), consult the [[Registration/2FA|2FA Guide]]. |
|||
* If you want to de-register, consult the [[Registration/Deregistration|De-registration Guide]]. |
|||
* If you need an SSH key for your workflow, read [[Registration/SSH|Registering SSH Keys with your Cluster]]. |
|||
* Configuring your shell: [[.bashrc Do's and Don'ts]] |
Latest revision as of 11:55, 5 November 2024
Access to bwForCluster Helix is only possible from IP addresses within the BelWü network which connects universities and other scientific institutions in Baden-Württemberg. If your computer is in your University network (e.g. at your office), you should be able to connect to bwForCluster Helix without restrictions. If you are outside the BelWü network (e.g. at home), a VPN (virtual private network) connection to your University network must be established first. Please consult the VPN documentation of your University. |
Prerequisites for successful login:
You need to have
- completed the 3-step bwForCluster registration procedure.
- set a service password for bwForCluster Helix.
- registered a token for the two factor authentication (2FA).
Login to bwForCluster Helix
Login to bwForCluster Helix is only possible with a Secure Shell (SSH) client for which you must know your username on the cluster and the hostname of the login nodes. For more gneral information on SSH clients, visit the SSH clients Guide.
Username
Your username on bwForCluster Helix consists of a prefix and your local username. For prefixes please refer to the Username Guide.
Example: If your local username at your University is ab123
and you are a user from Heidelberg University, your username on the cluster is: hd_ab123
.
Hostnames
bwForCluster Helix has two login nodes. We use so-called DNS round-robin scheduling to load-balance the incoming connections between the nodes. If you open multiple SSH sessions, these sessions may run on different login nodes, so processes started in one session might not be visible in other sessions.
Hostname | Destination |
---|---|
helix.bwservices.uni-heidelberg.de | one of the two login nodes |
Login with SSH command (Linux, Mac, Windows)
Most Unix and Unix-like operating systems like Linux or MacOS come with a built-in SSH client provided by the OpenSSH project. More recent versions of Windows 10 and Windows 11 using the Windows Subsystem for Linux (WSL) also come with a built-in OpenSSH client.
For login use one of the following ssh commands:
ssh <username>@helix.bwservices.uni-heidelberg.de ssh -l <username> helix.bwservices.uni-heidelberg.de
To run graphical applications on the cluster, you need to enable X11 forwarding with the -X
flag:
ssh -X -l <username> helix.bwservices.uni-heidelberg.de
Login with graphical SSH client (Windows)
For Windows we suggest using MobaXterm for login and file transfer.
Start MobaXterm and fill in the following fields:
Remote name : helix.bwservices.uni-heidelberg.de Specify user name : <username> Port : 22
After that click on 'ok'. Then a terminal will open where you can enter your credentials.
Note: When using File transfer with MobaXterm version >=23.3, the following configuration change has to be made: In the settings in the tab "SSH", change the option "SSH engine" from "<new>" to "<legacy>". Then restart MobaXterm.
Login Example
To login to bwForCluster Helix, proceed as follows:
- Login with SSH command or MoabXterm as shown above.
- The system will ask for a one-time password
Your OTP:
. Please enter your OTP and confirm it with Enter/Return. The OTP is not displayed when typing. If you do not have a second factor yet, please create one (see Registration/2FA). - The system will ask you for your service password
Password:
. Please enter it and confirm it with Enter/Return. The password is not displayed when typing. If you do not have a service password yet or have forgotten it, please create one (see Registration/Password). - You will be greeted by the cluster, followed by a shell.
$ ssh -l hd_ab123 helix.bwservices.uni-heidelberg.de Your OTP: Password: ******************************************************************************** * * * Baden-Wuerttemberg HPC Cluster for * * Structural and Systems Biology, Medical Science, * * Soft Matter, Computational Humanities, and * * Mathematics and Computer Science * * * * bwForCluster * * _ _ _ _ * * | | | | | | (_) * * | |__| | ___ | | _ __ __ * * | __ | / _ \ | | | | \ \/ / * * | | | | | __/ | | | | > < * * |_| |_| \___| |_| |_| /_/\_\ * * * * * * (xCAT 2.16.4 / RHEL 8.8 / GPFS 5.1.8) * * * * * * bwHPC Wiki : https://wiki.bwhpc.de/e/Helix * * Ticket System : https://www.bwhpc.de/supportportal * * Job Monitoring : https://helix-monitoring.bwservices.uni-heidelberg.de * * E-learning : https://training.bwhpc.de/ * * -> 'Introduction to bwForCluster Helix' * * * ******************************************************************************** Last login: ... [hd_ab123@login ~]$
Allowed Activities on Login Nodes
To guarantee usability for all users you must not run your compute jobs on the login nodes. Compute jobs must be submitted as batch jobs. Any compute job running on the login nodes will be terminated without notice. Long-running compilation or long-running pre- or post-processing tasks must also be submitted as batch jobs. |
The login nodes are the access points to the compute system, your $HOME
directory and your workspaces.
These nodes are shared with all users. Hence, your activities on the login nodes are primarily limited to setting up your batch jobs.
Your activities may also be:
- quick compilation of program code or
- quick pre- and post-processing of results from batch jobs.
We advise to use interactive batch jobs for compute and memory intensive compilation and pre- and post-processing tasks.
Related Information
- If you want to reset your service password, consult the Password Guide.
- If you want to register a new token for the two factor authentication (2FA), consult the 2FA Guide.
- If you want to de-register, consult the De-registration Guide.
- If you need an SSH key for your workflow, read Registering SSH Keys with your Cluster.
- Configuring your shell: .bashrc Do's and Don'ts