VSCode

VSCode Remote-SSH可以让您直接在本地VSCode中连接并管理远程实例，适合进行代码编辑、调试和环境配置。
警告： 如果使用VSCode直接执行或开终端执行训练程序，请在调试完成后最后通过screen或tmux工具开守护进程，确保程序不受SSH连接中断影响程序执行。详情请参考守护进程文档。

官方文档：VSCode Remote-SSH

使用前准备

在进行操作前，您需要提前准备好以下内容：

安装VSCode；

在OLA Cloud租用并开机实例；

获取实例的SSH登录信息，包括登录指令和登录密码；

在本地VSCode中安装Remote-SSH插件。

1.登录OLA Cloud选择开机的实例

登录OLA Cloud，进入“容器管理”，启动需要使用的实例。

在实例详情或连接信息中找到SSH登录指令，并复制完整命令。下面以以下命令为例：

这条命令中各个参数的含义如下：

用户名：root

主机（host）：123.xxx.xxx.32

端口号：30220

注意： 每个实例的SSH主机和端口都可能不同，请以当前实例页面显示的登录指令为准，不要直接照抄示例中的地址和端口。

2.本地VSCode配置Remote-SSH

如果本地VSCode已经安装Remote-SSH插件，可以跳过此步骤，直接参考步骤3。

打开VSCode左侧的扩展程序菜单，在搜索框中输入Remote - SSH，找到微软官方发布的Remote - SSH扩展并安装。

安装完成后，VSCode左侧通常会出现远程连接相关图标，也可以通过命令面板使用Remote-SSH功能。

3.添加SSH主机

点击VSCode左下角的“远程窗口”按钮，在弹出的菜单中选择“连接到主机”，然后选择“添加新的SSH主机”。

将实例页面中的完整SSH登录指令粘贴到输入框中：

按回车键继续操作。

注意： 如果SSH命令的最后有多余空格，请删除空格后再确认，否则可能无法正常连接。

随后会弹出选择SSH配置文件的窗口。一般情况下直接选择默认配置文件即可；如果出现多个配置文件选项，选择您平时使用的SSH配置文件。

4.连接并登录远程实例

添加SSH主机后，再次点击VSCode左下角的“远程窗口”按钮，选择“连接到主机”，然后选择刚才添加的SSH主机。

首次连接时，VSCode可能会弹出选择远程服务器平台的窗口。OLA Cloud实例一般使用Linux系统，请选择Linux。

输入实例SSH密码，等待VSCode完成连接。

连接成功后，VSCode左下角会显示远程主机信息，表示当前窗口已经连接到远程实例。此时打开的终端和执行的命令都将在远程实例中运行。

5.选择代码目录

连接远程实例后，点击VSCode左侧的“资源管理器”，选择“打开文件夹”。

根据代码所在位置选择远程目录。您可以直接选择实例中的项目目录进行开发；如果代码尚未上传，也可以在 VSCode 远程窗口中创建或编写代码，并将其保存到选定的远程目录。建议使用实例的数据盘或其他专用项目目录，不建议直接使用 / 作为项目目录。如果您需要上传代码，可以使用SCP工具或参考JupyterLab章节上传资源。

选择目录后，VSCode会加载远程文件，左侧资源管理器中将显示远程代码目录的文件内容。

建议： 使用VSCode开发代码时，请根据开发语言配置相应的解释器。例如，Python项目需要选择远程实例中的Python解释器，而不是本地计算机中的解释器。

6.使用VSCode远程终端

连接远程实例后，可以通过菜单“终端 -> 新建终端”打开远程终端。

可以使用以下命令确认当前所在的服务器和目录：

在远程终端中执行的命令会直接作用于远程实例。请注意区分VSCode本地终端和远程终端，避免将安装依赖或运行程序的命令执行到错误的环境中。

7.长时间运行程序时使用screen

如果直接在VSCode终端中运行训练程序，VSCode或SSH连接断开后，程序可能会被一并终止。因此，调试完成后，强烈建议使用screen或tmux运行需要长时间执行的程序。

详情请参考守护进程文档。

8.常见问题

Remote - SSH插件搜索不到或安装失败

请检查本地网络是否正常，并确认安装的是微软官方的Remote - SSH扩展。如果插件已经安装，可以重启VSCode后再次尝试连接。

出现`Permission denied`

请检查以下内容：

用户名是否为实例页面提供的用户名，通常为root；

SSH密码是否正确；

SSH登录指令中的主机和端口是否完整；

是否误删了命令中的-p参数或端口号。

出现`Connection refused`或连接超时

请确认：

实例已经开机并处于运行状态；

使用的是当前实例最新的SSH登录信息；

SSH主机地址和端口没有填写错误；

本地网络或代理没有拦截SSH连接。

无法选择或连接Linux平台

请确认远程实例使用的是Linux系统，并重新执行“连接到主机”操作。如果VSCode提示安装远程服务失败，请检查实例磁盘空间、网络连接以及当前用户权限。

打开代码目录后没有文件

请确认选择的是远程窗口中的“打开文件夹”，而不是本地窗口中的“打开文件夹”。同时检查代码是否已经上传到实例，并确认选择的目录路径正确。

关闭VSCode后程序停止

如果程序是在普通远程终端中直接执行的，断开连接后程序可能会终止。请使用screen或tmux重新启动程序，并通过日志文件查看运行情况。

远程终端中文显示乱码

可以检查VSCode终端编码、远程服务器Locale配置以及程序本身的文本编码设置。通常建议使用UTF-8编码。

使用前准备#

1.登录OLA Cloud选择开机的实例#

2.本地VSCode配置Remote-SSH#

3.添加SSH主机#

4.连接并登录远程实例#

5.选择代码目录#

6.使用VSCode远程终端#

7.长时间运行程序时使用screen#

8.常见问题#

Remote - SSH插件搜索不到或安装失败#

出现Permission denied#

出现Connection refused或连接超时#

无法选择或连接Linux平台#

打开代码目录后没有文件#

关闭VSCode后程序停止#

远程终端中文显示乱码#