Visual Studio Code SSH - Revision history

Moses: /* 1. Prepare a batch job submission script for VSCode tunnel session */

2026-04-20T18:47:40Z

1. Prepare a batch job submission script for VSCode tunnel session

← Older revision		Revision as of 14:47, 20 April 2026
Line 305:		Line 305:

	# Computing resources (CPU, memory, GPU) allocated for your batch job will be available within your VSCode tunnel working environment.		# Computing resources (CPU, memory, GPU) allocated for your batch job will be available within your VSCode tunnel working environment.
	# You can load additional compatible central modules in your batch job submission script. Any modules loaded ~~there~~ will be configured and available within your VSCode tunnel working environment.		# You can load additional compatible central modules in your batch job submission script. Any modules loaded for your batch job will be configured and available within your VSCode tunnel working environment.

	==== 2. Submit a batch job ====		==== 2. Submit a batch job ====

Moses: /* 1. Prepare a batch job submission script for VSCode tunnel session */

2026-04-20T18:46:17Z

1. Prepare a batch job submission script for VSCode tunnel session

← Older revision		Revision as of 14:46, 20 April 2026
Line 302:		Line 302:
	code-tunnel tunnel --name vscode-tunnel-0416 --cli-data-dir ~/.code_tunnel --accept-server-license-terms		code-tunnel tunnel --name vscode-tunnel-0416 --cli-data-dir ~/.code_tunnel --accept-server-license-terms

	</syntaxhighlight>'''Note:''' You can load additional compatible central modules in your batch job submission script. Any modules loaded there will be configured and available within your VSCode tunnel working environment.		</syntaxhighlight>'''Note:'''

			# Computing resources (CPU, memory, GPU) allocated for your batch job will be available within your VSCode tunnel working environment.
			# You can load additional compatible central modules in your batch job submission script. Any modules loaded there will be configured and available within your VSCode tunnel working environment.

	==== 2. Submit a batch job ====		==== 2. Submit a batch job ====

Moses at 18:44, 20 April 2026

2026-04-20T18:44:43Z

← Older revision		Revision as of 14:44, 20 April 2026
Line 204:		Line 204:
	<syntaxhighlight lang="shell">		<syntaxhighlight lang="shell">
	interact -c 20 --mem 80gb -p gpu_p --gres gpu:L4:2		interact -c 20 --mem 80gb -p gpu_p --gres gpu:L4:2
	</syntaxhighlight>		</syntaxhighlight>'''Note:''' Computing resources (CPU, memory, GPU) allocated here will be available within your VSCode tunnel working environment.
	----		----

Line 285:		Line 285:

	==== 1. Prepare a batch job submission script for VSCode tunnel session ====		==== 1. Prepare a batch job submission script for VSCode tunnel session ====


	Within the working directory of the interactive job described above, you can use a batch job submission script (<code>sub.sh</code>) as shown below:<syntaxhighlight lang="shell">		Within the working directory of the interactive job described above, you can use a batch job submission script (<code>sub.sh</code>) as shown below:<syntaxhighlight lang="shell">
	#!/bin/bash		#!/bin/bash

Moses: /* Interpretation */

2026-04-20T18:34:59Z

Interpretation

← Older revision		Revision as of 14:34, 20 April 2026
Line 532:		Line 532:

	=== Best Practices ===		=== Best Practices ===
	* Always run inside a Slurm ~~allocation~~
	* Never run VSCode directly on login nodes		* Always run VSCode (server/tunnel) inside a Slurm interactive or batch job on a compute node.
	* Install only ~~necessary~~ extensions		* Never run VSCode directly on login nodes.
	* ~~Clean~~ unused extensions ~~periodically~~		* Request appropriate CPU, memory, and GPU resources for your workload.
			* Install only the extensions you need.
			* Periodically remove unused extensions to reduce resource usage.
			* Avoid leaving idle VSCode sessions running; terminate jobs when not in use.
			* VS Code and its extensions are installed under ${HOME}/.vscode-server/, which counts toward your home directory quota.

	=== Key Takeaway ===		=== Key Takeaway ===
	VSCode is a ~~distributed,~~ multi-process system. It must be treated like a compute workload—not a simple SSH tool or text editor.		VSCode is a multi-process system. It must be treated like a compute workload—not a simple SSH tool or text editor.

	=== Final Note ===		=== Final Note ===

Moses at 18:22, 20 April 2026

2026-04-20T18:22:40Z

← Older revision		Revision as of 14:22, 20 April 2026
Line 482:		Line 482:

	=== Compute Node and Login Node Behavior (Observed) ===		=== Compute Node and Login Node Behavior (Observed) ===
	When your VSCode tunnel interactive or batch job is running on a compute node, you can check ~~relevant VSCode~~ processes with:<syntaxhighlight lang="shell">		When your VSCode tunnel (interactive or batch job) is running on a compute node, you can check the related VS Code processes with:<syntaxhighlight lang="shell">
	ssh <node> "pgrep -u $USER -af 'code\|vscode\|node\|~~python'~~"		ssh <node> "pgrep -u $USER -af 'code\|vscode\|node'"
			</syntaxhighlight>To compare, run the same command on the login node where you started the interactive job or submitted the batch job:<syntaxhighlight>
			pgrep -u $USER -af "code\|vscode\|node"
	</syntaxhighlight>Example:<syntaxhighlight lang="shell">		</syntaxhighlight>Example:<syntaxhighlight lang="shell">
	ssh ra5-6 "pgrep -u $USER -af 'code\|vscode\|node~~\|python~~'"		zhuofei@ss-sub4 VSCode_tunnel$ ssh ra5-6 "pgrep -u $USER -af 'code\|vscode\|node'"
	</~~syntaxhighlight>For comparing, you can also run the same pgrep on the login~~ node ~~where you started the interactive job or submitted compute~~ node:		3064679 code-tunnel tunnel --name vscode-tunnel-0416 --cli-data-dir /home/zhuofei/.code_tunnel --accept-server-license-terms
			3064696 sh /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/bin/code-server --connection-token=j2x9Z0dD03TwZ5WpnxGpodje1UFflxwsjGy0uDjVIOA --accept-server-license-terms --start-server --enable-remote-auto-shutdown --socket-path=/tmp/code-6ca97adf-e1a0-4b74-a319-bd3dff74b07c
			3064700 /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/node /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/out/server-main.js --connection-token=j2x9Z0dD03TwZ5WpnxGpodje1UFflxwsjGy0uDjVIOA --accept-server-license-terms --start-server --enable-remote-auto-shutdown --socket-path=/tmp/code-6ca97adf-e1a0-4b74-a319-bd3dff74b07c
			3064724 /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/node /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/out/bootstrap-fork --type=fileWatcher
			3064815 /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/node --dns-result-order=ipv4first /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/out/bootstrap-fork --type=extensionHost --transformURIs --useHostProxy=false
			3064832 /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/node /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/out/bootstrap-fork --type=ptyHost --logsPath /home/zhuofei/.vscode-server/data/logs/20260420T110646
			3064843 /bin/bash --init-file /home/zhuofei/.code_tunnel/servers/Stable-560a9dba96f961efea7b1612916f89e5d5d4d679/server/out/vs/workbench/contrib/terminal/common/scripts/shellIntegration-bash.sh

	~~Processes include:~~		zhuofei@ss-sub4 VSCode_tunnel$ pgrep -u $USER -af 'code\|vscode\|node'
			# (no output)

	* VSCode server		</syntaxhighlight>
	* Node.js services
	* Extension hosts
	* Terminal backend

	~~Resource usage example~~:		==== Observed Behavior ====
			'''On compute node:'''

	* ~~CPU: low but persistent~~		* VS Code Server process (<code>code-server</code>)
	* ~~Memory: non-trivial~~		* Node runtime processes (shown as <code>node</code>)
	* ~~GPU: allocated but may be idle~~		* Extension host (<code>node ... --type=extensionHost</code>)
	* ~~Processes:~~ <code>~~code~~-~~tunnel~~</code>~~, multiple~~ <code>node</code>		* File watcher (<code>node ... --type=fileWatcher</code>)
			* Terminal backend (<code>node ... --type=ptyHost</code>)

			'''On login node:'''

			* No VSCode-related processes

	----		----

	~~Across all~~ login ~~nodes (<code>ss-sub1</code>–<code>ss-sub4</code>):~~		==== Result ====

			* VSCode backend processes run only on the compute node
			* No VSCode services remain on the login node

	~~==== Result ====~~		----
	* No VSCode backend processes present
	* Only Slurm launcher processes visible
	* No persistent services running

	==== Interpretation ====		==== Interpretation ====
	~~VSCode workload is fully isolated to compute node~~

	Login nodes remain clean and responsive		* The VSCode workload is fully isolated to the compute node
			* Login nodes remain clean and responsive
			* This behavior aligns with HPC best practices

	----		----

Moses: /* Compute Node and Login Node Behavior (Observed) (To be completed ZH.20260417 4:53PM) */

2026-04-20T16:25:32Z

Compute Node and Login Node Behavior (Observed) (To be completed ZH.20260417 4:53PM)

@@ Line 481: / Line 481: @@
 ----
-=== Compute Node and Login Node Behavior (Observed) (To be completed ZH.20260417 4:53PM) ===
+=== Compute Node and Login Node Behavior (Observed) ===
-Example on compute node:
+When your VSCode tunnel interactive or batch job is running on a compute node, you can check relevant VSCode processes with:<syntaxhighlight lang="shell">
 Processes include:
@@ Line 511: / Line 515: @@
 Login nodes remain clean and responsive
 ----
@@ Line 556: / Line 524: @@
 === Key Takeaway ===
-VSCode is a distributed, multi-process system.
+VSCode is a distributed, multi-process system. It must be treated like a compute workload—not a simple SSH tool or text editor.
 === Final Note ===

Moses at 16:04, 20 April 2026

2026-04-20T16:04:02Z

← Older revision		Revision as of 12:04, 20 April 2026
Line 254:		Line 254:
	'''Important Notes:'''		'''Important Notes:'''

	* If another authorization prompt appears, it means the previous login was not fully completed.		* If another authorization prompt appears, it means the previous login in Step 5 was not fully completed.
	* Complete authorization using the latest code ~~shown in the log~~ (for example: <code>E1F9-D7E8</code>).		* Complete authorization using the latest code provided (for example: <code>E1F9-D7E8</code>).
	* Once authorization is successful, the VSCode link will appear ~~in the log~~ and can be used directly.		* Once authorization is successful, the VSCode link will appear and can be used directly.

	The VSCode tunnel is now active. Open the provided link in your browser to connect ~~<nowiki>https://vscode.dev/tunnel/</nowiki><tunnel-name>/<full>/<path>/<to>/<your>/<working folder where you started tunnel>~~		The VSCode tunnel is now active. Open the provided link in your browser to connect

	~~For example~~:		<nowiki>https://vscode.dev/tunnel/</nowiki><tunnel-name>/<full>/<path>/<to>/<your>/<working folder where you started tunnel>

			Example:

	<nowiki>https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel</nowiki>		<nowiki>https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel</nowiki>

Moses: /* Compute Node and Login Node Behavior (Observed) (To be completed ZH.20260417 4:53PM) */

2026-04-20T16:00:29Z

Compute Node and Login Node Behavior (Observed) (To be completed ZH.20260417 4:53PM)

← Older revision		Revision as of 12:00, 20 April 2026
Line 252:		Line 252:
	* Enter the code generated at this step, for example, E1F9-D7E8		* Enter the code generated at this step, for example, E1F9-D7E8
	* Authorize access		* Authorize access
			'''Important Notes:'''

			* If another authorization prompt appears, it means the previous login was not fully completed.
			* Complete authorization using the latest code shown in the log (for example: <code>E1F9-D7E8</code>).
			* Once authorization is successful, the VSCode link will appear in the log and can be used directly.

	The VSCode tunnel is now active. Open the provided link in your browser to connect <nowiki>https://vscode.dev/tunnel/</nowiki><tunnel-name>/<full>/<path>/<to>/<your>/<working folder where you started tunnel>		The VSCode tunnel is now active. Open the provided link in your browser to connect <nowiki>https://vscode.dev/tunnel/</nowiki><tunnel-name>/<full>/<path>/<to>/<your>/<working folder where you started tunnel>

Moses: /* 5. Example of steps */

2026-04-20T15:41:57Z

5. Example of steps

← Older revision		Revision as of 11:41, 20 April 2026
Line 310:		Line 310:
	If you cancel the batch job, or if the job is terminated after reaching its time limit, the VSCode tunnel session will stop, and all allocated resources (CPU, memory, and GPU) will be released. You will also lose the active VSCode connection and need to start a new session.		If you cancel the batch job, or if the job is terminated after reaching its time limit, the VSCode tunnel session will stop, and all allocated resources (CPU, memory, and GPU) will be released. You will also lose the active VSCode connection and need to start a new session.

	==== 5. Example of steps ====		==== 5. Example steps ====
	<syntaxhighlight lang="shell">		<syntaxhighlight lang="shell">
	zhuofei@ss-sub4 VSCode_tunnel$ pwd		zhuofei@ss-sub4 VSCode_tunnel$ pwd
Line 344:		Line 344:
	zhuofei@ss-sub4 VSCode_tunnel$ ls		zhuofei@ss-sub4 VSCode_tunnel$ ls
	log.44594144.out sub.sh		log.44594144.out sub.sh
	~~</syntaxhighlight><syntaxhighlight lang="shell">~~
	# --- ~~IMPORTANT WORKFLOW~~ ---		# --- Next Steps ---
	# --- 1. Run `cat log` ---		# --- 1. Run `cat log` ---
	# --- 2. Follow the instructions shown ~~(usually~~ in browser) ---		# --- 2. Follow the instructions shown in a browser ---
	# --- 3. Return and run `cat log` again ---		# --- 3. Return and run `cat log` again to see new instructions at the bottom of the log ---
	# --- 4. Repeat until tunnel is fully ready ---		# --- 4. Repeat until tunnel is fully ready ---


	# Open the log file first time		# Open the log file first time
	zhuofei@ss-sub4 VSCode_tunnel$ cat log.44594144.out		zhuofei@ss-sub4 VSCode_tunnel$ cat log.44594144.out

	# --- ~~VSCode~~ tunnel requests GitHub device authentication ---		# --- VS Code tunnel requests GitHub device authentication ---
	# --- ACTION: Open browser and complete authorization ---		# --- ACTION: Open a browser and complete authorization using the code shown below ---
	To grant access to the server, please log into https://github.com/login/device and use code D9D8-6303		To grant access to the server, please log into https://github.com/login/device and use code D9D8-6303

Line 370:		Line 369:

	# --- ACTION ---		# --- ACTION ---
	# --- If ~~prompted~~ again, complete ~~authorization~~ in browser ~~before continuing~~ ---		# --- If this authorization message appears again and you have NOT completed login, complete it in a browser using the latest code shown ---
	# --- If already ~~authorized~~, ~~proceed to next step~~ ---		# --- If you have already completed authorization, ignore this message and continue ---

	*		*
Line 382:		Line 381:

	# --- Tunnel provides browser access link ---		# --- Tunnel provides browser access link ---
	# --- ACTION: Open this link on your ~~local machine~~ ---		# --- ACTION: Open this link in your browser ---
	Open this link in your browser https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel		Open this link in your browser https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel

Line 391:		Line 390:
	zhuofei@ss-sub4 VSCode_tunnel$ cat log.44594144.out		zhuofei@ss-sub4 VSCode_tunnel$ cat log.44594144.out

	# --- Authentication message may still appear ~~(normal behavior)~~ ---		# --- Authentication message may still appear ---
	# --- No action needed if already completed ---		# --- No action needed if authorization is already completed ---
	To grant access to the server, please log into https://github.com/login/device and use code D9D8-6303		To grant access to the server, please log into https://github.com/login/device and use code D9D8-6303

Line 402:		Line 401:

	# --- Tunnel link remains active ---		# --- Tunnel link remains active ---
	# --- ACTION: Ensure browser is connected using the link above ---		# --- ACTION: Ensure your browser is connected using the link above ---
	Open this link in your browser https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel		Open this link in your browser https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel

Line 422:		Line 421:
	Open this link in your browser https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel		Open this link in your browser https://vscode.dev/tunnel/vscode-tunnel-0416/scratch/zhuofei/VSCode_tunnel

	# --- A client (browser) connected to the tunnel ---		# --- A client (your browser) connected to the tunnel ---
	[2026-04-20 11:06:45] info [tunnels::connections::relay_tunnel_host] Opened new client on channel 2		[2026-04-20 11:06:45] info [tunnels::connections::relay_tunnel_host] Opened new client on channel 2

Line 442:		Line 441:

	# --- DONE: Tunnel is fully ready ---		# --- DONE: Tunnel is fully ready ---
	# --- You can now use VS Code in browser ---		# --- You can now use VS Code in your browser ---
	</syntaxhighlight>		</syntaxhighlight>

	=== What Happens Under the Hood When Using VSCode ===		=== What Happens Under the Hood When Using VSCode ===
	We would like VSCode users to understand what happens behind the scenes.		We would like VSCode users to understand what happens behind the scenes.

Moses: /* 5. Example of steps */

2026-04-20T15:26:57Z

5. Example of steps

Show changes