Commit 9f04a49b authored by Chris Hines's avatar Chris Hines
Browse files

Update vscode.md

parent 974dc392
Pipeline #18071 failed with stage
in 4 minutes and 10 seconds
......@@ -14,9 +14,8 @@ By default, if you follow those instructions, you will end up running the VS Cod
Please follow the excelent instructions here https://code.visualstudio.com/docs/remote/ssh#_installation ... When you get to the section "Connect to a remote host" please come back here
### Setup ssh-agent and keys (optional HIGHLY recommended)
####. Generate a key
### Generate a key (optional HIGHLY recommended)
If you are still using passwords, you should definitly switch to keys open a terminal (mac and linux) or a powershell (windows) and run the command
```
......@@ -32,11 +31,11 @@ copy the line of text printed out. Using Strudel2 (beta.cloud.cvl.org.au), selec
```
echo <paste the line you just copied> >> .ssh/authorized_keys
```
#### Setup the agent
### Setup the agent (optinal HIGHLY recommended if on windows)
Windows only (the agent is already running on linux and mac)
This is only needed on Windows as its the default on mac/linux so no action is needed.
##### ALERT ALERT THIS DOCUMENTATION IS INCOMPLETE!!!!!
#### ALERT ALERT THIS DOCUMENTATION IS INCOMPLETE!!!!!
I *think* you may have to install openssh on windows, but it may be pre-installed.
```
......@@ -48,14 +47,14 @@ To install the OpenSSH components:
Next you need to start the OpenSSH SSH agent. You have two options
##### Option 1 Via GUI:
#### Option 1 Via GUI:
1. Press the windows key (to begin search) and type "Services". Hit enter to open the services app
1. Scroll down to OpenSSH Authentication Agent and double click
1. Change "Startup type" to "Automatic"
1. Click start
##### Option 2 Via PowerShell:
#### Option 2 Via PowerShell:
Start a powershell as administrator and run the following
```
......@@ -64,11 +63,11 @@ Get-Service -Name ssh-agent | Set-Service -StartupType Automatic
Start-Service ssh-agent
```
#### Add the key to the agent
### Add the key to the agent (optional HIGHLY recommended)
Open a terminal and type `ssh-add .ssh/id_ed25519` you'll be asked for that key passphrase, but then your computer will remember the key (until the next reboot)
###. Configure VS Code
### Configure VS Code
Skip down to here https://code.visualstudio.com/docs/remote/ssh#_remember-hosts-and-advanced-settings. If you are on linux or mac, for your "SSH Connection Command" enter
```
......@@ -82,11 +81,11 @@ ssh -l <username> VSCode -o ProxyCommand="ssh.exe <username>@m3.massive.org.au /
The proxycommand allows us to connect, not to the login nodes but to a node allocated just to you. This is different than a regular VSCode setup because youre on an HPC cluster, not a regular server.
###. Allocate a computer for the remote server
### Allocate a computer for the remote server
Using strudel2 https://beta.cloud.cvl.org.au login to CVL and select the VS Code application on the left. Fill in how many CPUs which GPU and how much RAM you need for how long and click launch
###. Start the remote server
### Start the remote server
Switching back to vscode, Remote-ssh: Connect to host and select the VS Code host If you didn't add the key to the agent, VS Code will ask you for either you key passphrase or your M3 password. It will ask twice (once to the connect to the login nodes, then again to connect to the node running the remote server)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment