Jupyter¶

Linux or MacOS¶

If you are using Linux or MacOS, then use the nice little tool named sshuttle to access it.

Sshuttle is a program that, according to its documentation, acts as a “Transparent proxy server that works as a poor man’s VPN. Forwards over ssh. Doesn’t require admin. Works with Linux and MacOS.” Installation on a Linux or MacOS laptop can be done with apt, pacman, dnf depending on your Linux distribution, or with brew, MacPort on MacOS, but you can also install it with pip or git clone from GitHub directly. See the GitHub page for details.

After you have installed sshuttle, make sure you can access the cluster via the ssh command. In the following, we will assume the connection to the CECI cluster where you started the jupyter job works by just running ssh cecicluster on your terminal.

Then, create a tunnel with sshuttle. Open a terminal in your machine that will be dedicated to that and run the following in it:

$ sshuttle -r cecicluster XX.XXX.X.X/YY
[local sudo] Password
Warning: No xauth data; using fake authentication data for X11 forwarding.
client: Connected.

The IP range to introduce for sshuttle depends on the cluster where you started the JuptyerLab job.

• nic5 10.252.1.0/16
• lemaitre4 10.4.1.1/16
• dragon2 10.102.169.0/24
• hercules 192.168.1.100/23
• lyra 10.0.7.1/24

When running the command it will ask for your password in order to elevate privileges (sudo). That is needed because it will modify temporarily low-level network routing. As long as it runs, the private network of the cluster worker nodes will be accessible from your laptop, wherever you are connected. Leave that terminal session open for as long as you need access to the Jupyter service in your job.

If your terminal supports it, you can then click on the URL from the srun interactive job that starts with http://10.xx or http://192.xx in the previous step. Otherwise simply copy that URL in your browser and you should land on the JupyterLab interface.

Once you are finished hit CTRL-C in both terminals to stop everything.

See a video with a connexion example on lemaitre3.

Windows¶

If you are using Windows, we assume you already installed and configured MobaXterm.

Use the compute node IP address and port you get when submitting the job.

To reach the IP address of the compute node from your computer (localhost) two forwarding ports must be created. The first one will forward a intermediate localhost port (1111) to the front-end (nic5, lemaitre4 ...) through the gateway. The second one will forward the local port 2222 on the localhost port 1111 to the computer node port 8888

Create the first tunnel between your computer and the cluster frontend:

• Open MobaXTerm and click on “tunnelling” and click on “new ssh tunnel” to create the first tunnel.
• Fill the local port with 1111.
• Fill “ssh server” with the login and gateway address of your university.
• Fill the remote server with the frontend cluster address

• Click Save and set the name of the new tunnel with the cluster name
• Click on the key and add your CÉCI key id_rsa.ceci

You can create a tunnel for each cluster (nic5, lemaitre4 ...)

Create the second tunnel between your computer and the compute node through the first tunnel:

• Create a “new ssh tunnel” .
• Fill the local port with 2222.
• Fill “ssh server” with the localhost forwarded port 1111 and your CÉCI user login name
• Fill the remote server with the compute node IP and port you get when submitting the job.

• Click Save and set the name of the new tunnel as node.
• Click on the key and add your CÉCI key id_rsa.ceci

You will have something like this:

Start the tunnel for the cluster where you submitted the job and the tunnel for the node. Then open your browser at http://localhost:2222/lab?token=XXXXXXXXXX. Replacing XXXXXXXXXX with the token you received wen submitting the job.

See a video with a connexion example on dragon2.