Skip to content

Update VSCode interactive node setup for current IRB cluster #326

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.

Sign up for GitHub

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

Closed
CarlosLopezElorduy wants to merge 2 commits into from
Closed

Update VSCode interactive node setup for current IRB cluster #326

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9ff4be
docs: update VSCode interactive node setup for current IRB cluster
CarlosLopezElorduy Sep 1, 2026
844bc1d
docs: restore vscode-interactive-job.sh SBATCH header
CarlosLopezElorduy Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 16 additions & 48 deletions docs/Tools/VSCode/cluster_node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Example:

```bash
$ hostname
irbccn43.hpc.irbbarcelona.pcb.ub.es
irbccn43.sc.irbbarcelona.org
```

### Step 2: [CLUSTER] Execute job vscode-interactive-job.sh
Expand Down Expand Up @@ -69,31 +69,17 @@ bash vscode-interactive-job.sh

It will prompt you several times to confirm the generation of the key. You can just press `Enter` to accept the default values.

The terminal will look like it got stuck, but what is happening is that it is waiting for
the SSH tunnel to be established.
The terminal will look like it got stuck. The `-D` flag keeps sshd running in the
Comment on lines 71 to +72
foreground on port 2222. Leave it running and open a new terminal for the next steps.
Comment on lines +72 to +73

### Step 3: [LOCAL] Open SSH tunnel

In your local machine, you need to open the SSH tunnel with the following command:

```bash
ssh -L 2222:<interactive_hostname>:22 <user>@irblogin01.irbbarcelona.pcb.ub.es
```

Example:

```bash
ssh -L 2222:irbccn43.hpc.irbbarcelona.pcb.ub.es:22 clopeze@irblogin01.irbbarcelona.pcb.ub.es
```

### Step 4: [LOCAL] [ONE-TIME-STEP] Add the SSH configuration
### Step 3: [LOCAL] [ONE-TIME-STEP] Add the SSH configuration

Modify the file `~/.ssh/config` in your local machine to include the following configuration:

```bash
Host irbccn*
HostName %h
ProxyJump irblogin01.irbbarcelona.pcb.ub.es
ProxyJump irblogin02.sc.irbbarcelona.org
User <user>
Port 2222
```
Expand All @@ -103,7 +89,7 @@ Example:
```bash
Host irbccn43
HostName %h
ProxyJump irblogin01.irbbarcelona.pcb.ub.es
ProxyJump irblogin02.sc.irbbarcelona.org
User clopeze
Port 2222
```
Expand All @@ -114,52 +100,34 @@ Host irbccn43

!!! tip "Tip (Optional): Helper function to add SSH configuration"
Here is a helper function that you can add to your `.bashrc` file to make it easier to
setup the node and the tunnel.

Steps the function does:
add a node to your SSH config.

1. Prompts only for the **host alias**.
2. Checks if a config entry for that **host already exists** in `~/.ssh/config` (and skips adding it if so).
3. Uses the fixed configuration values (with HostName as "%h", the fixed ProxyJump, port 2222, and the current computer user).
4. Computes the full hostname for the tunnel (by appending ".hpc.irbbarcelona.pcb.ub.es" to the alias) and creates the SSH tunnel (running in the background).
It prompts for the host alias, checks if an entry already exists, and appends the
config block if not.

```bash
add_cluster_ssh_host_with_tunnel() {
add_cluster_ssh_host() {
read -p "Enter host alias (e.g., irbccn43): " host_alias
current_user=$(whoami)

# Check if SSH config for this host already exists
if grep -qE "^Host[[:space:]]+${host_alias}\$" ~/.ssh/config; then
echo "SSH configuration for host '${host_alias}' already exists. Skipping configuration update."
if grep -qE "^Host[[:space:]]+${host_alias}$" ~/.ssh/config; then
echo "SSH configuration for host '${host_alias}' already exists. Skipping."
else
new_entry="Host ${host_alias}
HostName %h
ProxyJump irblogin01.irbbarcelona.pcb.ub.es
ProxyJump irblogin02.sc.irbbarcelona.org
User ${current_user}
Port 2222
"
echo -e "\n${new_entry}" >> ~/.ssh/config
echo "SSH configuration added for host '${host_alias}'."
fi

# Create the SSH tunnel.
# Assuming the full hostname is <host_alias>.hpc.irbbarcelona.pcb.ub.es
computed_hostname="${host_alias}.hpc.irbbarcelona.pcb.ub.es"
tunnel_cmd="ssh -f -N -L 2222:${computed_hostname}:22 ${current_user}@irblogin01.irbbarcelona.pcb.ub.es"
echo "Establishing SSH tunnel with command:"
echo "${tunnel_cmd}"
eval ${tunnel_cmd}
if [ $? -eq 0 ]; then
echo "SSH tunnel established for host '${host_alias}'."
else
echo "Failed to establish SSH tunnel."
fi
}

alias addsshcluster='add_cluster_ssh_host_with_tunnel'
alias addsshcluster='add_cluster_ssh_host'
```

#### Step 4.1: [LOCAL] [ONE-TIME-STEP] Access though the terminal to the node
#### Step 3.1: [LOCAL] [ONE-TIME-STEP] Access through the terminal to the node

To make sure the configuration is working, you can access the node through the terminal with the following command:

Expand All @@ -175,7 +143,7 @@ ssh irbccn43

This is needed the first time you connect to a new node, so that the node is added to the known hosts.

### Step 5: [VSCODE] Connect VSCode to the interactive node
### Step 4: [VSCODE] Connect VSCode to the interactive node

Open Visual Studio Code and make sure you have installed the `Remote - SSH` extension.

Expand Down
Loading