Difference between revisions of "Accessing the cluster"

From ScientificComputing
Jump to: navigation, search
(102 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<table style="width: 100%">
+
__NOTOC__
 +
<table style="width: 100%;">
 
<tr valign=top>
 
<tr valign=top>
−
<td style="width: 30%; background: white;">
+
<td style="width: 50%; text-align:left">
−
== New users==
+
< [[Main_Page|Home]]
−
'''Prerequisites'''
+
</td>
 +
<td style="width: 50%; text-align:right">
 +
[[Storage and data transfer]] >
 +
</td>
 +
</tr>
 +
</table>
 +
 
 +
 
 +
<table style="width: 100%;">
 +
<tr valign=top>
 +
<td style="width: 45%;">
 +
[[File:Accessing the clusters.png|600px]]
 +
</td>
 +
<td style="width: 5%;>
 +
</td>
 +
<td style="width: 50%;">
 +
 
 +
== Prerequisites ==
 
* A valid ETH account
 
* A valid ETH account
 
* Local computer with an SSH client
 
* Local computer with an SSH client
−
* An X11 server for graphical user interface (optional)
+
** Linux and macOS contain SSH client in the operating system
 +
** Windows users need to install a third party SSH client, e.g., [https://mobaxterm.mobatek.net/ MobaXterm], [https://www.putty.org/ PuTTY], [https://gitforwindows.org/ Git BASH] or [https://docs.microsoft.com/en-us/windows/wsl/install Windows Subsystem Linux (WSL)]
 +
* [[Accessing_the_clusters#X11| An X11 server for graphical user interface (GUI)]] (optional)
 +
** Linux: [https://www.xorg.com Xorg] is usually installed
 +
** macOS users need to install [https://xquartz.org XQuartz]
 +
** Windows: MobaXterm includes and enables an X11 server
 +
</td>
 +
</tr>
 +
</table>
 +
 
 +
== How to access the cluster ==
 +
<table style="width: 100%;">
 +
<tr valign=top>
 +
<td style="width: 45%;">
 +
=== From a terminal (Linux, MacOS, Git BASH, WSL) ===
 +
* Start a terminal
 +
* Use ssh command to connect to the login node of Euler
 +
  $ ssh username@euler.ethz.ch
 +
* Use your ETH credentials to log in
 +
</td>
 +
<td style="width: 5%;>
 +
</td>
 +
<td style="width: 45%;">
 +
=== For Windows users ===
 +
* [[How to access the cluster with MobaXterm]]: MobaXterm is a convenient tool for accessing the cluster as it includes an SSH client, a local shell and data transfer functions.
 +
* [[How to access the cluster with PuTTY]]: PuTTY is an SSH client and does not provide a local shell. WinSCP can import a saved PuTTY session to create a connection for data transfer.
 +
* To run [[Jupyter on Euler and Leonhard Open|Jupyter Notebook]] or [[VSCode|VSCode on Euler]], use [https://gitforwindows.org/ Git BASH] or [https://docs.microsoft.com/en-us/windows/wsl/install WSL]
 +
</td>
 +
</tr>
 +
</table>
 +
 
 +
<table style="width: 100%;">
 +
<tr valign=top>
 +
<td style="width: 45%;">
 +
 
 +
=== For new users and unverified accounts ===
 +
* Upon the first login, a verification code should be sent to your ETH email address (username@ethz.ch)
 +
* Enter the verification code to the prompt
 +
 
 +
An access code has been sent to your ETH email address.
 +
Enter the access code at the prompt below.
 +
If you do not receive the access code within a few minutes,
 +
then contact us by opening a ticket at
 +
http://smartdesk.ethz.ch
 +
 +
Access code (ending in ******Ls):
 +
 
 +
* [[Accessing_the_clusters#First_login|Accept the cluster’s usage rules upon the first access]]
 +
 
 +
</td>
 +
<td style="width: 5%;>
 +
</td>
 +
<td style="width: 45%;">
 +
 
 +
=== Login options ===
 +
* To use GUI on the cluster
 +
** In MobaXterm, X11 forwarding is already included and enabled
 +
** In PuTTY, go to Connection > SSH > X11, check the box ''Enable X11 forwarding''
 +
** From a terminal (Linux, MacOS, [https://gitforwindows.org/ Git BASH], [https://docs.microsoft.com/en-us/windows/wsl/install WSL]), users have to enable X11 forwarding when log in
 +
    $ ssh -Y username@euler.ethz.ch
 +
 
 +
* After a successful login with password, [[Accessing_the_cluster#SSH_Keys|generate SSH keys for passwordless login]]
 +
 
 +
 
 +
</td>
 +
</tr>
 +
</table>
 +
 
 +
== Who can access the cluster ==
 +
<table style="width: 100%;">
 +
<tr valign=top>
 +
<td style="width: 45%;">
 +
 
 +
{| class="wikitable" | style="background: white;"
 +
! || Euler CPU || Euler GPU
 +
|-
 +
| Shareholders who invest in the cluster resources || style="color:green; text-align: center;"| &#x2713; <br /> Euler CPU shareholders ||style="color:green;text-align: center;"| &#x2713; <br /> Euler GPU shareholders
 +
|-
 +
| External collaborators of shareholders || style="color:green;text-align:center;"| &#x2713; ||style="color:green;text-align: center;"| &#x2713;
 +
|-
 +
| Guest users || style="color:green;text-align:center;"| &#x2713; <br />All ETH members can access Euler as guest users with limited resources||style="color:red;text-align:center;"| &#x2715;
 +
|}
 +
 
 +
</td>
 +
<td style="width: 5%;>
 +
</td>
 +
<td style="width: 45%;">
 +
=== External collaborators ===
 +
Members of other institutions who have a collaboration with a research group at ETH may use the clusters for the purpose of said collaboration
 +
* Their counterpart (“sponsor”) at ETH can create an ETH guest account, e-mail address and VPN service for them
 +
* Then, they can access Euler like members of ETH
 +
</td>
 +
</tr>
 +
</table>
  
−
'''How to get access'''
+
== Security ==
−
* Request authorization of your ETH account from cluster-support@id.ethz.ch
+
<table style="width:100%">
−
* Start your SSH client
+
<tr valign=top>
−
* Use ssh command to connect to the login node of Euler or Leonhard Open
+
<td style="width: 40%">
−
  ssh username@euler.ethz.ch
+
* To connect from outside of the ETH network to the cluster, establish first a [[Accessing_the_clusters#VPN|VPN connection]]. Then, connect to the cluster through SSH.
−
  ssh username@login.leonhard.ethz.ch
+
* To connect from a compute node to an external service, use the ETH proxy service:
−
* Use your ETH credentials to login
+
$ module load eth_proxy
−
* New users must accept the cluster’s usage rules upon first login
+
 
−
* You can generate SSH keys for passwordless login
+
=== Legal Compliance ===
 +
The HPC clusters are subject to ETH’s acceptable use policy for IT resources ([https://rechtssammlung.sp.ethz.ch/Dokumente/203.21en.pdf Benutzungsordnung für Telematik (BOT)]), in particular:
 +
* Cluster accounts are strictly personal
 +
* DO NOT share your account (password, sshkeys) with anyone
 +
* DO NOT use someone else’s account, even if they say it’s OK
 +
* If you suspect that someone used your account, [https://www.password.ethz.ch change your password] and contact [mailto:cluster-support@id.ethz.ch cluster support]
 
</td>
 
</td>
 +
<td style="width: 5%">
 +
</td>
 +
<td style="width: 55%">
 +
[[Image:security.png|600px]]
 +
</td>
 +
</tr>
 +
</table>
 +
Consequences:
 +
 +
* In case of abuse, the offender’s account may be blocked temporarily or closed
 +
* System administrators are obliged by law to investigate abusive or illegal activities and report them to the relevant authorities
 +
 +
== SSH Keys ==
 +
* SSH keys allows passwordless login which is useful for file transfers, automated tasks and running interactive tools, such as [[Jupyter on Euler and Leonhard Open|Jupyter Notebook]] and [[VSCode]], on the cluster
 +
* When used properly, SSH keys are much safer than passwords
 +
* SSH keys always come in pairs:
 +
** '''A private key''', stored on your local workstation (and nowhere else!)
 +
** '''A public key''', stored on the computer(s) you want to connect to
 +
** You can generate as many pairs as you like, e.g., one for each computer you intend to connect to
 +
* Keys should be protected with a passphrase
 +
* You can unlock keys with SSH key management tools such as [https://www.ssh.com/academy/ssh/agent#starting-ssh-agent ssh-agent] and [https://linux.die.net/man/1/keychain keychain]
  
−
<td style="width: 3%; background: white;">
+
<table>
 +
<tr valign=center>
 +
<td style="width: 30%; background: white;">
 +
=== Step 1: Create your keys ===
 
</td>
 
</td>
 +
</tr>
 +
<tr valign=center>
 +
<td style="width: 30%; background: white;">
 +
<br>
 +
[[Image:ssh_keys_gen.png|370px]]
 +
<br>
 +
</td>
 +
<td style="width: 60%; background: white; text-align: left">
 +
* First, verify whether logging in with password works
 +
* Generate a key pair with the ed25519 algorithm for each computer you want to connect to
 +
 +
$ ssh-keygen -t ed25519 -f $HOME/.ssh/id_ed25519_euler
 +
 +
* Enter a passphrase to protect your SSH keys
 +
</td>
 +
</tr>
  
 +
<tr valign=center>
 
<td style="width: 30%; background: white;">
 
<td style="width: 30%; background: white;">
−
== Current users ==
+
=== Step 2: Copy the public key to the cluster ===
−
To regain the access after [[Reopening of Euler and Leonhard (May 2020)|the incident on 15 May 2020]], all users have to change their LDAP password and generate a new SSH key.
 
−
* Change your ETH password at https://password.ethz.ch
 
−
* Wait for one working day. The change should become active on the next day from 8am.
 
−
* If you have waited for one working day and could still not access the cluster, please contact us.
 
−
* Regenerate SSH keys
 
 
</td>
 
</td>
 +
</tr>
  
−
<td style="width: 3%; background: white;">
+
<tr valign=center>
 +
<td style="width: 30%; background: white;">
 +
[[Image:ssh_keys_copy.png|370px]]
 +
</td>
 +
<td style="width: 60%; background: white; text-align: left;">
 +
$ ssh-copy-id -i $HOME/.ssh/id_ed25519_euler.pub username@euler.ethz.ch
 
</td>
 
</td>
 +
</tr>
  
 +
<tr valign=center>
 
<td style="width: 30%; background: white;">
 
<td style="width: 30%; background: white;">
−
== External collaborators ==
+
=== Step 3: Use keys with non-default names ===
−
* Members of other institutions who have a collaboration with a research group at ETH may use the clusters for the purpose of said collaboration
 
−
* Their counterpart (“sponsor”) at ETH must create an ETH guest account for them, including e-mail address and VPN service
 
−
* Once this is done, they can access Euler like members of ETH
 
 
</td>
 
</td>
 +
</tr>
  
 +
<tr valign=top>
 +
<td style="width: 30%; background: white;">
 +
<br>
 +
[[Image:ssh_keys_connect.png|370px]]
 +
<br>
 +
</td>
 +
<td style="width: 60%; background: white; text-align: left;">
 +
The login commands become:
 +
 +
$ ssh -i $HOME/.ssh/id_ed25519_euler username@euler.ethz.ch
 +
 +
Alternatively, SSH clients can use this option automatically by adding the option IdentityFile in your $HOME/.ssh/config file, e.g.:
 +
 +
Host euler
 +
HostName euler.ethz.ch
 +
User username
 +
IdentityFile ~/.ssh/id_ed25519_euler
 +
 +
Next time you login, you can type
 +
 +
$ ssh euler
 +
 +
</td>
 +
</tr>
 +
</table>
 +
 +
=== SSH key management with SSH Agent ===
 +
As we have to enter the passphrase to unlock the keys, it takes away the convenience of passwordless login. We can use an SSH agent (ssh-agent) to unlock the SSH keys.
 +
$ eval `ssh-agent`
 +
Agent pid 17906
 +
 +
$ ssh-add $HOME/.ssh/id_ed25519_euler
 +
Enter passphrase for id_ed25519_euler:
 +
Identity added: id_ed15519_euler (username@local-computer-name)
 +
 +
== Further reading ==
 +
* [[New_account_request_process_for_HPC_clusters| New account request process for HPC clusters]]
 +
* [[Accessing_the_clusters|User guide: Accessing the clusters]]
 +
* [[Getting_started_with_clusters#Troubleshooting | Troubleshooting]]
 +
 +
 +
<table style="width: 100%;">
 +
<tr valign=top>
 +
<td style="width: 50%; text-align:left">
 +
< [[Main_Page|Home]]
 +
</td>
 +
<td style="width: 50%; text-align:right">
 +
[[Storage and data transfer]] >
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Revision as of 11:10, 27 January 2022

< Home

Storage and data transfer >


Accessing the clusters.png

Prerequisites

How to access the cluster

From a terminal (Linux, MacOS, Git BASH, WSL)

  • Start a terminal
  • Use ssh command to connect to the login node of Euler
 $ ssh username@euler.ethz.ch
  • Use your ETH credentials to log in

For Windows users

For new users and unverified accounts

  • Upon the first login, a verification code should be sent to your ETH email address (username@ethz.ch)
  • Enter the verification code to the prompt
An access code has been sent to your ETH email address.
Enter the access code at the prompt below.
If you do not receive the access code within a few minutes,
then contact us by opening a ticket at
http://smartdesk.ethz.ch

Access code (ending in ******Ls):

Login options

  • To use GUI on the cluster
    • In MobaXterm, X11 forwarding is already included and enabled
    • In PuTTY, go to Connection > SSH > X11, check the box Enable X11 forwarding
    • From a terminal (Linux, MacOS, Git BASH, WSL), users have to enable X11 forwarding when log in
   $ ssh -Y username@euler.ethz.ch


Who can access the cluster

Euler CPU Euler GPU
Shareholders who invest in the cluster resources ✓
Euler CPU shareholders 		✓
Euler GPU shareholders
External collaborators of shareholders ✓ ✓
Guest users ✓
All ETH members can access Euler as guest users with limited resources		 ✕

External collaborators

Members of other institutions who have a collaboration with a research group at ETH may use the clusters for the purpose of said collaboration

  • Their counterpart (“sponsor”) at ETH can create an ETH guest account, e-mail address and VPN service for them
  • Then, they can access Euler like members of ETH

Security

  • To connect from outside of the ETH network to the cluster, establish first a VPN connection. Then, connect to the cluster through SSH.
  • To connect from a compute node to an external service, use the ETH proxy service:
$ module load eth_proxy

Legal Compliance

The HPC clusters are subject to ETH’s acceptable use policy for IT resources (Benutzungsordnung für Telematik (BOT)), in particular:

  • Cluster accounts are strictly personal
  • DO NOT share your account (password, sshkeys) with anyone
  • DO NOT use someone else’s account, even if they say it’s OK
  • If you suspect that someone used your account, change your password and contact cluster support

Security.png

Consequences:

  • In case of abuse, the offender’s account may be blocked temporarily or closed
  • System administrators are obliged by law to investigate abusive or illegal activities and report them to the relevant authorities

SSH Keys

  • SSH keys allows passwordless login which is useful for file transfers, automated tasks and running interactive tools, such as Jupyter Notebook and VSCode, on the cluster
  • When used properly, SSH keys are much safer than passwords
  • SSH keys always come in pairs:
    • A private key, stored on your local workstation (and nowhere else!)
    • A public key, stored on the computer(s) you want to connect to
    • You can generate as many pairs as you like, e.g., one for each computer you intend to connect to
  • Keys should be protected with a passphrase
  • You can unlock keys with SSH key management tools such as ssh-agent and keychain

Step 1: Create your keys


Ssh keys gen.png

  • First, verify whether logging in with password works
  • Generate a key pair with the ed25519 algorithm for each computer you want to connect to
$ ssh-keygen -t ed25519 -f $HOME/.ssh/id_ed25519_euler
  • Enter a passphrase to protect your SSH keys

Step 2: Copy the public key to the cluster

Ssh keys copy.png 

$ ssh-copy-id -i $HOME/.ssh/id_ed25519_euler.pub username@euler.ethz.ch

Step 3: Use keys with non-default names


Ssh keys connect.png

The login commands become: 

$ ssh -i $HOME/.ssh/id_ed25519_euler username@euler.ethz.ch

Alternatively, SSH clients can use this option automatically by adding the option IdentityFile in your $HOME/.ssh/config file, e.g.: 

Host euler
HostName euler.ethz.ch
User username
IdentityFile ~/.ssh/id_ed25519_euler

Next time you login, you can type 

$ ssh euler

SSH key management with SSH Agent

As we have to enter the passphrase to unlock the keys, it takes away the convenience of passwordless login. We can use an SSH agent (ssh-agent) to unlock the SSH keys. 

$ eval `ssh-agent`
Agent pid 17906

$ ssh-add $HOME/.ssh/id_ed25519_euler
Enter passphrase for id_ed25519_euler:
Identity added: id_ed15519_euler (username@local-computer-name)

Further reading


< Home

Storage and data transfer >

Retrieved from "https://scicomp.ethz.ch/w/index.php?title=Accessing_the_cluster&oldid=6862"