VS Code连接开发环境失败时的排查方法

网络链路检查

1. 在ModelArts管理控制台查看Notebook实例状态是否正常，确保实例无问题。
2. 在VS Code Terminal里执行如下命令，检测SSH命令是否可用。

   ssh -i <密钥相对路径> -p <端口> ma-user@<域名/ip>

   如果SSH命令不可用，请执行以下命令，排查端口是否正常。

   curl -kv telnet://<域名/ip>:<port>

   如果排查端口有问题，请联系环境管理人员；如果排查IP/域名、端口没有问题，只有SSH命令有问题，请参照SSH故障进行排查。

   图1 端口正常示例
   

本地排查

1. 检查密钥权限，并确保密钥文件无中文字符。

   以Windows系统为例，密钥一般放于C:\Users\<username>\目录下。

2. 检查本地配置SSH config文件是否正确。

   打开config文件进行检查：正常配置格式示例如下，Host必须放在每组配置的第一行，作为每组配置的唯一ID，配置顺序不能错误，Host的值不能重复。

   

   配置格式示例：

   HOST remote-dev
        hostname <instance connection host>
        port <instance connection port>
        user ma-user
        IdentityFile ~/.ssh/test.pem
        StrictHostKeyChecking no
        UserKnownHostsFile /dev/null
        ForwardAgent yes

   具体配置示例如下：

   Host ModelArts-Instance-Name
   HostName dev-modelarts.cn-southwest-2.huaweicloud.com
   Port 31375
   User ma-user
   IdentityFile c:\Users\<userID>\keypair.pem
   StrictHostKeyChecking no
   UserKnownHostsFile /dev/null
   ForwardAgent yes

   如果SSH config配置文件内容过多，需要快速确认是否为config文件的问题，可以尝试备份并删除config文件，重新从Notebook页面打开VS Code。

   • 如果config配置文件正确请按继续排查。
   • 如果不正确请按上面格式修改后继续排查。

3. 排查本地VS Code第三方插件。
   • 如果有VS Code中文插件，请卸载该插件后，重启Notebook实例，重新打开VS Code。

     VS Code中文插件可能会导致工具使用问题。

   • 排查插件包是否为兼容版本：在extensions中搜索，看是否需要升级。检查Remote-SSH三方插件是否兼容。

     

4. 检查本地VS Code是否为最新版，最新版可能有Bug，建议使用VS Code 1.86版本和VS Code 1.109.5版本。VS Code版本约束限制，请参见安装VS Code软件。

   如果以上步骤排查均无问题仍未解决，请联系技术支持定位。