| title | description | h1 |
|---|---|---|
Visual Studio Code |
How to use Visual Studio Code's Remote Development plugin with Teleport |
Remote Development With Visual Studio Code |
This guide explains how to use Teleport and Visual Studio Code's remote SSH extension.
(!docs/pages/includes/edition-prereqs-tabs-not-admin.mdx!)
- OpenSSH client.
- Visual Studio Code with the Remote - SSH extension for the Remote - SSH extension.
- One or more Teleport Agents running the Teleport SSH Service. If you have not yet done this, read the getting started guide to learn how.
Configure your local SSH client to access Teleport Nodes. Replace with the address of your Teleport Proxy Service (e.g., mytenant.teleport.sh for Teleport Cloud users), and replace with your Teleport user.
# log in to your proxy:
$ tsh login --proxy <Var name="teleport.example.com"/> --user <Var name="alice"/>
# generate the OpenSSH config for the proxy:
$ tsh config --proxy <Var name="teleport.example.com"/>
Append the resulting configuration snippet into your SSH config file located in the path below:
`$HOME/.ssh/config` `%UserProfile%\.ssh\config`If using PowerShell on Windows to write your SSH config, note that normal shell redirection may write the file with the incorrect encoding. To ensure it's written properly, try the following:
$ tsh.exe config | out-file .ssh\config -encoding utf8 -append
You should be able to connect to the desired node using following command, replacing with the username you would like to assume on the node and with the node name:
$ ssh <Var name="user" />@<Var name="example-node" description="An SSH node in your Teleport cluster"/>.<Var name="teleport.example.com"/>
[email protected]: Permission denied (publickey).
ERROR: exit status 255
kex_exchange_identification: Connection closed by remote hostWhen you see this error, re-run tsh login to refresh your local certificate.
Install the Remote - SSH extension in your local VS Code instance. A new "Window Indicator" (icon with two arrows) should appear in the bottom left of your VS Code window.
Prior to connecting with a host, set the Remote.SSH: Use Local Server setting
to false in the extension setting. You can search for
@ext:ms-vscode-remote.remote-ssh to find the plugin-specific settings.
To connect, click on the icon with two arrows and select "Connect to Host...". Select "+ Add New SSH Host..."
For each host you wish to remotely develop on, add an entry like the following:
When prompted to choose which SSH Configuration file to update select the one we generated during Step 1.
This will write a new node into your SSH Configuration file. You can edit and manage all your nodes in this file.
Start a Remote Development session by either:
- Clicking "Connect" on the notification that opens after adding a new host.
- Clicking on the Window Indicator again and selecting "Connect to Host". You should see the host you just added and any others in your Configuration file in the drop down.
On first connect, you'll be prompted to configure the remote OS. Select the proper platform and VS Code will install its server-side component. When it completes, you should be left with a working editor:
The Window Indicator in the bottom left highlights the currently connected remote host.
It's possible to remotely develop on any OpenSSH host joined to a Teleport cluster so long as its host OS is supported by VS Code. Refer to the OpenSSH guide to configure the remote host to authenticate via Teleport certificates, after which the procedure outlined above can be used to connect to the host in VS Code.
This guide makes use of tsh config; refer to the
dedicated guide for additional information.